diff options
Diffstat (limited to 'deno')
29 files changed, 1522 insertions, 824 deletions
diff --git a/deno/mail-relay/.gitignore b/deno/.gitignore index 327aef0..327aef0 100644 --- a/deno/mail-relay/.gitignore +++ b/deno/.gitignore diff --git a/deno/base/config.ts b/deno/base/config.ts new file mode 100644 index 0000000..a5f5d86 --- /dev/null +++ b/deno/base/config.ts @@ -0,0 +1,93 @@ +import { camelCaseToKebabCase } from "./lib.ts"; + +export interface ConfigDefinitionItem { + readonly description: string; + readonly default?: string; + readonly secret?: boolean; +} + +interface ConfigMapItem extends ConfigDefinitionItem { + readonly env: string; + value?: string; +} + +export type ConfigDefinition<K extends string = string> = Record< + K, + ConfigDefinitionItem +>; +type ConfigMap<K extends string = string> = Record<K, ConfigMapItem>; + +export class ConfigProvider<K extends string> { + readonly #prefix: string; + readonly #map: ConfigMap<K>; + + constructor(prefix: string, ...definitions: Partial<ConfigDefinition<K>>[]) { + this.#prefix = prefix; + + const map: ConfigMap = {}; + for (const definition of definitions) { + for (const [key, def] of Object.entries(definition as ConfigDefinition)) { + map[key] = { + ...def, + env: `${this.#prefix}-${camelCaseToKebabCase(key as string)}` + .replaceAll("-", "_") + .toUpperCase(), + }; + } + } + this.#map = map as ConfigMap<K>; + } + + resolveFromEnv(options?: { keys?: K[] }) { + const keys = options?.keys ?? Object.keys(this.#map); + for (const key of keys) { + const { env, description, default: _default } = this.#map[key as K]; + const value = Deno.env.get(env) ?? _default; + if (value == null) { + throw new Error(`Required env ${env} (${description}) is not set.`); + } + this.#map[key as K].value = value; + } + } + + get(key: K): string { + if (!(key in this.#map)) { + throw new Error(`Unknown config key ${key as string}.`); + } + if (this.#map[key].value == null) { + this.resolveFromEnv({ keys: [key] }); + } + return this.#map[key].value!; + } + + set(key: K, value: string) { + if (!(key in this.#map)) { + throw new Error(`Unknown config key ${key as string}.`); + } + this.#map[key].value = value; + } + + getInt(key: K): number { + return Number(this.get(key)); + } + + getList(key: K, separator: string = ","): string[] { + const value = this.get(key); + if (value.length === 0) return []; + return value.split(separator); + } + + [Symbol.for("Deno.customInspect")]() { + const getValueString = (item: ConfigMapItem): string => { + if (item.value == null) return "(unresolved)"; + if (item.secret === true) return "***"; + return item.value; + }; + + return Object.entries(this.#map as ConfigMap) + .map( + ([key, item]) => `${key} [env: ${item.env}]: ${getValueString(item)}`, + ) + .join("\n"); + } +} diff --git a/deno/mail-relay/cron.ts b/deno/base/cron.ts index bf0a0be..bf0a0be 100644 --- a/deno/mail-relay/cron.ts +++ b/deno/base/cron.ts diff --git a/deno/base/deno.json b/deno/base/deno.json new file mode 100644 index 0000000..dabc02a --- /dev/null +++ b/deno/base/deno.json @@ -0,0 +1,10 @@ +{ + "name": "@crupest/base", + "version": "0.1.0", + "exports": { + ".": "./lib.ts", + "./config": "./config.ts", + "./cron": "./cron.ts", + "./log": "./log.ts" + } +} diff --git a/deno/base/lib.ts b/deno/base/lib.ts new file mode 100644 index 0000000..a5e4a6a --- /dev/null +++ b/deno/base/lib.ts @@ -0,0 +1,10 @@ +export function camelCaseToKebabCase(str: string): string { + return str.replace(/[A-Z]/g, (m) => "-" + m.toLowerCase()); +} + +export function toFileNameString(date: Date, dateOnly?: boolean): string { + const str = date.toISOString(); + return dateOnly === true + ? str.slice(0, str.indexOf("T")) + : str.replaceAll(/:|\./g, "-"); +} diff --git a/deno/base/log.ts b/deno/base/log.ts new file mode 100644 index 0000000..940f569 --- /dev/null +++ b/deno/base/log.ts @@ -0,0 +1,60 @@ +import { join } from "@std/path"; + +import { toFileNameString } from "./lib.ts"; + +export interface ExternalLogStream extends Disposable { + stream: WritableStream; +} + +export class LogFileProvider { + #directory: string; + + constructor(directory: string) { + this.#directory = directory; + Deno.mkdirSync(directory, { recursive: true }); + } + + async createExternalLogStream( + name: string, + options?: { + noTime?: boolean; + }, + ): Promise<ExternalLogStream> { + if (name.includes("/")) { + throw new Error(`External log stream's name (${name}) contains '/'.`); + } + + const logPath = join( + this.#directory, + options?.noTime === true + ? name + : `${name}-${toFileNameString(new Date())}`, + ); + + const file = await Deno.open(logPath, { + read: false, + write: true, + append: true, + create: true, + }); + return { + stream: file.writable, + [Symbol.dispose]: file[Symbol.dispose].bind(file), + }; + } + + async createExternalLogStreamsForProgram( + program: string, + ): Promise<{ stdout: WritableStream; stderr: WritableStream } & Disposable> { + const stdout = await this.createExternalLogStream(`${program}-stdout`); + const stderr = await this.createExternalLogStream(`${program}-stderr`); + return { + stdout: stdout.stream, + stderr: stderr.stream, + [Symbol.dispose]: () => { + stdout[Symbol.dispose](); + stderr[Symbol.dispose](); + }, + }; + } +} diff --git a/deno/deno.json b/deno/deno.json index 558795f..53cdf7a 100644 --- a/deno/deno.json +++ b/deno/deno.json @@ -1,6 +1,19 @@ { - "workspace": [ "./mail-relay" ], + "workspace": ["./base", "./mail-relay", "./tools"], "tasks": { "compile:mail-relay": "deno task --cwd=mail-relay compile" + }, + "imports": { + "@std/collections": "jsr:@std/collections@^1.1.1", + "@std/csv": "jsr:@std/csv@^1.0.6", + "@std/encoding": "jsr:@std/encoding@^1.0.10", + "@std/expect": "jsr:@std/expect@^1.0.16", + "@std/io": "jsr:@std/io@^0.225.2", + "@std/path": "jsr:@std/path@^1.1.0", + "@std/testing": "jsr:@std/testing@^1.0.13", + "@std/dotenv": "jsr:@std/dotenv@^0.225.5", + "@std/fs": "jsr:@std/fs@^1.0.18", + "yargs": "npm:yargs@^18.0.0", + "@types/yargs": "npm:@types/yargs@^17.0.33" } } diff --git a/deno/deno.lock b/deno/deno.lock index 020a2c4..871a9ae 100644 --- a/deno/deno.lock +++ b/deno/deno.lock @@ -5,29 +5,43 @@ "jsr:@denosaurs/plug@1": "1.1.0", "jsr:@std/assert@0.217": "0.217.0", "jsr:@std/assert@^1.0.13": "1.0.13", + "jsr:@std/async@^1.0.13": "1.0.13", "jsr:@std/bytes@^1.0.5": "1.0.6", - "jsr:@std/cli@^1.0.19": "1.0.19", + "jsr:@std/collections@^1.1.1": "1.1.1", "jsr:@std/csv@^1.0.6": "1.0.6", + "jsr:@std/data-structures@^1.0.8": "1.0.8", + "jsr:@std/dotenv@~0.225.5": "0.225.5", "jsr:@std/encoding@1": "1.0.10", "jsr:@std/encoding@^1.0.10": "1.0.10", "jsr:@std/expect@^1.0.16": "1.0.16", "jsr:@std/fmt@1": "1.0.8", "jsr:@std/fs@1": "1.0.17", + "jsr:@std/fs@^1.0.17": "1.0.17", + "jsr:@std/fs@^1.0.18": "1.0.18", "jsr:@std/internal@^1.0.6": "1.0.7", "jsr:@std/internal@^1.0.7": "1.0.7", + "jsr:@std/internal@^1.0.8": "1.0.8", "jsr:@std/io@~0.225.2": "0.225.2", "jsr:@std/path@0.217": "0.217.0", "jsr:@std/path@1": "1.1.0", "jsr:@std/path@^1.0.9": "1.1.0", "jsr:@std/path@^1.1.0": "1.1.0", "jsr:@std/streams@^1.0.9": "1.0.9", + "jsr:@std/testing@^1.0.13": "1.0.13", "npm:@aws-sdk/client-s3@^3.821.0": "3.824.0", "npm:@aws-sdk/client-sesv2@^3.821.0": "3.824.0", "npm:@hono/zod-validator@0.7": "0.7.0_hono@4.7.11_zod@3.25.51", "npm:@smithy/fetch-http-handler@^5.0.4": "5.0.4", + "npm:@types/lodash@*": "4.17.17", + "npm:@types/mustache@*": "4.2.6", + "npm:@types/node@*": "22.15.15", + "npm:@types/yargs@*": "17.0.33", + "npm:@types/yargs@^17.0.33": "17.0.33", "npm:email-addresses@5": "5.0.0", "npm:hono@^4.7.11": "4.7.11", "npm:kysely@~0.28.2": "0.28.2", + "npm:mustache@^4.2.0": "4.2.0", + "npm:yargs@18": "18.0.0", "npm:zod@^3.25.48": "3.25.51" }, "jsr": { @@ -43,7 +57,7 @@ "dependencies": [ "jsr:@std/encoding@1", "jsr:@std/fmt", - "jsr:@std/fs", + "jsr:@std/fs@1", "jsr:@std/path@1" ] }, @@ -56,11 +70,14 @@ "jsr:@std/internal@^1.0.6" ] }, + "@std/async@1.0.13": { + "integrity": "1d76ca5d324aef249908f7f7fe0d39aaf53198e5420604a59ab5c035adc97c96" + }, "@std/bytes@1.0.6": { "integrity": "f6ac6adbd8ccd99314045f5703e23af0a68d7f7e58364b47d2c7f408aeb5820a" }, - "@std/cli@1.0.19": { - "integrity": "b3601a54891f89f3f738023af11960c4e6f7a45dc76cde39a6861124cba79e88" + "@std/collections@1.1.1": { + "integrity": "eff6443fbd9d5a6697018fb39c5d13d5f662f0045f21392d640693d0008ab2af" }, "@std/csv@1.0.6": { "integrity": "52ef0e62799a0028d278fa04762f17f9bd263fad9a8e7f98c14fbd371d62d9fd", @@ -68,6 +85,12 @@ "jsr:@std/streams" ] }, + "@std/data-structures@1.0.8": { + "integrity": "2fb7219247e044c8fcd51341788547575653c82ae2c759ff209e0263ba7d9b66" + }, + "@std/dotenv@0.225.5": { + "integrity": "9ce6f9d0ec3311f74a32535aa1b8c62ed88b1ab91b7f0815797d77a6f60c922f" + }, "@std/encoding@1.0.10": { "integrity": "8783c6384a2d13abd5e9e87a7ae0520a30e9f56aeeaa3bdf910a3eaaf5c811a1" }, @@ -87,9 +110,18 @@ "jsr:@std/path@^1.0.9" ] }, + "@std/fs@1.0.18": { + "integrity": "24bcad99eab1af4fde75e05da6e9ed0e0dce5edb71b7e34baacf86ffe3969f3a", + "dependencies": [ + "jsr:@std/path@^1.1.0" + ] + }, "@std/internal@1.0.7": { "integrity": "39eeb5265190a7bc5d5591c9ff019490bd1f2c3907c044a11b0d545796158a0f" }, + "@std/internal@1.0.8": { + "integrity": "fc66e846d8d38a47cffd274d80d2ca3f0de71040f855783724bb6b87f60891f5" + }, "@std/io@0.225.2": { "integrity": "3c740cd4ee4c082e6cfc86458f47e2ab7cb353dc6234d5e9b1f91a2de5f4d6c7", "dependencies": [ @@ -110,6 +142,17 @@ "dependencies": [ "jsr:@std/bytes" ] + }, + "@std/testing@1.0.13": { + "integrity": "74418be16f627dfe996937ab0ffbdbda9c1f35534b78724658d981492f121e71", + "dependencies": [ + "jsr:@std/assert@^1.0.13", + "jsr:@std/async", + "jsr:@std/data-structures", + "jsr:@std/fs@^1.0.17", + "jsr:@std/internal@^1.0.8", + "jsr:@std/path@^1.1.0" + ] } }, "npm": { @@ -1127,12 +1170,53 @@ "tslib" ] }, + "@types/lodash@4.17.17": { + "integrity": "sha512-RRVJ+J3J+WmyOTqnz3PiBLA501eKwXl2noseKOrNo/6+XEHjTAxO4xHvxQB6QuNm+s4WRbn6rSiap8+EA+ykFQ==" + }, + "@types/mustache@4.2.6": { + "integrity": "sha512-t+8/QWTAhOFlrF1IVZqKnMRJi84EgkIK5Kh0p2JV4OLywUvCwJPFxbJAl7XAow7DVIHsF+xW9f1MVzg0L6Szjw==" + }, + "@types/node@22.15.15": { + "integrity": "sha512-R5muMcZob3/Jjchn5LcO8jdKwSCbzqmPB6ruBxMcf9kbxtniZHP327s6C37iOfuw8mbKK3cAQa7sEl7afLrQ8A==", + "dependencies": [ + "undici-types" + ] + }, + "@types/yargs-parser@21.0.3": { + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==" + }, + "@types/yargs@17.0.33": { + "integrity": "sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA==", + "dependencies": [ + "@types/yargs-parser" + ] + }, + "ansi-regex@6.1.0": { + "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==" + }, + "ansi-styles@6.2.1": { + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==" + }, "bowser@2.11.0": { "integrity": "sha512-AlcaJBi/pqqJBIQ8U9Mcpc9i8Aqxn88Skv5d+xBX006BY5u8N3mGLHa5Lgppa7L/HfwgwLgZ6NYs+Ag6uUmJRA==" }, + "cliui@9.0.1": { + "integrity": "sha512-k7ndgKhwoQveBL+/1tqGJYNz097I7WOvwbmmU2AR5+magtbjPWQTS1C5vzGkBC8Ym8UWRzfKUzUUqFLypY4Q+w==", + "dependencies": [ + "string-width", + "strip-ansi", + "wrap-ansi" + ] + }, "email-addresses@5.0.0": { "integrity": "sha512-4OIPYlA6JXqtVn8zpHpGiI7vE6EQOAg16aGnDMIAlZVinnoZ8208tW1hAbjWydgN/4PLTT9q+O1K6AH/vALJGw==" }, + "emoji-regex@10.4.0": { + "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==" + }, + "escalade@3.2.0": { + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==" + }, "fast-xml-parser@4.4.1": { "integrity": "sha512-xkjOecfnKGkSsOwtZ5Pz7Us/T6mrbPQrq0nh+aCO5V9nk5NLWmasAHumTKjiPJPWANe+kAZ84Jc8ooJkzZ88Sw==", "dependencies": [ @@ -1140,38 +1224,96 @@ ], "bin": true }, + "get-caller-file@2.0.5": { + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==" + }, + "get-east-asian-width@1.3.0": { + "integrity": "sha512-vpeMIQKxczTD/0s2CdEWHcb0eeJe6TFjxb+J5xgX7hScxqrGuyjmv4c1D4A/gelKfyox0gJJwIHF+fLjeaM8kQ==" + }, "hono@4.7.11": { "integrity": "sha512-rv0JMwC0KALbbmwJDEnxvQCeJh+xbS3KEWW5PC9cMJ08Ur9xgatI0HmtgYZfOdOSOeYsp5LO2cOhdI8cLEbDEQ==" }, "kysely@0.28.2": { "integrity": "sha512-4YAVLoF0Sf0UTqlhgQMFU9iQECdah7n+13ANkiuVfRvlK+uI0Etbgd7bVP36dKlG+NXWbhGua8vnGt+sdhvT7A==" }, + "mustache@4.2.0": { + "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ==", + "bin": true + }, + "string-width@7.2.0": { + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "dependencies": [ + "emoji-regex", + "get-east-asian-width", + "strip-ansi" + ] + }, + "strip-ansi@7.1.0": { + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "dependencies": [ + "ansi-regex" + ] + }, "strnum@1.1.2": { "integrity": "sha512-vrN+B7DBIoTTZjnPNewwhx6cBA/H+IS7rfW68n7XxC1y7uoiGQBxaKzqucGUgavX15dJgiGztLJ8vxuEzwqBdA==" }, "tslib@2.8.1": { "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==" }, + "undici-types@6.21.0": { + "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==" + }, "uuid@9.0.1": { "integrity": "sha512-b+1eJOlsR9K8HJpow9Ok3fiWOWSIcIzXodvv0rQjVoOVNpWMpxf1wZNpt4y9h10odCNrqnYp1OBzRktckBe3sA==", "bin": true }, + "wrap-ansi@9.0.0": { + "integrity": "sha512-G8ura3S+3Z2G+mkgNRq8dqaFZAuxfsxpBB8OCTGRTCtp+l/v9nbFNmCUP1BZMts3G1142MsZfn6eeUKrr4PD1Q==", + "dependencies": [ + "ansi-styles", + "string-width", + "strip-ansi" + ] + }, + "y18n@5.0.8": { + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==" + }, + "yargs-parser@22.0.0": { + "integrity": "sha512-rwu/ClNdSMpkSrUb+d6BRsSkLUq1fmfsY6TOpYzTwvwkg1/NRG85KBy3kq++A8LKQwX6lsu+aWad+2khvuXrqw==" + }, + "yargs@18.0.0": { + "integrity": "sha512-4UEqdc2RYGHZc7Doyqkrqiln3p9X2DZVxaGbwhn2pi7MrRagKaOcIKe8L3OxYcbhXLgLFUS3zAYuQjKBQgmuNg==", + "dependencies": [ + "cliui", + "escalade", + "get-caller-file", + "string-width", + "y18n", + "yargs-parser" + ] + }, "zod@3.25.51": { "integrity": "sha512-TQSnBldh+XSGL+opiSIq0575wvDPqu09AqWe1F7JhUMKY+M91/aGlK4MhpVNO7MgYfHcVCB1ffwAUTJzllKJqg==" } }, "workspace": { + "dependencies": [ + "jsr:@std/collections@^1.1.1", + "jsr:@std/csv@^1.0.6", + "jsr:@std/dotenv@~0.225.5", + "jsr:@std/encoding@^1.0.10", + "jsr:@std/expect@^1.0.16", + "jsr:@std/fs@^1.0.18", + "jsr:@std/io@~0.225.2", + "jsr:@std/path@^1.1.0", + "jsr:@std/testing@^1.0.13", + "npm:@types/yargs@^17.0.33", + "npm:yargs@18" + ], "members": { "mail-relay": { "dependencies": [ "jsr:@db/sqlite@0.12", - "jsr:@std/cli@^1.0.19", - "jsr:@std/csv@^1.0.6", - "jsr:@std/encoding@^1.0.10", - "jsr:@std/expect@^1.0.16", - "jsr:@std/io@~0.225.2", - "jsr:@std/path@^1.1.0", - "jsr:@std/testing@^1.0.13", "npm:@aws-sdk/client-s3@^3.821.0", "npm:@aws-sdk/client-sesv2@^3.821.0", "npm:@hono/zod-validator@0.7", @@ -1181,6 +1323,11 @@ "npm:kysely@~0.28.2", "npm:zod@^3.25.48" ] + }, + "tools": { + "dependencies": [ + "npm:mustache@^4.2.0" + ] } } } diff --git a/deno/mail-relay/app.ts b/deno/mail-relay/app.ts index deb72c2..eeffc12 100644 --- a/deno/mail-relay/app.ts +++ b/deno/mail-relay/app.ts @@ -1,81 +1,84 @@ -import { join } from "@std/path"; import { Hono } from "hono"; import { logger as honoLogger } from "hono/logger"; -import log from "./log.ts"; -import config from "./config.ts"; -import { DbService } from "./db.ts"; +import { LogFileProvider } from "@crupest/base/log"; + import { AliasRecipientMailHook, FallbackRecipientHook, MailDeliverer, + RecipientFromHeadersHook, } from "./mail.ts"; -import { DovecotMailDeliverer } from "./dovecot/deliver.ts"; -import { CronTask, CronTaskConfig } from "./cron.ts"; +import { DovecotMailDeliverer } from "./dovecot.ts"; import { DumbSmtpServer } from "./dumb-smtp-server.ts"; -export abstract class AppBase { - protected readonly db: DbService; - protected readonly crons: CronTask[] = []; - protected readonly routes: Hono[] = []; - protected readonly inboundDeliverer: MailDeliverer; - protected readonly hono = new Hono(); - - protected abstract readonly outboundDeliverer: MailDeliverer; - - constructor() { - const dataPath = config.get("dataPath"); - Deno.mkdirSync(dataPath, { recursive: true }); - log.path = join(dataPath, "log"); - log.info(config); +export function createInbound( + logFileProvider: LogFileProvider, + { + fallback, + mailDomain, + aliasFile, + ldaPath, + }: { + fallback: string[]; + mailDomain: string; + aliasFile: string; + ldaPath: string; + }, +) { + const deliverer = new DovecotMailDeliverer(logFileProvider, ldaPath); + deliverer.preHooks.push( + new RecipientFromHeadersHook(mailDomain), + new FallbackRecipientHook(new Set(fallback)), + new AliasRecipientMailHook(aliasFile), + ); + return deliverer; +} - this.db = new DbService(join(dataPath, "db.sqlite")); - this.inboundDeliverer = new DovecotMailDeliverer(); - this.inboundDeliverer.preHooks.push( - new FallbackRecipientHook(new Set(config.getList("inboundFallback"))), - new AliasRecipientMailHook(join(dataPath, "aliases.csv")), - ); +export function createHono(outbound: MailDeliverer, inbound: MailDeliverer) { + const hono = new Hono(); - this.hono.onError((err, c) => { - log.error(err); - return c.json({ msg: "Server error, check its log." }, 500); - }); + hono.onError((err, c) => { + console.error("Hono handler throws an error.", err); + return c.json({ msg: "Server error, check its log." }, 500); + }); + hono.use(honoLogger()); + hono.post("/send/raw", async (context) => { + const body = await context.req.text(); + if (body.trim().length === 0) { + return context.json({ msg: "Can't send an empty mail." }, 400); + } else { + const result = await outbound.deliverRaw(body); + return context.json({ + awsMessageId: result.awsMessageId, + }); + } + }); + hono.post("/receive/raw", async (context) => { + await inbound.deliverRaw(await context.req.text()); + return context.json({ msg: "Done!" }); + }); - this.hono.use(honoLogger()); - this.hono.post("/send/raw", async (context) => { - const body = await context.req.text(); - if (body.trim().length === 0) { - return context.json({ msg: "Can't send an empty mail." }, 400); - } else { - const result = await this.outboundDeliverer.deliverRaw(body); - return context.json({ - awsMessageId: result.awsMessageId, - }); - } - }); - this.hono.post("/receive/raw", async (context) => { - await this.inboundDeliverer.deliverRaw(await context.req.text()); - return context.json({ "msg": "Done!" }); - }); - } + return hono; +} - createCron(config: CronTaskConfig): CronTask { - const cron = new CronTask(config); - this.crons.push(cron); - return cron; - } +export function createSmtp(outbound: MailDeliverer) { + return new DumbSmtpServer(outbound); +} - async setup() { - await this.db.migrate() +export async function sendMail(port: number) { + const decoder = new TextDecoder(); + let text = ""; + for await (const chunk of Deno.stdin.readable) { + text += decoder.decode(chunk); } - serve(): { smtp: DumbSmtpServer; http: Deno.HttpServer } { - const smtp = new DumbSmtpServer(this.outboundDeliverer); - smtp.serve(); - const http = Deno.serve({ - hostname: config.HTTP_HOST, - port: config.HTTP_PORT, - }, this.hono.fetch); - return { smtp, http }; - } + const res = await fetch(`http://127.0.0.1:${port}/send/raw`, { + method: "post", + body: text, + }); + const fn = res.ok ? "info" : "error"; + console[fn](res); + console[fn](await res.text()); + if (!res.ok) Deno.exit(-1); } diff --git a/deno/mail-relay/aws/app.ts b/deno/mail-relay/aws/app.ts index 1fda64e..cb275ae 100644 --- a/deno/mail-relay/aws/app.ts +++ b/deno/mail-relay/aws/app.ts @@ -1,136 +1,297 @@ -import { parseArgs } from "@std/cli"; +import { join } from "@std/path"; import { z } from "zod"; +import { Hono } from "hono"; import { zValidator } from "@hono/zod-validator"; +import { FetchHttpHandler } from "@smithy/fetch-http-handler"; +// @ts-types="npm:@types/yargs" +import yargs from "yargs"; -import log from "../log.ts"; -import config from "../config.ts"; -import { AppBase } from "../app.ts"; -import { AwsContext } from "./context.ts"; +import { LogFileProvider } from "@crupest/base/log"; +import { ConfigDefinition, ConfigProvider } from "@crupest/base/config"; +import { CronTask } from "@crupest/base/cron"; + +import { DbService } from "../db.ts"; +import { Mail } from "../mail.ts"; import { - AwsMailDeliverer, AwsMailMessageIdRewriteHook, AwsMailMessageIdSaveHook, -} from "./deliver.ts"; -import { AwsMailRetriever } from "./retriever.ts"; - -export class AwsRelayApp extends AppBase { - readonly #aws = new AwsContext(); - readonly #retriever; - protected readonly outboundDeliverer = new AwsMailDeliverer(this.#aws); - - constructor() { - super(); - this.#retriever = new AwsMailRetriever(this.#aws, this.inboundDeliverer); - - this.outboundDeliverer.preHooks.push( - new AwsMailMessageIdRewriteHook(this.db), - ); - this.outboundDeliverer.postHooks.push( - new AwsMailMessageIdSaveHook(this.db), - ); - - this.hono.post( - `/${config.get("awsInboundPath")}`, - async (ctx, next) => { - const auth = ctx.req.header("Authorization"); - if (auth !== config.get("awsInboundKey")) { - return ctx.json({ "msg": "Bad auth!" }, 403); - } - await next(); - }, - zValidator( - "json", - z.object({ - key: z.string(), - recipients: z.optional(z.array(z.string())), - }), - ), - async (ctx) => { - const { key, recipients } = ctx.req.valid("json"); - await this.#retriever.deliverS3Mail(key, recipients); - return ctx.json({ "msg": "Done!" }); - }, - ); - } +} from "./mail.ts"; +import { AwsMailDeliverer } from "./deliver.ts"; +import { AwsMailFetcher, AwsS3MailConsumer } from "./fetch.ts"; +import { createHono, createInbound, createSmtp, sendMail } from "../app.ts"; - realServe() { - this.createCron({ - name: "live-mail-recycler", - interval: 6 * 3600 * 1000, - callback: () => { - return this.#retriever.recycleLiveMails(); - }, - startNow: true, - }); +const PREFIX = "crupest-mail-server"; +const CONFIG_DEFINITIONS = { + dataPath: { + description: "Path to save app persistent data.", + default: ".", + }, + mailDomain: { + description: + "The part after `@` of an address. Used to determine local recipients.", + }, + httpHost: { + description: "Listening address for http server.", + default: "0.0.0.0", + }, + httpPort: { description: "Listening port for http server.", default: "2345" }, + smtpHost: { + description: "Listening address for dumb smtp server.", + default: "127.0.0.1", + }, + smtpPort: { + description: "Listening port for dumb smtp server.", + default: "2346", + }, + ldaPath: { + description: "full path of lda executable", + default: "/dovecot/libexec/dovecot/dovecot-lda", + }, + inboundFallback: { + description: "comma separated addresses used as fallback recipients", + default: "", + }, + awsInboundPath: { + description: "(random set) path for aws sns", + }, + awsInboundKey: { + description: "(random set) http header Authorization for aws sns", + }, + awsRegion: { + description: "aws region", + }, + awsUser: { + description: "aws access key id", + }, + awsPassword: { + description: "aws secret access key", + secret: true, + }, + awsMailBucket: { + description: "aws s3 bucket saving raw mails", + secret: true, + }, +} as const satisfies ConfigDefinition; - return this.serve(); - } +function createAwsOptions({ + user, + password, + region, +}: { + user: string; + password: string; + region: string; +}) { + return { + credentials: () => + Promise.resolve({ + accessKeyId: user, + secretAccessKey: password, + }), + requestHandler: new FetchHttpHandler(), + region, + }; +} - readonly cli = { - "init": (_: unknown) => { - log.info("Just init!"); - return Promise.resolve(); - }, - "list-lives": async (_: unknown) => { - const liveMails = await this.#retriever.listLiveMails(); - log.info(`Total ${liveMails.length}:`); - log.info(liveMails.join("\n")); - }, - "recycle-lives": async (_: unknown) => { - await this.#retriever.recycleLiveMails(); +function createOutbound( + awsOptions: ReturnType<typeof createAwsOptions>, + db: DbService, +) { + const deliverer = new AwsMailDeliverer(awsOptions); + deliverer.preHooks.push( + new AwsMailMessageIdRewriteHook(db.messageIdToAws.bind(db)), + ); + deliverer.postHooks.push( + new AwsMailMessageIdSaveHook((original, aws) => + db.addMessageIdMap({ message_id: original, aws_message_id: aws }).then() + ), + ); + return deliverer; +} + +function setupAwsHono( + hono: Hono, + options: { + path: string; + auth: string; + callback: (s3Key: string, recipients?: string[]) => Promise<void>; + }, +) { + hono.post( + `/${options.path}`, + async (ctx, next) => { + const auth = ctx.req.header("Authorization"); + if (auth !== options.auth) { + return ctx.json({ msg: "Bad auth!" }, 403); + } + await next(); }, - "serve": async (_: unknown) => { - await this.serve().http.finished; + zValidator( + "json", + z.object({ + key: z.string(), + recipients: z.optional(z.array(z.string())), + }), + ), + async (ctx) => { + const { key, recipients } = ctx.req.valid("json"); + await options.callback(key, recipients); + return ctx.json({ msg: "Done!" }); }, - "real-serve": async (_: unknown) => { - await this.realServe().http.finished; + ); +} + +function createCron(fetcher: AwsMailFetcher, consumer: AwsS3MailConsumer) { + return new CronTask({ + name: "live-mail-recycler", + interval: 6 * 3600 * 1000, + callback: () => { + return fetcher.recycleLiveMails(consumer); }, - } as const; + startNow: true, + }); } -const nonServerCli = { - "sendmail": async (_: unknown) => { - const decoder = new TextDecoder(); - let text = ""; - for await (const chunk of Deno.stdin.readable) { - text += decoder.decode(chunk); - } - - const res = await fetch( - `http://localhost:${config.HTTP_PORT}/send/raw`, - { - method: "post", - body: text, - }, - ); - log.infoOrError(!res.ok, res); - log.infoOrError(!res.ok, "Body\n" + await res.text()); - if (!res.ok) Deno.exit(-1); - }, -} as const; +function createBaseServices() { + const config = new ConfigProvider(PREFIX, CONFIG_DEFINITIONS); + Deno.mkdirSync(config.get("dataPath"), { recursive: true }); + const logFileProvider = new LogFileProvider( + join(config.get("dataPath"), "log"), + ); + return { config, logFileProvider }; +} -if (import.meta.main) { - const args = parseArgs(Deno.args); +function createAwsFetchOnlyServices() { + const services = createBaseServices(); + const { config } = services; - if (args._.length === 0) { - throw new Error("You must specify a command."); - } + const awsOptions = createAwsOptions({ + user: config.get("awsUser"), + password: config.get("awsPassword"), + region: config.get("awsRegion"), + }); + const fetcher = new AwsMailFetcher(awsOptions, config.get("awsMailBucket")); + + return { ...services, awsOptions, fetcher }; +} + +function createAwsRecycleOnlyServices() { + const services = createAwsFetchOnlyServices(); + const { config, logFileProvider } = services; - const command = args._[0]; + const inbound = createInbound(logFileProvider, { + fallback: config.getList("inboundFallback"), + ldaPath: config.get("ldaPath"), + aliasFile: join(config.get("dataPath"), "aliases.csv"), + mailDomain: config.get("mailDomain"), + }); + const recycler = (rawMail: string, _: unknown): Promise<void> => + inbound.deliver({ mail: new Mail(rawMail) }).then(); - if (command in nonServerCli) { - log.info(`Run non-server command ${command}.`); - await nonServerCli[command as keyof typeof nonServerCli](args); - Deno.exit(0); + return { ...services, inbound, recycler }; +} +function createAwsServices() { + const services = createAwsRecycleOnlyServices(); + const { config, awsOptions } = services; + + const dbService = new DbService(join(config.get("dataPath"), "db.sqlite")); + const outbound = createOutbound(awsOptions, dbService); + + return { ...services, dbService, outbound }; +} + +function createServerServices() { + const services = createAwsServices(); + const { config, outbound, inbound, fetcher } = services; + + const smtp = createSmtp(outbound); + const hono = createHono(outbound, inbound); + setupAwsHono(hono, { + path: config.get("awsInboundPath"), + auth: config.get("awsInboundKey"), + callback: (s3Key, recipients) => { + return fetcher.consumeS3Mail( + s3Key, + (rawMail, _) => + inbound.deliver({ mail: new Mail(rawMail), recipients }).then(), + ); + }, + }); + + return { ...services, smtp, hono }; +} + +function serve(cron: boolean = false) { + const { config, fetcher, recycler, smtp, hono } = createServerServices(); + smtp.serve({ + hostname: config.get("smtpHost"), + port: config.getInt("smtpPort"), + }); + Deno.serve( + { + hostname: config.get("httpHost"), + port: config.getInt("httpPort"), + }, + hono.fetch, + ); + + if (cron) { + createCron(fetcher, recycler); } +} - const app = new AwsRelayApp(); - await app.setup(); - if (command in app.cli) { - log.info(`Run command ${command}.`); - await app.cli[command as keyof AwsRelayApp["cli"]](args); - Deno.exit(0); - } else { - throw new Error(command + " is not a valid command."); +async function listLives() { + const { fetcher } = createAwsFetchOnlyServices(); + const liveMails = await fetcher.listLiveMails(); + console.info(`Total ${liveMails.length}:`); + if (liveMails.length !== 0) { + console.info(liveMails.join("\n")); } } + +async function recycleLives() { + const { fetcher, recycler } = createAwsRecycleOnlyServices(); + await fetcher.recycleLiveMails(recycler); +} + +if (import.meta.main) { + await yargs(Deno.args) + .scriptName("mail-relay") + .command({ + command: "sendmail", + describe: "send mail via this server's endpoint", + handler: async (_argv) => { + const { config } = createBaseServices(); + await sendMail(config.getInt("httpPort")); + }, + }) + .command({ + command: "live", + describe: "work with live mails", + builder: (builder) => { + return builder + .command({ + command: "list", + describe: "list live mails", + handler: listLives, + }) + .command({ + command: "recycle", + describe: "recycle all live mails", + handler: recycleLives, + }) + .demandCommand(1, "One command must be specified."); + }, + handler: () => {}, + }) + .command({ + command: "serve", + describe: "start the http and smtp servers", + builder: (builder) => builder.option("real", { type: "boolean" }), + handler: (argv) => serve(argv.real), + }) + .demandCommand(1, "One command must be specified.") + .help() + .strict() + .parse(); +} diff --git a/deno/mail-relay/aws/context.ts b/deno/mail-relay/aws/context.ts deleted file mode 100644 index b1e0336..0000000 --- a/deno/mail-relay/aws/context.ts +++ /dev/null @@ -1,41 +0,0 @@ -import { - CopyObjectCommand, - DeleteObjectCommand, - S3Client, -} from "@aws-sdk/client-s3"; -import { FetchHttpHandler } from "@smithy/fetch-http-handler"; - -import config from "../config.ts"; - -export class AwsContext { - readonly credentials = () => - Promise.resolve({ - accessKeyId: config.get("awsUser"), - secretAccessKey: config.get("awsPassword"), - }); - readonly requestHandler = new FetchHttpHandler(); - - get region() { - return config.get("awsRegion"); - } -} - -export async function s3MoveObject( - client: S3Client, - bucket: string, - path: string, - newPath: string, -): Promise<void> { - const copyCommand = new CopyObjectCommand({ - Bucket: bucket, - Key: newPath, - CopySource: `${bucket}/${path}`, - }); - await client.send(copyCommand); - - const deleteCommand = new DeleteObjectCommand({ - Bucket: bucket, - Key: path, - }); - await client.send(deleteCommand); -} diff --git a/deno/mail-relay/aws/deliver.ts b/deno/mail-relay/aws/deliver.ts index 0db5fa8..4dd4b3a 100644 --- a/deno/mail-relay/aws/deliver.ts +++ b/deno/mail-relay/aws/deliver.ts @@ -1,16 +1,10 @@ -// spellchecker: words sesv2 amazonses - -import { SendEmailCommand, SESv2Client } from "@aws-sdk/client-sesv2"; - -import log from "../log.ts"; -import { DbService } from "../db.ts"; import { - Mail, - MailDeliverContext, - MailDeliverHook, - SyncMailDeliverer, -} from "../mail.ts"; -import { AwsContext } from "./context.ts"; + SendEmailCommand, + SESv2Client, + SESv2ClientConfig, +} from "@aws-sdk/client-sesv2"; + +import { Mail, MailDeliverContext, SyncMailDeliverer } from "../mail.ts"; declare module "../mail.ts" { interface MailDeliverResult { @@ -18,60 +12,12 @@ declare module "../mail.ts" { } } -export class AwsMailMessageIdRewriteHook implements MailDeliverHook { - readonly #db; - - constructor(db: DbService) { - this.#db = db; - } - - async callback(context: MailDeliverContext): Promise<void> { - log.info("Rewrite message ids..."); - const addresses = context.mail.simpleFindAllAddresses(); - log.info(`Addresses found in mail: ${addresses.join(", ")}.`); - for (const address of addresses) { - const awsMessageId = await this.#db.messageIdToAws(address); - if (awsMessageId != null && awsMessageId.length !== 0) { - log.info(`Rewrite ${address} to ${awsMessageId}.`); - context.mail.raw = context.mail.raw.replaceAll(address, awsMessageId); - } - } - log.info("Done rewrite message ids."); - } -} - -export class AwsMailMessageIdSaveHook implements MailDeliverHook { - readonly #db; - - constructor(db: DbService) { - this.#db = db; - } - - async callback(context: MailDeliverContext): Promise<void> { - log.info("Save aws message ids..."); - const messageId = context.mail.startSimpleParse().sections().headers() - .messageId(); - if (messageId == null) { - log.info("Original mail does not have message id. Skip saving."); - return; - } - if (context.result.awsMessageId != null) { - log.info(`Saving ${messageId} => ${context.result.awsMessageId}.`); - await this.#db.addMessageIdMap({ - message_id: messageId, - aws_message_id: context.result.awsMessageId, - }); - } - log.info("Done save message ids."); - } -} - export class AwsMailDeliverer extends SyncMailDeliverer { readonly name = "aws"; readonly #aws; readonly #ses; - constructor(aws: AwsContext) { + constructor(aws: SESv2ClientConfig) { super(); this.#aws = aws; this.#ses = new SESv2Client(aws); @@ -81,7 +27,7 @@ export class AwsMailDeliverer extends SyncMailDeliverer { mail: Mail, context: MailDeliverContext, ): Promise<void> { - log.info("Begin to call aws send-email api..."); + console.info("Begin to call aws send-email api..."); try { const sendCommand = new SendEmailCommand({ @@ -92,7 +38,7 @@ export class AwsMailDeliverer extends SyncMailDeliverer { const res = await this.#ses.send(sendCommand); if (res.MessageId == null) { - log.warn("Aws send-email returns no message id."); + console.warn("Aws send-email returns no message id."); } else { context.result.awsMessageId = `${res.MessageId}@${this.#aws.region}.amazonses.com`; diff --git a/deno/mail-relay/aws/fetch.ts b/deno/mail-relay/aws/fetch.ts new file mode 100644 index 0000000..9278e63 --- /dev/null +++ b/deno/mail-relay/aws/fetch.ts @@ -0,0 +1,127 @@ +import { + CopyObjectCommand, + DeleteObjectCommand, + GetObjectCommand, + ListObjectsV2Command, + S3Client, + S3ClientConfig, +} from "@aws-sdk/client-s3"; + +import { toFileNameString } from "@crupest/base"; + +import { Mail } from "../mail.ts"; + +async function s3MoveObject( + client: S3Client, + bucket: string, + path: string, + newPath: string, +): Promise<void> { + const copyCommand = new CopyObjectCommand({ + Bucket: bucket, + Key: newPath, + CopySource: `${bucket}/${path}`, + }); + await client.send(copyCommand); + + const deleteCommand = new DeleteObjectCommand({ + Bucket: bucket, + Key: path, + }); + await client.send(deleteCommand); +} + +const AWS_SES_S3_SETUP_TAG = "AMAZON_SES_SETUP_NOTIFICATION"; + +export type AwsS3MailConsumer = ( + rawMail: string, + s3Key: string, +) => Promise<void>; + +export class AwsMailFetcher { + readonly #livePrefix = "mail/live/"; + readonly #archivePrefix = "mail/archive/"; + readonly #s3; + readonly #bucket; + + constructor(aws: S3ClientConfig, bucket: string) { + this.#s3 = new S3Client(aws); + this.#bucket = bucket; + } + + async listLiveMails(): Promise<string[]> { + console.info("Begin to retrieve live mails."); + + const listCommand = new ListObjectsV2Command({ + Bucket: this.#bucket, + Prefix: this.#livePrefix, + }); + const res = await this.#s3.send(listCommand); + + if (res.Contents == null) { + console.warn("Listing live mails in S3 returns null Content."); + return []; + } + + const result: string[] = []; + for (const object of res.Contents) { + if (object.Key == null) { + console.warn("Listing live mails in S3 returns an object with no Key."); + continue; + } + + if (object.Key.endsWith(AWS_SES_S3_SETUP_TAG)) continue; + + result.push(object.Key.slice(this.#livePrefix.length)); + } + return result; + } + + async consumeS3Mail(s3Key: string, consumer: AwsS3MailConsumer) { + console.info(`Begin to consume s3 mail ${s3Key} ...`); + + console.info(`Fetching s3 mail ${s3Key}...`); + const mailPath = `${this.#livePrefix}${s3Key}`; + const command = new GetObjectCommand({ + Bucket: this.#bucket, + Key: mailPath, + }); + const res = await this.#s3.send(command); + + if (res.Body == null) { + throw new Error("S3 mail returns a null body."); + } + + const rawMail = await res.Body.transformToString(); + console.info(`Done fetching s3 mail ${s3Key}.`); + + console.info(`Calling consumer...`); + await consumer(rawMail, s3Key); + console.info(`Done consuming s3 mail ${s3Key}.`); + + const date = new Mail(rawMail) + .startSimpleParse() + .sections() + .headers() + .date(); + const dateString = date != null + ? toFileNameString(date, true) + : "invalid-date"; + const newPath = `${this.#archivePrefix}${dateString}/${s3Key}`; + + console.info(`Archiving s3 mail ${s3Key} to ${newPath}...`); + await s3MoveObject(this.#s3, this.#bucket, mailPath, newPath); + console.info(`Done archiving s3 mail ${s3Key}.`); + + console.info(`Done consuming s3 mail ${s3Key}.`); + } + + async recycleLiveMails(consumer: AwsS3MailConsumer) { + console.info("Begin to recycle live mails..."); + const mails = await this.listLiveMails(); + console.info(`Found ${mails.length} live mails`); + for (const s3Key of mails) { + await this.consumeS3Mail(s3Key, consumer); + } + } +} diff --git a/deno/mail-relay/aws/mail.ts b/deno/mail-relay/aws/mail.ts new file mode 100644 index 0000000..cc05d23 --- /dev/null +++ b/deno/mail-relay/aws/mail.ts @@ -0,0 +1,49 @@ +import { MailDeliverContext, MailDeliverHook } from "../mail.ts"; + +export class AwsMailMessageIdRewriteHook implements MailDeliverHook { + readonly #lookup; + + constructor(lookup: (origin: string) => Promise<string | null>) { + this.#lookup = lookup; + } + + async callback(context: MailDeliverContext): Promise<void> { + console.info("Rewrite message ids..."); + const addresses = context.mail.simpleFindAllAddresses(); + console.info(`Addresses found in mail: ${addresses.join(", ")}.`); + for (const address of addresses) { + const awsMessageId = await this.#lookup(address); + if (awsMessageId != null && awsMessageId.length !== 0) { + console.info(`Rewrite ${address} to ${awsMessageId}.`); + context.mail.raw = context.mail.raw.replaceAll(address, awsMessageId); + } + } + console.info("Done rewrite message ids."); + } +} + +export class AwsMailMessageIdSaveHook implements MailDeliverHook { + readonly #record; + + constructor(record: (original: string, aws: string) => Promise<void>) { + this.#record = record; + } + + async callback(context: MailDeliverContext): Promise<void> { + console.info("Save aws message ids..."); + const messageId = context.mail + .startSimpleParse() + .sections() + .headers() + .messageId(); + if (messageId == null) { + console.info("Original mail does not have message id. Skip saving."); + return; + } + if (context.result.awsMessageId != null) { + console.info(`Saving ${messageId} => ${context.result.awsMessageId}.`); + await this.#record(messageId, context.result.awsMessageId); + } + console.info("Done save message ids."); + } +} diff --git a/deno/mail-relay/aws/retriever.ts b/deno/mail-relay/aws/retriever.ts deleted file mode 100644 index 756cfc3..0000000 --- a/deno/mail-relay/aws/retriever.ts +++ /dev/null @@ -1,100 +0,0 @@ -/// <reference types="npm:@types/node" /> - -import { - GetObjectCommand, - ListObjectsV2Command, - S3Client, -} from "@aws-sdk/client-s3"; - -import log from "../log.ts"; -import config from "../config.ts"; -import "../better-js.ts"; - -import { Mail, MailDeliverer } from "../mail.ts"; -import { AwsContext, s3MoveObject } from "./context.ts"; - -const AWS_SES_S3_SETUP_TAG = "AMAZON_SES_SETUP_NOTIFICATION"; - -export class AwsMailRetriever { - readonly liveMailPrefix = "mail/live/"; - readonly archiveMailPrefix = "mail/archive/"; - readonly mailBucket = config.get("awsMailBucket"); - - readonly #s3; - - constructor( - aws: AwsContext, - public readonly inboundDeliverer: MailDeliverer, - ) { - this.#s3 = new S3Client(aws); - } - - async listLiveMails(): Promise<string[]> { - log.info("Begin to retrieve live mails."); - - const listCommand = new ListObjectsV2Command({ - Bucket: this.mailBucket, - Prefix: this.liveMailPrefix, - }); - const res = await this.#s3.send(listCommand); - - if (res.Contents == null) { - log.warn("Listing live mails in S3 returns null Content."); - return []; - } - - const result: string[] = []; - for (const object of res.Contents) { - if (object.Key == null) { - log.warn("Listing live mails in S3 returns an object with no Key."); - continue; - } - - if (object.Key.endsWith(AWS_SES_S3_SETUP_TAG)) continue; - - result.push(object.Key.slice(this.liveMailPrefix.length)); - } - return result; - } - - async deliverS3Mail(s3Key: string, recipients: string[] = []) { - log.info(`Begin to deliver s3 mail ${s3Key} to ${recipients.join(" ")}...`); - - log.info(`Fetching s3 mail ${s3Key}...`); - const mailPath = `${this.liveMailPrefix}${s3Key}`; - const command = new GetObjectCommand({ - Bucket: this.mailBucket, - Key: mailPath, - }); - const res = await this.#s3.send(command); - - if (res.Body == null) { - throw new Error("S3 mail returns a null body."); - } - - const rawMail = await res.Body.transformToString(); - log.info(`Done fetching s3 mail ${s3Key}.`); - - log.info(`Delivering s3 mail ${s3Key}...`); - const mail = new Mail(rawMail); - await this.inboundDeliverer.deliver({ mail, recipients: recipients }); - log.info(`Done delivering s3 mail ${s3Key}.`); - - const date = mail.startSimpleParse().sections().headers().date(); - const dateString = date?.toFileNameString(true) ?? "invalid-date"; - const newPath = `${this.archiveMailPrefix}${dateString}/${s3Key}`; - - log.info(`Archiving s3 mail ${s3Key} to ${newPath}...`); - await s3MoveObject(this.#s3, this.mailBucket, mailPath, newPath); - log.info(`Done delivering s3 mail ${s3Key}...`); - } - - async recycleLiveMails() { - log.info("Begin to recycle live mails..."); - const mails = await this.listLiveMails(); - log.info(`Found ${mails.length} live mails`); - for (const s3Key of mails) { - await this.deliverS3Mail(s3Key); - } - } -} diff --git a/deno/mail-relay/better-js.ts b/deno/mail-relay/better-js.ts deleted file mode 100644 index c424a6e..0000000 --- a/deno/mail-relay/better-js.ts +++ /dev/null @@ -1,14 +0,0 @@ -declare global { - interface Date { - toFileNameString(dateOnly?: boolean): string; - } -} - -Object.defineProperty(Date.prototype, "toFileNameString", { - value: function (this: Date, dateOnly?: boolean) { - const str = this.toISOString(); - return dateOnly === true - ? str.slice(0, str.indexOf("T")) - : str.replaceAll(/:|\./g, "-"); - }, -}); diff --git a/deno/mail-relay/config.ts b/deno/mail-relay/config.ts deleted file mode 100644 index d58b163..0000000 --- a/deno/mail-relay/config.ts +++ /dev/null @@ -1,103 +0,0 @@ -export const APP_PREFIX = "crupest"; -export const APP_NAME = "mail-server"; - -export interface ConfigItemDefinition { - description: string; - default?: string; - secret?: boolean; -} - -export const CONFIG_DEFINITIONS = { - mailDomain: { - description: "the part after `@` of an address", - }, - dataPath: { - description: "path to save app persistent data", - }, - ldaPath: { - description: "full path of lda executable", - "default": "/dovecot/libexec/dovecot/dovecot-lda", - }, - inboundFallback: { - description: "comma separated addresses used as fallback recipients", - "default": "", - }, - awsInboundPath: { - description: "(random set) path for aws sns", - }, - awsInboundKey: { - description: "(random set) http header Authorization for aws sns", - }, - awsRegion: { - description: "aws region", - }, - awsUser: { - description: "aws access key id", - }, - awsPassword: { - description: "aws secret access key", - secret: true, - }, - awsMailBucket: { - description: "aws s3 bucket saving raw mails", - secret: true, - }, -} as const satisfies Record<string, ConfigItemDefinition>; - -type ConfigDefinitions = typeof CONFIG_DEFINITIONS; -type ConfigNames = keyof ConfigDefinitions; -type ConfigMap = { - [K in ConfigNames]: ConfigDefinitions[K] & { - readonly env: string; - readonly value: string; - }; -}; - -function resolveConfig(): ConfigMap { - const result: Record<string, ConfigMap[ConfigNames]> = {}; - for (const [name, def] of Object.entries(CONFIG_DEFINITIONS)) { - const env = `${APP_PREFIX}-${APP_NAME}-${ - name.replace(/[A-Z]/g, (m) => "-" + m.toLowerCase()) - }`.replaceAll("-", "_").toUpperCase(); - const value = Deno.env.get(env) ?? (def as ConfigItemDefinition).default; - if (value == null) { - throw new Error(`Required env ${env} (${def.description}) is not set.`); - } - result[name] = { ...def, env, value }; - } - return result as ConfigMap; -} - -export class Config { - #config = resolveConfig(); - - readonly HTTP_HOST = "0.0.0.0"; - readonly HTTP_PORT = 2345; - readonly SMTP_HOST = "127.0.0.1"; - readonly SMTP_PORT = 2346; - - getAllConfig<K extends ConfigNames>(key: K): ConfigMap[K] { - return this.#config[key]; - } - - get(key: ConfigNames): string { - return this.getAllConfig(key).value; - } - - getList(key: ConfigNames, separator: string = ","): string[] { - const value = this.get(key); - if (value.length === 0) return []; - return value.split(separator); - } - - [Symbol.for("Deno.customInspect")]() { - return Object.entries(this.#config).map(([key, item]) => - `${key} [env: ${item.env}]: ${ - (item as ConfigItemDefinition).secret === true ? "***" : item.value - }` - ).join("\n"); - } -} - -const config = new Config(); -export default config; diff --git a/deno/mail-relay/db.ts b/deno/mail-relay/db.ts index 9b05e32..062700b 100644 --- a/deno/mail-relay/db.ts +++ b/deno/mail-relay/db.ts @@ -1,5 +1,3 @@ -// spellchecker: words kysely insertable updateable introspector - import { Generated, Insertable, @@ -20,19 +18,20 @@ class SqliteStatementAdapter implements SqliteStatement { } all(parameters: readonly unknown[]): unknown[] { - return this.stmt.all(...parameters as sqlite.BindValue[]); + return this.stmt.all(...(parameters as sqlite.BindValue[])); } iterate(parameters: readonly unknown[]): IterableIterator<unknown> { - return this.stmt.iter(...parameters as sqlite.BindValue[]); + return this.stmt.iter(...(parameters as sqlite.BindValue[])); } - run( - parameters: readonly unknown[], - ): { changes: number | bigint; lastInsertRowid: number | bigint } { + run(parameters: readonly unknown[]): { + changes: number | bigint; + lastInsertRowid: number | bigint; + } { const { db } = this.stmt; const totalChangesBefore = db.totalChanges; - const changes = this.stmt.run(...parameters as sqlite.BindValue[]); + const changes = this.stmt.run(...(parameters as sqlite.BindValue[])); return { changes: totalChangesBefore === db.totalChanges ? 0 : changes, lastInsertRowid: db.lastInsertRowId, @@ -52,8 +51,7 @@ class SqliteDatabaseAdapter implements SqliteDatabase { } } -export class DbError extends Error { -} +export class DbError extends Error {} interface AwsMessageIdMapTable { id: Generated<number>; @@ -100,9 +98,9 @@ export class DbService { constructor(public readonly path: string) { this.#db = new sqlite.Database(path); this.#kysely = new Kysely<Database>({ - dialect: new SqliteDialect( - { database: new SqliteDatabaseAdapter(this.#db) }, - ), + dialect: new SqliteDialect({ + database: new SqliteDatabaseAdapter(this.#db), + }), }); this.#migrator = new Migrator({ db: this.#kysely, @@ -121,24 +119,27 @@ export class DbService { async addMessageIdMap( mail: Insertable<AwsMessageIdMapTable>, ): Promise<number> { - const inserted = await this.#kysely.insertInto("aws_message_id_map").values( - mail, - ).executeTakeFirstOrThrow(); + const inserted = await this.#kysely + .insertInto("aws_message_id_map") + .values(mail) + .executeTakeFirstOrThrow(); return Number(inserted.insertId!); } async messageIdToAws(messageId: string): Promise<string | null> { - const row = await this.#kysely.selectFrom("aws_message_id_map").where( - "message_id", - "=", - messageId, - ).select("aws_message_id").executeTakeFirst(); + const row = await this.#kysely + .selectFrom("aws_message_id_map") + .where("message_id", "=", messageId) + .select("aws_message_id") + .executeTakeFirst(); return row?.aws_message_id ?? null; } async messageIdFromAws(awsMessageId: string): Promise<string | null> { - const row = await this.#kysely.selectFrom("aws_message_id_map") - .where("aws_message_id", "=", awsMessageId).select("message_id") + const row = await this.#kysely + .selectFrom("aws_message_id_map") + .where("aws_message_id", "=", awsMessageId) + .select("message_id") .executeTakeFirst(); return row?.message_id ?? null; } diff --git a/deno/mail-relay/deno.json b/deno/mail-relay/deno.json index 9066b33..9105747 100644 --- a/deno/mail-relay/deno.json +++ b/deno/mail-relay/deno.json @@ -1,7 +1,7 @@ { + "version": "0.1.0", "tasks": { "run": "deno run -A aws/app.ts", - "test": "deno test -A", "compile": "deno compile -o out/crupest-relay -A aws/app.ts" }, "imports": { @@ -10,13 +10,6 @@ "@db/sqlite": "jsr:@db/sqlite@^0.12.0", "@hono/zod-validator": "npm:@hono/zod-validator@^0.7.0", "@smithy/fetch-http-handler": "npm:@smithy/fetch-http-handler@^5.0.4", - "@std/cli": "jsr:@std/cli@^1.0.19", - "@std/csv": "jsr:@std/csv@^1.0.6", - "@std/encoding": "jsr:@std/encoding@^1.0.10", - "@std/expect": "jsr:@std/expect@^1.0.16", - "@std/io": "jsr:@std/io@^0.225.2", - "@std/path": "jsr:@std/path@^1.1.0", - "@std/testing": "jsr:@std/testing@^1.0.13", "email-addresses": "npm:email-addresses@^5.0.0", "hono": "npm:hono@^4.7.11", "kysely": "npm:kysely@^0.28.2", diff --git a/deno/mail-relay/dovecot/deliver.ts b/deno/mail-relay/dovecot.ts index 92bdc58..bace225 100644 --- a/deno/mail-relay/dovecot/deliver.ts +++ b/deno/mail-relay/dovecot.ts @@ -1,29 +1,25 @@ import { basename } from "@std/path"; -import config from "../config.ts"; -import log from "../log.ts"; -import { - Mail, - MailDeliverContext, - MailDeliverer, - RecipientFromHeadersHook, -} from "../mail.ts"; +import { LogFileProvider } from "@crupest/base/log"; + +import { Mail, MailDeliverContext, MailDeliverer } from "./mail.ts"; export class DovecotMailDeliverer extends MailDeliverer { readonly name = "dovecot"; + readonly #logFileProvider; + readonly #ldaPath; - constructor() { + constructor(logFileProvider: LogFileProvider, ldaPath: string) { super(); - this.preHooks.push( - new RecipientFromHeadersHook(), - ); + this.#logFileProvider = logFileProvider; + this.#ldaPath = ldaPath; } protected override async doDeliver( mail: Mail, context: MailDeliverContext, ): Promise<void> { - const ldaPath = config.get("ldaPath"); + const ldaPath = this.#ldaPath; const ldaBinName = basename(ldaPath); const utf8Stream = mail.toUtf8Bytes(); @@ -35,14 +31,12 @@ export class DovecotMailDeliverer extends MailDeliverer { return; } - log.info(`Deliver to dovecot users: ${recipients.join(", ")}.`); + console.info(`Deliver to dovecot users: ${recipients.join(", ")}.`); for (const recipient of recipients) { try { const commandArgs = ["-d", recipient]; - log.info( - `Run ${ldaBinName} ${commandArgs.join(" ")}...`, - ); + console.info(`Run ${ldaBinName} ${commandArgs.join(" ")}...`); const ldaCommand = new Deno.Command(ldaPath, { args: commandArgs, @@ -52,9 +46,12 @@ export class DovecotMailDeliverer extends MailDeliverer { }); const ldaProcess = ldaCommand.spawn(); - using logFiles = await log.openLogForProgram(ldaBinName); - ldaProcess.stdout.pipeTo(logFiles.stdout.writable); - ldaProcess.stderr.pipeTo(logFiles.stderr.writable); + using logFiles = await this.#logFileProvider + .createExternalLogStreamsForProgram( + ldaBinName, + ); + ldaProcess.stdout.pipeTo(logFiles.stdout); + ldaProcess.stderr.pipeTo(logFiles.stderr); const stdinWriter = ldaProcess.stdin.getWriter(); await stdinWriter.write(utf8Stream); @@ -97,6 +94,6 @@ export class DovecotMailDeliverer extends MailDeliverer { } } - log.info("Done handling all recipients."); + console.info("Done handling all recipients."); } } diff --git a/deno/mail-relay/dumb-smtp-server.ts b/deno/mail-relay/dumb-smtp-server.ts index 6c63f5c..ac7069c 100644 --- a/deno/mail-relay/dumb-smtp-server.ts +++ b/deno/mail-relay/dumb-smtp-server.ts @@ -1,23 +1,29 @@ -import config from "./config.ts"; -import log from "./log.ts"; import { MailDeliverer } from "./mail.ts"; const CRLF = "\r\n"; -const SERVER_NAME = `[${config.SMTP_HOST}]:${config.SMTP_PORT}`; +function createResponses(host: string, port: number | string) { + const serverName = `[${host}]:${port}`; + return { + serverName, + READY: `220 ${serverName} SMTP Ready`, + EHLO: `250 ${serverName}`, + MAIL: "250 2.1.0 Sender OK", + RCPT: "250 2.1.5 Recipient OK", + DATA: "354 Start mail input; end with <CRLF>.<CRLF>", + QUIT: `211 2.0.0 ${serverName} closing connection`, + INVALID: "500 5.5.1 Error: command not recognized", + } as const; +} -const RESPONSES = { - "READY": `220 ${SERVER_NAME} SMTP Ready`, - "EHLO": `250 ${SERVER_NAME}`, - "MAIL": "250 2.1.0 Sender OK", - "RCPT": "250 2.1.5 Recipient OK", - "DATA": "354 Start mail input; end with <CRLF>.<CRLF>", - "QUIT": `211 2.0.0 ${SERVER_NAME} closing connection`, - "INVALID": "500 5.5.1 Error: command not recognized", -} as const; +const LOG_TAG = "[dumb-smtp]"; export class DumbSmtpServer { - #deliverer: MailDeliverer; + #deliverer; + #responses: ReturnType<typeof createResponses> = createResponses( + "invalid", + "invalid", + ); constructor(deliverer: MailDeliverer) { this.#deliverer = deliverer; @@ -26,9 +32,12 @@ export class DumbSmtpServer { async #handleConnection(conn: Deno.Conn) { using disposeStack = new DisposableStack(); disposeStack.defer(() => { - log.info("Close smtp session tcp connection."); + console.info(LOG_TAG, "Close session's tcp connection."); conn.close(); }); + + console.info(LOG_TAG, "New session's tcp connection established."); + const writer = conn.writable.getWriter(); disposeStack.defer(() => writer.releaseLock()); const reader = conn.readable.getReader(); @@ -36,13 +45,15 @@ export class DumbSmtpServer { const [decoder, encoder] = [new TextDecoder(), new TextEncoder()]; const decode = (data: Uint8Array) => decoder.decode(data); - const send = async (s: string) => + const send = async (s: string) => { + console.info(LOG_TAG, "Send line: " + s); await writer.write(encoder.encode(s + CRLF)); + }; let buffer: string = ""; let rawMail: string | null = null; - await send(RESPONSES["READY"]); + await send(this.#responses["READY"]); while (true) { const { value, done } = await reader.read(); @@ -58,36 +69,36 @@ export class DumbSmtpServer { buffer = buffer.slice(eolPos + CRLF.length); if (rawMail == null) { - log.info("Smtp server received line:", line); + console.info(LOG_TAG, "Received line: " + line); const upperLine = line.toUpperCase(); if (upperLine.startsWith("EHLO") || upperLine.startsWith("HELO")) { - await send(RESPONSES["EHLO"]); + await send(this.#responses["EHLO"]); } else if (upperLine.startsWith("MAIL FROM:")) { - await send(RESPONSES["MAIL"]); + await send(this.#responses["MAIL"]); } else if (upperLine.startsWith("RCPT TO:")) { - await send(RESPONSES["RCPT"]); + await send(this.#responses["RCPT"]); } else if (upperLine === "DATA") { - await send(RESPONSES["DATA"]); - log.info("Begin to receive mail data..."); + await send(this.#responses["DATA"]); + console.info(LOG_TAG, "Begin to receive mail data..."); rawMail = ""; } else if (upperLine === "QUIT") { - await send(RESPONSES["QUIT"]); + await send(this.#responses["QUIT"]); return; } else { - log.warn("Smtp server command unrecognized:", line); - await send(RESPONSES["INVALID"]); + console.warn(LOG_TAG, "Unrecognized command from client: " + line); + await send(this.#responses["INVALID"]); return; } } else { if (line === ".") { try { - log.info("Done receiving mail data, begin to relay..."); + console.info(LOG_TAG, "Mail data Received, begin to relay..."); const { message } = await this.#deliverer.deliverRaw(rawMail); await send(`250 2.6.0 ${message}`); rawMail = null; - log.info("Done SMTP mail session."); + console.info(LOG_TAG, "Relay succeeded."); } catch (err) { - log.info(err); + console.error(LOG_TAG, "Relay failed.", err); await send("554 5.3.0 Error: check server log"); return; } @@ -100,19 +111,19 @@ export class DumbSmtpServer { } } - async serve() { - const listener = Deno.listen({ - hostname: config.SMTP_HOST, - port: config.SMTP_PORT, - }); - listener.unref(); - log.info(`Dumb SMTP server starts running on port ${config.SMTP_PORT}.`); + async serve(options: { hostname: string; port: number }) { + const listener = Deno.listen(options); + this.#responses = createResponses(options.hostname, options.port); + console.info( + LOG_TAG, + `Dumb SMTP server starts to listen on ${this.#responses.serverName}.`, + ); for await (const conn of listener) { try { await this.#handleConnection(conn); } catch (cause) { - log.error("One smtp connection session throws an error " + cause); + console.error(LOG_TAG, "Tcp connection throws an error.", cause); } } } diff --git a/deno/mail-relay/log.ts b/deno/mail-relay/log.ts deleted file mode 100644 index ce27eca..0000000 --- a/deno/mail-relay/log.ts +++ /dev/null @@ -1,116 +0,0 @@ -import { join } from "@std/path"; -import { toWritableStream, Writer } from "@std/io"; - -import "./better-js.ts"; - -export interface LogOptions { - time?: Date; - error?: boolean; -} - -export type LogFile = Pick<Deno.FsFile, "writable"> & Disposable; - -export class Log { - #path: string | null = null; - - #wrapWriter(writer: Writer): LogFile { - return { - writable: toWritableStream(writer, { autoClose: false }), - [Symbol.dispose]() {}, - }; - } - - #stdoutWrapper: LogFile = this.#wrapWriter(Deno.stdout); - #stderrWrapper: LogFile = this.#wrapWriter(Deno.stderr); - - constructor() { - } - - get path() { - return this.#path; - } - - set path(path) { - this.#path = path; - if (path != null) { - Deno.mkdirSync(path, { recursive: true }); - } - } - - infoOrError(isError: boolean, ...args: unknown[]) { - this[isError ? "error" : "info"].call(this, ...args); - } - - info(...args: unknown[]) { - console.log(...args); - } - - warn(...args: unknown[]) { - console.warn(...args); - } - - error(...args: unknown[]) { - console.error(...args); - } - - #extractOptions(options?: LogOptions): Required<LogOptions> { - return { - time: options?.time ?? new Date(), - error: options?.error ?? false, - }; - } - - async openLog( - prefix: string, - suffix: string, - options?: LogOptions, - ): Promise<LogFile> { - if (prefix.includes("/")) { - throw new Error(`Log file prefix ${prefix} contains '/'.`); - } - if (suffix.includes("/")) { - throw new Error(`Log file suffix ${suffix} contains '/'.`); - } - - const { time, error } = this.#extractOptions(options); - if (this.#path == null) { - return error ? this.#stderrWrapper : this.#stdoutWrapper; - } - - const logPath = join( - this.#path, - `${prefix}-${time.toFileNameString()}-${suffix}`, - ); - return await Deno.open(logPath, { - read: false, - write: true, - append: true, - create: true, - }); - } - - async openLogForProgram( - program: string, - options?: Omit<LogOptions, "error">, - ): Promise<{ stdout: LogFile; stderr: LogFile } & Disposable> { - const stdout = await this.openLog(program, "stdout", { - ...options, - error: false, - }); - const stderr = await this.openLog(program, "stderr", { - ...options, - error: true, - }); - return { - stdout, - stderr, - [Symbol.dispose]: () => { - stdout[Symbol.dispose](); - stderr[Symbol.dispose](); - }, - }; - } -} - -const log = new Log(); -export default log; diff --git a/deno/mail-relay/mail.test.ts b/deno/mail-relay/mail.test.ts index ee275af..cd0c38d 100644 --- a/deno/mail-relay/mail.test.ts +++ b/deno/mail-relay/mail.test.ts @@ -65,48 +65,31 @@ describe("Mail", () => { }); it("simple parse date", () => { - expect(new Mail(mockMailStr).startSimpleParse().sections().headers().date()) - .toEqual(new Date(mockDate)); + expect( + new Mail(mockMailStr).startSimpleParse().sections().headers().date(), + ).toEqual(new Date(mockDate)); }); it("simple parse headers", () => { expect( - new Mail(mockMailStr).startSimpleParse().sections().headers(), - ).toEqual(mockHeaders.map( - (h) => [h[0], " " + h[1].replaceAll("\n", "")], - )); - }); - - it("append headers", () => { - const mail = new Mail(mockMailStr); - const mockMoreHeaders = [["abc", "123"], ["def", "456"]] satisfies [ - string, - string, - ][]; - mail.appendHeaders(mockMoreHeaders); - - expect(mail.raw).toBe( - mockHeaderStr + "\n" + - mockMoreHeaders.map((h) => h[0] + ": " + h[1]).join("\n") + - "\n\n" + mockBodyStr, - ); + new Mail(mockMailStr).startSimpleParse().sections().headers().fields, + ).toEqual(mockHeaders.map((h) => [h[0], " " + h[1].replaceAll("\n", "")])); }); it("parse recipients", () => { const mail = new Mail(mockMailStr); - expect([...mail.startSimpleParse().sections().headers().recipients()]) - .toEqual([ - ...mockToAddresses, - mockCcAddress, - ]); + expect([ + ...mail.startSimpleParse().sections().headers().recipients(), + ]).toEqual([...mockToAddresses, mockCcAddress]); expect([ ...mail.startSimpleParse().sections().headers().recipients({ domain: "example.com", }), - ]).toEqual([ - ...mockToAddresses, - mockCcAddress, - ].filter((a) => a.endsWith("example.com"))); + ]).toEqual( + [...mockToAddresses, mockCcAddress].filter((a) => + a.endsWith("example.com") + ), + ); }); it("find all addresses", () => { diff --git a/deno/mail-relay/mail.ts b/deno/mail-relay/mail.ts index af0df40..d6dfe65 100644 --- a/deno/mail-relay/mail.ts +++ b/deno/mail-relay/mail.ts @@ -2,24 +2,13 @@ import { encodeBase64 } from "@std/encoding/base64"; import { parse } from "@std/csv/parse"; import emailAddresses from "email-addresses"; -import log from "./log.ts"; -import config from "./config.ts"; - -class MailSimpleParseError extends Error { - constructor( - message: string, - public readonly text: string, - public readonly lineNumber?: number, - options?: ErrorOptions, - ) { - if (lineNumber != null) message += `(at line ${lineNumber})`; - super(message, options); - } -} +class MailSimpleParseError extends Error {} + +class MailSimpleParsedHeaders { + constructor(public fields: [key: string, value: string][]) {} -class MailSimpleParsedHeaders extends Array<[key: string, value: string]> { getFirst(fieldKey: string): string | undefined { - for (const [key, value] of this) { + for (const [key, value] of this.fields) { if (key.toLowerCase() === fieldKey.toLowerCase()) return value; } return undefined; @@ -33,7 +22,7 @@ class MailSimpleParsedHeaders extends Array<[key: string, value: string]> { if (match != null) { return match[1]; } else { - console.warn("Invalid message-id header of mail: ", messageIdField); + console.warn("Invalid message-id header of mail: " + messageIdField); return undefined; } } @@ -44,7 +33,7 @@ class MailSimpleParsedHeaders extends Array<[key: string, value: string]> { const date = new Date(dateField); if (invalidToUndefined && isNaN(date.getTime())) { - log.warn(`Invalid date string (${dateField}) found in header.`); + console.warn(`Invalid date string (${dateField}) found in header.`); return undefined; } return date; @@ -54,15 +43,16 @@ class MailSimpleParsedHeaders extends Array<[key: string, value: string]> { const domain = options?.domain; const headers = options?.headers ?? ["to", "cc", "bcc", "x-original-to"]; const recipients = new Set<string>(); - for (const [key, value] of this) { + for (const [key, value] of this.fields) { if (headers.includes(key.toLowerCase())) { - emailAddresses.parseAddressList(value)?.flatMap((a) => - a.type === "mailbox" ? a : a.addresses - )?.forEach(({ address }) => { - if (domain == null || address.endsWith(domain)) { - recipients.add(address); - } - }); + emailAddresses + .parseAddressList(value) + ?.flatMap((a) => (a.type === "mailbox" ? a : a.addresses)) + ?.forEach(({ address }) => { + if (domain == null || address.endsWith(domain)) { + recipients.add(address); + } + }); } } return recipients; @@ -80,14 +70,13 @@ class MailSimpleParsedSections { if (twoEolMatch == null) { throw new MailSimpleParseError( "No header/body section separator (2 successive EOLs) found.", - raw, ); } const [eol, sep] = [twoEolMatch[1], twoEolMatch[2]]; if (eol !== sep) { - log.warn("Different EOLs (\\r\\n, \\n) found."); + console.warn("Different EOLs (\\r\\n, \\n) found."); } this.header = raw.slice(0, twoEolMatch.index!); @@ -97,7 +86,7 @@ class MailSimpleParsedSections { } headers(): MailSimpleParsedHeaders { - const headers = new MailSimpleParsedHeaders(); + const headers = [] as [key: string, value: string][]; let field: string | null = null; let lineNumber = 1; @@ -106,11 +95,7 @@ class MailSimpleParsedSections { if (field == null) return; const sepPos = field.indexOf(":"); if (sepPos === -1) { - throw new MailSimpleParseError( - "No ':' in the header field.", - this.header, - lineNumber, - ); + throw new MailSimpleParseError(`No ':' in the header line: ${field}`); } headers.push([field.slice(0, sepPos).trim(), field.slice(sepPos + 1)]); field = null; @@ -119,11 +104,7 @@ class MailSimpleParsedSections { for (const line of this.header.trimEnd().split(/\r?\n|\r/)) { if (line.match(/^\s/)) { if (field == null) { - throw new MailSimpleParseError( - "Header field starts with a space.", - this.header, - lineNumber, - ); + throw new MailSimpleParseError("Header section starts with a space."); } field += line; } else { @@ -135,7 +116,7 @@ class MailSimpleParsedSections { handleField(); - return headers; + return new MailSimpleParsedHeaders(headers); } } @@ -156,17 +137,8 @@ export class Mail { } simpleFindAllAddresses(): string[] { - const re = /,?\<?([a-z0-9_'+\-\.]+\@[a-z0-9_'+\-\.]+)\>?,?/ig - return [...this.raw.matchAll(re)].map(m => m[1]) - } - - // TODO: Add folding. - appendHeaders(headers: [key: string, value: string][]) { - const { header, body, sep, eol } = this.startSimpleParse().sections(); - - this.raw = header + eol + - headers.map(([k, v]) => `${k}: ${v}`).join(eol) + eol + sep + - body; + const re = /,?\<?([a-z0-9_'+\-\.]+\@[a-z0-9_'+\-\.]+)\>?,?/gi; + return [...this.raw.matchAll(re)].map((m) => m[1]); } } @@ -185,16 +157,21 @@ export class MailDeliverResult { constructor(public mail: Mail) {} hasError(): boolean { - return this.recipients.size === 0 || - this.recipients.values().some((r) => r.kind !== "done"); + return ( + this.recipients.size === 0 || + this.recipients.values().some((r) => r.kind !== "done") + ); } [Symbol.for("Deno.customInspect")]() { return [ `message: ${this.message}`, - ...this.recipients.entries().map(([recipient, result]) => - `${recipient} [${result.kind}]: ${result.message}` - ), + ...this.recipients + .entries() + .map( + ([recipient, result]) => + `${recipient} [${result.kind}]: ${result.message}`, + ), ].join("\n"); } } @@ -226,10 +203,11 @@ export abstract class MailDeliverer { return await this.deliver({ mail: new Mail(rawMail) }); } - async deliver( - options: { mail: Mail; recipients?: string[] }, - ): Promise<MailDeliverResult> { - log.info(`Begin to deliver mail via ${this.name}...`); + async deliver(options: { + mail: Mail; + recipients?: string[]; + }): Promise<MailDeliverResult> { + console.info(`Begin to deliver mail via ${this.name}...`); const context = new MailDeliverContext(options.mail); options.recipients?.forEach((r) => context.recipients.add(r)); @@ -244,8 +222,8 @@ export abstract class MailDeliverer { await hook.callback(context); } - log.info("Deliver result:"); - log.info(context.result); + console.info("Deliver result:"); + console.info(context.result); if (context.result.hasError()) { throw new Error("Mail failed to deliver."); @@ -258,31 +236,44 @@ export abstract class MailDeliverer { export abstract class SyncMailDeliverer extends MailDeliverer { #last: Promise<void> = Promise.resolve(); - override async deliver( - options: { mail: Mail; recipients?: string[] }, - ): Promise<MailDeliverResult> { - log.info("The mail deliverer is sync. Wait for last delivering done..."); + override async deliver(options: { + mail: Mail; + recipients?: string[]; + }): Promise<MailDeliverResult> { + console.info( + "The mail deliverer is sync. Wait for last delivering done...", + ); await this.#last; const result = super.deliver(options); - this.#last = result.then(() => {}, () => {}); + this.#last = result.then( + () => {}, + () => {}, + ); return result; } } export class RecipientFromHeadersHook implements MailDeliverHook { + constructor(public mailDomain: string) {} + callback(context: MailDeliverContext) { if (context.recipients.size !== 0) { - log.warn( + console.warn( "Recipients are already filled. Won't set them with ones in headers.", ); } else { - context.mail.startSimpleParse().sections().headers().recipients({ - domain: config.get("mailDomain"), - }).forEach((r) => context.recipients.add(r)); - - log.info( - "Recipients found from mail headers: ", - [...context.recipients].join(" "), + context.mail + .startSimpleParse() + .sections() + .headers() + .recipients({ + domain: this.mailDomain, + }) + .forEach((r) => context.recipients.add(r)); + + console.info( + "Recipients found from mail headers: " + + [...context.recipients].join(", "), ); } return Promise.resolve(); @@ -294,9 +285,8 @@ export class FallbackRecipientHook implements MailDeliverHook { callback(context: MailDeliverContext) { if (context.recipients.size === 0) { - log.info( - "No recipients, fill with fallback: ", - [...this.fallback].join(" "), + console.info( + "No recipients, fill with fallback: " + [...this.fallback].join(", "), ); this.fallback.forEach((a) => context.recipients.add(a)); } @@ -314,7 +304,7 @@ export class AliasRecipientMailHook implements MailDeliverHook { async #parseAliasFile(): Promise<Map<string, string>> { const result = new Map(); if ((await Deno.stat(this.#aliasFile)).isFile) { - log.info(`Found recipients alias file: ${this.#aliasFile}.`); + console.info(`Found recipients alias file: ${this.#aliasFile}.`); const text = await Deno.readTextFile(this.#aliasFile); const csv = parse(text); for (const [real, ...aliases] of csv) { @@ -329,7 +319,7 @@ export class AliasRecipientMailHook implements MailDeliverHook { for (const recipient of [...context.recipients]) { const realRecipients = aliases.get(recipient); if (realRecipients != null) { - log.info( + console.info( `Recipient alias resolved: ${recipient} => ${realRecipients}.`, ); context.recipients.delete(recipient); diff --git a/deno/tools/deno.json b/deno/tools/deno.json new file mode 100644 index 0000000..355046a --- /dev/null +++ b/deno/tools/deno.json @@ -0,0 +1,8 @@ +{ + "version": "0.1.0", + "tasks": { + }, + "imports": { + "mustache": "npm:mustache@^4.2.0" + } +} diff --git a/deno/tools/generate-geosite-rules.ts b/deno/tools/generate-geosite-rules.ts new file mode 100644 index 0000000..bfa53ba --- /dev/null +++ b/deno/tools/generate-geosite-rules.ts @@ -0,0 +1,160 @@ +const PROXY_NAME = "node-select"; +const ATTR = "cn"; +const REPO_NAME = "domain-list-community"; +const URL = + "https://github.com/v2fly/domain-list-community/archive/refs/heads/master.zip"; +const SITES = [ + "github", + "google", + "youtube", + "twitter", + "facebook", + "discord", + "reddit", + "twitch", + "quora", + "telegram", + "imgur", + "stackexchange", + "onedrive", + "duckduckgo", + "wikimedia", + "gitbook", + "gitlab", + "creativecommons", + "archive", + "matrix", + "tor", + "python", + "ruby", + "rust", + "nodejs", + "npmjs", + "qt", + "docker", + "v2ray", + "homebrew", + "bootstrap", + "heroku", + "vercel", + "ieee", + "sci-hub", + "libgen", +]; + +const prefixes = ["include", "domain", "keyword", "full", "regexp"] as const; + +interface Rule { + kind: (typeof prefixes)[number]; + value: string; + attrs: string[]; +} + +type FileProvider = (name: string) => string; + +function extract(starts: string[], provider: FileProvider): Rule[] { + function parseLine(line: string): Rule { + let kind = prefixes.find((p) => line.startsWith(p + ":")); + if (kind != null) { + line = line.slice(line.indexOf(":") + 1); + } else { + kind = "domain"; + } + const segs = line.split("@"); + return { + kind, + value: segs[0].trim(), + attrs: [...segs.slice(1)].map((s) => s.trim()), + }; + } + + function parse(text: string): Rule[] { + return text + .replaceAll("\c\n", "\n") + .split("\n") + .map((l) => l.trim()) + .filter((l) => l.length !== 0 && !l.startsWith("#")) + .map((l) => parseLine(l)); + } + + const visited = [] as string[]; + const rules = [] as Rule[]; + + function add(name: string) { + const text = provider(name); + for (const rule of parse(text)) { + if (rule.kind === "include") { + if (visited.includes(rule.value)) { + console.warn(`circular refs found: ${name} includes ${rule.value}.`); + continue; + } else { + visited.push(rule.value); + add(rule.value); + } + } else { + rules.push(rule); + } + } + } + + for (const start of starts) { + add(start); + } + + return rules; +} + +function toNewFormat(rules: Rule[], attr: string): [string, string] { + function toLine(rule: Rule) { + const prefixMap = { + domain: "DOMAIN-SUFFIX", + full: "DOMAIN", + keyword: "DOMAIN-KEYWORD", + regexp: "DOMAIN-REGEX", + } as const; + if (rule.kind === "include") { + throw new Error("Include rule not parsed."); + } + return `${prefixMap[rule.kind]},${rule.value}`; + } + + function toLines(rules: Rule[]) { + return rules.map((r) => toLine(r)).join("\n"); + } + + const has: Rule[] = []; + const notHas: Rule[] = []; + rules.forEach((r) => (r.attrs.includes(attr) ? has.push(r) : notHas.push(r))); + + return [toLines(has), toLines(notHas)]; +} + +if (import.meta.main) { + const tmpDir = Deno.makeTempDirSync({ prefix: "geosite-rules-" }); + console.log("Work dir is ", tmpDir); + const zipFilePath = tmpDir + "/repo.zip"; + const res = await fetch(URL); + if (!res.ok) { + throw new Error("Failed to download repo."); + } + Deno.writeFileSync(zipFilePath, await res.bytes()); + const unzip = new Deno.Command("unzip", { + args: ["-q", zipFilePath], + cwd: tmpDir, + }); + if (!(await unzip.spawn().status).success) { + throw new Error("Failed to unzip"); + } + + const dataDir = tmpDir + "/" + REPO_NAME + "-master/data"; + const provider = (name: string) => + Deno.readTextFileSync(dataDir + "/" + name); + + const rules = extract(SITES, provider); + const [has, notHas] = toNewFormat(rules, ATTR); + const hasFile = tmpDir + "/has-rule"; + const notHasFile = tmpDir + "/not-has-rule"; + console.log("Write result to: " + hasFile + " , " + notHasFile); + Deno.writeTextFileSync(hasFile, has); + Deno.writeTextFileSync(notHasFile, notHas); +} diff --git a/deno/tools/manage-service.ts b/deno/tools/manage-service.ts new file mode 100644 index 0000000..148f55a --- /dev/null +++ b/deno/tools/manage-service.ts @@ -0,0 +1,42 @@ +import { join } from "@std/path"; +// @ts-types="npm:@types/yargs" +import yargs from "yargs"; + +import { TemplateDir } from "./template.ts"; + +if (import.meta.main) { + await yargs(Deno.args) + .scriptName("manage-service") + .option("project-dir", { + type: "string", + }) + .demandOption("project-dir") + .command({ + command: "gen-tmpl", + describe: "generate files for templates", + builder: (builder) => { + return builder + .option("dry-run", { + type: "boolean", + default: true, + }) + .strict(); + }, + handler: (argv) => { + const { projectDir, dryRun } = argv; + new TemplateDir( + join(projectDir, "services/templates"), + ).generateWithVariableFiles( + [ + join(projectDir, "data/config"), + join(projectDir, "services/config.template"), + ], + dryRun ? undefined : join(projectDir, "services/generated"), + ); + }, + }) + .demandCommand(1, "One command must be specified.") + .help() + .strict() + .parse(); +} diff --git a/deno/tools/manage-vm.ts b/deno/tools/manage-vm.ts new file mode 100644 index 0000000..bb985ce --- /dev/null +++ b/deno/tools/manage-vm.ts @@ -0,0 +1,144 @@ +import os from "node:os"; +import { join } from "@std/path"; +// @ts-types="npm:@types/yargs" +import yargs from "yargs"; + +type ArchAliasMap = { [name: string]: string[] }; +const arches = { + x86_64: ["x86_64", "amd64"], + i386: ["i386", "x86", "i686"], +} as const satisfies ArchAliasMap; +type Arch = keyof typeof arches; +type GeneralArch = (typeof arches)[Arch][number]; + +function normalizeArch(generalName: GeneralArch): Arch { + for (const [name, aliases] of Object.entries(arches as ArchAliasMap)) { + if (aliases.includes(generalName)) return name as Arch; + } + throw Error("Unknown architecture name."); +} + +interface GeneralVmSetup { + name?: string[]; + arch: GeneralArch; + disk: string; + sshForwardPort: number; + kvm?: boolean; +} + +interface VmSetup { + arch: Arch; + disk: string; + sshForwardPort: number; + kvm: boolean; +} + +const MY_VMS: GeneralVmSetup[] = [ + { + name: ["hurd", ...arches.i386.map((a) => `hurd-${a}`)], + arch: "i386", + disk: join(os.homedir(), "vms/hurd-i386.qcow2"), + sshForwardPort: 3222, + }, + { + name: [...arches.x86_64.map((a) => `hurd-${a}`)], + arch: "x86_64", + disk: join(os.homedir(), "vms/hurd-x86_64.qcow2"), + sshForwardPort: 3223, + }, +]; + +function normalizeVmSetup(generalSetup: GeneralVmSetup): VmSetup { + const { arch, disk, sshForwardPort, kvm } = generalSetup; + return { + arch: normalizeArch(arch), + disk, + sshForwardPort, + kvm: kvm ?? Deno.build.os === "linux", + }; +} + +function resolveVmSetup( + name: string, + vms: GeneralVmSetup[], +): VmSetup | undefined { + const setup = vms.find((vm) => vm.name?.includes(name)); + return setup == null ? undefined : normalizeVmSetup(setup); +} + +const qemuBinPrefix = "qemu-system" as const; + +const qemuBinSuffix = { + x86_64: "x86_64", + i386: "x86_64", +} as const; + +function getQemuBin(arch: Arch): string { + return `${qemuBinPrefix}-${qemuBinSuffix[arch]}`; +} + +function getLinuxHostArgs(kvm: boolean): string[] { + return kvm ? ["-enable-kvm"] : []; +} + +function getMachineArgs(arch: Arch): string[] { + const is64 = arch === "x86_64"; + const machineArgs = is64 ? ["-machine", "q35"] : []; + const memory = is64 ? 8 : 4; + return [...machineArgs, "-m", `${memory}G`]; +} + +function getNetworkArgs(sshForwardPort: number): string[] { + return ["-net", "nic", "-net", `user,hostfwd=tcp::${sshForwardPort}-:22`]; +} + +function getDisplayArgs(): string[] { + return ["-vga", "vmware"]; +} + +function getDiskArgs(disk: string): string[] { + return ["-drive", `cache=writeback,file=${disk}`]; +} + +function createQemuArgs(setup: VmSetup): string[] { + const { arch, disk, sshForwardPort } = setup; + return [ + getQemuBin(arch), + ...getLinuxHostArgs(setup.kvm), + ...getMachineArgs(arch), + ...getDisplayArgs(), + ...getNetworkArgs(sshForwardPort), + ...getDiskArgs(disk), + ]; +} + +if (import.meta.main) { + await yargs(Deno.args) + .scriptName("manage-vm") + .command({ + command: "gen <name>", + describe: "generate cli command to run the vm", + builder: (builder) => { + return builder + .positional("name", { + describe: "name of the vm to run", + type: "string", + }) + .demandOption("name") + .strict(); + }, + handler: (argv) => { + const vm = resolveVmSetup(argv.name, MY_VMS); + if (vm == null) { + console.error(`No vm called ${argv.name} is found.`); + Deno.exit(-1); + } + const cli = createQemuArgs(vm); + console.log(`${cli.join(" ")}`); + }, + }) + .demandCommand(1, "One command must be specified.") + .help() + .strict() + .parse(); +} diff --git a/deno/tools/template.ts b/deno/tools/template.ts new file mode 100644 index 0000000..1b67eb8 --- /dev/null +++ b/deno/tools/template.ts @@ -0,0 +1,124 @@ +import { dirname, join, relative } from "@std/path"; +import { copySync, existsSync, walkSync } from "@std/fs"; +import { parse } from "@std/dotenv"; +import { distinct } from "@std/collections"; +// @ts-types="npm:@types/mustache" +import Mustache from "mustache"; + +Mustache.tags = ["@@", "@@"]; +Mustache.escape = (value) => String(value); + +function getVariableKeys(original: string): string[] { + return distinct( + Mustache.parse(original) + .filter(function (v) { + return v[0] === "name"; + }) + .map(function (v) { + return v[1]; + }), + ); +} + +export function loadVariables(files: string[]): Record<string, string> { + const vars: Record<string, string> = {}; + for (const file of files) { + const text = Deno.readTextFileSync(file); + for (const [key, valueText] of Object.entries(parse(text))) { + getVariableKeys(valueText).forEach((name) => { + if (!(name in vars)) { + throw new Error( + `Variable ${name} is not defined yet, perhaps due to typos or wrong order.`, + ); + } + }); + vars[key] = Mustache.render(valueText, vars); + } + } + return vars; +} + +const TEMPLATE_FILE_EXT = ".template"; + +export class TemplateDir { + templates: { path: string; ext: string; text: string; vars: string[] }[] = []; + plains: { path: string }[] = []; + + constructor(public dir: string) { + console.log("Scanning template dir:"); + Array.from( + walkSync(dir, { includeDirs: false, followSymlinks: true }), + ).forEach(({ path }) => { + path = relative(this.dir, path); + if (path.endsWith(TEMPLATE_FILE_EXT)) { + console.log(` (template) ${path}`); + const text = Deno.readTextFileSync(join(dir, path)); + this.templates.push({ + path, + ext: TEMPLATE_FILE_EXT, + text, + vars: getVariableKeys(text), + }); + } else { + console.log(` (plain) ${path}`); + this.plains.push({ path }); + } + }); + console.log("Done scanning template dir."); + } + + allNeededVars() { + return distinct(this.templates.flatMap((t) => t.vars)); + } + + generate(vars: Record<string, string>, generatedDir?: string) { + console.log( + `Generating, template dir: ${this.dir}, generated dir: ${ + generatedDir ?? "[dry-run]" + }:`, + ); + + const undefinedVars = this.allNeededVars().filter((v) => !(v in vars)); + if (undefinedVars.length !== 0) { + throw new Error( + `Needed variables are not defined: ${undefinedVars.join(", ")}`, + ); + } + + if (generatedDir != null) { + if (existsSync(generatedDir)) { + console.log(` delete old generated dir ${generatedDir}`); + Deno.removeSync(generatedDir, { recursive: true }); + } + + for (const file of this.plains) { + const [source, destination] = [ + join(this.dir, file.path), + join(generatedDir, file.path), + ]; + console.log(` copy ${source} to ${destination} ...`); + Deno.mkdirSync(dirname(destination), { recursive: true }); + copySync(source, destination); + } + for (const file of this.templates) { + const [source, destination] = [ + join(this.dir, file.path), + join(generatedDir, file.path.slice(0, -file.ext.length)), + ]; + console.log(` generate ${source} to ${destination} ...`); + const rendered = Mustache.render(file.text, vars); + Deno.mkdirSync(dirname(destination), { recursive: true }); + Deno.writeTextFileSync(destination, rendered); + } + } + console.log(`Done generating.`); + } + + generateWithVariableFiles(varFiles: string[], generatedDir?: string) { + console.log("Scanning defined vars:"); + const vars = loadVariables(varFiles); + Object.keys(vars).forEach((name) => console.log(` ${name}`)); + console.log("Done scanning defined vars."); + this.generate(vars, generatedDir); + } +} |