From 23e49c6e6e63a518e704f82879a5fdcf268c51d8 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Tue, 8 Apr 2025 22:14:04 +0900 Subject: 1st stage, only language switch. Thank you, MomentQYC ( https://github.com/MomentQYC ). Your first attemt encourage me. --- src/app.ts | 200 ++++++++++++++++++++++++++++---------- src/helpers.ts | 93 +++++++++++------- src/routes/frontend.ts | 8 +- src/types/i18next-fs-backend.d.ts | 5 + 4 files changed, 218 insertions(+), 88 deletions(-) create mode 100644 src/types/i18next-fs-backend.d.ts (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 0708081..febc67d 100755 --- a/src/app.ts +++ b/src/app.ts @@ -1,6 +1,20 @@ import express from "express"; import hbs from "express-handlebars"; import cookieParser from "cookie-parser"; +import i18next from "i18next"; +import Backend from "i18next-fs-backend"; +import { LanguageDetector, handle } from 'i18next-http-middleware'; +import { createRequire } from 'module'; +import { fileURLToPath } from 'url'; +import { dirname } from 'path'; +import path from 'path'; + +const require = createRequire(import.meta.url); +const handlebarsI18next = require('handlebars-i18next'); + +// ESモジュールで__dirnameを再現 +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); import routes from "./routes.js"; import frontend from "./routes/frontend.js"; @@ -11,6 +25,7 @@ import staticPages from "./routes/static.js"; import magicLink from "./routes/magicLink.js"; import { initEmailService } from "./lib/email.js"; +import { getI18nHelpers } from "./helpers.js"; import { activityPubContentType, alternateActivityPubContentType, @@ -20,55 +35,142 @@ const app = express(); app.locals.sendEmails = initEmailService(); -// View engine // -const hbsInstance = hbs.create({ - defaultLayout: "main", - partialsDir: ["views/partials/"], - layoutsDir: "views/layouts/", - helpers: { - plural: function (number: number, text: string) { - var singular = number === 1; - // If no text parameter was given, just return a conditional s. - if (typeof text !== "string") return singular ? "" : "s"; - // Split with regex into group1/group2 or group1(group3) - var match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); - // If no match, just append a conditional s. - if (!match) return text + (singular ? "" : "s"); - // We have a good match, so fire away - return ( - (singular && match[1]) || // Singular case - match[2] || // Plural case: 'bagel/bagels' --> bagels - match[1] + (match[3] || "s") - ); // Plural case: 'bagel(s)' or 'bagel' --> bagels - }, - json: function (context: any) { - return JSON.stringify(context); +// ESモジュールで__dirnameを再現する部分を関数化 +const getLocalesPath = () => { + const __filename = fileURLToPath(import.meta.url); + const __dirname = dirname(__filename); + return path.join(__dirname, '..', 'locales'); +}; + +async function initializeApp() { + // Cookies // + app.use(cookieParser()); + + // カスタム言語検出ミドルウェア + // app.use((req, res, next) => { + // const acceptLanguage = req.headers['accept-language']; + // if (acceptLanguage && acceptLanguage.includes('ja')) { + // res.cookie('i18next', 'ja', { + // maxAge: 365 * 24 * 60 * 60 * 1000, + // httpOnly: true, + // sameSite: 'lax' + // }); + // } + // next(); + // }); + + // i18next configuration + await i18next + .use(Backend) + .use(LanguageDetector) + .init({ + backend: { + loadPath: path.join(getLocalesPath(), '{{lng}}.json'), + }, + fallbackLng: 'en', + preload: ['en', 'ja'], + supportedLngs: ['en', 'ja'], + nonExplicitSupportedLngs: true, + load: 'languageOnly', + debug: true, + detection: { + order: ['header', 'cookie'], + lookupHeader: 'accept-language', + lookupCookie: 'i18next', + caches: ['cookie'] + }, + interpolation: { + escapeValue: false + } + }); + + app.use(handle(i18next)); + + // 言語を明示的に切り替える + app.use((req, res, next) => { + const currentLanguage = i18next.language; + i18next.changeLanguage(req.language); + const newLanguage = i18next.language; + console.log('Language Change:', { + header: req.headers['accept-language'], + detected: req.language, + currentLanguage: currentLanguage, + newLanguage: newLanguage + }); + next(); + }); + + // デバッグ用 + app.use((req, res, next) => { + console.log('Language Detection:', { + header: req.headers['accept-language'], + detected: req.language, + i18next: i18next.language + }); + next(); + }); + + // View engine // + const hbsInstance = hbs.create({ + defaultLayout: "main", + partialsDir: ["views/partials/"], + layoutsDir: "views/layouts/", + helpers: { + plural: function (number: number, text: string) { + var singular = number === 1; + // If no text parameter was given, just return a conditional s. + if (typeof text !== "string") return singular ? "" : "s"; + // Split with regex into group1/group2 or group1(group3) + var match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); + // If no match, just append a conditional s. + if (!match) return text + (singular ? "" : "s"); + // We have a good match, so fire away + return ( + (singular && match[1]) || // Singular case + match[2] || // Plural case: 'bagel/bagels' --> bagels + match[1] + (match[3] || "s") + ); // Plural case: 'bagel(s)' or 'bagel' --> bagels + }, + json: function (context: any) { + return JSON.stringify(context); + }, + // i18nextヘルパーを追加 + ...getI18nHelpers() }, - }, -}); -app.engine("handlebars", hbsInstance.engine); -app.set("view engine", "handlebars"); -app.set("hbsInstance", hbsInstance); - -// Static files // -app.use(express.static("public")); - -// Body parser // -app.use(express.json({ type: alternateActivityPubContentType })); -app.use(express.json({ type: activityPubContentType })); -app.use(express.json({ type: "application/json" })); -app.use(express.urlencoded({ extended: true })); - -// Cookies // -app.use(cookieParser()); - -// Router // -app.use("/", staticPages); -app.use("/", frontend); -app.use("/", activitypub); -app.use("/", event); -app.use("/", group); -app.use("/", magicLink); -app.use("/", routes); + }); + + // i18nextHelperの呼び出し方法を変更 + if (typeof handlebarsI18next === 'function') { + handlebarsI18next(hbsInstance.handlebars, i18next); + } else if (typeof handlebarsI18next.default === 'function') { + handlebarsI18next.default(hbsInstance.handlebars, i18next); + } else { + console.error('handlebars-i18next helper is not properly loaded'); + } + + app.engine("handlebars", hbsInstance.engine); + app.set("view engine", "handlebars"); + app.set("hbsInstance", hbsInstance); + + // Static files // + app.use(express.static("public")); + + // Body parser // + app.use(express.json({ type: alternateActivityPubContentType })); + app.use(express.json({ type: activityPubContentType })); + app.use(express.json({ type: "application/json" })); + app.use(express.urlencoded({ extended: true })); + + // Router // + app.use("/", staticPages); + app.use("/", frontend); + app.use("/", activitypub); + app.use("/", event); + app.use("/", group); + app.use("/", magicLink); + app.use("/", routes); +} + +initializeApp().catch(console.error); export default app; diff --git a/src/helpers.ts b/src/helpers.ts index 47b380f..5590912 100644 --- a/src/helpers.ts +++ b/src/helpers.ts @@ -1,5 +1,8 @@ -import moment from "moment-timezone"; -import icalGenerator from "ical-generator"; +import mongoose from 'mongoose'; +import moment from 'moment-timezone'; +import icalGenerator from 'ical-generator'; +import i18next from 'i18next'; +import handlebars from 'handlebars'; import Log from "./models/Log.js"; import { getConfig } from "./lib/config.js"; import { IEvent } from "./models/Event.js"; @@ -10,41 +13,61 @@ const siteName = config.general.site_name; // LOGGING export function addToLog(process: string, status: string, message: string) { - const logEntry = { - status, - process, - message, - timestamp: new Date(), - }; - new Log(logEntry).save().catch(() => { - console.log("Error saving log entry!"); - }); + const logEntry = { + status, + process, + message, + timestamp: new Date(), + }; + new Log(logEntry).save().catch(() => { + console.log("Error saving log entry!"); + }); } -export function exportICal(events: IEvent[], calendarName: string) { - if (!events || events.length < 1) return; +export function exportIcal(events: IEvent | IEvent[], calendarName?: string) { // Ical -> ICal + // Create a new icalGenerator... generator + const cal = icalGenerator({ + name: calendarName || siteName, + timezone: 'UTC' + }); - // Create a new icalGenerator... generator - const cal = icalGenerator({ - name: calendarName || siteName, - }); - events.forEach((event) => { - // Add the event to the generator - cal.createEvent({ - start: moment.tz(event.start, event.timezone), - end: moment.tz(event.end, event.timezone), - timezone: event.timezone, - summary: event.name, - description: event.description, - organizer: { - name: event.hostName || "Anonymous", - email: event.creatorEmail || "anonymous@anonymous.com", - }, - location: event.location, - url: "https://" + domain + "/" + event.id, - }); + const eventArray = Array.isArray(events) ? events : [events]; + eventArray.forEach(event => { + cal.createEvent({ + start: moment.tz(event.start, event.timezone), + end: moment.tz(event.end, event.timezone), + timezone: event.timezone, + summary: event.name, + description: event.description, + organizer: { + name: event.hostName || "Anonymous", + email: event.creatorEmail || 'anonymous@anonymous.com', + }, + location: event.location, + url: 'https://' + domain + '/' + event.id }); - // Stringify it! - const string = cal.toString(); - return string; + }); + + return cal.toString(); +} + +interface I18nHelpers { + t: (key: string, options?: object) => string; + tn: (key: string, options?: object) => string; + count?: number; +} + +export function getI18nHelpers(): I18nHelpers { + return { + t: function(key: string, options?: object) { + const translation = i18next.t(key, { ...this, ...options }); + const template = handlebars.compile(translation); + return template(this); + }, + tn: function(key: string, options?: object) { + const translation = i18next.t(key, { count: this.count, ...options }); + const template = handlebars.compile(translation); + return template(this); + } + }; } diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 14bb779..96d7587 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -8,7 +8,7 @@ import { instanceDescription, instanceRules, } from "../lib/config.js"; -import { addToLog, exportICal } from "../helpers.js"; +import { addToLog, exportIcal } from "../helpers.js"; import Event from "../models/Event.js"; import EventGroup, { IEventGroup } from "../models/EventGroup.js"; import { @@ -546,7 +546,7 @@ router.get( const events = await Event.find({ eventGroup: eventGroup._id, }).sort("start"); - const string = exportICal(events, eventGroup.name); + const string = exportIcal(events, eventGroup.name); res.set("Content-Type", "text/calendar").send(string); } } catch (err) { @@ -568,7 +568,7 @@ router.get("/export/event/:eventID", async (req: Request, res: Response) => { }).populate("eventGroup"); if (event) { - const string = exportICal([event], event.name); + const string = exportIcal([event], event.name); res.set("Content-Type", "text/calendar").send(string); } } catch (err) { @@ -594,7 +594,7 @@ router.get( const events = await Event.find({ eventGroup: eventGroup._id, }).sort("start"); - const string = exportICal(events, eventGroup.name); + const string = exportIcal(events, eventGroup.name); res.set("Content-Type", "text/calendar").send(string); } } catch (err) { diff --git a/src/types/i18next-fs-backend.d.ts b/src/types/i18next-fs-backend.d.ts new file mode 100644 index 0000000..33714e7 --- /dev/null +++ b/src/types/i18next-fs-backend.d.ts @@ -0,0 +1,5 @@ +declare module 'i18next-fs-backend' { + import { BackendModule } from 'i18next'; + const backend: BackendModule; + export default backend; +} \ No newline at end of file -- cgit v1.2.3 From 90bdf104d76674d307cbd50dc1cf3d973b663471 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Tue, 8 Apr 2025 22:18:02 +0900 Subject: fix and add some translation keys. --- src/app.ts | 13 ------------- 1 file changed, 13 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index febc67d..5fe0100 100755 --- a/src/app.ts +++ b/src/app.ts @@ -46,19 +46,6 @@ async function initializeApp() { // Cookies // app.use(cookieParser()); - // カスタム言語検出ミドルウェア - // app.use((req, res, next) => { - // const acceptLanguage = req.headers['accept-language']; - // if (acceptLanguage && acceptLanguage.includes('ja')) { - // res.cookie('i18next', 'ja', { - // maxAge: 365 * 24 * 60 * 60 * 1000, - // httpOnly: true, - // sameSite: 'lax' - // }); - // } - // next(); - // }); - // i18next configuration await i18next .use(Backend) -- cgit v1.2.3 From 1b57d9ea6513b81e538677f9ebf221d0c635f482 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Tue, 8 Apr 2025 22:18:39 +0900 Subject: Plural with i18next --- src/app.ts | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 5fe0100..ddfc101 100755 --- a/src/app.ts +++ b/src/app.ts @@ -1,5 +1,6 @@ import express from "express"; -import hbs from "express-handlebars"; +import hbs, { ExpressHandlebars } from "express-handlebars"; +import Handlebars from 'handlebars'; import cookieParser from "cookie-parser"; import i18next from "i18next"; import Backend from "i18next-fs-backend"; @@ -98,31 +99,20 @@ async function initializeApp() { }); // View engine // - const hbsInstance = hbs.create({ + const hbsInstance: ExpressHandlebars = hbs.create({ defaultLayout: "main", partialsDir: ["views/partials/"], layoutsDir: "views/layouts/", helpers: { - plural: function (number: number, text: string) { - var singular = number === 1; - // If no text parameter was given, just return a conditional s. - if (typeof text !== "string") return singular ? "" : "s"; - // Split with regex into group1/group2 or group1(group3) - var match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); - // If no match, just append a conditional s. - if (!match) return text + (singular ? "" : "s"); - // We have a good match, so fire away - return ( - (singular && match[1]) || // Singular case - match[2] || // Plural case: 'bagel/bagels' --> bagels - match[1] + (match[3] || "s") - ); // Plural case: 'bagel(s)' or 'bagel' --> bagels - }, json: function (context: any) { return JSON.stringify(context); }, // i18nextヘルパーを追加 - ...getI18nHelpers() + ...getI18nHelpers(), + plural: function (key: string, count: number, options: any) { // ★plural ヘルパーを登録 + const translation = i18next.t(key, { count: count }); + return translation; + } }, }); @@ -135,6 +125,12 @@ async function initializeApp() { console.error('handlebars-i18next helper is not properly loaded'); } + + (hbsInstance.handlebars as typeof Handlebars).registerHelper('pluralize', function(count: number, key: string, options: any) { + const translation = i18next.t(key, { count: count }); + return translation; + }); + app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); app.set("hbsInstance", hbsInstance); -- cgit v1.2.3 From b6c5301bef843eab1262faca8548df204908b663 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Tue, 8 Apr 2025 22:20:04 +0900 Subject: Add 'en-US', change preload language --- src/app.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index ddfc101..9828905 100755 --- a/src/app.ts +++ b/src/app.ts @@ -56,8 +56,8 @@ async function initializeApp() { loadPath: path.join(getLocalesPath(), '{{lng}}.json'), }, fallbackLng: 'en', - preload: ['en', 'ja'], - supportedLngs: ['en', 'ja'], + preload: ['en-US', 'ja'], + supportedLngs: ['en','en-US', 'ja'], nonExplicitSupportedLngs: true, load: 'languageOnly', debug: true, -- cgit v1.2.3 From f2ee19f15a78125a1dc2ba8b9c175dd9831e5700 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Thu, 20 Mar 2025 22:54:38 +0900 Subject: hidden attendees (? people) --- src/app.ts | 6 ------ src/routes/frontend.ts | 3 ++- 2 files changed, 2 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 9828905..9301484 100755 --- a/src/app.ts +++ b/src/app.ts @@ -125,12 +125,6 @@ async function initializeApp() { console.error('handlebars-i18next helper is not properly loaded'); } - - (hbsInstance.handlebars as typeof Handlebars).registerHelper('pluralize', function(count: number, key: string, options: any) { - const translation = i18next.t(key, { count: count }); - return translation; - }); - app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); app.set("hbsInstance", hbsInstance); diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 96d7587..40b5393 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -19,6 +19,7 @@ import MagicLink from "../models/MagicLink.js"; import { getConfigMiddleware } from "../lib/middleware.js"; import { getMessage } from "../util/messages.js"; import { EventListEvent, bucketEventsByMonth } from "../lib/event.js"; +import i18next from "i18next"; const router = Router(); @@ -257,7 +258,7 @@ router.get("/:eventID", async (req: Request, res: Response) => { el.id = el._id; } if (el.number && el.number > 1) { - el.name = `${el.name} (${el.number} people)`; + el.name = `${el.name} ${i18next.t("frontend.elnumber", { count: el.number })}`; } return { ...el, -- cgit v1.2.3 From 2449234e28aab435ffe28d567ece8c651d45d2b3 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sat, 22 Mar 2025 21:03:25 +0900 Subject: DateTime format, and some translation fix --- src/lib/event.ts | 4 ++- src/routes/frontend.ts | 91 ++++++++++++++++++++++++++++++++------------------ 2 files changed, 61 insertions(+), 34 deletions(-) (limited to 'src') diff --git a/src/lib/event.ts b/src/lib/event.ts index 334ddf6..09631b9 100644 --- a/src/lib/event.ts +++ b/src/lib/event.ts @@ -1,3 +1,4 @@ +import i18next from "i18next"; import { IEventGroup } from "../models/EventGroup.js"; export interface EventListEvent { @@ -15,7 +16,8 @@ export const bucketEventsByMonth = ( acc: Record[], event: EventListEvent, ) => { - const month = event.startMoment.format("MMMM YYYY"); + event.startMoment.locale(i18next.language); + const month = event.startMoment.format(i18next.t("year-month-format" )); const matchingBucket = acc.find((bucket) => bucket.title === month); if (!matchingBucket) { acc.push({ diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 40b5393..6f9e00a 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -71,7 +71,7 @@ router.get("/new/:magicLinkToken", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "danger", - text: "This magic link is invalid or has expired. Please request a new one here.", + text: i18next.t("magiclink-invalid"), }, }); } @@ -92,6 +92,7 @@ router.get("/events", async (_: Request, res: Response) => { .lean() .sort("start"); const updatedEvents: EventListEvent[] = events.map((event) => { + moment.locale(i18next.language); const startMoment = moment.tz(event.start, event.timezone); const endMoment = moment.tz(event.end, event.timezone); const isSameDay = startMoment.isSame(endMoment, "day"); @@ -101,9 +102,9 @@ router.get("/events", async (_: Request, res: Response) => { name: event.name, location: event.location, displayDate: isSameDay - ? startMoment.format("D MMM YYYY") - : `${startMoment.format("D MMM YYYY")} - ${endMoment.format( - "D MMM YYYY", + ? startMoment.format("LL") + : `${startMoment.format("LL")} - ${endMoment.format( + "LL", )}`, eventHasConcluded: endMoment.isBefore(moment.tz(event.timezone)), eventGroup: event.eventGroup as any as IEventGroup, @@ -133,7 +134,7 @@ router.get("/events", async (_: Request, res: Response) => { }); res.render("publicEventList", { - title: "Public events", + title: i18next.t("frontend.publicevents"), upcomingEvents: upcomingEventsInMonthBuckets, pastEvents: pastEventsInMonthBuckets, eventGroups: updatedEventGroups, @@ -155,31 +156,57 @@ router.get("/:eventID", async (req: Request, res: Response) => { } const parsedLocation = event.location.replace(/\s+/g, "+"); let displayDate; + moment.locale(i18next.language); + const dateformat = i18next.t("frontend.dateformat"); + const timeformat = i18next.t('frontend.timeformat'); if (moment.tz(event.end, event.timezone).isSame(event.start, "day")) { // Happening during one day - displayDate = - moment - .tz(event.start, event.timezone) - .format( - 'dddd D MMMM YYYY [from] h:mm a', - ) + - moment - .tz(event.end, event.timezone) - .format( - ' [to] h:mm a [](z)[]', - ); + displayDate = i18next.t("frontend.displaydate-sameday", + { + startdate: + moment + .tz(event.start, event.timezone) + .format(dateformat), + starttime: + moment + .tz(event.start, event.timezone) + .format(timeformat), + endtime: + moment + .tz(event.end, event.timezone) + .format(timeformat), + timezone: + i18next.t('frontend.sameday.timezone', + { tz: + moment + .tz(event.end, event.timezone) + .format('(z)',) + } ) + }); } else { - displayDate = - moment - .tz(event.start, event.timezone) - .format( - 'dddd D MMMM YYYY [at] h:mm a', - ) + - moment - .tz(event.end, event.timezone) - .format( - ' [–] dddd D MMMM YYYY [at] h:mm a [](z)[]', - ); + displayDate = i18next.t("frontend.displaydate-days", + { + startdate: + moment + .tz(event.start, event.timezone) + .format(dateformat), + starttime: + moment + .tz(event.start, event.timezone) + .format(timeformat), + enddate: + moment + .tz(event.end, event.timezone) + .format(dateformat), + endtime: + moment + .tz(event.end, event.timezone) + .format(timeformat), + timezone: + moment + .tz(event.end, event.timezone) + .format('(z)',) + }); } let eventStartISO = moment.tz(event.start, "Etc/UTC").toISOString(); let eventEndISO = moment.tz(event.end, "Etc/UTC").toISOString(); @@ -430,8 +457,8 @@ router.get("/group/:eventGroupID", async (req: Request, res: Response) => { .sort("start"); const updatedEvents: EventListEvent[] = events.map((event) => { - const startMoment = moment.tz(event.start, event.timezone); - const endMoment = moment.tz(event.end, event.timezone); + const startMoment = moment.tz(event.start, event.timezone).locale(i18next.language); + const endMoment = moment.tz(event.end, event.timezone).locale(i18next.language); const isSameDay = startMoment.isSame(endMoment, "day"); return { @@ -439,10 +466,8 @@ router.get("/group/:eventGroupID", async (req: Request, res: Response) => { name: event.name, location: event.location, displayDate: isSameDay - ? startMoment.format("D MMM YYYY") - : `${startMoment.format("D MMM YYYY")} - ${endMoment.format( - "D MMM YYYY", - )}`, + ? startMoment.format("LL") + : `${startMoment.format("LL")} - ${endMoment.format("LL")}`, eventHasConcluded: endMoment.isBefore( moment.tz(event.timezone), ), -- cgit v1.2.3 From 73e8b168c3ffc4e3ffe30e50dd3e46ed70d909d8 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sat, 22 Mar 2025 22:55:46 +0900 Subject: some fix, moment.locale setting --- src/app.ts | 5 +++++ src/routes/frontend.ts | 6 ++---- 2 files changed, 7 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 9301484..a71bf30 100755 --- a/src/app.ts +++ b/src/app.ts @@ -31,6 +31,7 @@ import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; +import moment from "moment"; const app = express(); @@ -125,6 +126,10 @@ async function initializeApp() { console.error('handlebars-i18next helper is not properly loaded'); } + i18next.on('languageChanged', function(lng) { + moment.locale(lng); + }); + app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); app.set("hbsInstance", hbsInstance); diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 6f9e00a..44d3a76 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -50,7 +50,7 @@ router.get("/new", (req: Request, res: Response) => { return res.render("createEventMagicLink", frontendConfig(res)); } return res.render("newevent", { - title: "New event", + title: i18next.t("frontend.newevent"), ...frontendConfig(res), }); }); @@ -76,7 +76,7 @@ router.get("/new/:magicLinkToken", async (req: Request, res: Response) => { }); } res.render("newevent", { - title: "New event", + title: i18next.t("frontend.newevent"), ...frontendConfig(res), magicLinkToken: req.params.magicLinkToken, creatorEmail: magicLink.email, @@ -92,7 +92,6 @@ router.get("/events", async (_: Request, res: Response) => { .lean() .sort("start"); const updatedEvents: EventListEvent[] = events.map((event) => { - moment.locale(i18next.language); const startMoment = moment.tz(event.start, event.timezone); const endMoment = moment.tz(event.end, event.timezone); const isSameDay = startMoment.isSame(endMoment, "day"); @@ -156,7 +155,6 @@ router.get("/:eventID", async (req: Request, res: Response) => { } const parsedLocation = event.location.replace(/\s+/g, "+"); let displayDate; - moment.locale(i18next.language); const dateformat = i18next.t("frontend.dateformat"); const timeformat = i18next.t('frontend.timeformat'); if (moment.tz(event.end, event.timezone).isSame(event.start, "day")) { -- cgit v1.2.3 From 9b955505e6a8dc4f1dbcd8f12d25996b57cf64df Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sat, 22 Mar 2025 23:50:51 +0900 Subject: validations --- src/util/validation.ts | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) (limited to 'src') diff --git a/src/util/validation.ts b/src/util/validation.ts index a3bea63..0d82b88 100644 --- a/src/util/validation.ts +++ b/src/util/validation.ts @@ -1,3 +1,4 @@ +import i18next from "i18next"; import moment from "moment-timezone"; type Error = { @@ -90,26 +91,26 @@ const validateUrl = (url: string) => { export const validateEventTime = (start: Date, end: Date): Error | boolean => { if (moment(start).isAfter(moment(end))) { return { - message: "Start time must be before end time.", + message: i18next.t('validation.eventtime.startisafter'), field: "eventStart", }; } if (moment(start).isBefore(moment())) { return { - message: "Start time must be in the future.", + message: i18next.t('validation.eventtime.startisbefore'), field: "eventStart", }; } if (moment(end).isBefore(moment())) { return { - message: "End time must be in the future.", + message: i18next.t('validation.eventtime.endisbefore'), field: "eventEnd", }; } // Duration cannot be longer than 1 year if (moment(end).diff(moment(start), "years") > 1) { return { - message: "Event duration cannot be longer than 1 year.", + message: i18next.t("validation.eventtime.endyears"), field: "eventEnd", }; } @@ -130,25 +131,25 @@ export const validateEventData = ( const errors: Error[] = []; if (!validatedData.eventName) { errors.push({ - message: "Event name is required.", + message: i18next.t('validation.eventdata.eventname'), field: "eventName", }); } if (!validatedData.eventLocation) { errors.push({ - message: "Event location is required.", + message: i18next.t("validation.eventdata.eventlocation"), field: "eventLocation", }); } if (!validatedData.eventStart) { errors.push({ - message: "Event start time is required.", + message: i18next.t("validation.eventdata.eventstart"), field: "eventStart", }); } if (!validatedData.eventEnd) { errors.push({ - message: "Event end time is required.", + message: i18next.t("validation.eventdata.eventend"), field: "eventEnd", }); } @@ -163,26 +164,26 @@ export const validateEventData = ( } if (!validatedData.timezone) { errors.push({ - message: "Event timezone is required.", + message: i18next.t("validation.eventdata.timezone"), field: "timezone", }); } if (!validatedData.eventDescription) { errors.push({ - message: "Event description is required.", + message: i18next.t("validation.eventdata.eventdescription"), field: "eventDescription", }); } if (validatedData.eventGroupBoolean) { if (!validatedData.eventGroupID) { errors.push({ - message: "Event group ID is required.", + message: i18next.t("validation.eventdata.eventgroupboolean"), field: "eventGroupID", }); } if (!validatedData.eventGroupEditToken) { errors.push({ - message: "Event group edit token is required.", + message: i18next.t("validation.eventdata.eventgroupedittoken"), field: "eventGroupEditToken", }); } @@ -190,13 +191,13 @@ export const validateEventData = ( if (validatedData.maxAttendeesBoolean) { if (!validatedData.maxAttendees) { errors.push({ - message: "Max number of attendees is required.", + message: i18next.t("validation.eventdata.maxattendeesboolean"), field: "maxAttendees", }); } if (isNaN(validatedData.maxAttendees)) { errors.push({ - message: "Max number of attendees must be a number.", + message: i18next.t("validation.eventdata.maxattendees"), field: "maxAttendees", }); } @@ -204,7 +205,7 @@ export const validateEventData = ( if (validatedData.creatorEmail) { if (!validateEmail(validatedData.creatorEmail)) { errors.push({ - message: "Email address is invalid.", + message: i18next.t("validation.eventdata.creatoremail"), field: "creatorEmail", }); } @@ -212,7 +213,7 @@ export const validateEventData = ( if (validatedData.eventURL) { if (!validateUrl(validatedData.eventURL)) { errors.push({ - message: "Event link is invalid.", + message: i18next.t("validation.eventdata.eventurl"), field: "eventURL", }); } @@ -230,20 +231,20 @@ export const validateGroupData = ( const errors: Error[] = []; if (!groupData.eventGroupName) { errors.push({ - message: "Event group name is required.", + message: i18next.t("validation.groupdata.eventgroupname"), field: "eventGroupName", }); } if (!groupData.eventGroupDescription) { errors.push({ - message: "Event group description is required.", + message: i18next.t("validation.groupdata.eventgroupdescription"), field: "eventGroupDescription", }); } if (groupData.creatorEmail) { if (!validateEmail(groupData.creatorEmail)) { errors.push({ - message: "Email address is invalid.", + message: i18next.t("validation.groupdata.creatoremail"), field: "creatorEmail", }); } @@ -251,7 +252,7 @@ export const validateGroupData = ( if (groupData.eventGroupURL) { if (!validateUrl(groupData.eventGroupURL)) { errors.push({ - message: "Group link is invalid.", + message: i18next.t("validation.groupdata.eventgroupurl"), field: "eventGroupURL", }); } -- cgit v1.2.3 From 79d28b2a14cfab50b9a5a42e7d85ce7dedc7c180 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sun, 23 Mar 2025 14:06:00 +0900 Subject: MagicLink translation --- src/routes/magicLink.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/routes/magicLink.ts b/src/routes/magicLink.ts index b4afca6..5eb424b 100644 --- a/src/routes/magicLink.ts +++ b/src/routes/magicLink.ts @@ -4,6 +4,7 @@ import { sendEmailFromTemplate } from "../lib/email.js"; import { generateMagicLinkToken } from "../util/generator.js"; import MagicLink from "../models/MagicLink.js"; import { getConfigMiddleware } from "../lib/middleware.js"; +import i18next from "i18next"; const router = Router(); @@ -16,7 +17,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "danger", - text: "Please provide an email address.", + text: i18next.t("ml.provideemail"), }, }); return; @@ -31,7 +32,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "success", - text: "Thanks! If this email address can create events, you should receive an email with a magic link.", + text: i18next.t("ml.thanks"), }, }); return; @@ -51,7 +52,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { sendEmailFromTemplate( email, "", - `Magic link to create an event`, + i18next.t("ml.mailsubject"), "createEventMagicLink", { token, @@ -65,7 +66,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "success", - text: "Thanks! If this email address can create events, you should receive an email with a magic link.", + text: i18next.t("ml.thanks"), }, }); }); -- cgit v1.2.3 From 90357f6a7729e82d5498835d92bf86e8e07d3478 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sun, 23 Mar 2025 16:22:10 +0900 Subject: instance description etc. fix translation --- src/lib/config.ts | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) (limited to 'src') diff --git a/src/lib/config.ts b/src/lib/config.ts index e8b774a..406775d 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -3,6 +3,7 @@ import toml from "toml"; import { exitWithError } from "./process.js"; import { Response } from "express"; import { markdownToSanitizedHTML } from "../util/markdown.js"; +import i18next from "i18next"; interface StaticPage { title: string; @@ -109,44 +110,44 @@ export const instanceRules = (): InstanceRule[] => { rules.push( config.general.show_public_event_list ? { - text: "Public events and groups are displayed on the homepage", + text: i18next.t("config.instancerule.showpubliceventlist-true"), icon: "fas fa-eye", } : { - text: "Events and groups can only be accessed by direct link", + text: i18next.t("config.instancerule..showpubliceventlist-false"), icon: "fas fa-eye-slash", }, ); rules.push( config.general.creator_email_addresses?.length ? { - text: "Only specific people can create events and groups", + text: i18next.t("config.instancerule.creatoremail-true"), icon: "fas fa-user-check", } : { - text: "Anyone can create events and groups", + text: i18next.t("config.instancerule.creatoremail-false"), icon: "fas fa-users", }, ); rules.push( config.general.delete_after_days > 0 ? { - text: `Events are automatically deleted ${config.general.delete_after_days} days after they end`, + text: i18next.t("config.instancerule.deleteafterdays-true", { days: config.general.delete_after_days } ), icon: "far fa-calendar-times", } : { - text: "Events are permanent, and are never automatically deleted", + text: i18next.t("config.instancerule.deleteafterdays-false"), icon: "far fa-calendar-check", }, ); rules.push( config.general.is_federated ? { - text: "This instance federates with other instances using ActivityPub", + text: i18next.t("config.instancerule.isfederated-true"), icon: "fas fa-globe", } : { - text: "This instance does not federate with other instances", + text: i18next.t("config.instancerule.isfederated-false"), icon: "fas fa-globe", }, ); @@ -156,12 +157,13 @@ export const instanceRules = (): InstanceRule[] => { export const instanceDescription = (): string => { const config = getConfig(); const defaultInstanceDescription = - "**{{ siteName }}** is running on Gathio — a simple, federated, privacy-first event hosting platform."; + i18next.t("config.defaultinstancedesc"); let instanceDescription = defaultInstanceDescription; + let instancedescfile = "./static/instance-description-" + i18next.language + ".md"; try { - if (fs.existsSync("./static/instance-description.md")) { + if (fs.existsSync(instancedescfile)) { const fileBody = fs.readFileSync( - "./static/instance-description.md", + instancedescfile, "utf-8", ); instanceDescription = markdownToSanitizedHTML(fileBody); -- cgit v1.2.3 From 61e2bfd5b1e7b601ca6e8d5f1f32b04b47697e7c Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Mon, 24 Mar 2025 21:36:57 +0900 Subject: some translation fix --- src/routes/frontend.ts | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 44d3a76..387cd65 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -174,12 +174,9 @@ router.get("/:eventID", async (req: Request, res: Response) => { .tz(event.end, event.timezone) .format(timeformat), timezone: - i18next.t('frontend.sameday.timezone', - { tz: - moment - .tz(event.end, event.timezone) - .format('(z)',) - } ) + moment + .tz(event.end, event.timezone) + .format(' (z)',) }); } else { displayDate = i18next.t("frontend.displaydate-days", -- cgit v1.2.3 From 15151fb2de8bfa8b934a4705150c4e7aef611ec3 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Mon, 24 Mar 2025 21:38:47 +0900 Subject: remove i18n debug code --- src/app.ts | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index a71bf30..47bb2d1 100755 --- a/src/app.ts +++ b/src/app.ts @@ -61,7 +61,7 @@ async function initializeApp() { supportedLngs: ['en','en-US', 'ja'], nonExplicitSupportedLngs: true, load: 'languageOnly', - debug: true, + debug: false, detection: { order: ['header', 'cookie'], lookupHeader: 'accept-language', @@ -80,24 +80,24 @@ async function initializeApp() { const currentLanguage = i18next.language; i18next.changeLanguage(req.language); const newLanguage = i18next.language; - console.log('Language Change:', { - header: req.headers['accept-language'], - detected: req.language, - currentLanguage: currentLanguage, - newLanguage: newLanguage - }); +// console.log('Language Change:', { +// header: req.headers['accept-language'], +// detected: req.language, +// currentLanguage: currentLanguage, +// newLanguage: newLanguage +// }); next(); }); - // デバッグ用 - app.use((req, res, next) => { - console.log('Language Detection:', { - header: req.headers['accept-language'], - detected: req.language, - i18next: i18next.language - }); - next(); - }); +// // デバッグ用 +// app.use((req, res, next) => { +// console.log('Language Detection:', { +// header: req.headers['accept-language'], +// detected: req.language, +// i18next: i18next.language +// }); +// next(); +// }); // View engine // const hbsInstance: ExpressHandlebars = hbs.create({ -- cgit v1.2.3 From b56f838718386e611af71a74b479a331b832da79 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Mon, 24 Mar 2025 21:50:25 +0900 Subject: mails translation --- src/routes.js | 15 ++++++++------- src/routes/event.ts | 24 +++++++++++++----------- 2 files changed, 21 insertions(+), 18 deletions(-) (limited to 'src') diff --git a/src/routes.js b/src/routes.js index 49718ff..23959dd 100755 --- a/src/routes.js +++ b/src/routes.js @@ -24,6 +24,7 @@ import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; +import i18next from "i18next"; const config = getConfig(); const domain = config.general.domain; @@ -377,7 +378,7 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { const msg = { to: attendeeEmails, from: contactEmail, - subject: `${siteName}: ${event.name} was deleted`, + subject: `${siteName} : ` + i18next.t("routes.deleteeventsubject", {eventName: event.name}), html, }; switch (mailService) { @@ -722,7 +723,7 @@ router.post("/attendevent/:eventID", async (req, res) => { const msg = { to: req.body.attendeeEmail, from: contactEmail, - subject: `${siteName}: You're RSVPed to ${event.name}`, + subject: `${siteName} : ` + i18next.t("routes.addeventattendeesubject", {eventName: event.name}), html, }; switch (mailService) { @@ -798,7 +799,7 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { const msg = { to: req.body.attendeeEmail, from: contactEmail, - subject: `${siteName}: You have been removed from an event`, + subject: `${siteName} : ` + i18next.t("routes.removeeventattendeesubject"), html, }; switch (mailService) { @@ -867,7 +868,7 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { const msg = { to: req.body.attendeeEmail, from: contactEmail, - subject: `${siteName}: You have been removed from an event`, + subject: `${siteName} : ` + i18next.t("routes.removeeventattendeesubject"), html, }; switch (mailService) { @@ -945,7 +946,7 @@ router.post("/subscribe/:eventGroupID", (req, res) => { const msg = { to: subscriber.email, from: contactEmail, - subject: `${siteName}: You have subscribed to an event group`, + subject: `${siteName} : ` + i18next.t("routes.subscribedsubject"), html, }; switch (mailService) { @@ -1084,7 +1085,7 @@ router.post("/post/comment/:eventID", (req, res) => { const msg = { to: attendeeEmails, from: contactEmail, - subject: `${siteName}: New comment in ${event.name}`, + subject: `${siteName} : ` + i18next.t("routes.addeventcommentsubject", { eventName: event.name }), html, }; switch (mailService) { @@ -1212,7 +1213,7 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { const msg = { to: attendeeEmails, from: contactEmail, - subject: `${siteName}: New comment in ${event.name}`, + subject: `${siteName} : ` + i18next.t("routes.addeventcommentsubject", { eventName: event.name }), html, }; switch (mailService) { diff --git a/src/routes/event.ts b/src/routes/event.ts index de5cb4c..ca333c5 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -28,6 +28,8 @@ import ical from "ical"; import { markdownToSanitizedHTML } from "../util/markdown.js"; import { checkMagicLink, getConfigMiddleware } from "../lib/middleware.js"; import { getConfig } from "../lib/config.js"; +import i18next from "i18next"; +moment.locale(i18next.language); const config = getConfig(); @@ -409,33 +411,33 @@ router.put( : undefined, }; let diffText = - "

This event was just updated with new information.

    "; + "

    " + i18next.t("routes.event.difftext") + "

      "; let displayDate; if (event.name !== updatedEvent.name) { - diffText += `
    • the event name changed to ${updatedEvent.name}
      • `; + diffText += `
    • ` + i18next.t("routes.event.namechanged") + updatedEvent.name + `
      • `; } if (event.location !== updatedEvent.location) { - diffText += `
    • the location changed to ${updatedEvent.location}
      • `; + diffText += `
    • ` + i18next.t("routes.event.locationchanged") + updatedEvent.location + `
      • `; } if ( event.start.toISOString() !== updatedEvent.start.toISOString() ) { displayDate = moment .tz(updatedEvent.start, updatedEvent.timezone) - .format("dddd D MMMM YYYY h:mm a"); - diffText += `
    • the start time changed to ${displayDate}
      • `; + .format(i18next.t("common.datetimeformat")); + diffText += `
    • ` + i18next.t("routes.event.starttimechanged") + displayDate + `
      • `; } if (event.end.toISOString() !== updatedEvent.end.toISOString()) { displayDate = moment .tz(updatedEvent.end, updatedEvent.timezone) - .format("dddd D MMMM YYYY h:mm a"); - diffText += `
    • the end time changed to ${displayDate}
      • `; + .format(i18next.t("common.datetimeformat")); + diffText += `
    • ` + i18next.t("routes.event.endtimechanged") + displayDate + `
      • `; } if (event.timezone !== updatedEvent.timezone) { - diffText += `
    • the time zone changed to ${updatedEvent.timezone}
      • `; + diffText += `
    • ` + i18next.t("routes.event.timezonechanged") + updatedEvent.timezone + `
      • `; } if (event.description !== updatedEvent.description) { - diffText += `
    • the event description changed
      • `; + diffText += `
    • ` + i18next.t("routes.event.descriptionchanged") + `
      • `; } diffText += `
    `; const updatedEventObject = await Event.findOneAndUpdate( @@ -500,7 +502,7 @@ router.put( sendEmailFromTemplate( config.general.email, attendeeEmails.join(","), - `${event.name} was just edited`, + `${event.name} ` + i18next.t("routes.event.editedsubject"), "editEvent", { diffText, @@ -696,7 +698,7 @@ router.delete( await sendEmailFromTemplate( attendeeEmail, "", - "You have been removed from an event", + i18next.t("routes.removeeventattendeesubject"), "unattendEvent", { eventID: req.params.eventID, -- cgit v1.2.3 From 1fd6a7d2249fdf6ba5ca9ced6ea43348ebe0941d Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Wed, 2 Apr 2025 01:49:11 +0900 Subject: rename translation keys as filestructure --- src/lib/event.ts | 2 +- src/routes/frontend.ts | 2 +- src/routes/magicLink.ts | 8 ++++---- src/util/validation.ts | 32 ++++++++++++++++---------------- 4 files changed, 22 insertions(+), 22 deletions(-) (limited to 'src') diff --git a/src/lib/event.ts b/src/lib/event.ts index 09631b9..bcb7cd9 100644 --- a/src/lib/event.ts +++ b/src/lib/event.ts @@ -17,7 +17,7 @@ export const bucketEventsByMonth = ( event: EventListEvent, ) => { event.startMoment.locale(i18next.language); - const month = event.startMoment.format(i18next.t("year-month-format" )); + const month = event.startMoment.format(i18next.t("common.year-month-format" )); const matchingBucket = acc.find((bucket) => bucket.title === month); if (!matchingBucket) { acc.push({ diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 387cd65..16a44c8 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -71,7 +71,7 @@ router.get("/new/:magicLinkToken", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "danger", - text: i18next.t("magiclink-invalid"), + text: i18next.t("routes.magiclink-invalid"), }, }); } diff --git a/src/routes/magicLink.ts b/src/routes/magicLink.ts index 5eb424b..14312c1 100644 --- a/src/routes/magicLink.ts +++ b/src/routes/magicLink.ts @@ -17,7 +17,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "danger", - text: i18next.t("ml.provideemail"), + text: i18next.t("routes.magiclink.provideemail"), }, }); return; @@ -32,7 +32,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "success", - text: i18next.t("ml.thanks"), + text: i18next.t("routes.magiclink.thanks"), }, }); return; @@ -52,7 +52,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { sendEmailFromTemplate( email, "", - i18next.t("ml.mailsubject"), + i18next.t("routes.magiclink.mailsubject"), "createEventMagicLink", { token, @@ -66,7 +66,7 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { ...frontendConfig(res), message: { type: "success", - text: i18next.t("ml.thanks"), + text: i18next.t("routes.magiclink.thanks"), }, }); }); diff --git a/src/util/validation.ts b/src/util/validation.ts index 0d82b88..4ead7df 100644 --- a/src/util/validation.ts +++ b/src/util/validation.ts @@ -110,7 +110,7 @@ export const validateEventTime = (start: Date, end: Date): Error | boolean => { // Duration cannot be longer than 1 year if (moment(end).diff(moment(start), "years") > 1) { return { - message: i18next.t("validation.eventtime.endyears"), + message: i18next.t("util.validation.eventtime.endyears"), field: "eventEnd", }; } @@ -137,19 +137,19 @@ export const validateEventData = ( } if (!validatedData.eventLocation) { errors.push({ - message: i18next.t("validation.eventdata.eventlocation"), + message: i18next.t("util.validation.eventdata.eventlocation"), field: "eventLocation", }); } if (!validatedData.eventStart) { errors.push({ - message: i18next.t("validation.eventdata.eventstart"), + message: i18next.t("util.validation.eventdata.eventstart"), field: "eventStart", }); } if (!validatedData.eventEnd) { errors.push({ - message: i18next.t("validation.eventdata.eventend"), + message: i18next.t("util.validation.eventdata.eventend"), field: "eventEnd", }); } @@ -164,26 +164,26 @@ export const validateEventData = ( } if (!validatedData.timezone) { errors.push({ - message: i18next.t("validation.eventdata.timezone"), + message: i18next.t("util.validation.eventdata.timezone"), field: "timezone", }); } if (!validatedData.eventDescription) { errors.push({ - message: i18next.t("validation.eventdata.eventdescription"), + message: i18next.t("util.validation.eventdata.eventdescription"), field: "eventDescription", }); } if (validatedData.eventGroupBoolean) { if (!validatedData.eventGroupID) { errors.push({ - message: i18next.t("validation.eventdata.eventgroupboolean"), + message: i18next.t("util.validation.eventdata.eventgroupboolean"), field: "eventGroupID", }); } if (!validatedData.eventGroupEditToken) { errors.push({ - message: i18next.t("validation.eventdata.eventgroupedittoken"), + message: i18next.t("util.validation.eventdata.eventgroupedittoken"), field: "eventGroupEditToken", }); } @@ -191,13 +191,13 @@ export const validateEventData = ( if (validatedData.maxAttendeesBoolean) { if (!validatedData.maxAttendees) { errors.push({ - message: i18next.t("validation.eventdata.maxattendeesboolean"), + message: i18next.t("util.validation.eventdata.maxattendeesboolean"), field: "maxAttendees", }); } if (isNaN(validatedData.maxAttendees)) { errors.push({ - message: i18next.t("validation.eventdata.maxattendees"), + message: i18next.t("util.validation.eventdata.maxattendees"), field: "maxAttendees", }); } @@ -205,7 +205,7 @@ export const validateEventData = ( if (validatedData.creatorEmail) { if (!validateEmail(validatedData.creatorEmail)) { errors.push({ - message: i18next.t("validation.eventdata.creatoremail"), + message: i18next.t("util.validation.eventdata.creatoremail"), field: "creatorEmail", }); } @@ -213,7 +213,7 @@ export const validateEventData = ( if (validatedData.eventURL) { if (!validateUrl(validatedData.eventURL)) { errors.push({ - message: i18next.t("validation.eventdata.eventurl"), + message: i18next.t("util.validation.eventdata.eventurl"), field: "eventURL", }); } @@ -231,20 +231,20 @@ export const validateGroupData = ( const errors: Error[] = []; if (!groupData.eventGroupName) { errors.push({ - message: i18next.t("validation.groupdata.eventgroupname"), + message: i18next.t("util.validation.groupdata.eventgroupname"), field: "eventGroupName", }); } if (!groupData.eventGroupDescription) { errors.push({ - message: i18next.t("validation.groupdata.eventgroupdescription"), + message: i18next.t("util.validation.groupdata.eventgroupdescription"), field: "eventGroupDescription", }); } if (groupData.creatorEmail) { if (!validateEmail(groupData.creatorEmail)) { errors.push({ - message: i18next.t("validation.groupdata.creatoremail"), + message: i18next.t("util.validation.groupdata.creatoremail"), field: "creatorEmail", }); } @@ -252,7 +252,7 @@ export const validateGroupData = ( if (groupData.eventGroupURL) { if (!validateUrl(groupData.eventGroupURL)) { errors.push({ - message: i18next.t("validation.groupdata.eventgroupurl"), + message: i18next.t("util.validation.groupdata.eventgroupurl"), field: "eventGroupURL", }); } -- cgit v1.2.3 From aace2c7e6ccb6e74df83faac74c427d43bfaf79b Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Wed, 23 Apr 2025 15:06:54 -0700 Subject: Fix ReferenceError: nodemailerTransporter is not defined Part of https://github.com/lowercasename/gathio/pull/200 was migrating more code to use the shared init email function, but all the local usages of nodemailerTransporter were missed --- src/app.ts | 39 +++- src/lib/email.ts | 57 +++-- src/lib/handlebars.ts | 27 +++ src/routes.js | 568 +++++++++++++++++-------------------------------- src/routes/frontend.ts | 5 +- 5 files changed, 302 insertions(+), 394 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 0708081..85ee64e 100755 --- a/src/app.ts +++ b/src/app.ts @@ -15,16 +15,28 @@ import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; +import getConfig from "./lib/config.js"; const app = express(); +const config = getConfig(); -app.locals.sendEmails = initEmailService(); +initEmailService().then((sendEmails) => (app.locals.sendEmails = sendEmails)); // View engine // const hbsInstance = hbs.create({ defaultLayout: "main", partialsDir: ["views/partials/"], layoutsDir: "views/layouts/", + runtimeOptions: { + data: { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + }, + }, helpers: { plural: function (number: number, text: string) { var singular = number === 1; @@ -46,6 +58,31 @@ const hbsInstance = hbs.create({ }, }, }); +app.locals.renderEmail = async function renderEmail( + template: string, + data: object +) { + const [html, text] = await Promise.all([ + hbsInstance.renderView( + `./views/emails/${template}Html.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + hbsInstance.renderView( + `./views/emails/${template}Text.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + ]); + return { html, text } +} + app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); app.set("hbsInstance", hbsInstance); diff --git a/src/lib/email.ts b/src/lib/email.ts index 7b7a7a1..e7243aa 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -1,10 +1,10 @@ -import { Request } from "express"; import sgMail from "@sendgrid/mail"; import nodemailer, { Transporter } from "nodemailer"; import { getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; import { renderTemplate } from "./handlebars.js"; +import { ExpressHandlebars } from "express-handlebars"; const config = getConfig(); type EmailTemplate = @@ -36,10 +36,12 @@ export const initEmailService = async (): Promise => { sgMail.setApiKey(config.sendgrid.api_key); console.log("Sendgrid is ready to send emails."); return true; - case "nodemailer": - let nodemailerTransporter:Transporter|undefined = undefined; + case "nodemailer": { + let nodemailerTransporter: Transporter | undefined = undefined; if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport(config.nodemailer?.smtp_url); + nodemailerTransporter = nodemailer.createTransport( + config.nodemailer?.smtp_url, + ); } else { if ( !config.nodemailer?.smtp_server || @@ -52,7 +54,7 @@ export const initEmailService = async (): Promise => { const nodemailerConfig = { host: config.nodemailer?.smtp_server, port: Number(config.nodemailer?.smtp_port) || 587, - tls: { + tls: { // do not fail on invalid certs rejectUnauthorized: false, }, @@ -61,10 +63,11 @@ export const initEmailService = async (): Promise => { if (config.nodemailer?.smtp_username) { nodemailerConfig.auth = { user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password + pass: config.nodemailer?.smtp_password, }; } - nodemailerTransporter = nodemailer.createTransport(nodemailerConfig); + nodemailerTransporter = + nodemailer.createTransport(nodemailerConfig); } const nodemailerVerified = await nodemailerTransporter.verify(); @@ -76,6 +79,7 @@ export const initEmailService = async (): Promise => { "Error verifying Nodemailer transporter. Please check your Nodemailer configuration.", ); } + } case "none": default: console.warn( @@ -85,10 +89,34 @@ export const initEmailService = async (): Promise => { } }; -export const sendEmail = async ( +export const sendTemplatedEmail = async ( + hbs: ExpressHandlebars, to: string, bcc: string, subject: string, + template: string, + data: object, +): Promise => { + const [html, text] = await Promise.all([ + hbs.renderView(`./views/emails/${template}Html.handlebars`, { + cache: true, + layout: "email.handlebars", + ...data, + }), + hbs.renderView(`./views/emails/${template}Text.handlebars`, { + cache: true, + layout: "email.handlebars", + ...data, + }), + ]); + + return await sendEmail(to, bcc, subject, text, html); +}; + +export const sendEmail = async ( + to: string | string[], + bcc: string | string[] | undefined, + subject: string, text: string, html?: string, ): Promise => { @@ -104,7 +132,7 @@ export const sendEmail = async ( html, }); return true; - } catch (e: any) { + } catch (e: Error) { if (e.response) { console.error(e.response.body); } else { @@ -114,9 +142,11 @@ export const sendEmail = async ( } case "nodemailer": try { - let nodemailerTransporter:Transporter|undefined = undefined; + let nodemailerTransporter: Transporter | undefined = undefined; if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport(config.nodemailer?.smtp_url); + nodemailerTransporter = nodemailer.createTransport( + config.nodemailer?.smtp_url, + ); } else { const nodemailerConfig = { host: config.nodemailer?.smtp_server, @@ -126,11 +156,12 @@ export const sendEmail = async ( if (config.nodemailer?.smtp_username) { nodemailerConfig.auth = { user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password + pass: config.nodemailer?.smtp_password, }; } - nodemailerTransporter = nodemailer.createTransport(nodemailerConfig); + nodemailerTransporter = + nodemailer.createTransport(nodemailerConfig); } await nodemailerTransporter.sendMail({ envelope: { diff --git a/src/lib/handlebars.ts b/src/lib/handlebars.ts index d5a8b6e..42f8010 100644 --- a/src/lib/handlebars.ts +++ b/src/lib/handlebars.ts @@ -1,4 +1,5 @@ import { Request } from "express"; +import { ExpressHandlebars } from "express-handlebars"; export const renderTemplate = async ( req: Request, @@ -21,3 +22,29 @@ export const renderTemplate = async ( ); }); }; + +export const renderEmail = async ( + hbsInstance: ExpressHandlebars, + templateName: string, + data: Record, +): Promise<{ html: string, text: string }> => { + const [html, text] = await Promise.all([ + hbsInstance.renderView( + `./views/emails/${templateName}Html.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + hbsInstance.renderView( + `./views/emails/${templateName}Text.handlebars`, + { + cache: true, + layout: "email.handlebars", + ...data, + } + ), + ]); + return { html, text } +} diff --git a/src/routes.js b/src/routes.js index e758e6b..f609f94 100755 --- a/src/routes.js +++ b/src/routes.js @@ -19,12 +19,13 @@ import { broadcastDeleteMessage, processInbox, } from "./activitypub.js"; +import { renderEmail } from "./lib/handlebars.js"; import Event from "./models/Event.js"; import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; -import { initEmailService } from "./lib/email.js"; +import { initEmailService, sendEmail } from "./lib/email.js"; const config = getConfig(); const domain = config.general.domain; @@ -44,9 +45,7 @@ const nanoid = customAlphabet( const router = express.Router(); let sendEmails = false; -initEmailService().then((emailService) => { - sendEmails = emailService -}); +initEmailService().then((emailService) => (sendEmails = emailService)); router.use(fileUpload()); @@ -58,7 +57,10 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { return; } - const too_old = moment.tz("Etc/UTC").subtract(deleteAfterDays, "days").toDate(); + const too_old = moment + .tz("Etc/UTC") + .subtract(deleteAfterDays, "days") + .toDate(); console.log( "Old event deletion running! Deleting all events concluding before ", too_old, @@ -81,9 +83,9 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { "deleteOldEvents", "error", "Attempt to delete old event " + - id + - " failed with error: " + - err, + id + + " failed with error: " + + err, ); }); }; @@ -100,9 +102,9 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { "deleteOldEvents", "error", "Attempt to delete event image for old event " + - event.id + - " failed with error: " + - err, + event.id + + " failed with error: " + + err, ); } // Image removed @@ -149,9 +151,9 @@ schedule.scheduleJob("59 23 * * *", function (fireDate) { "deleteOldEvents", "error", "Attempt to delete old event " + - event.id + - " failed with error: " + - err, + event.id + + " failed with error: " + + err, ); }); @@ -204,9 +206,9 @@ router.post("/deleteimage/:eventID/:editToken", (req, res) => { "deleteEventImage", "error", "Attempt to delete event image for event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); } // Image removed @@ -227,9 +229,9 @@ router.post("/deleteimage/:eventID/:editToken", (req, res) => { "deleteEventImage", "error", "Attempt to delete event image for event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -271,9 +273,9 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); } }, @@ -293,9 +295,9 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event image for event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); } // Image removed @@ -303,8 +305,8 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "success", "Event " + - req.params.eventID + - " deleted", + req.params.eventID + + " deleted", ); }, ); @@ -316,63 +318,29 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { // Send emails here otherwise they don't exist lol if (sendEmails) { - const attendeeEmails = event.attendees - .filter( + const attendeeEmails = event?.attendees?.filter( (o) => o.status === "attending" && o.email, ) - .map((o) => o.email); + .map((o) => o.email || '') || []; if (attendeeEmails.length) { console.log( "Sending emails to: " + - attendeeEmails, + attendeeEmails, ); - req.app.get("hbsInstance").renderView( - "./views/emails/deleteEvent/deleteEventHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "deleteEvent/deleteEvent", { - siteName, - siteLogo, - domain, - eventName: event.name, - cache: true, - layout: "email.handlebars", + eventName: event?.name, }, - function (err, html) { - const msg = { - to: attendeeEmails, - from: contactEmail, - subject: `${siteName}: ${event.name} was deleted`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail - .sendMultiple(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: ${event?.name} was deleted`, text, html) + ).catch((e) => { + console.error('error sending attendy email', e.toString()); + res.status(500).end(); + }); } else { console.log("Nothing to send!"); } @@ -381,15 +349,15 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -401,8 +369,8 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: token does not match", + req.params.eventID + + " failed with error: token does not match", ); } }) @@ -412,9 +380,9 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "deleteEvent", "error", "Attempt to delete event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }); @@ -447,9 +415,9 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); } }, @@ -469,9 +437,9 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event image for event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); } }, @@ -487,8 +455,8 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "success", "Event group " + - req.params.eventGroupID + - " deleted", + req.params.eventGroupID + + " deleted", ); res.writeHead(302, { Location: "/", @@ -498,30 +466,30 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); }); }) .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); }); } else { @@ -531,8 +499,8 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: token does not match", + req.params.eventGroupID + + " failed with error: token does not match", ); } }) @@ -542,9 +510,9 @@ router.post("/deleteeventgroup/:eventGroupID/:editToken", (req, res) => { "deleteEventGroup", "error", "Attempt to delete event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); }); }); @@ -562,9 +530,9 @@ router.post("/attendee/provision", async (req, res) => { "provisionEventAttendee", "error", "Attempt to provision attendee in event " + - req.query.eventID + - " failed with error: " + - e, + req.query.eventID + + " failed with error: " + + e, ); return res.sendStatus(500); }); @@ -580,9 +548,9 @@ router.post("/attendee/provision", async (req, res) => { "provisionEventAttendee", "error", "Attempt to provision attendee in event " + - req.query.eventID + - " failed with error: " + - e, + req.query.eventID + + " failed with error: " + + e, ); return res.sendStatus(500); }); @@ -618,9 +586,9 @@ router.post("/attendevent/:eventID", async (req, res) => { "attendEvent", "error", "Attempt to attend event " + - req.params.eventID + - " failed with error: " + - e, + req.params.eventID + + " failed with error: " + + e, ); return res.sendStatus(500); }); @@ -659,7 +627,9 @@ router.post("/attendevent/:eventID", async (req, res) => { "attendees.$.name": req.body.attendeeName, "attendees.$.email": req.body.attendeeEmail, "attendees.$.number": req.body.attendeeNumber, - "attendees.$.visibility": !!req.body.attendeeVisible ? "public" : "private", + "attendees.$.visibility": req.body.attendeeVisible + ? "public" + : "private", }, }, ) @@ -670,44 +640,23 @@ router.post("/attendevent/:eventID", async (req, res) => { "Attendee added to event " + req.params.eventID, ); if (sendEmails) { - if (req.body.attendeeEmail) { - req.app.get("hbsInstance").renderView( - "./views/emails/addEventAttendee/addEventAttendeeHtml.handlebars", + if (req.body.attendeeEmail) { + renderEmail( + req.app.get("hbsInstance"), + "addEventAttendee/addEventAttendee", { eventID: req.params.eventID, - siteName, - siteLogo, - domain, removalPassword: req.body.removalPassword, - removalPasswordHash: hashString(req.body.removalPassword), - cache: true, - layout: "email.handlebars", - }, - function (err, html) { - const msg = { - to: req.body.attendeeEmail, - from: contactEmail, - subject: `${siteName}: You're RSVPed to ${event.name}`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } + removalPasswordHash: hashString( + req.body.removalPassword, + ), }, - ); + ).then( + ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You're RSVPed to ${event.name}`, text, html) + ).catch((e) => { + console.error('error sending addEventAttendee email', e.toString()); + res.status(500).end(); + }); } } res.redirect(`/${req.params.eventID}`); @@ -718,9 +667,9 @@ router.post("/attendevent/:eventID", async (req, res) => { "addEventAttendee", "error", "Attempt to add attendee to event " + - req.params.eventID + - " failed with error: " + - error, + req.params.eventID + + " failed with error: " + + error, ); }); }); @@ -750,40 +699,18 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - req.app.get("hbsInstance").renderView( - "./views/emails/removeEventAttendee/removeEventAttendeeHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "removeEventAttendee/removeEventAttendee", { eventName: req.params.eventName, - siteName, - domain, - cache: true, - layout: "email.handlebars", }, - function (err, html) { - const msg = { - to: req.body.attendeeEmail, - from: contactEmail, - subject: `${siteName}: You have been removed from an event`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } } res.writeHead(302, { @@ -797,9 +724,9 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { "removeEventAttendee", "error", "Attempt to remove attendee by admin from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }); @@ -818,41 +745,18 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - req.app.get("hbsInstance").renderView( - "./views/emails/removeEventAttendee/removeEventAttendeeHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "removeEventAttendee/removeEventAttendee", { eventName: req.params.eventName, - siteName, - siteLogo, - domain, - cache: true, - layout: "email.handlebars", - }, - function (err, html) { - const msg = { - to: req.body.attendeeEmail, - from: contactEmail, - subject: `${siteName}: You have been removed from an event`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } }, - ); + ).then( + ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } } res.writeHead(302, { @@ -866,9 +770,9 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { "removeEventAttendee", "error", "Attempt to remove attendee by admin from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }); @@ -894,43 +798,20 @@ router.post("/subscribe/:eventGroupID", (req, res) => { eventGroup.subscribers.push(subscriber); eventGroup.save(); if (sendEmails) { - req.app.get("hbsInstance").renderView( - "./views/emails/subscribed/subscribedHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "subscribed/subscribed", { eventGroupName: eventGroup.name, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(subscriber.email), - siteName, - siteLogo, - domain, - cache: true, - layout: "email.handlebars", }, - function (err, html) { - const msg = { - to: subscriber.email, - from: contactEmail, - subject: `${siteName}: You have subscribed to an event group`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail.send(msg).catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error(e.toString()); - res.status(500).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(subscriber.email, '', `${siteName}: You have subscribed to an event group`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } return res.redirect(`/group/${eventGroup.id}`); }) @@ -939,11 +820,11 @@ router.post("/subscribe/:eventGroupID", (req, res) => { "addSubscription", "error", "Attempt to subscribe " + - req.body.emailAddress + - " to event group " + - req.params.eventGroupID + - " failed with error: " + - error, + req.body.emailAddress + + " to event group " + + req.params.eventGroupID + + " failed with error: " + + error, ); return res.sendStatus(500); }); @@ -970,11 +851,11 @@ router.get("/unsubscribe/:eventGroupID", (req, res) => { "removeSubscription", "error", "Attempt to unsubscribe " + - req.query.email + - " from event group " + - req.params.eventGroupID + - " failed with error: " + - error, + req.query.email + + " from event group " + + req.params.eventGroupID + + " failed with error: " + + error, ); return res.sendStatus(500); }); @@ -1028,58 +909,24 @@ router.post("/post/comment/:eventID", (req, res) => { (o) => o.status === "attending" && o.email, ) - .map((o) => o.email); + .map((o) => o.email || '') || []; if (attendeeEmails.length) { console.log( "Sending emails to: " + attendeeEmails, ); - req.app.get("hbsInstance").renderView( - "./views/emails/addEventComment/addEventCommentHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "addEventComment/addEventComment", { - siteName, - siteLogo, - domain, eventID: req.params.eventID, - commentAuthor: - req.body.commentAuthor, - cache: true, - layout: "email.handlebars", - }, - function (err, html) { - const msg = { - to: attendeeEmails, - from: contactEmail, - subject: `${siteName}: New comment in ${event.name}`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail - .sendMultiple(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - } + commentAuthor: req.body.commentAuthor, }, - ); + ).then( + ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } else { console.log("Nothing to send!"); } @@ -1097,9 +944,9 @@ router.post("/post/comment/:eventID", (req, res) => { "addEventComment", "error", "Attempt to add comment to event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -1130,9 +977,9 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { "addEventReply", "success", "Reply added to comment " + - commentID + - " in event " + - req.params.eventID, + commentID + + " in event " + + req.params.eventID, ); // broadcast an identical message to all followers, will show in their home timeline const guidObject = crypto.randomBytes(16).toString("hex"); @@ -1157,57 +1004,24 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { (o) => o.status === "attending" && o.email, ) - .map((o) => o.email); + .map((o) => o.email || '') || []; if (attendeeEmails.length) { console.log( "Sending emails to: " + attendeeEmails, ); - req.app.get("hbsInstance").renderView( - "./views/emails/addEventComment/addEventCommentHtml.handlebars", + renderEmail( + req.app.get("hbsInstance"), + "addEventComment/addEventComment", { - siteName, - siteLogo, - domain, eventID: req.params.eventID, commentAuthor: req.body.replyAuthor, - cache: true, - layout: "email.handlebars", }, - function (err, html) { - const msg = { - to: attendeeEmails, - from: contactEmail, - subject: `${siteName}: New comment in ${event.name}`, - html, - }; - switch (mailService) { - case "sendgrid": - sgMail - .sendMultiple(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - case "nodemailer": - nodemailerTransporter - .sendMail(msg) - .catch((e) => { - console.error( - e.toString(), - ); - res.status( - 500, - ).end(); - }); - break; - } - }, - ); + ).then( + ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) + ).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } else { console.log("Nothing to send!"); } @@ -1225,11 +1039,11 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { "addEventReply", "error", "Attempt to add reply to comment " + - commentID + - " in event " + - req.params.eventID + - " failed with error: " + - err, + commentID + + " in event " + + req.params.eventID + + " failed with error: " + + err, ); }); }, @@ -1265,17 +1079,17 @@ router.post("/deletecomment/:eventID/:commentID/:editToken", (req, res) => { .catch((err) => { res.send( "Sorry! Something went wrong (error deleting): " + - err, + err, ); addToLog( "deleteComment", "error", "Attempt to delete comment " + - req.params.commentID + - "from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.commentID + + "from event " + + req.params.eventID + + " failed with error: " + + err, ); }); } else { @@ -1285,10 +1099,10 @@ router.post("/deletecomment/:eventID/:commentID/:editToken", (req, res) => { "deleteComment", "error", "Attempt to delete comment " + - req.params.commentID + - "from event " + - req.params.eventID + - " failed with error: token does not match", + req.params.commentID + + "from event " + + req.params.eventID + + " failed with error: token does not match", ); } }) @@ -1298,11 +1112,11 @@ router.post("/deletecomment/:eventID/:commentID/:editToken", (req, res) => { "deleteComment", "error", "Attempt to delete comment " + - req.params.commentID + - "from event " + - req.params.eventID + - " failed with error: " + - err, + req.params.commentID + + "from event " + + req.params.eventID + + " failed with error: " + + err, ); }); }); diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index 14bb779..1b95763 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -1,5 +1,4 @@ import { Router, Request, Response } from "express"; -import fs from "fs"; import moment from "moment-timezone"; import { marked } from "marked"; import { markdownToSanitizedHTML, renderPlain } from "../util/markdown.js"; @@ -25,7 +24,7 @@ const router = Router(); // Add config middleware to all routes router.use(getConfigMiddleware); -router.get("/", (_: Request, res: Response) => { +router.get("/", (_, res) => { if (res.locals.config?.general.show_public_event_list) { return res.redirect("/events"); } @@ -44,7 +43,7 @@ router.get("/about", (_: Request, res: Response) => { }); }); -router.get("/new", (req: Request, res: Response) => { +router.get("/new", (_: Request, res: Response) => { if (res.locals.config?.general.creator_email_addresses?.length) { return res.render("createEventMagicLink", frontendConfig(res)); } -- cgit v1.2.3 From a8a17443c2d070d2d23920ffff7e4a43c905698c Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Wed, 23 Apr 2025 17:27:55 -0700 Subject: Refactor for everywhere to use sendEmailFromTemplate everywhere * Created a singleton to house handlebars so req doesn't need to be passed everywhere (should make unit testing easier later) * Subjectline for sendgrid and nodemailer are both always prefixed in sendEmail() * removed prefix subjectline from all other email places * added a couple if (!event) { return 404 } to help make typescript happy * some minor eslint auto fixes (looks like let => const where it can) --- src/app.ts | 68 ++--------------------------- src/lib/email.ts | 101 ++++++++++++++++++++----------------------- src/lib/handlebars.ts | 97 +++++++++++++++++++++-------------------- src/routes.js | 112 ++++++++++++++++++++++++++---------------------- src/routes/event.ts | 51 ++++++---------------- src/routes/group.ts | 6 +-- src/routes/magicLink.ts | 6 +-- 7 files changed, 176 insertions(+), 265 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 85ee64e..5f7c024 100755 --- a/src/app.ts +++ b/src/app.ts @@ -1,5 +1,4 @@ import express from "express"; -import hbs from "express-handlebars"; import cookieParser from "cookie-parser"; import routes from "./routes.js"; @@ -15,77 +14,16 @@ import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; -import getConfig from "./lib/config.js"; +import { HandlebarsSingleton } from "./lib/handlebars.js"; const app = express(); -const config = getConfig(); initEmailService().then((sendEmails) => (app.locals.sendEmails = sendEmails)); // View engine // -const hbsInstance = hbs.create({ - defaultLayout: "main", - partialsDir: ["views/partials/"], - layoutsDir: "views/layouts/", - runtimeOptions: { - data: { - domain: config.general.domain, - contactEmail: config.general.email, - siteName: config.general.site_name, - mailService: config.general.mail_service, - siteLogo: config.general.email_logo_url, - isFederated: config.general.is_federated || true, - }, - }, - helpers: { - plural: function (number: number, text: string) { - var singular = number === 1; - // If no text parameter was given, just return a conditional s. - if (typeof text !== "string") return singular ? "" : "s"; - // Split with regex into group1/group2 or group1(group3) - var match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); - // If no match, just append a conditional s. - if (!match) return text + (singular ? "" : "s"); - // We have a good match, so fire away - return ( - (singular && match[1]) || // Singular case - match[2] || // Plural case: 'bagel/bagels' --> bagels - match[1] + (match[3] || "s") - ); // Plural case: 'bagel(s)' or 'bagel' --> bagels - }, - json: function (context: any) { - return JSON.stringify(context); - }, - }, -}); -app.locals.renderEmail = async function renderEmail( - template: string, - data: object -) { - const [html, text] = await Promise.all([ - hbsInstance.renderView( - `./views/emails/${template}Html.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - hbsInstance.renderView( - `./views/emails/${template}Text.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - ]); - return { html, text } -} - -app.engine("handlebars", hbsInstance.engine); +app.engine("handlebars", HandlebarsSingleton.instance.engine); app.set("view engine", "handlebars"); -app.set("hbsInstance", hbsInstance); +app.set("hbsInstance", HandlebarsSingleton.instance); // Static files // app.use(express.static("public")); diff --git a/src/lib/email.ts b/src/lib/email.ts index e7243aa..57f69f5 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -1,13 +1,15 @@ import sgMail from "@sendgrid/mail"; +import sgHelpers from "@sendgrid/helpers"; + import nodemailer, { Transporter } from "nodemailer"; import { getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; -import { renderTemplate } from "./handlebars.js"; -import { ExpressHandlebars } from "express-handlebars"; +import { HandlebarsSingleton } from "./handlebars.js"; + const config = getConfig(); -type EmailTemplate = +type EmailTemplateName = | "addEventAttendee" | "addEventComment" | "createEvent" @@ -16,6 +18,7 @@ type EmailTemplate = | "deleteEvent" | "editEvent" | "eventGroupUpdated" + | "removeEventAttendee" | "subscribed" | "unattendEvent"; @@ -89,30 +92,6 @@ export const initEmailService = async (): Promise => { } }; -export const sendTemplatedEmail = async ( - hbs: ExpressHandlebars, - to: string, - bcc: string, - subject: string, - template: string, - data: object, -): Promise => { - const [html, text] = await Promise.all([ - hbs.renderView(`./views/emails/${template}Html.handlebars`, { - cache: true, - layout: "email.handlebars", - ...data, - }), - hbs.renderView(`./views/emails/${template}Text.handlebars`, { - cache: true, - layout: "email.handlebars", - ...data, - }), - ]); - - return await sendEmail(to, bcc, subject, text, html); -}; - export const sendEmail = async ( to: string | string[], bcc: string | string[] | undefined, @@ -132,11 +111,11 @@ export const sendEmail = async ( html, }); return true; - } catch (e: Error) { - if (e.response) { - console.error(e.response.body); + } catch (e: unknown | sgHelpers.classes.ResponseError) { + if (e instanceof sgHelpers.classes.ResponseError) { + console.error('sendgrid error', e.response.body); } else { - console.error(e); + console.error('sendgrid error', e); } return false; } @@ -164,15 +143,10 @@ export const sendEmail = async ( nodemailer.createTransport(nodemailerConfig); } await nodemailerTransporter.sendMail({ - envelope: { - from: config.general.email, - to, - bcc, - }, from: config.general.email, to, bcc, - subject, + subject: `${config.general.site_name}: ${subject}`, text, html, }); @@ -187,25 +161,42 @@ export const sendEmail = async ( }; export const sendEmailFromTemplate = async ( - to: string, - bcc: string, + to: string | string[], + bcc: string | string[] | undefined, subject: string, - template: EmailTemplate, - templateData: Record, - req: Request, + templateName: EmailTemplateName, + templateData: object, ): Promise => { - const html = await renderTemplate(req, `${template}/${template}Html`, { - siteName: config.general.site_name, - siteLogo: config.general.email_logo_url, - domain: config.general.domain, - cache: true, - layout: "email.handlebars", - ...templateData, - }); - const text = await renderTemplate( - req, - `${template}/${template}Text`, - templateData, - ); + const [html, text] = await Promise.all([ + HandlebarsSingleton.instance.renderView( + `./views/emails/${templateName}/${templateName}Html.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + HandlebarsSingleton.instance.renderView( + `./views/emails/${templateName}/${templateName}Text.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + ]); + return await sendEmail(to, bcc, subject, text, html); }; diff --git a/src/lib/handlebars.ts b/src/lib/handlebars.ts index 42f8010..6d4f796 100644 --- a/src/lib/handlebars.ts +++ b/src/lib/handlebars.ts @@ -1,50 +1,55 @@ -import { Request } from "express"; -import { ExpressHandlebars } from "express-handlebars"; +import hbs, { ExpressHandlebars } from "express-handlebars"; +import { RenderViewOptions } from "express-handlebars/types/index.js"; -export const renderTemplate = async ( - req: Request, - templateName: string, - data: Record, -): Promise => { - return new Promise((resolve, reject) => { - req.app - .get("hbsInstance") - .renderView( - `./views/emails/${templateName}.handlebars`, - data, - (err: any, html: string) => { - if (err) { - console.error(err); - reject(err); - } - resolve(html); +export class HandlebarsSingleton { + static #instance: HandlebarsSingleton; + hbsInstance: hbs.ExpressHandlebars; + + private constructor() { + this.hbsInstance = hbs.create({ + defaultLayout: "main", + partialsDir: ["views/partials/"], + layoutsDir: "views/layouts/", + helpers: { + plural: function (number: number, text: string) { + const singular = number === 1; + // If no text parameter was given, just return a conditional s. + if (typeof text !== "string") return singular ? "" : "s"; + // Split with regex into group1/group2 or group1(group3) + const match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); + // If no match, just append a conditional s. + if (!match) return text + (singular ? "" : "s"); + // We have a good match, so fire away + return ( + (singular && match[1]) || // Singular case + match[2] || // Plural case: 'bagel/bagels' --> bagels + match[1] + (match[3] || "s") + ); // Plural case: 'bagel(s)' or 'bagel' --> bagels + }, + json: function (context: object) { + return JSON.stringify(context); }, - ); - }); -}; + }, + }); + } + + public static get instance(): HandlebarsSingleton { + if (!HandlebarsSingleton.#instance) { + HandlebarsSingleton.#instance = new HandlebarsSingleton(); + } + + return HandlebarsSingleton.#instance; + } + + public get engine(): ExpressHandlebars["engine"] { + return this.hbsInstance.engine; + } -export const renderEmail = async ( - hbsInstance: ExpressHandlebars, - templateName: string, - data: Record, -): Promise<{ html: string, text: string }> => { - const [html, text] = await Promise.all([ - hbsInstance.renderView( - `./views/emails/${templateName}Html.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - hbsInstance.renderView( - `./views/emails/${templateName}Text.handlebars`, - { - cache: true, - layout: "email.handlebars", - ...data, - } - ), - ]); - return { html, text } + /** + * Finally, any singleton can define some business logic, which can be + * executed on its instance. + */ + public renderView(viewPath: string, options: RenderViewOptions): Promise { + return this.hbsInstance.renderView(viewPath, options); + } } diff --git a/src/routes.js b/src/routes.js index f609f94..d5b5877 100755 --- a/src/routes.js +++ b/src/routes.js @@ -9,8 +9,6 @@ import crypto from "crypto"; import request from "request"; import niceware from "niceware"; import ical from "ical"; -import sgMail from "@sendgrid/mail"; -import nodemailer from "nodemailer"; import fileUpload from "express-fileupload"; import Jimp from "jimp"; import schedule from "node-schedule"; @@ -19,20 +17,15 @@ import { broadcastDeleteMessage, processInbox, } from "./activitypub.js"; -import { renderEmail } from "./lib/handlebars.js"; import Event from "./models/Event.js"; import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; -import { initEmailService, sendEmail } from "./lib/email.js"; +import { initEmailService, sendEmailFromTemplate } from "./lib/email.js"; const config = getConfig(); const domain = config.general.domain; -const contactEmail = config.general.email; -const siteName = config.general.site_name; -const mailService = config.general.mail_service; -const siteLogo = config.general.email_logo_url; const isFederated = config.general.is_federated || true; // This alphabet (used to generate all event, group, etc. IDs) is missing '-' @@ -329,14 +322,14 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { "Sending emails to: " + attendeeEmails, ); - renderEmail( - req.app.get("hbsInstance"), - "deleteEvent/deleteEvent", + sendEmailFromTemplate( + attendeeEmails, + '', + `${event?.name} was deleted`, + "deleteEvent", { eventName: event?.name, }, - ).then( - ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: ${event?.name} was deleted`, text, html) ).catch((e) => { console.error('error sending attendy email', e.toString()); res.status(500).end(); @@ -634,6 +627,10 @@ router.post("/attendevent/:eventID", async (req, res) => { }, ) .then((event) => { + if (!event) { + return res.sendStatus(404); + } + addToLog( "addEventAttendee", "success", @@ -641,9 +638,11 @@ router.post("/attendevent/:eventID", async (req, res) => { ); if (sendEmails) { if (req.body.attendeeEmail) { - renderEmail( - req.app.get("hbsInstance"), - "addEventAttendee/addEventAttendee", + sendEmailFromTemplate( + req.body.attendeeEmail, + '', + `You're RSVPed to ${event.name}`, + "addEventAttendee", { eventID: req.params.eventID, removalPassword: req.body.removalPassword, @@ -651,8 +650,6 @@ router.post("/attendevent/:eventID", async (req, res) => { req.body.removalPassword, ), }, - ).then( - ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You're RSVPed to ${event.name}`, text, html) ).catch((e) => { console.error('error sending addEventAttendee email', e.toString()); res.status(500).end(); @@ -686,11 +683,14 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { ) { return res.sendStatus(200); } - Event.updateOne( + Event.findOneAndUpdate( { id: req.params.eventID }, { $pull: { attendees: { _id: req.params.attendeeID } } }, ) - .then((response) => { + .then((event) => { + if (!event) { + return res.sendStatus(404); + } addToLog( "oneClickUnattend", "success", @@ -699,14 +699,14 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - renderEmail( - req.app.get("hbsInstance"), - "removeEventAttendee/removeEventAttendee", + sendEmailFromTemplate( + req.body.attendeeEmail, + '', + `You have been removed from an event`, + "removeEventAttendee", { - eventName: req.params.eventName, + eventName: event.name, }, - ).then( - ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -732,11 +732,14 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { }); router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { - Event.updateOne( + Event.findOneAndUpdate( { id: req.params.eventID }, { $pull: { attendees: { _id: req.params.attendeeID } } }, ) - .then((response) => { + .then((event) => { + if (!event) { + return res.sendStatus(404); + } addToLog( "removeEventAttendee", "success", @@ -745,14 +748,14 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { if (sendEmails) { // currently this is never called because we don't have the email address if (req.body.attendeeEmail) { - renderEmail( - req.app.get("hbsInstance"), - "removeEventAttendee/removeEventAttendee", + sendEmailFromTemplate( + req.body.attendeeEmail, + '', + `You have been removed from an event`, + "removeEventAttendee", { - eventName: req.params.eventName, + eventName: event.name, }, - ).then( - ({ html, text }) => sendEmail(req.body.attendeeEmail, '', `${siteName}: You have been removed from an event`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -798,16 +801,16 @@ router.post("/subscribe/:eventGroupID", (req, res) => { eventGroup.subscribers.push(subscriber); eventGroup.save(); if (sendEmails) { - renderEmail( - req.app.get("hbsInstance"), - "subscribed/subscribed", + sendEmailFromTemplate( + subscriber.email, + '', + `You have subscribed to an event group`, + "subscribed", { eventGroupName: eventGroup.name, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(subscriber.email), }, - ).then( - ({ html, text }) => sendEmail(subscriber.email, '', `${siteName}: You have subscribed to an event group`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -875,7 +878,9 @@ router.post("/post/comment/:eventID", (req, res) => { id: req.params.eventID, }, function (err, event) { - if (!event) return; + if (!event) { + return res.sendStatus(404); + } event.comments.push(newComment); event .save() @@ -914,15 +919,15 @@ router.post("/post/comment/:eventID", (req, res) => { console.log( "Sending emails to: " + attendeeEmails, ); - renderEmail( - req.app.get("hbsInstance"), - "addEventComment/addEventComment", + sendEmailFromTemplate( + event?.creatorEmail || config.general.email, + attendeeEmails, + `New comment in ${event.name}`, + "addEventComment", { eventID: req.params.eventID, commentAuthor: req.body.commentAuthor, }, - ).then( - ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); @@ -967,7 +972,9 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { id: req.params.eventID, }, function (err, event) { - if (!event) return; + if (!event) { + return res.sendStatus(404); + } var parentComment = event.comments.id(commentID); parentComment.replies.push(newReply); event @@ -999,6 +1006,9 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { if (sendEmails) { Event.findOne({ id: req.params.eventID }).then( (event) => { + if (!event) { + return res.sendStatus(404); + } const attendeeEmails = event.attendees .filter( (o) => @@ -1009,15 +1019,15 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { console.log( "Sending emails to: " + attendeeEmails, ); - renderEmail( - req.app.get("hbsInstance"), - "addEventComment/addEventComment", + sendEmailFromTemplate( + event?.creatorEmail || config.general.email, + attendeeEmails, + `New comment in ${event.name}`, + "addEventComment", { eventID: req.params.eventID, commentAuthor: req.body.replyAuthor, }, - ).then( - ({ html, text }) => sendEmail(attendeeEmails, '', `${siteName}: New comment in ${event.name}`, text, html) ).catch((e) => { console.error('error sending removeEventAttendeeHtml email', e.toString()); res.status(500).end(); diff --git a/src/routes/event.ts b/src/routes/event.ts index de5cb4c..f97adc9 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -80,8 +80,8 @@ router.post( }); } - let eventID = generateEventID(); - let editToken = generateEditToken(); + const eventID = generateEventID(); + const editToken = generateEditToken(); let eventImageFilename; let isPartOfEventGroup = false; @@ -125,7 +125,7 @@ router.post( } // generate RSA keypair for ActivityPub - let { publicKey, privateKey } = generateRSAKeypair(); + const { publicKey, privateKey } = generateRSAKeypair(); const event = new Event({ id: eventID, @@ -202,11 +202,7 @@ router.post( { eventID, editToken, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, - }, - req, + } ); } // If the event was added to a group, send an email to any group @@ -237,17 +233,12 @@ router.post( `New event in ${eventGroup.name}`, "eventGroupUpdated", { - siteName: res.locals.config?.general.site_name, - siteLogo: - res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, eventGroupName: eventGroup.name, eventName: event.name, eventID: event.id, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(emailAddress), - }, - req, + } ); }); } catch (err) { @@ -332,7 +323,7 @@ router.put( } // Token matches // If there is a new image, upload that first - let eventID = req.params.eventID; + const eventID = req.params.eventID; let eventImageFilename = event.image; if (req.file?.buffer) { Jimp.read(req.file.buffer) @@ -452,7 +443,7 @@ router.put( "Event " + req.params.eventID + " edited", ); // send update to ActivityPub subscribers - let attendees = updatedEventObject.attendees?.filter((el) => el.id); + const attendees = updatedEventObject.attendees?.filter((el) => el.id); // broadcast an identical message to all followers, will show in home timeline const guidObject = crypto.randomBytes(16).toString("hex"); const jsonObject = { @@ -495,21 +486,17 @@ router.put( if (req.app.locals.sendEmails) { const attendeeEmails = event.attendees ?.filter((o) => o.status === "attending" && o.email) - .map((o) => o.email); + .map((o) => o.email!); if (attendeeEmails?.length) { sendEmailFromTemplate( config.general.email, - attendeeEmails.join(","), + attendeeEmails, `${event.name} was just edited`, "editEvent", { diffText, eventID: req.params.eventID, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } } @@ -550,12 +537,12 @@ router.post( }); } - let eventID = generateEventID(); - let editToken = generateEditToken(); + const eventID = generateEventID(); + const editToken = generateEditToken(); - let iCalObject = ical.parseICS(req.file.buffer.toString("utf8")); + const iCalObject = ical.parseICS(req.file.buffer.toString("utf8")); - let importedEventData = iCalObject[Object.keys(iCalObject)[0]]; + const importedEventData = iCalObject[Object.keys(iCalObject)[0]]; let creatorEmail: string | undefined; if (req.body.creatorEmail) { @@ -620,11 +607,7 @@ router.post( { eventID, editToken, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } return res.json({ @@ -700,11 +683,7 @@ router.delete( "unattendEvent", { eventID: req.params.eventID, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } res.sendStatus(200); @@ -752,11 +731,7 @@ router.get( "unattendEvent", { event, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } return res.redirect(`/${req.params.eventID}?m=unattend`); diff --git a/src/routes/group.ts b/src/routes/group.ts index 9f4105c..c63413e 100644 --- a/src/routes/group.ts +++ b/src/routes/group.ts @@ -101,11 +101,7 @@ router.post( { eventGroupID: eventGroup.id, editToken: eventGroup.editToken, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, }, - req, ); } @@ -182,7 +178,7 @@ router.put( } // Token matches // If there is a new image, upload that first - let eventGroupID = req.params.eventGroupID; + const eventGroupID = req.params.eventGroupID; let eventGroupImageFilename = eventGroup.image; if (req.file?.buffer) { Jimp.read(req.file.buffer) diff --git a/src/routes/magicLink.ts b/src/routes/magicLink.ts index b4afca6..8d0f147 100644 --- a/src/routes/magicLink.ts +++ b/src/routes/magicLink.ts @@ -54,12 +54,8 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { `Magic link to create an event`, "createEventMagicLink", { - token, - siteName: res.locals.config?.general.site_name, - siteLogo: res.locals.config?.general.email_logo_url, - domain: res.locals.config?.general.domain, + token }, - req, ); res.render("createEventMagicLink", { ...frontendConfig(res), -- cgit v1.2.3 From 14041a319cace03cfc23c0a919ed81fb141f88ce Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Fri, 25 Apr 2025 21:43:39 -0700 Subject: Refactor to have email service MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Move hbsInstance back to app * Add email and hbs to req so typescript 🎉🎉🎉 * Init Email and config once --- src/app.ts | 47 +++++++- src/index.d.ts | 17 +-- src/lib/config.ts | 70 +++++++---- src/lib/email.ts | 263 ++++++++++++++++++++-------------------- src/lib/handlebars.ts | 55 --------- src/routes.js | 313 +++++++++++++++++++++++------------------------- src/routes/event.ts | 146 +++++++++++----------- src/routes/group.ts | 22 ++-- src/routes/magicLink.ts | 14 +-- 9 files changed, 458 insertions(+), 489 deletions(-) delete mode 100644 src/lib/handlebars.ts (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 5f7c024..7ed535c 100755 --- a/src/app.ts +++ b/src/app.ts @@ -1,5 +1,6 @@ import express from "express"; import cookieParser from "cookie-parser"; +import { create as createHandlebars, ExpressHandlebars } from "express-handlebars"; import routes from "./routes.js"; import frontend from "./routes/frontend.js"; @@ -8,22 +9,56 @@ import event from "./routes/event.js"; import group from "./routes/group.js"; import staticPages from "./routes/static.js"; import magicLink from "./routes/magicLink.js"; - -import { initEmailService } from "./lib/email.js"; import { activityPubContentType, alternateActivityPubContentType, } from "./lib/activitypub.js"; -import { HandlebarsSingleton } from "./lib/handlebars.js"; +import { EmailService } from "./lib/email.js"; +import getConfig from "./lib/config.js"; const app = express(); +const config = getConfig(); + +const hbsInstance = createHandlebars({ + defaultLayout: "main", + partialsDir: ["views/partials/"], + layoutsDir: "views/layouts/", + helpers: { + plural: function (number: number, text: string) { + const singular = number === 1; + // If no text parameter was given, just return a conditional s. + if (typeof text !== "string") return singular ? "" : "s"; + // Split with regex into group1/group2 or group1(group3) + const match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); + // If no match, just append a conditional s. + if (!match) return text + (singular ? "" : "s"); + // We have a good match, so fire away + return ( + (singular && match[1]) || // Singular case + match[2] || // Plural case: 'bagel/bagels' --> bagels + match[1] + (match[3] || "s") + ); // Plural case: 'bagel(s)' or 'bagel' --> bagels + }, + json: function (context: object) { + return JSON.stringify(context); + }, + }, +}); + +const emailService = new EmailService(config, hbsInstance); +emailService.verify(); -initEmailService().then((sendEmails) => (app.locals.sendEmails = sendEmails)); +app.use((req: express.Request, _: express.Response, next: express.NextFunction) => { + req.hbsInstance = hbsInstance; + req.emailService = emailService; + next() + return +}) // View engine // -app.engine("handlebars", HandlebarsSingleton.instance.engine); +app.engine("handlebars", hbsInstance.engine); app.set("view engine", "handlebars"); -app.set("hbsInstance", HandlebarsSingleton.instance); +app.set("hbsInstance", hbsInstance); // Static files // app.use(express.static("public")); diff --git a/src/index.d.ts b/src/index.d.ts index 292e5d3..4811f7f 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -1,14 +1,17 @@ import "express"; -import { GathioConfig } from "./lib/config.js"; +import { GathioConfig } from "./lib/config.ts"; +import { EmailService } from "./lib/email.ts"; +import { ExpressHandlebars } from "express-handlebars"; interface Locals { config: GathioConfig; } -declare module "express" { - export interface Response { - locals: { - config?: GathioConfig; - }; +declare global { + namespace Express { + interface Request extends Express.Request { + hbsInstance: ExpressHandlebars; + emailService: EmailService; + } } -} +} \ No newline at end of file diff --git a/src/lib/config.ts b/src/lib/config.ts index 003a714..6642eef 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -110,46 +110,46 @@ export const instanceRules = (): InstanceRule[] => { rules.push( config.general.show_public_event_list ? { - text: "Public events and groups are displayed on the homepage", - icon: "fas fa-eye", - } + text: "Public events and groups are displayed on the homepage", + icon: "fas fa-eye", + } : { - text: "Events and groups can only be accessed by direct link", - icon: "fas fa-eye-slash", - }, + text: "Events and groups can only be accessed by direct link", + icon: "fas fa-eye-slash", + }, ); rules.push( config.general.creator_email_addresses?.length ? { - text: "Only specific people can create events and groups", - icon: "fas fa-user-check", - } + text: "Only specific people can create events and groups", + icon: "fas fa-user-check", + } : { - text: "Anyone can create events and groups", - icon: "fas fa-users", - }, + text: "Anyone can create events and groups", + icon: "fas fa-users", + }, ); rules.push( config.general.delete_after_days > 0 ? { - text: `Events are automatically deleted ${config.general.delete_after_days} days after they end`, - icon: "far fa-calendar-times", - } + text: `Events are automatically deleted ${config.general.delete_after_days} days after they end`, + icon: "far fa-calendar-times", + } : { - text: "Events are permanent, and are never automatically deleted", - icon: "far fa-calendar-check", - }, + text: "Events are permanent, and are never automatically deleted", + icon: "far fa-calendar-check", + }, ); rules.push( config.general.is_federated ? { - text: "This instance federates with other instances using ActivityPub", - icon: "fas fa-globe", - } + text: "This instance federates with other instances using ActivityPub", + icon: "fas fa-globe", + } : { - text: "This instance does not federate with other instances", - icon: "fas fa-globe", - }, + text: "This instance does not federate with other instances", + icon: "fas fa-globe", + }, ); return rules; }; @@ -179,17 +179,35 @@ export const instanceDescription = (): string => { } }; +let _resolvedConfig: GathioConfig | null = null; // Attempt to load our global config. Will stop the app if the config file // cannot be read (there's no point trying to continue!) export const getConfig = (): GathioConfig => { + if (_resolvedConfig) { + return _resolvedConfig; + } + try { const config = toml.parse( fs.readFileSync("./config/config.toml", "utf-8"), ) as GathioConfig; - return { + const resolvedConfig = { ...defaultConfig, ...config, - }; + } + if (process.env.CYPRESS || process.env.CI) { + config.general.mail_service = "none"; + console.log( + "Running in Cypress or CI, not initializing email service.", + ); + } else if (config.general.mail_service === "none") { + console.warn( + "You have not configured this Gathio instance to send emails! This means that event creators will not receive emails when their events are created, which means they may end up locked out of editing events. Consider setting up an email service.", + ); + } + + _resolvedConfig = resolvedConfig; + return resolvedConfig; } catch { exitWithError( "Configuration file not found! Have you renamed './config/config-example.toml' to './config/config.toml'?", diff --git a/src/lib/email.ts b/src/lib/email.ts index 57f69f5..7c7c2dd 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -1,11 +1,10 @@ import sgMail from "@sendgrid/mail"; import sgHelpers from "@sendgrid/helpers"; - +import { ExpressHandlebars } from "express-handlebars"; import nodemailer, { Transporter } from "nodemailer"; -import { getConfig } from "./config.js"; +import { GathioConfig, getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; -import { HandlebarsSingleton } from "./handlebars.js"; const config = getConfig(); @@ -22,58 +21,65 @@ type EmailTemplateName = | "subscribed" | "unattendEvent"; -export const initEmailService = async (): Promise => { - if (process.env.CYPRESS || process.env.CI) { - console.log( - "Running in Cypress or CI, not initializing email service.", - ); - return false; - } - switch (config.general.mail_service) { - case "sendgrid": - if (!config.sendgrid?.api_key) { - return exitWithError( - "Sendgrid is configured as the email service, but no API key is provided. Please provide an API key in the config file.", - ); - } - sgMail.setApiKey(config.sendgrid.api_key); - console.log("Sendgrid is ready to send emails."); - return true; - case "nodemailer": { - let nodemailerTransporter: Transporter | undefined = undefined; - if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport( - config.nodemailer?.smtp_url, - ); - } else { - if ( - !config.nodemailer?.smtp_server || - !config.nodemailer?.smtp_port - ) { +export class EmailService { + nodemailerTransporter: Transporter | undefined = undefined; + sgMail: typeof sgMail | undefined = undefined; + hbs: ExpressHandlebars + + public constructor(config: GathioConfig, hbs: ExpressHandlebars) { + this.hbs = hbs; + switch (config.general.mail_service) { + case "sendgrid": { + if (!config.sendgrid?.api_key) { return exitWithError( - "Nodemailer is configured as the email service, but not all required fields are provided. Please provide all required fields in the config file.", + "Sendgrid is configured as the email service, but no API key is provided. Please provide an API key in the config file.", ); } - const nodemailerConfig = { - host: config.nodemailer?.smtp_server, - port: Number(config.nodemailer?.smtp_port) || 587, - tls: { - // do not fail on invalid certs - rejectUnauthorized: false, - }, - } as SMTPTransport.Options; + this.sgMail = sgMail; + this.sgMail.setApiKey(config.sendgrid.api_key); + console.log("Sendgrid is ready to send emails."); + break; + } + case "nodemailer": { + if (config.nodemailer?.smtp_url) { + this.nodemailerTransporter = nodemailer.createTransport( + config.nodemailer?.smtp_url, + ); + } else { + if ( + !config.nodemailer?.smtp_server || + !config.nodemailer?.smtp_port + ) { + return exitWithError( + "Nodemailer is configured as the email service, but not all required fields are provided. Please provide all required fields in the config file.", + ); + } + const nodemailerConfig = { + host: config.nodemailer?.smtp_server, + port: Number(config.nodemailer?.smtp_port) || 587, + tls: { + // do not fail on invalid certs + rejectUnauthorized: false, + }, + } as SMTPTransport.Options; - if (config.nodemailer?.smtp_username) { - nodemailerConfig.auth = { - user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password, - }; + if (config.nodemailer?.smtp_username) { + nodemailerConfig.auth = { + user: config.nodemailer?.smtp_username, + pass: config.nodemailer?.smtp_password, + }; + } + this.nodemailerTransporter = + nodemailer.createTransport(nodemailerConfig); } - nodemailerTransporter = - nodemailer.createTransport(nodemailerConfig); } - const nodemailerVerified = await nodemailerTransporter.verify(); + } + } + + public async verify(): Promise { + if (this.nodemailerTransporter) { + const nodemailerVerified = await this.nodemailerTransporter.verify(); if (nodemailerVerified) { console.log("Nodemailer is ready to send emails."); return true; @@ -83,30 +89,29 @@ export const initEmailService = async (): Promise => { ); } } - case "none": - default: - console.warn( - "You have not configured this Gathio instance to send emails! This means that event creators will not receive emails when their events are created, which means they may end up locked out of editing events. Consider setting up an email service.", - ); - return false; + return true; } -}; -export const sendEmail = async ( - to: string | string[], - bcc: string | string[] | undefined, - subject: string, - text: string, - html?: string, -): Promise => { - switch (config.general.mail_service) { - case "sendgrid": + public async sendEmail({ + to, + bcc, + subject, + text, + html, + }: { + to: string | string[]; + bcc?: string | string[]; + subject: string; + text: string; + html?: string; + }): Promise { + if (this.sgMail) { try { - await sgMail.send({ + await this.sgMail.send({ to, bcc, from: config.general.email, - subject: `${config.general.site_name}: ${subject}`, + subject, text, html, }); @@ -119,34 +124,13 @@ export const sendEmail = async ( } return false; } - case "nodemailer": + } else if (this.nodemailerTransporter) { try { - let nodemailerTransporter: Transporter | undefined = undefined; - if (config.nodemailer?.smtp_url) { - nodemailerTransporter = nodemailer.createTransport( - config.nodemailer?.smtp_url, - ); - } else { - const nodemailerConfig = { - host: config.nodemailer?.smtp_server, - port: Number(config.nodemailer?.smtp_port) || 587, - } as SMTPTransport.Options; - - if (config.nodemailer?.smtp_username) { - nodemailerConfig.auth = { - user: config.nodemailer?.smtp_username, - pass: config.nodemailer?.smtp_password, - }; - } - - nodemailerTransporter = - nodemailer.createTransport(nodemailerConfig); - } - await nodemailerTransporter.sendMail({ + await this.nodemailerTransporter.sendMail({ from: config.general.email, to, bcc, - subject: `${config.general.site_name}: ${subject}`, + subject, text, html, }); @@ -155,48 +139,63 @@ export const sendEmail = async ( console.error(e); return false; } - default: - return false; + } else { + // no mailer, so noop + return true; + } } -}; -export const sendEmailFromTemplate = async ( - to: string | string[], - bcc: string | string[] | undefined, - subject: string, - templateName: EmailTemplateName, - templateData: object, -): Promise => { - const [html, text] = await Promise.all([ - HandlebarsSingleton.instance.renderView( - `./views/emails/${templateName}/${templateName}Html.handlebars`, - { - domain: config.general.domain, - contactEmail: config.general.email, - siteName: config.general.site_name, - mailService: config.general.mail_service, - siteLogo: config.general.email_logo_url, - isFederated: config.general.is_federated || true, - cache: true, - layout: "email.handlebars", - ...templateData, - } - ), - HandlebarsSingleton.instance.renderView( - `./views/emails/${templateName}/${templateName}Text.handlebars`, - { - domain: config.general.domain, - contactEmail: config.general.email, - siteName: config.general.site_name, - mailService: config.general.mail_service, - siteLogo: config.general.email_logo_url, - isFederated: config.general.is_federated || true, - cache: true, - layout: "email.handlebars", - ...templateData, - } - ), - ]); + public async sendEmailFromTemplate({ + to, + bcc = "", + subject, + templateName, + templateData = {} + }: { + to: string | string[]; + bcc?: string | string[] | undefined; + subject: string; + templateName: EmailTemplateName; + templateData?: object; + }, + ): Promise { + const [html, text] = await Promise.all([ + this.hbs.renderView( + `./views/emails/${templateName}/${templateName}Html.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + this.hbs.renderView( + `./views/emails/${templateName}/${templateName}Text.handlebars`, + { + domain: config.general.domain, + contactEmail: config.general.email, + siteName: config.general.site_name, + mailService: config.general.mail_service, + siteLogo: config.general.email_logo_url, + isFederated: config.general.is_federated || true, + cache: true, + layout: "email.handlebars", + ...templateData, + } + ), + ]); - return await sendEmail(to, bcc, subject, text, html); -}; + return this.sendEmail({ + to, + bcc, + subject: `${config.general.site_name}: ${subject}`, + text, + html + }); + } +} diff --git a/src/lib/handlebars.ts b/src/lib/handlebars.ts deleted file mode 100644 index 6d4f796..0000000 --- a/src/lib/handlebars.ts +++ /dev/null @@ -1,55 +0,0 @@ -import hbs, { ExpressHandlebars } from "express-handlebars"; -import { RenderViewOptions } from "express-handlebars/types/index.js"; - -export class HandlebarsSingleton { - static #instance: HandlebarsSingleton; - hbsInstance: hbs.ExpressHandlebars; - - private constructor() { - this.hbsInstance = hbs.create({ - defaultLayout: "main", - partialsDir: ["views/partials/"], - layoutsDir: "views/layouts/", - helpers: { - plural: function (number: number, text: string) { - const singular = number === 1; - // If no text parameter was given, just return a conditional s. - if (typeof text !== "string") return singular ? "" : "s"; - // Split with regex into group1/group2 or group1(group3) - const match = text.match(/^([^()\/]+)(?:\/(.+))?(?:\((\w+)\))?/); - // If no match, just append a conditional s. - if (!match) return text + (singular ? "" : "s"); - // We have a good match, so fire away - return ( - (singular && match[1]) || // Singular case - match[2] || // Plural case: 'bagel/bagels' --> bagels - match[1] + (match[3] || "s") - ); // Plural case: 'bagel(s)' or 'bagel' --> bagels - }, - json: function (context: object) { - return JSON.stringify(context); - }, - }, - }); - } - - public static get instance(): HandlebarsSingleton { - if (!HandlebarsSingleton.#instance) { - HandlebarsSingleton.#instance = new HandlebarsSingleton(); - } - - return HandlebarsSingleton.#instance; - } - - public get engine(): ExpressHandlebars["engine"] { - return this.hbsInstance.engine; - } - - /** - * Finally, any singleton can define some business logic, which can be - * executed on its instance. - */ - public renderView(viewPath: string, options: RenderViewOptions): Promise { - return this.hbsInstance.renderView(viewPath, options); - } -} diff --git a/src/routes.js b/src/routes.js index d5b5877..d0fd9fc 100755 --- a/src/routes.js +++ b/src/routes.js @@ -22,7 +22,7 @@ import EventGroup from "./models/EventGroup.js"; import path from "path"; import { activityPubContentType } from "./lib/activitypub.js"; import { hashString } from "./util/generator.js"; -import { initEmailService, sendEmailFromTemplate } from "./lib/email.js"; +import { EmailService } from "./lib/email.js"; const config = getConfig(); const domain = config.general.domain; @@ -36,10 +36,6 @@ const nanoid = customAlphabet( ); const router = express.Router(); - -let sendEmails = false; -initEmailService().then((emailService) => (sendEmails = emailService)); - router.use(fileUpload()); // SCHEDULED DELETION @@ -309,34 +305,30 @@ router.post("/deleteevent/:eventID/:editToken", (req, res) => { }); res.end(); - // Send emails here otherwise they don't exist lol - if (sendEmails) { - const attendeeEmails = event?.attendees?.filter( - (o) => - o.status === "attending" && - o.email, - ) - .map((o) => o.email || '') || []; - if (attendeeEmails.length) { - console.log( - "Sending emails to: " + - attendeeEmails, - ); - sendEmailFromTemplate( - attendeeEmails, - '', - `${event?.name} was deleted`, - "deleteEvent", - { - eventName: event?.name, - }, - ).catch((e) => { - console.error('error sending attendy email', e.toString()); - res.status(500).end(); - }); - } else { - console.log("Nothing to send!"); - } + const attendeeEmails = event?.attendees?.filter( + (o) => + o.status === "attending" && + o.email, + ) + .map((o) => o.email || '') || []; + if (attendeeEmails.length) { + console.log( + "Sending emails to: " + + attendeeEmails, + ); + req.emailService.sendEmailFromTemplate({ + to: attendeeEmails, + subject: `${event?.name} was deleted`, + templateName: "deleteEvent", + templateData: { + eventName: event?.name, + }, + }).catch((e) => { + console.error('error sending attendee email', e.toString()); + res.status(500).end(); + }); + } else { + console.log("Nothing to send!"); } }) .catch((err) => { @@ -636,25 +628,22 @@ router.post("/attendevent/:eventID", async (req, res) => { "success", "Attendee added to event " + req.params.eventID, ); - if (sendEmails) { - if (req.body.attendeeEmail) { - sendEmailFromTemplate( - req.body.attendeeEmail, - '', - `You're RSVPed to ${event.name}`, - "addEventAttendee", - { - eventID: req.params.eventID, - removalPassword: req.body.removalPassword, - removalPasswordHash: hashString( - req.body.removalPassword, - ), - }, - ).catch((e) => { - console.error('error sending addEventAttendee email', e.toString()); - res.status(500).end(); - }); - } + if (req.body.attendeeEmail) { + req.emailService.sendEmailFromTemplate({ + to: req.body.attendeeEmail, + subject: `You're RSVPed to ${event.name}`, + templateName: "addEventAttendee", + templateData:{ + eventID: req.params.eventID, + removalPassword: req.body.removalPassword, + removalPasswordHash: hashString( + req.body.removalPassword, + ), + }, + }).catch((e) => { + console.error('error sending addEventAttendee email', e.toString()); + res.status(500).end(); + }); } res.redirect(`/${req.params.eventID}`); }) @@ -696,22 +685,19 @@ router.get("/oneclickunattendevent/:eventID/:attendeeID", (req, res) => { "success", "Attendee removed via one click unattend " + req.params.eventID, ); - if (sendEmails) { - // currently this is never called because we don't have the email address - if (req.body.attendeeEmail) { - sendEmailFromTemplate( - req.body.attendeeEmail, - '', - `You have been removed from an event`, - "removeEventAttendee", - { - eventName: event.name, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } + // currently this is never called because we don't have the email address + if (req.body.attendeeEmail) { + req.emailService.sendEmailFromTemplate({ + to: req.body.attendeeEmail, + subject: `You have been removed from an event`, + templateName: "removeEventAttendee", + templateData:{ + eventName: event.name, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } res.writeHead(302, { Location: "/" + req.params.eventID, @@ -745,22 +731,19 @@ router.post("/removeattendee/:eventID/:attendeeID", (req, res) => { "success", "Attendee removed by admin from event " + req.params.eventID, ); - if (sendEmails) { - // currently this is never called because we don't have the email address - if (req.body.attendeeEmail) { - sendEmailFromTemplate( - req.body.attendeeEmail, - '', - `You have been removed from an event`, - "removeEventAttendee", - { - eventName: event.name, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } + // currently this is never called because we don't have the email address + if (req.body.attendeeEmail) { + req.emailService.sendEmailFromTemplate({ + to: req.body.attendeeEmail, + subject: `You have been removed from an event`, + templateName: "removeEventAttendee", + templateData: { + eventName: event.name, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); } res.writeHead(302, { Location: "/" + req.params.eventID, @@ -800,22 +783,20 @@ router.post("/subscribe/:eventGroupID", (req, res) => { } eventGroup.subscribers.push(subscriber); eventGroup.save(); - if (sendEmails) { - sendEmailFromTemplate( - subscriber.email, - '', - `You have subscribed to an event group`, - "subscribed", - { - eventGroupName: eventGroup.name, - eventGroupID: eventGroup.id, - emailAddress: encodeURIComponent(subscriber.email), - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } + req.emailService.sendEmailFromTemplate({ + to: subscriber.email, + subject: "You have subscribed to an event group", + templateName: "subscribed", + templateData:{ + eventGroupName: eventGroup.name, + eventGroupID: eventGroup.id, + emailAddress: encodeURIComponent(subscriber.email), + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); + return res.redirect(`/group/${eventGroup.id}`); }) .catch((error) => { @@ -906,38 +887,40 @@ router.post("/post/comment/:eventID", (req, res) => { event.followers, req.params.eventID, ); - if (sendEmails) { - Event.findOne({ id: req.params.eventID }).then( - (event) => { - const attendeeEmails = event.attendees - .filter( - (o) => - o.status === "attending" && o.email, - ) - .map((o) => o.email || '') || []; - if (attendeeEmails.length) { - console.log( - "Sending emails to: " + attendeeEmails, - ); - sendEmailFromTemplate( - event?.creatorEmail || config.general.email, - attendeeEmails, - `New comment in ${event.name}`, - "addEventComment", - { - eventID: req.params.eventID, - commentAuthor: req.body.commentAuthor, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } else { - console.log("Nothing to send!"); - } - }, - ); + if (!event) { + return res.sendStatus(404); } + + Event.findOne({ id: req.params.eventID }).then( + (event) => { + const attendeeEmails = event.attendees + .filter( + (o) => + o.status === "attending" && o.email, + ) + .map((o) => o.email || '') || []; + if (attendeeEmails.length) { + console.log( + "Sending emails to: " + attendeeEmails, + ); + req.emailService.sendEmailFromTemplate({ + to: event?.creatorEmail || config.general.email, + bcc: attendeeEmails, + subject: `New comment in ${event.name}`, + templateName: "addEventComment", + templateData:{ + eventID: req.params.eventID, + commentAuthor: req.body.commentAuthor, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); + } else { + console.log("Nothing to send!"); + } + }, + ); res.writeHead(302, { Location: "/" + req.params.eventID, }); @@ -1003,41 +986,39 @@ router.post("/post/reply/:eventID/:commentID", (req, res) => { event.followers, req.params.eventID, ); - if (sendEmails) { - Event.findOne({ id: req.params.eventID }).then( - (event) => { - if (!event) { - return res.sendStatus(404); - } - const attendeeEmails = event.attendees - .filter( - (o) => - o.status === "attending" && o.email, - ) - .map((o) => o.email || '') || []; - if (attendeeEmails.length) { - console.log( - "Sending emails to: " + attendeeEmails, - ); - sendEmailFromTemplate( - event?.creatorEmail || config.general.email, - attendeeEmails, - `New comment in ${event.name}`, - "addEventComment", - { - eventID: req.params.eventID, - commentAuthor: req.body.replyAuthor, - }, - ).catch((e) => { - console.error('error sending removeEventAttendeeHtml email', e.toString()); - res.status(500).end(); - }); - } else { - console.log("Nothing to send!"); - } - }, - ); - } + Event.findOne({ id: req.params.eventID }).then( + (event) => { + if (!event) { + return res.sendStatus(404); + } + const attendeeEmails = event.attendees + .filter( + (o) => + o.status === "attending" && o.email, + ) + .map((o) => o.email || '') || []; + if (attendeeEmails.length) { + console.log( + "Sending emails to: " + attendeeEmails, + ); + req.emailService.sendEmailFromTemplate({ + to: event?.creatorEmail || config.general.email, + bcc: attendeeEmails, + subject: `New comment in ${event.name}`, + templateName: "addEventComment", + templateData: { + eventID: req.params.eventID, + commentAuthor: req.body.replyAuthor, + }, + }).catch((e) => { + console.error('error sending removeEventAttendeeHtml email', e.toString()); + res.status(500).end(); + }); + } else { + console.log("Nothing to send!"); + } + }, + ); res.writeHead(302, { Location: "/" + req.params.eventID, }); diff --git a/src/routes/event.ts b/src/routes/event.ts index f97adc9..ee45d96 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -22,14 +22,13 @@ import { updateActivityPubActor, updateActivityPubEvent, } from "../activitypub.js"; -import { sendEmailFromTemplate } from "../lib/email.js"; import crypto from "crypto"; import ical from "ical"; import { markdownToSanitizedHTML } from "../util/markdown.js"; import { checkMagicLink, getConfigMiddleware } from "../lib/middleware.js"; import { getConfig } from "../lib/config.js"; -const config = getConfig(); +const config = getConfig(); const storage = multer.memoryStorage(); // Accept only JPEG, GIF or PNG images, up to 10MB @@ -193,21 +192,20 @@ router.post( const savedEvent = await event.save(); addToLog("createEvent", "success", "Event " + eventID + "created"); // Send email with edit link - if (eventData.creatorEmail && req.app.locals.sendEmails) { - sendEmailFromTemplate( - eventData.creatorEmail, - "", - `${eventData.eventName}`, - "createEvent", - { + if (eventData.creatorEmail) { + req.emailService.sendEmailFromTemplate({ + to: eventData.creatorEmail, + subject: eventData.eventName, + templateName: "createEvent", + templateData: { eventID, editToken, } - ); + }); } // If the event was added to a group, send an email to any group // subscribers - if (event.eventGroup && req.app.locals.sendEmails) { + if (event.eventGroup) { try { const eventGroup = await EventGroup.findOne({ _id: event.eventGroup.toString(), @@ -227,19 +225,18 @@ router.post( [] as string[], ); subscribers?.forEach((emailAddress) => { - sendEmailFromTemplate( - emailAddress, - "", - `New event in ${eventGroup.name}`, - "eventGroupUpdated", - { + req.emailService.sendEmailFromTemplate({ + to: emailAddress, + subject: `New event in ${eventGroup.name}`, + templateName: "eventGroupUpdated", + templateData: { eventGroupName: eventGroup.name, eventName: event.name, eventID: event.id, eventGroupID: eventGroup.id, emailAddress: encodeURIComponent(emailAddress), } - ); + }); }); } catch (err) { console.error(err); @@ -247,7 +244,7 @@ router.post( "createEvent", "error", "Attempt to send event group emails failed with error: " + - err, + err, ); } } @@ -379,24 +376,24 @@ router.put( eventGroup: isPartOfEventGroup ? eventGroup?._id : null, activityPubActor: event.activityPubActor ? updateActivityPubActor( - JSON.parse(event.activityPubActor), - eventData.eventDescription, - eventData.eventName, - eventData.eventLocation, - eventImageFilename, - startUTC, - endUTC, - eventData.timezone, - ) + JSON.parse(event.activityPubActor), + eventData.eventDescription, + eventData.eventName, + eventData.eventLocation, + eventImageFilename, + startUTC, + endUTC, + eventData.timezone, + ) : undefined, activityPubEvent: event.activityPubEvent ? updateActivityPubEvent( - JSON.parse(event.activityPubEvent), - eventData.eventName, - startUTC, - endUTC, - eventData.timezone, - ) + JSON.parse(event.activityPubEvent), + eventData.eventName, + startUTC, + endUTC, + eventData.timezone, + ) : undefined, }; let diffText = @@ -483,22 +480,20 @@ router.put( } } // Send update to all attendees - if (req.app.locals.sendEmails) { - const attendeeEmails = event.attendees - ?.filter((o) => o.status === "attending" && o.email) - .map((o) => o.email!); - if (attendeeEmails?.length) { - sendEmailFromTemplate( - config.general.email, - attendeeEmails, - `${event.name} was just edited`, - "editEvent", - { - diffText, - eventID: req.params.eventID, - }, - ); - } + const attendeeEmails = event.attendees + ?.filter((o) => o.status === "attending" && o.email) + .map((o) => o.email!); + if (attendeeEmails?.length) { + req.emailService.sendEmailFromTemplate({ + to: config.general.email, + bcc: attendeeEmails, + subject: `${event.name} was just edited`, + templateName: "editEvent", + templateData: { + diffText, + eventID: req.params.eventID, + }, + }); } res.sendStatus(200); } catch (err) { @@ -507,9 +502,9 @@ router.put( "editEvent", "error", "Attempt to edit event " + - req.params.eventID + - " failed with error: " + - err, + req.params.eventID + + " failed with error: " + + err, ); return res.status(500).json({ errors: [ @@ -598,17 +593,16 @@ router.post( await event.save(); addToLog("createEvent", "success", `Event ${eventID} created`); // Send email with edit link - if (creatorEmail && req.app.locals.sendEmails) { - sendEmailFromTemplate( - creatorEmail, - "", - `${importedEventData.summary}`, - "createEvent", - { + if (creatorEmail) { + req.emailService.sendEmailFromTemplate({ + to: creatorEmail, + subject: importedEventData.summary || "", + templateName: "createEvent", + templateData: { eventID, editToken, }, - ); + }); } return res.json({ eventID: eventID, @@ -675,16 +669,15 @@ router.delete( "success", `Attendee removed self from event ${req.params.eventID}`, ); - if (attendeeEmail && req.app.locals.sendEmails) { - await sendEmailFromTemplate( - attendeeEmail, - "", - "You have been removed from an event", - "unattendEvent", - { + if (attendeeEmail) { + await req.emailService.sendEmailFromTemplate({ + to: attendeeEmail, + subject: "You have been removed from an event", + templateName: "unattendEvent", + templateData: { eventID: req.params.eventID, }, - ); + }); } res.sendStatus(200); } catch (e) { @@ -723,16 +716,15 @@ router.get( ); await event.save(); // Send email to the attendee - if (req.app.locals.sendEmails && attendee.email) { - sendEmailFromTemplate( - attendee.email, - "", - `You have been removed from ${event.name}`, - "unattendEvent", - { + if (attendee.email) { + req.emailService.sendEmailFromTemplate({ + to: attendee.email, + subject: `You have been removed from ${event.name}`, + templateName: "unattendEvent", + templateData: { event, }, - ); + }); } return res.redirect(`/${req.params.eventID}?m=unattend`); }, diff --git a/src/routes/group.ts b/src/routes/group.ts index c63413e..cc53976 100644 --- a/src/routes/group.ts +++ b/src/routes/group.ts @@ -5,7 +5,6 @@ import { validateGroupData } from "../util/validation.js"; import Jimp from "jimp"; import { addToLog } from "../helpers.js"; import EventGroup from "../models/EventGroup.js"; -import { sendEmailFromTemplate } from "../lib/email.js"; import { marked } from "marked"; import { renderPlain } from "../util/markdown.js"; import { checkMagicLink, getConfigMiddleware } from "../lib/middleware.js"; @@ -92,17 +91,16 @@ router.post( ); // Send email with edit link - if (groupData.creatorEmail && req.app.locals.sendEmails) { - sendEmailFromTemplate( - groupData.creatorEmail, - "", - `${eventGroup.name}`, - "createEventGroup", - { + if (groupData.creatorEmail) { + req.emailService.sendEmailFromTemplate({ + to: groupData.creatorEmail, + subject: eventGroup.name, + templateName: "createEventGroup", + templateData: { eventGroupID: eventGroup.id, editToken: eventGroup.editToken, }, - ); + }); } res.status(200).json({ @@ -224,9 +222,9 @@ router.put( "editEventGroup", "error", "Attempt to edit event group " + - req.params.eventGroupID + - " failed with error: " + - err, + req.params.eventGroupID + + " failed with error: " + + err, ); return res.status(500).json({ errors: [ diff --git a/src/routes/magicLink.ts b/src/routes/magicLink.ts index 8d0f147..e0a6310 100644 --- a/src/routes/magicLink.ts +++ b/src/routes/magicLink.ts @@ -1,6 +1,5 @@ import { Router, Request, Response } from "express"; import { frontendConfig } from "../lib/config.js"; -import { sendEmailFromTemplate } from "../lib/email.js"; import { generateMagicLinkToken } from "../util/generator.js"; import MagicLink from "../models/MagicLink.js"; import { getConfigMiddleware } from "../lib/middleware.js"; @@ -48,15 +47,14 @@ router.post("/magic-link/event/create", async (req: Request, res: Response) => { // Take this opportunity to delete any expired magic links await MagicLink.deleteMany({ expiryTime: { $lt: new Date() } }); - sendEmailFromTemplate( - email, - "", - `Magic link to create an event`, - "createEventMagicLink", - { + req.emailService.sendEmailFromTemplate({ + to: email, + subject: "Magic link to create an event", + templateName: "createEventMagicLink", + templateData: { token }, - ); + }); res.render("createEventMagicLink", { ...frontendConfig(res), message: { -- cgit v1.2.3 From 889bae2029211abfd61a25ddecd7eb5b0f4a2c90 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sun, 27 Apr 2025 23:40:06 +0900 Subject: translate Japanese comments to English --- src/app.ts | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 47bb2d1..4cf37c8 100755 --- a/src/app.ts +++ b/src/app.ts @@ -13,7 +13,7 @@ import path from 'path'; const require = createRequire(import.meta.url); const handlebarsI18next = require('handlebars-i18next'); -// ESモジュールで__dirnameを再現 +// Recreate __dirname in ES module const __filename = fileURLToPath(import.meta.url); const __dirname = dirname(__filename); @@ -37,7 +37,7 @@ const app = express(); app.locals.sendEmails = initEmailService(); -// ESモジュールで__dirnameを再現する部分を関数化 +// function to construct __dirname with ES module const getLocalesPath = () => { const __filename = fileURLToPath(import.meta.url); const __dirname = dirname(__filename); @@ -75,11 +75,12 @@ async function initializeApp() { app.use(handle(i18next)); - // 言語を明示的に切り替える + // to Switch language app.use((req, res, next) => { const currentLanguage = i18next.language; i18next.changeLanguage(req.language); const newLanguage = i18next.language; +// Uncomment for debugging // console.log('Language Change:', { // header: req.headers['accept-language'], // detected: req.language, @@ -89,7 +90,7 @@ async function initializeApp() { next(); }); -// // デバッグ用 +// Uncomment for debugging // app.use((req, res, next) => { // console.log('Language Detection:', { // header: req.headers['accept-language'], @@ -108,16 +109,16 @@ async function initializeApp() { json: function (context: any) { return JSON.stringify(context); }, - // i18nextヘルパーを追加 + // add i18next helpers ...getI18nHelpers(), - plural: function (key: string, count: number, options: any) { // ★plural ヘルパーを登録 + plural: function (key: string, count: number, options: any) { // Register the plural helper const translation = i18next.t(key, { count: count }); return translation; } }, }); - // i18nextHelperの呼び出し方法を変更 + // calling i18nextHelper if (typeof handlebarsI18next === 'function') { handlebarsI18next(hbsInstance.handlebars, i18next); } else if (typeof handlebarsI18next.default === 'function') { -- cgit v1.2.3 From 018870a06324b8ebc19c0d5ab3a209f872768306 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Mon, 28 Apr 2025 20:53:27 +0900 Subject: Fix some i18next call, which concatted translation and some string without i18next parameter --- src/routes/event.ts | 14 +++++++------- src/util/validation.ts | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'src') diff --git a/src/routes/event.ts b/src/routes/event.ts index ca333c5..8972169 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -414,10 +414,10 @@ router.put( "

    " + i18next.t("routes.event.difftext") + "

      "; let displayDate; if (event.name !== updatedEvent.name) { - diffText += `
    • ` + i18next.t("routes.event.namechanged") + updatedEvent.name + `
      • `; + diffText += `
    • ` + i18next.t("routes.event.namechanged", { eventname: updatedEvent.name} ) + `
      • `; } if (event.location !== updatedEvent.location) { - diffText += `
    • ` + i18next.t("routes.event.locationchanged") + updatedEvent.location + `
      • `; + diffText += `
    • ` + i18next.t("routes.event.locationchanged", { location: updatedEvent.location} ) + `
      • `; } if ( event.start.toISOString() !== updatedEvent.start.toISOString() @@ -425,19 +425,19 @@ router.put( displayDate = moment .tz(updatedEvent.start, updatedEvent.timezone) .format(i18next.t("common.datetimeformat")); - diffText += `
    • ` + i18next.t("routes.event.starttimechanged") + displayDate + `
      • `; + diffText += `
    • ` + i18next.t("routes.event.starttimechanged", { starttime: displayDate }) + `
      • `; } if (event.end.toISOString() !== updatedEvent.end.toISOString()) { displayDate = moment .tz(updatedEvent.end, updatedEvent.timezone) .format(i18next.t("common.datetimeformat")); - diffText += `
    • ` + i18next.t("routes.event.endtimechanged") + displayDate + `
      • `; + diffText += `
    • ` + i18next.t("routes.event.endtimechanged", { endtime: displayDate }) + `
      • `; } if (event.timezone !== updatedEvent.timezone) { - diffText += `
    • ` + i18next.t("routes.event.timezonechanged") + updatedEvent.timezone + `
      • `; + diffText += `
    • ` + i18next.t("routes.event.timezonechanged", { timezone: updatedEvent.timezone }) + `
      • `; } if (event.description !== updatedEvent.description) { - diffText += `
    • ` + i18next.t("routes.event.descriptionchanged") + `
      • `; + diffText += `
    • ` + i18next.t("routes.event.descriptionchanged", { description: updatedEvent.description }) + `
      • `; } diffText += `
    `; const updatedEventObject = await Event.findOneAndUpdate( @@ -502,7 +502,7 @@ router.put( sendEmailFromTemplate( config.general.email, attendeeEmails.join(","), - `${event.name} ` + i18next.t("routes.event.editedsubject"), + i18next.t("routes.event.editedsubject", { eventname: event.name}), "editEvent", { diffText, diff --git a/src/util/validation.ts b/src/util/validation.ts index 4ead7df..ccfc8d5 100644 --- a/src/util/validation.ts +++ b/src/util/validation.ts @@ -131,7 +131,7 @@ export const validateEventData = ( const errors: Error[] = []; if (!validatedData.eventName) { errors.push({ - message: i18next.t('validation.eventdata.eventname'), + message: i18next.t('util.validation.eventdata.eventname'), field: "eventName", }); } -- cgit v1.2.3 From 53e7e321d20cd7071ff617ecfcf42f6122020bcd Mon Sep 17 00:00:00 2001 From: Gavin Mogan Date: Mon, 28 Apr 2025 19:16:28 -0700 Subject: switch to 3rd party merge which doesn't mutate config --- src/lib/middleware.ts | 2 +- src/util/object.ts | 30 ------------------------------ 2 files changed, 1 insertion(+), 31 deletions(-) delete mode 100644 src/util/object.ts (limited to 'src') diff --git a/src/lib/middleware.ts b/src/lib/middleware.ts index 5073137..69fbe4e 100644 --- a/src/lib/middleware.ts +++ b/src/lib/middleware.ts @@ -1,7 +1,7 @@ import { NextFunction, Request, Response } from "express"; import MagicLink from "../models/MagicLink.js"; import getConfig, { GathioConfig } from "../lib/config.js"; -import { deepMerge } from "../util/object.js"; +import { merge as deepMerge } from "ts-deepmerge"; export const checkMagicLink = async ( req: Request, diff --git a/src/util/object.ts b/src/util/object.ts deleted file mode 100644 index 1ecc89b..0000000 --- a/src/util/object.ts +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Simple object check. - */ -export function isObject(item: any) { - return item && typeof item === "object" && !Array.isArray(item); -} - -/** - * Deep merge two objects. - */ -export function deepMerge( - target: Record, - ...sources: Record[] -): T { - if (!sources.length) return target; - const source = sources.shift(); - - if (isObject(target) && isObject(source)) { - for (const key in source) { - if (isObject(source[key])) { - if (!target[key]) Object.assign(target, { [key]: {} }); - deepMerge(target[key], source[key]); - } else { - Object.assign(target, { [key]: source[key] }); - } - } - } - - return deepMerge(target, ...sources) as T; -} -- cgit v1.2.3 From 9286a9b97ec9aef5bcef965e01e1964521c84ab6 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Thu, 1 May 2025 22:03:32 +0900 Subject: "en-us" removed, only "en" now. --- src/app.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/app.ts b/src/app.ts index 4cf37c8..c4bcdcd 100755 --- a/src/app.ts +++ b/src/app.ts @@ -57,8 +57,8 @@ async function initializeApp() { loadPath: path.join(getLocalesPath(), '{{lng}}.json'), }, fallbackLng: 'en', - preload: ['en-US', 'ja'], - supportedLngs: ['en','en-US', 'ja'], + preload: ['en', 'ja'], + supportedLngs: ['en', 'ja'], nonExplicitSupportedLngs: true, load: 'languageOnly', debug: false, -- cgit v1.2.3 From d0ea0d22f5c12fc558948e5a2ac1acdba7111bb6 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Fri, 2 May 2025 23:14:55 +0900 Subject: Fix wrong translation string keys --- src/util/validation.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/util/validation.ts b/src/util/validation.ts index ccfc8d5..42b524a 100644 --- a/src/util/validation.ts +++ b/src/util/validation.ts @@ -91,19 +91,19 @@ const validateUrl = (url: string) => { export const validateEventTime = (start: Date, end: Date): Error | boolean => { if (moment(start).isAfter(moment(end))) { return { - message: i18next.t('validation.eventtime.startisafter'), + message: i18next.t('util.validation.eventtime.startisafter'), field: "eventStart", }; } if (moment(start).isBefore(moment())) { return { - message: i18next.t('validation.eventtime.startisbefore'), + message: i18next.t('util.validation.eventtime.startisbefore'), field: "eventStart", }; } if (moment(end).isBefore(moment())) { return { - message: i18next.t('validation.eventtime.endisbefore'), + message: i18next.t('util.validation.eventtime.endisbefore'), field: "eventEnd", }; } -- cgit v1.2.3 From fde84325ba98bbbab79cc5c88157457ee1cb0e42 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sat, 3 May 2025 00:00:05 +0900 Subject: Rollback mail text when the event description changed --- src/routes/event.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/routes/event.ts b/src/routes/event.ts index 8972169..2116df8 100644 --- a/src/routes/event.ts +++ b/src/routes/event.ts @@ -437,7 +437,7 @@ router.put( diffText += `
  • ` + i18next.t("routes.event.timezonechanged", { timezone: updatedEvent.timezone }) + `
    • `; } if (event.description !== updatedEvent.description) { - diffText += `
  • ` + i18next.t("routes.event.descriptionchanged", { description: updatedEvent.description }) + `
    • `; + diffText += `
  • ` + i18next.t("routes.event.descriptionchanged") + `
    • `; } diffText += `
`; const updatedEventObject = await Event.findOneAndUpdate( -- cgit v1.2.3 From d2c2147ac6a02d647217a303e5810125e0d112c0 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Sun, 11 May 2025 18:26:06 +0900 Subject: Avoid "Type 'GathioConfig' is missing the following properties from type 'IObject[]':..." --- src/lib/middleware.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/lib/middleware.ts b/src/lib/middleware.ts index 69fbe4e..be05c3f 100644 --- a/src/lib/middleware.ts +++ b/src/lib/middleware.ts @@ -62,7 +62,7 @@ export const getConfigMiddleware = ( if (process.env.CYPRESS === "true" && req.cookies?.cypressConfigOverride) { console.log("Overriding config with Cypress config"); const override = JSON.parse(req.cookies.cypressConfigOverride); - res.locals.config = deepMerge(config, override); + res.locals.config = deepMerge(config, override); return next(); } res.locals.config = config; -- cgit v1.2.3 From b2e8547dc9c91bf48bd5743e1bda2c9e507da908 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Mon, 19 May 2025 00:16:39 +0900 Subject: Fix to parse markdown, default instance description --- src/lib/config.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/lib/config.ts b/src/lib/config.ts index 5b74e4a..b08fa31 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -157,8 +157,9 @@ export const instanceRules = (): InstanceRule[] => { export const instanceDescription = (): string => { const config = getConfig(); - const defaultInstanceDescription = - i18next.t("config.defaultinstancedesc"); + const defaultInstanceDescription = markdownToSanitizedHTML( + i18next.t("config.defaultinstancedesc", "Welcome to this Gathio instance!") + ); let instanceDescription = defaultInstanceDescription; let instancedescfile = "./static/instance-description-" + i18next.language + ".md"; try { -- cgit v1.2.3 From bc9e983b16d9ac2d27a4458c0a87f9d11aa80c0e Mon Sep 17 00:00:00 2001 From: Raphael Kabo Date: Tue, 27 May 2025 19:07:27 +0100 Subject: Add Mailgun email service --- src/lib/config.ts | 7 +++++- src/lib/email.ts | 71 ++++++++++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 66 insertions(+), 12 deletions(-) (limited to 'src') diff --git a/src/lib/config.ts b/src/lib/config.ts index 6642eef..3fd6eb7 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -21,7 +21,7 @@ export interface GathioConfig { email_logo_url: string; show_kofi: boolean; show_public_event_list: boolean; - mail_service: "nodemailer" | "sendgrid" | "none"; + mail_service: "nodemailer" | "sendgrid" | "mailgun" | "none"; creator_email_addresses: string[]; }; database: { @@ -37,6 +37,11 @@ export interface GathioConfig { sendgrid?: { api_key: string; }; + mailgun?: { + api_key: string; + api_url: string; + domain: string; + }; static_pages?: StaticPage[]; } diff --git a/src/lib/email.ts b/src/lib/email.ts index 7c7c2dd..fc585a1 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -5,6 +5,8 @@ import nodemailer, { Transporter } from "nodemailer"; import { GathioConfig, getConfig } from "./config.js"; import SMTPTransport from "nodemailer/lib/smtp-transport/index.js"; import { exitWithError } from "./process.js"; +import Mailgun from "mailgun.js"; +import { IMailgunClient } from "node_modules/mailgun.js/Types/Interfaces/index.js"; const config = getConfig(); @@ -24,7 +26,8 @@ type EmailTemplateName = export class EmailService { nodemailerTransporter: Transporter | undefined = undefined; sgMail: typeof sgMail | undefined = undefined; - hbs: ExpressHandlebars + mailgunClient: IMailgunClient | undefined = undefined; + hbs: ExpressHandlebars; public constructor(config: GathioConfig, hbs: ExpressHandlebars) { this.hbs = hbs; @@ -40,6 +43,26 @@ export class EmailService { console.log("Sendgrid is ready to send emails."); break; } + case "mailgun": { + if ( + !config.mailgun?.api_key || + !config.mailgun?.api_url || + !config.mailgun?.domain + ) { + return exitWithError( + "Mailgun is configured as the email service, but not all required fields are provided. Please provide all required fields in the config file.", + ); + } + const mailgun = new Mailgun(FormData); + this.mailgunClient = mailgun.client({ + username: "api", + key: config.mailgun.api_key, + url: config.mailgun.api_url, + }); + // TODO: Can we verify the Mailgun connection? + console.log("Mailgun is ready to send emails."); + break; + } case "nodemailer": { if (config.nodemailer?.smtp_url) { this.nodemailerTransporter = nodemailer.createTransport( @@ -73,13 +96,13 @@ export class EmailService { nodemailer.createTransport(nodemailerConfig); } } - } } public async verify(): Promise { if (this.nodemailerTransporter) { - const nodemailerVerified = await this.nodemailerTransporter.verify(); + const nodemailerVerified = + await this.nodemailerTransporter.verify(); if (nodemailerVerified) { console.log("Nodemailer is ready to send emails."); return true; @@ -118,9 +141,36 @@ export class EmailService { return true; } catch (e: unknown | sgHelpers.classes.ResponseError) { if (e instanceof sgHelpers.classes.ResponseError) { - console.error('sendgrid error', e.response.body); + console.error("sendgrid error", e.response.body); + } else { + console.error("sendgrid error", e); + } + return false; + } + } else if (this.mailgunClient) { + try { + if (!config.mailgun?.domain) { + return exitWithError( + "Mailgun is configured as the email service, but no domain is provided. Please provide a domain in the config file.", + ); + } + await this.mailgunClient.messages.create( + config.mailgun.domain, + { + from: config.general.email, + to, + bcc, + subject: `${config.general.site_name}: ${subject}`, + text, + html, + }, + ); + return true; + } catch (e: any) { + if (e.response) { + console.error(e.response.body); } else { - console.error('sendgrid error', e); + console.error(e); } return false; } @@ -150,15 +200,14 @@ export class EmailService { bcc = "", subject, templateName, - templateData = {} + templateData = {}, }: { to: string | string[]; bcc?: string | string[] | undefined; subject: string; templateName: EmailTemplateName; templateData?: object; - }, - ): Promise { + }): Promise { const [html, text] = await Promise.all([ this.hbs.renderView( `./views/emails/${templateName}/${templateName}Html.handlebars`, @@ -172,7 +221,7 @@ export class EmailService { cache: true, layout: "email.handlebars", ...templateData, - } + }, ), this.hbs.renderView( `./views/emails/${templateName}/${templateName}Text.handlebars`, @@ -186,7 +235,7 @@ export class EmailService { cache: true, layout: "email.handlebars", ...templateData, - } + }, ), ]); @@ -195,7 +244,7 @@ export class EmailService { bcc, subject: `${config.general.site_name}: ${subject}`, text, - html + html, }); } } -- cgit v1.2.3 From fb85d79dd2333cd6e0982e5ee0fdc1070ff99889 Mon Sep 17 00:00:00 2001 From: INOUE Daisuke Date: Wed, 28 May 2025 23:25:36 +0900 Subject: To pass final test --- src/routes/frontend.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/routes/frontend.ts b/src/routes/frontend.ts index a64bce4..fca14c6 100644 --- a/src/routes/frontend.ts +++ b/src/routes/frontend.ts @@ -175,7 +175,7 @@ router.get("/:eventID", async (req: Request, res: Response) => { timezone: moment .tz(event.end, event.timezone) - .format(' (z)',) + .format('(z)',) }); } else { displayDate = i18next.t("frontend.displaydate-days", -- cgit v1.2.3