ghost 5.61.3 → 5.63.0

package/core/server/services/mentions/WebmentionMetadata.js

@@ -1,12 +1,41 @@
 const oembedService = require('../oembed');
 
 module.exports = class WebmentionMetadata {
+    /**
+     * Helpers that change the URL for which metadata for a given external resource is fetched. Return undefined to now handle the URL.
+     * @type {((url: URL) => URL|undefined)[]}
+     */
+    #mappers = [];
+
+    /**
+     * @param {(url: URL) => URL|undefined} mapper
+     */
+    addMapper(mapper) {
+        this.#mappers.push(mapper);
+    }
+
+    /**
+     *
+     * @param {URL} url
+     */
+    #getMappedUrl(url) {
+        for (const mapper of this.#mappers) {
+            const mappedUrl = mapper(url);
+            if (mappedUrl) {
+                return this.#getMappedUrl(mappedUrl);
+            }
+        }
+        return url;
+    }
+
     /**
      * @param {URL} url
      * @returns {Promise<import('@tryghost/webmentions/lib/MentionsAPI').WebmentionMetadata>}
      */
     async fetch(url) {
-        const data = await oembedService.fetchOembedDataFromUrl(url.href, 'mention');
+        const mappedUrl = this.#getMappedUrl(url);
+        const data = await oembedService.fetchOembedDataFromUrl(mappedUrl.href, 'mention');
+
         const result = {
             siteTitle: data.metadata.publisher,
             title: data.metadata.title,
@@ -17,6 +46,14 @@ module.exports = class WebmentionMetadata {
             body: data.body,
             contentType: data.contentType
         };
+
+        if (mappedUrl.href !== url.href) {
+            // Still need to fetch body and contentType separately now
+            // For verification
+            const {body, contentType} = await oembedService.fetchPageHtml(url);
+            result.body = body;
+            result.contentType = contentType;
+        }
         return result;
     }
 };

package/core/server/services/mentions/service.js

@@ -28,6 +28,7 @@ module.exports = {
     /** @type {import('@tryghost/webmentions/lib/MentionsAPI')} */
     api: null,
     controller: new MentionController(),
+    metadata: new WebmentionMetadata(),
     /** @type {import('@tryghost/webmentions/lib/MentionSendingService')} */
     sendingService: null,
     didInit: false,
@@ -40,7 +41,7 @@ module.exports = {
             MentionModel: models.Mention,
             DomainEvents
         });
-        const webmentionMetadata = new WebmentionMetadata();
+        const webmentionMetadata = this.metadata;
         const discoveryService = new MentionDiscoveryService({externalRequest});
         const resourceService = new ResourceService({
             urlUtils,

package/core/server/services/offers/OfferBookshelfRepository.js

@@ -0,0 +1,230 @@
+const {flowRight} = require('lodash');
+const {mapKeyValues, mapQuery} = require('@tryghost/mongo-utils');
+const DomainEvents = require('@tryghost/domain-events');
+const {Offer} = require('@tryghost/members-offers');
+const sentry = require('../../../shared/sentry');
+const logger = require('@tryghost/logging');
+
+const statusTransformer = mapKeyValues({
+    key: {
+        from: 'status',
+        to: 'active'
+    },
+    values: [{
+        from: 'active',
+        to: true
+    }, {
+        from: 'archived',
+        to: false
+    }]
+});
+
+const rejectNonStatusTransformer = input => mapQuery(input, function (value, key) {
+    if (key !== 'status') {
+        return;
+    }
+
+    return {
+        [key]: value
+    };
+});
+
+const mongoTransformer = flowRight(statusTransformer, rejectNonStatusTransformer);
+
+/**
+ * @typedef {object} BaseOptions
+ * @prop {import('knex').Transaction} transacting
+ */
+
+/**
+ * @typedef {object} ListOptions
+ * @prop {import('knex').Transaction} transacting
+ * @prop {string} filter
+ */
+
+class OfferBookshelfRepository {
+    /**
+     * @param {{forge: (data: object) => import('bookshelf').Model<Offer.OfferProps>}} OfferModel
+     * @param {{forge: (data: object) => import('bookshelf').Model<any>}} OfferRedemptionModel
+     */
+    constructor(OfferModel, OfferRedemptionModel) {
+        /** @private */
+        this.OfferModel = OfferModel;
+        /** @private */
+        this.OfferRedemptionModel = OfferRedemptionModel;
+    }
+
+    /**
+     * @template T
+     * @param {(t: import('knex').Transaction) => Promise<T>} cb
+     * @returns {Promise<T>}
+     */
+    async createTransaction(cb) {
+        return this.OfferModel.transaction(cb);
+    }
+
+    /**
+     * @param {string} name
+     * @param {BaseOptions} [options]
+     * @returns {Promise<boolean>}
+     */
+    async existsByName(name, options) {
+        const model = await this.OfferModel.findOne({name}, options);
+        if (!model) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * @param {string} code
+     * @param {BaseOptions} [options]
+     * @returns {Promise<boolean>}
+     */
+    async existsByCode(code, options) {
+        const model = await this.OfferModel.findOne({code}, options);
+        if (!model) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * @private
+     * @param {import('bookshelf').Model<any>} model
+     * @param {BaseOptions} options
+     * @returns {Promise<import('@tryghost/members-offers').Offer>}
+     */
+    async mapToOffer(model, options) {
+        const json = model.toJSON();
+
+        const count = await this.OfferRedemptionModel.where({offer_id: json.id}).count('id', {
+            transacting: options.transacting
+        });
+        try {
+            return await Offer.create({
+                id: json.id,
+                name: json.name,
+                code: json.code,
+                display_title: json.portal_title,
+                display_description: json.portal_description,
+                type: json.discount_type === 'amount' ? 'fixed' : json.discount_type,
+                amount: json.discount_amount,
+                cadence: json.interval,
+                currency: json.currency,
+                duration: json.duration,
+                duration_in_months: json.duration_in_months,
+                redemptionCount: count,
+                status: json.active ? 'active' : 'archived',
+                tier: {
+                    id: json.product.id,
+                    name: json.product.name
+                }
+            }, null);
+        } catch (err) {
+            logger.error(err);
+            sentry.captureException(err);
+            return null;
+        }
+    }
+
+    /**
+     * @param {string} id
+     * @param {BaseOptions} [options]
+     * @returns {Promise<import('@tryghost/members-offers').Offer>}
+     */
+    async getById(id, options) {
+        const model = await this.OfferModel.findOne({id}, {
+            ...options,
+            withRelated: ['product']
+        });
+
+        if (!model) {
+            return null;
+        }
+
+        return this.mapToOffer(model, options);
+    }
+
+    /**
+     * @param {string} id stripe_coupon_id
+     * @param {BaseOptions} [options]
+     * @returns {Promise<import('@tryghost/members-offers').Offer>}
+     */
+    async getByStripeCouponId(id, options) {
+        const model = await this.OfferModel.findOne({stripe_coupon_id: id}, {
+            ...options,
+            withRelated: ['product']
+        });
+
+        if (!model) {
+            return null;
+        }
+
+        return this.mapToOffer(model, options);
+    }
+
+    /**
+     * @param {ListOptions} options
+     * @returns {Promise<import('@tryghost/members-offers').Offer[]>}
+     */
+    async getAll(options) {
+        const models = await this.OfferModel.findAll({
+            ...options,
+            mongoTransformer,
+            withRelated: ['product']
+        });
+
+        const mapOptions = {
+            transacting: options && options.transacting
+        };
+
+        const offers = models.map(model => this.mapToOffer(model, mapOptions));
+
+        return (await Promise.all(offers)).filter(offer => offer !== null);
+    }
+
+    /**
+     * @param {import('@tryghost/members-offers').Offer} offer
+     * @param {BaseOptions} [options]
+     * @returns {Promise<void>}
+     */
+    async save(offer, options) {
+        /** @type any */
+        const data = {
+            id: offer.id,
+            name: offer.name.value,
+            code: offer.code.value,
+            portal_title: offer.displayTitle.value || null,
+            portal_description: offer.displayDescription.value || null,
+            discount_type: offer.type.value === 'fixed' ? 'amount' : offer.type.value,
+            discount_amount: offer.amount.value,
+            interval: offer.cadence.value,
+            product_id: offer.tier.id,
+            duration: offer.duration.value.type,
+            duration_in_months: offer.duration.value.type === 'repeating' ? offer.duration.value.months : null,
+            currency: offer.currency ? offer.currency.value : null,
+            active: offer.status.value === 'active'
+        };
+
+        if (offer.isNew) {
+            await this.OfferModel.add(data, options);
+        } else {
+            await this.OfferModel.edit(data, {...options, id: data.id});
+        }
+
+        for (const event of offer.events) {
+            if (options.transacting) {
+                // Only dispatch the event after the transaction has finished
+                // Because else the offer won't be committed to the database yet
+                options.transacting.executionPromise.then(() => {
+                    DomainEvents.dispatch(event);
+                });
+            } else {
+                DomainEvents.dispatch(event);
+            }
+        }
+    }
+}
+
+module.exports = OfferBookshelfRepository;

package/core/server/services/offers/service.js

@@ -4,6 +4,7 @@ const OffersModule = require('@tryghost/members-offers');
 const config = require('../../../shared/config');
 const urlUtils = require('../../../shared/url-utils');
 const models = require('../../models');
+const OfferBookshelfRepository = require('./OfferBookshelfRepository');
 
 let redirectManager;
 
@@ -15,10 +16,13 @@ module.exports = {
                 return urlUtils.urlJoin(urlUtils.getSubdir(), pathname);
             }
         });
+        const repository = new OfferBookshelfRepository(
+            models.Offer,
+            models.OfferRedemption
+        );
         const offersModule = OffersModule.create({
-            OfferModel: models.Offer,
-            OfferRedemptionModel: models.OfferRedemption,
-            redirectManager
+            redirectManager,
+            repository
         });
 
         this.api = offersModule.api;

package/core/server/services/public-config/site.js

@@ -9,10 +9,12 @@ module.exports = function getSiteProperties() {
         description: settingsCache.get('description'),
         logo: settingsCache.get('logo'),
         icon: settingsCache.get('icon'),
+        cover_image: settingsCache.get('cover_image'),
         accent_color: settingsCache.get('accent_color'),
         locale: settingsCache.get('locale'),
         url: urlUtils.urlFor('home', true),
-        version: ghostVersion.safe
+        version: ghostVersion.safe,
+        allow_self_signup: settingsCache.get('allow_self_signup')
     };
 
     if (config.get('client_sentry') && !config.get('client_sentry').disabled) {

package/core/server/services/recommendations/RecommendationEnablerService.js

@@ -0,0 +1,28 @@
+module.exports = class RecommendationEnablerService {
+    /** @type {import('../settings/SettingsBREADService')} */
+    #settingsService;
+
+    /**
+     * @param {object} deps
+     * @param {import('../settings/SettingsBREADService')} deps.settingsService
+     */
+    constructor(deps) {
+        this.#settingsService = deps.settingsService;
+    }
+
+    /**
+     * @returns {string}
+     */
+    getSetting() {
+        this.#settingsService.read('recommendations_enabled');
+    }
+
+    /**
+     *
+     * @param {string} value
+     * @returns Promise<void>
+     */
+    async setSetting(value) {
+        this.#settingsService.edit([{key: 'recommendations_enabled', value}], {context: {internal: true}});
+    }
+};

package/core/server/services/recommendations/RecommendationServiceWrapper.js

@@ -4,6 +4,16 @@ class RecommendationServiceWrapper {
      */
     repository;
 
+    /**
+     * @type {import('@tryghost/recommendations').BookshelfClickEventRepository}
+     */
+    clickEventRepository;
+
+    /**
+     * @type {import('@tryghost/recommendations').BookshelfSubscribeEventRepository}
+     */
+    subscribeEventRepository;
+
     /**
      * @type {import('@tryghost/recommendations').RecommendationController}
      */
@@ -23,7 +33,15 @@ class RecommendationServiceWrapper {
         const urlUtils = require('../../../shared/url-utils');
         const models = require('../../models');
         const sentry = require('../../../shared/sentry');
-        const {BookshelfRecommendationRepository, RecommendationService, RecommendationController, WellknownService} = require('@tryghost/recommendations');
+        const settings = require('../settings');
+        const RecommendationEnablerService = require('./RecommendationEnablerService');
+        const {
+            BookshelfRecommendationRepository,
+            RecommendationService,
+            RecommendationController,
+            WellknownService,
+            BookshelfClickEventRepository
+        } = require('@tryghost/recommendations');
 
         const mentions = require('../mentions');
 
@@ -37,13 +55,27 @@ class RecommendationServiceWrapper {
             urlUtils
         });
 
+        const settingsService = settings.getSettingsBREADServiceInstance();
+        const recommendationEnablerService = new RecommendationEnablerService({settingsService});
+
         this.repository = new BookshelfRecommendationRepository(models.Recommendation, {
             sentry
         });
+
+        this.clickEventRepository = new BookshelfClickEventRepository(models.RecommendationClickEvent, {
+            sentry
+        });
+        this.subscribeEventRepository = new BookshelfClickEventRepository(models.RecommendationSubscribeEvent, {
+            sentry
+        });
+
         this.service = new RecommendationService({
             repository: this.repository,
+            recommendationEnablerService,
             wellknownService,
-            mentionSendingService: mentions.sendingService
+            mentionSendingService: mentions.sendingService,
+            clickEventRepository: this.clickEventRepository,
+            subscribeEventRepository: this.subscribeEventRepository
         });
         this.controller = new RecommendationController({
             service: this.service
@@ -51,6 +83,17 @@ class RecommendationServiceWrapper {
 
         // eslint-disable-next-line no-console
         this.service.init().catch(console.error);
+
+        // Add mapper to WebmentionMetadata
+        mentions.metadata.addMapper((url) => {
+            const p = '/.well-known/recommendations.json';
+            if (url.pathname.endsWith(p)) {
+                // Strip p
+                const newUrl = new URL(url.toString());
+                newUrl.pathname = newUrl.pathname.slice(0, -p.length);
+                return newUrl;
+            }
+        });
     }
 }
 

package/core/server/services/settings/SettingsBREADService.js

@@ -66,6 +66,11 @@ class SettingsBREADService {
                 const adminUrl = urlUtils.urlFor('admin', true);
                 const signinURL = new URL(adminUrl);
                 signinURL.hash = `/settings/members/?verifyEmail=${token}`;
+                // NOTE: to be removed in future, this is to ensure that the new settings are used when enabled
+                if (labsService && labsService.isSet('adminXSettings')) {
+                    signinURL.hash = `/settings-x/portal/edit?verifyEmail=${token}`;
+                }
+
                 return signinURL.href;
             }
         };
@@ -147,7 +152,7 @@ class SettingsBREADService {
      * @param {Object[]} settings
      * @param {Object} options
      * @param {Object} [options.context]
-     * @param {Object} [stripeConnectData]
+     * @param {Object|null} [stripeConnectData]
      * @returns
      */
     async edit(settings, options, stripeConnectData) {

package/core/server/services/settings/settings-service.js

@@ -87,6 +87,7 @@ module.exports = {
 
         fields.push(new CalculatedField({key: 'members_enabled', type: 'boolean', group: 'members', fn: settingsHelpers.isMembersEnabled.bind(settingsHelpers), dependents: ['members_signup_access']}));
         fields.push(new CalculatedField({key: 'members_invite_only', type: 'boolean', group: 'members', fn: settingsHelpers.isMembersInviteOnly.bind(settingsHelpers), dependents: ['members_signup_access']}));
+        fields.push(new CalculatedField({key: 'allow_self_signup', type: 'boolean', group: 'members', fn: settingsHelpers.allowSelfSignup.bind(settingsHelpers), dependents: ['members_signup_access', 'portal_plans', 'stripe_secret_key', 'stripe_publishable_key', 'stripe_connect_secret_key', 'stripe_connect_publishable_key']}));
         fields.push(new CalculatedField({key: 'paid_members_enabled', type: 'boolean', group: 'members', fn: settingsHelpers.arePaidMembersEnabled.bind(settingsHelpers), dependents: ['members_signup_access', 'stripe_secret_key', 'stripe_publishable_key', 'stripe_connect_secret_key', 'stripe_connect_publishable_key']}));
         fields.push(new CalculatedField({key: 'firstpromoter_account', type: 'string', group: 'firstpromoter', fn: settingsHelpers.getFirstpromoterId.bind(settingsHelpers), dependents: ['firstpromoter', 'firstpromoter_id']}));
         fields.push(new CalculatedField({key: 'donations_enabled', type: 'boolean', group: 'donations', fn: settingsHelpers.areDonationsEnabled.bind(settingsHelpers), dependents: ['stripe_secret_key', 'stripe_publishable_key', 'stripe_connect_secret_key', 'stripe_connect_publishable_key']}));

package/core/server/services/settings-helpers/SettingsHelpers.js

@@ -20,6 +20,13 @@ class SettingsHelpers {
         return this.settingsCache.get('members_signup_access') === 'invite';
     }
 
+    /**
+     * NOTE! The backend still allows to self signup if this returns false because a site might use built-in free signup forms apart from Portal
+     */
+    allowSelfSignup() {
+        return this.settingsCache.get('members_signup_access') === 'all' && (this.settingsCache.get('portal_plans').includes('free') || !this.arePaidMembersEnabled());
+    }
+
     /**
      * @param {'direct' | 'connect'} type - The "type" of keys to fetch from settings
      * @returns {{publicKey: string, secretKey: string} | null}

package/core/server/web/members/app.js

@@ -88,6 +88,27 @@ module.exports = function setupMembersApp() {
         announcementRouter()
     );
 
+    // Recommendations
+    membersApp.post(
+        '/api/recommendations/:id/clicked',
+        middleware.loadMemberSession,
+        http(api.recommendationsPublic.trackClicked)
+    );
+
+    // Recommendations
+    membersApp.post(
+        '/api/recommendations/:id/subscribed',
+        middleware.loadMemberSession,
+        http(api.recommendationsPublic.trackSubscribed)
+    );
+
+    // Allow external systems to read public settings via the members api
+    // Without CORS issues and without a required integration token
+    // 1. Detect if a site is Running Ghost
+    // 2. For recommendations to know when we can offer 'one-click-subscribe' to know if members are enabled
+    // Why not content API? Domain can be different from recommended domain + CORS issues
+    membersApp.get('/api/site', http(api.site.read));
+
     // API error handling
     membersApp.use('/api', errorHandler.resourceNotFound);
     membersApp.use('/api', errorHandler.handleJSONResponse(sentry));

package/core/shared/config/defaults.json

@@ -182,7 +182,7 @@
     },
     "portal": {
         "url": "https://cdn.jsdelivr.net/ghost/portal@~{version}/umd/portal.min.js",
-        "version": "2.34"
+        "version": "2.36"
     },
     "sodoSearch": {
         "url": "https://cdn.jsdelivr.net/ghost/sodo-search@~{version}/umd/sodo-search.min.js",
@@ -202,7 +202,7 @@
         "version": "0.4"
     },
     "adminX": {
-        "url": "https://cdn.jsdelivr.net/ghost/admin-x-settings@~{version}/dist/admin-x-settings.umd.js",
+        "url": "https://cdn.jsdelivr.net/ghost/admin-x-settings@~{version}/dist/admin-x-settings.js",
         "version": "0.0"
     },
     "signupForm": {

package/core/shared/settings-cache/public.js

@@ -28,6 +28,7 @@ module.exports = {
     twitter_description: 'twitter_description',
     members_support_address: 'members_support_address',
     members_enabled: 'members_enabled',
+    allow_self_signup: 'allow_self_signup',
     members_invite_only: 'members_invite_only',
     paid_members_enabled: 'paid_members_enabled',
     firstpromoter_account: 'firstpromoter_account',
@@ -40,5 +41,6 @@ module.exports = {
     portal_name: 'portal_name',
     portal_button: 'portal_button',
     comments_enabled: 'comments_enabled',
-    recommendations_enabled: 'recommendations_enabled'
+    recommendations_enabled: 'recommendations_enabled',
+    outbound_link_tagging: 'outbound_link_tagging'
 };