ghost 6.57.1 → 6.58.0

package/core/server/lib/get-inbox-links.ts

@@ -1,276 +0,0 @@
-/**
- * This module is heavily modified from [Buttondown's Sniper Link project][0].
- * Its license is copied below.
- *
- * [0]: https://github.com/buttondown/sniper-link
- *
- * MIT License
- *
- * Copyright (c) 2024 Buttondown
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import type {MxRecord} from 'node:dns';
-import * as dns from 'node:dns/promises';
-import {parseEmailAddress} from '@tryghost/parse-email-address';
-import logging from '@tryghost/logging';
-
-type GetLinkFn = (options: Readonly<{recipient: string; sender: string}>) => string;
-
-type ProviderName = 'gmail' | 'yahoo' | 'outlook' | 'proton' | 'icloud' | 'hey' | 'aol' | 'mailru' | 'feedbin' | 'dev-mailpit';
-
-type Provider = {
-    name: ProviderName;
-    domains: ReadonlyArray<string>;
-    getDesktopLink: GetLinkFn;
-    getAndroidLink: GetLinkFn;
-};
-
-/**
- * Creates an [Android Chrome intent URL][0] which opens the a package by its ID
- * or hits an HTTP fallback.
- * [0]: https://developer.chrome.com/docs/android/intents
- */
-const getAndroidIntentUrl = (packageName: string, fallbackUrl: string): string => (
-    `intent:#Intent;action=android.intent.action.MAIN;category=android.intent.category.LAUNCHER;launchFlags=0x10000000;package=${packageName};S.browser_fallback_url=${encodeURIComponent(fallbackUrl)};end`
-);
-
-/**
- * Helper for building a URL with a single query parameter.
- */
-const buildUrl = (baseHref: string, key: string, value: string): string => {
-    const result = new URL(baseHref);
-    result.searchParams.set(key, value);
-    return result.toString();
-};
-
-const PROVIDERS: ReadonlyArray<Provider> = [
-    {
-        name: 'gmail',
-        domains: ['gmail.com', 'googlemail.com', 'google.com'],
-        // Gmail's `/mail/u/<X>/` path expects a numeric account index. Passing a
-        // raw email only resolves when that account happens to be signed in at
-        // that slot; Workspace accounts and signed-out users hit a 404 before
-        // the `#search` fragment runs. `authuser` is Gmail's own account
-        // resolver and falls through to sign-in instead of erroring.
-        getDesktopLink: ({recipient, sender}) => (
-            `https://mail.google.com/mail/u/0/?authuser=${encodeURIComponent(
-                recipient
-            )}#search/from%3A(${encodeURIComponent(
-                sender
-            )})+in%3Aanywhere+newer_than%3A1h`
-        ),
-        getAndroidLink: () => getAndroidIntentUrl('com.google.android.gm', 'https://mail.google.com/')
-    },
-    {
-        name: 'yahoo',
-        domains: ['yahoo.com', 'myyahoo.com', 'yahoo.co.uk', 'yahoo.fr', 'yahoo.it', 'ymail.com', 'rocketmail.com'],
-        getDesktopLink: ({sender}) => `https://mail.yahoo.com/d/search/keyword=from:${encodeURIComponent(sender)}`,
-        getAndroidLink: () => getAndroidIntentUrl('com.yahoo.mobile.client.android.mail', 'https://mail.yahoo.com/')
-    },
-    {
-        name: 'outlook',
-        domains: ['outlook.com', 'live.com', 'live.de', 'hotmail.com', 'hotmail.co.uk', 'hotmail.de', 'msn.com', 'passport.com', 'passport.net'],
-        getDesktopLink: ({recipient}) => buildUrl('https://outlook.live.com/mail/', 'login_hint', recipient),
-        getAndroidLink: () => getAndroidIntentUrl('com.microsoft.office.outlook', 'https://outlook.live.com/')
-    },
-    {
-        name: 'proton',
-        domains: ['proton.me', 'pm.me', 'protonmail.com', 'protonmail.ch'],
-        getDesktopLink: ({sender}) => `https://mail.proton.me/u/0/all-mail#from=${encodeURIComponent(sender)}`,
-        getAndroidLink: () => getAndroidIntentUrl('ch.protonmail.android', 'https://mail.proton.me/')
-    },
-    {
-        name: 'icloud',
-        domains: ['icloud.com', 'me.com', 'mac.com'],
-        getDesktopLink: () => 'https://www.icloud.com/mail',
-        getAndroidLink: () => 'https://www.icloud.com/mail'
-    },
-    {
-        name: 'hey',
-        domains: ['hey.com'],
-        getDesktopLink: () => 'https://app.hey.com/topics/everything',
-        getAndroidLink: () => getAndroidIntentUrl('com.basecamp.hey', 'https://app.hey.com/')
-    },
-    {
-        name: 'aol',
-        domains: ['aol.com'],
-        getDesktopLink: ({sender}) => `https://mail.aol.com/d/search/keyword=from:${encodeURIComponent(sender)}`,
-        getAndroidLink: () => getAndroidIntentUrl('com.aol.mobile.aolapp', 'https://mail.aol.com/')
-    },
-    {
-        name: 'mailru',
-        domains: ['mail.ru'],
-        getDesktopLink: ({sender}) => buildUrl('https://e.mail.ru/search/', 'q_from', sender),
-        getAndroidLink: () => getAndroidIntentUrl('ru.mail.mailapp', 'https://e.mail.ru/')
-    },
-    {
-        name: 'feedbin',
-        domains: ['feedb.in'],
-        getDesktopLink: () => 'https://feedbin.com/',
-        getAndroidLink: () => 'https://feedbin.com/'
-    },
-    ...(process.env.NODE_ENV === 'development' ? [{
-        name: 'dev-mailpit' as const,
-        domains: ['example.com'],
-        getDesktopLink: () => 'http://localhost:8025',
-        getAndroidLink: () => 'http://localhost:8025'
-    }] : [])
-];
-
-const PROVIDER_BY_DOMAIN = new Map<string, Provider>();
-for (const provider of PROVIDERS) {
-    for (const domain of provider.domains) {
-        PROVIDER_BY_DOMAIN.set(domain, provider);
-    }
-}
-
-const getErrorCode = (err: unknown): undefined | string => (
-    err && typeof err === 'object' && 'code' in err && typeof err.code === 'string'
-        ? err.code
-        : undefined
-);
-
-/**
- * Grab the MX records for a domain.
- *
- * If there are any errors at all, return the empty array. We don't want to
- * break inbox links if a DNS lookup fails—worst case, the user won't get a
- * "open in your email app" link.
- */
-const getMxRecords = async (
-    domain: string,
-    dnsResolver: Pick<dns.Resolver, 'resolveMx'>
-): Promise<MxRecord[]> => {
-    try {
-        return await dnsResolver.resolveMx(domain);
-    } catch (err: unknown) {
-        // This logs a warning, not an error, because most DNS errors could
-        // happen normally. For example, a user could provide a bogus hostname.
-        // There are some errors (like `dns.NOMEM`) which should probably use
-        // `logging.error`, but it's not worth maintaining a long list of which
-        // errors are which.
-        logging.warn('Got error code when looking up MX record', getErrorCode(err));
-        return [];
-    }
-};
-
-/**
- * Given an MX record exchange, return the provider if found.
- *
- * `google.com` and `smtp.google.com` return the Google provider, for example.
- */
-const getProviderForMxExchange = (exchange: string): undefined | Provider => {
-    const direct = PROVIDER_BY_DOMAIN.get(exchange);
-    if (direct) {
-        return direct;
-    }
-    for (const [providerDomain, provider] of PROVIDER_BY_DOMAIN.entries()) {
-        if (exchange.endsWith(`.${providerDomain}`)) {
-            return provider;
-        }
-    }
-};
-
-/**
- * Get the first item in an iterable, like a Set.
- *
- * Like `_.head()`, but works with any iterable.
- */
-const first = <T>(iterable: Iterable<T>): undefined | T => {
-    for (const result of iterable) {
-        return result;
-    }
-};
-
-/**
- * Given a domain like `gmail.com`, return a provider object.
- *
- * If the domain is in our hard-coded list of providers, return that.
- *
- * Otherwise, resolve the domain's MX records. If found, find the exchange with
- * the best priority that has exactly one unique provider.
- */
-const getProvider = async (
-    domain: string,
-    dnsResolver: Pick<dns.Resolver, 'resolveMx'>
-): Promise<undefined | Provider> => {
-    const hardcoded = PROVIDER_BY_DOMAIN.get(domain);
-    if (hardcoded) {
-        return hardcoded;
-    }
-
-    const mxRecords = await getMxRecords(domain, dnsResolver);
-
-    let bestPriorityThatHasAProvider = Infinity;
-    const providersByPriority = new Map<number, Set<undefined | Provider>>();
-
-    for (const {priority, exchange} of mxRecords) {
-        // We can skip these as an optimization.
-        if (priority > bestPriorityThatHasAProvider) {
-            continue;
-        }
-
-        const provider = getProviderForMxExchange(exchange);
-
-        const providersWithThisPriority = providersByPriority.get(priority) ?? new Set();
-        providersWithThisPriority.add(provider);
-        providersByPriority.set(priority, providersWithThisPriority);
-
-        if (provider) {
-            bestPriorityThatHasAProvider = Math.min(bestPriorityThatHasAProvider, priority);
-        }
-    }
-
-    const candidates = providersByPriority.get(bestPriorityThatHasAProvider);
-    return candidates?.size === 1 ? first(candidates) : undefined;
-};
-
-/**
- * Given an email address, return "inbox links" to open the email app/inbox.
- *
- * For example, if `newsletter@sender.example` emails `test@gmail.com`, we want
- * a link to open Gmail.
- */
-export const getInboxLinks = async (
-    options: Readonly<{
-        recipient: string;
-        sender: string;
-        dnsResolver: Pick<dns.Resolver, 'resolveMx'>
-    }>
-): Promise<undefined | {android: string; desktop: string; provider: ProviderName}> => {
-    const {recipient, dnsResolver} = options;
-
-    const domain = parseEmailAddress(recipient)?.domain;
-    if (!domain) {
-        return;
-    }
-
-    const provider = await getProvider(domain, dnsResolver);
-    if (!provider) {
-        return;
-    }
-
-    return {
-        android: provider.getAndroidLink(options),
-        desktop: provider.getDesktopLink(options),
-        provider: provider.name
-    };
-};

package/core/server/lib/post-revisions.ts

@@ -1,152 +0,0 @@
-type PostLike = {
-    id: string;
-    lexical: string;
-    html: string;
-    author_id: string;
-    feature_image: string | null;
-    feature_image_alt: string | null;
-    feature_image_caption: string | null;
-    title: string;
-    custom_excerpt: string | null;
-    reason: string;
-    post_status: string;
-}
-
-type Revision = {
-    post_id: string;
-    lexical: string;
-    author_id: string;
-    feature_image: string | null;
-    feature_image_alt: string | null;
-    feature_image_caption: string | null;
-    title: string;
-    custom_excerpt: string | null;
-    post_status: string;
-    reason: string;
-    created_at_ts: number;
-}
-
-type PostRevisionsDeps = {
-    config: {
-        max_revisions: number;
-        revision_interval_ms: number;
-    },
-    model: any
-}
-
-type RevisionResult = {
-    value: true;
-    reason: string;
-} | {
-    value: false
-}
-
-export class PostRevisions {
-    config: PostRevisionsDeps['config'];
-    model: any;
-
-    constructor(deps: PostRevisionsDeps) {
-        this.config = deps.config;
-        this.model = deps.model;
-    }
-
-    shouldGenerateRevision(current: PostLike, revisions: Revision[], options?: { isPublished?: boolean; forceRevision?: boolean; newStatus?: string; olderStatus?: string; }): RevisionResult {
-        const latestRevision = revisions[revisions.length - 1];
-        // If there's no revisions for this post, we should always save a revision
-        if (revisions.length === 0) {
-            return {value: true, reason: 'initial_revision'};
-        }
-        // check if the post has been unpublished
-        const isUnpublished = options && options.newStatus === 'draft' && options.olderStatus === 'published';
-        if (isUnpublished) {
-            return {value: true, reason: 'unpublished'};
-        }
-        // check if the post has been published
-        const isPublished = options && options.isPublished;
-        if (isPublished) {
-            return {value: true, reason: 'published'};
-        }
-
-        const forceRevision = options && options.forceRevision;
-        const featuredImagedHasChanged = latestRevision.feature_image !== current.feature_image;
-        const lexicalHasChanged = latestRevision.lexical !== current.lexical;
-        const titleHasChanged = latestRevision.title !== current.title;
-        const customExcerptHasChanged = latestRevision.custom_excerpt !== current.custom_excerpt;
-        // CASE: we only want to save a revision if something has changed since the previous revision
-        if (lexicalHasChanged || titleHasChanged || featuredImagedHasChanged || customExcerptHasChanged) {
-            // CASE: user has explicitly requested a revision by hitting cmd+s or leaving the editor
-            if (forceRevision) {
-                return {value: true, reason: 'explicit_save'};
-            }
-            // CASE: it's been X mins since the last revision, so we should save a new one
-            if ((Date.now() - latestRevision.created_at_ts) > this.config.revision_interval_ms) {
-                return {value: true, reason: 'background_save'};
-            }
-        }
-        return {value: false};
-    }
-
-    async getRevisions(current: PostLike, revisions: Revision[], options?: { isPublished?: boolean; forceRevision?: boolean; newStatus?: string; olderStatus?: string; }): Promise<Revision[]> {
-        const shouldGenerateRevision = this.shouldGenerateRevision(current, revisions, options);
-        if (!shouldGenerateRevision.value) {
-            return revisions;
-        }
-
-        const currentRevision = this.convertPostLikeToRevision(current);
-        currentRevision.reason = shouldGenerateRevision.reason;
-
-        if (revisions.length === 0) {
-            return [
-                currentRevision
-            ];
-        }
-
-        // Grab the most recent revisions, limited by max_revisions
-        const updatedRevisions = [...revisions, currentRevision];
-        if (updatedRevisions.length > this.config.max_revisions) {
-            return updatedRevisions.slice(updatedRevisions.length - this.config.max_revisions, updatedRevisions.length);
-        } else {
-            return updatedRevisions;
-        }
-    }
-
-    convertPostLikeToRevision(input: PostLike, offset = 0): Revision {
-        return {
-            post_id: input.id,
-            lexical: input.lexical,
-            created_at_ts: Date.now() - offset,
-            author_id: input.author_id,
-            feature_image: input.feature_image,
-            feature_image_alt: input.feature_image_alt,
-            feature_image_caption: input.feature_image_caption,
-            title: input.title,
-            custom_excerpt: input.custom_excerpt,
-            reason: input.reason,
-            post_status: input.post_status
-        };
-    }
-
-    async removeAuthorFromRevisions(authorId: string, options: any): Promise<void> {
-        const revisions = await this.model.findAll({
-            filter: `author_id:'${authorId}'`,
-            columns: ['id'],
-            transacting: options.transacting
-        });
-
-        const revisionIds = revisions.toJSON()
-            .map(({id}: {id: string}) => id);
-
-        if (revisionIds.length === 0) {
-            return;
-        }
-
-        await this.model.bulkEdit(revisionIds, 'post_revisions', {
-            data: {
-                author_id: null
-            },
-            column: 'id',
-            transacting: options.transacting,
-            throwErrors: true
-        });
-    }
-}

package/core/server/lib/soonest-timer.ts

@@ -1,57 +0,0 @@
-const MAX_TIMEOUT_MS = 2 ** 31 - 1;
-
-/**
- * Schedule a function for the soonest date it's been called with.
- *
- * @example
- * // Runs the function at `soon`, not `later`:
- *
- * const soonestTimer = new SoonestTimer(fn);
- *
- * const later = new Date(Date.now() + 10_000);
- * soonestTimer.scheduleAt(later);
- *
- * const soon = new Date(Date.now() + 1000);
- * soonestTimer.scheduleAt(soon);
- */
-export class SoonestTimer {
-    #scheduled: undefined | {
-        timeout: ReturnType<typeof setTimeout>;
-        at: Date;
-    };
-    #fn: () => unknown;
-
-    constructor(fn: () => unknown) {
-        this.#fn = fn;
-    }
-
-    scheduleAt(date: Readonly<Date>): void {
-        if (this.#scheduled && this.#scheduled.at <= date) {
-            return;
-        }
-
-        if (this.#scheduled) {
-            clearTimeout(this.#scheduled.timeout);
-        }
-
-        this.#scheduleAt(new Date(date));
-    }
-
-    #scheduleAt(at: Date): void {
-        // [`setTimeout` caps out at ~25 days][0], so we need a chain of timers
-        // if the delay is long.
-        // [0]: https://developer.mozilla.org/en-US/docs/Web/API/setTimeout#maximum_delay_value
-        const msUntilDate = at.getTime() - Date.now();
-        if (msUntilDate <= 0) {
-            this.#scheduled = undefined;
-            this.#fn();
-            return;
-        }
-
-        const timeout = setTimeout(() => {
-            this.#scheduleAt(at);
-        }, Math.min(msUntilDate, MAX_TIMEOUT_MS));
-
-        this.#scheduled = {timeout, at};
-    }
-}

package/core/server/models/base/plugins/bulk-filters.ts

@@ -1,35 +0,0 @@
-import chunk from 'lodash/chunk';
-import nql from '@tryghost/nql';
-import type {Knex} from 'knex';
-
-export const CHUNK_SIZE = 100;
-
-export type WhereStrategy = Iterable<(qb: Knex.QueryBuilder) => void>;
-
-/**
- * Creates a where strategy that applies an NQL filter to the query builder.
- * Yields a single query modifier — no chunking.
- */
-export function* byNQL(filter: string): WhereStrategy {
-    yield (qb) => {
-        nql(filter).querySQL(qb);
-    };
-}
-
-/**
- * Creates a where strategy that applies whereIn for the given column and values.
- * Automatically chunks values to avoid SQL parameter limits.
- */
-export function* byColumnValues(column: string, values: string[], chunkSize: number = CHUNK_SIZE): WhereStrategy {
-    for (const c of chunk(values, chunkSize)) {
-        yield qb => qb.whereIn(column, c);
-    }
-}
-
-/**
- * Creates a where strategy for matching by id column.
- * Convenience wrapper around byColumnValues.
- */
-export function* byIds(ids: string[], chunkSize: number = CHUNK_SIZE): WhereStrategy {
-    yield* byColumnValues('id', ids, chunkSize);
-}

package/core/server/models/role-utils.ts

@@ -1,56 +0,0 @@
-import type {ReadonlyDeep} from 'type-fest';
-
-type LoadedPermissionsWithRoles = ReadonlyDeep<{
-    user?: {
-        roles?: Array<{name: string}>;
-    } | null;
-}>;
-
-type RoleFlags = {
-    isOwner: boolean;
-    isAdmin: boolean;
-    isEditor: boolean;
-    isAuthor: boolean;
-    isContributor: boolean;
-    isSuperEditor: boolean;
-    isEitherEditor: boolean;
-};
-
-// check if the user has an assigned role
-// so that we can stop writing this everywhere:
-//_.some(loadedPermissions.user.roles, {name: 'Administrator'})
-
-export function checkUserPermissionsForRole(
-    loadedPermissions: LoadedPermissionsWithRoles | null | undefined,
-    roleName: string
-): boolean {
-    if (!loadedPermissions?.user?.roles) {
-        return false;
-    }
-
-    return loadedPermissions.user.roles.some(role => role.name === roleName);
-}
-
-export function setIsRoles(loadedPermissions: LoadedPermissionsWithRoles | null | undefined): RoleFlags {
-    // utility function to parse the permissions object and set up all the "is" variables.
-    const resultsObject: RoleFlags = {
-        isOwner: false,
-        isAdmin: false,
-        isEditor: false,
-        isAuthor: false,
-        isContributor: false,
-        isSuperEditor: false,
-        isEitherEditor: false
-    };
-    if (!loadedPermissions?.user?.roles) {
-        return resultsObject;
-    }
-    resultsObject.isOwner = checkUserPermissionsForRole(loadedPermissions, 'Owner');
-    resultsObject.isAdmin = checkUserPermissionsForRole(loadedPermissions, 'Administrator');
-    resultsObject.isEditor = checkUserPermissionsForRole(loadedPermissions, 'Editor');
-    resultsObject.isAuthor = checkUserPermissionsForRole(loadedPermissions, 'Author');
-    resultsObject.isContributor = checkUserPermissionsForRole(loadedPermissions, 'Contributor');
-    resultsObject.isSuperEditor = checkUserPermissionsForRole(loadedPermissions, 'Super Editor');
-    resultsObject.isEitherEditor = resultsObject.isEditor || resultsObject.isSuperEditor;
-    return resultsObject;
-}