ghost 5.5.0 → 5.7.1

package/core/server/services/mega/post-email-serializer.js

@@ -2,15 +2,18 @@ const _ = require('lodash');
 const template = require('./template');
 const settingsCache = require('../../../shared/settings-cache');
 const urlUtils = require('../../../shared/url-utils');
+const labs = require('../../../shared/labs');
 const moment = require('moment-timezone');
 const api = require('../../api').endpoints;
 const apiShared = require('../../api').shared;
 const {URL} = require('url');
 const mobiledocLib = require('../../lib/mobiledoc');
 const htmlToPlaintext = require('../../../shared/html-to-plaintext');
+const membersService = require('../members');
 const {isUnsplashImage, isLocalContentImage} = require('@tryghost/kg-default-cards/lib/utils');
 const {textColorForBackgroundColor, darkenToContrastThreshold} = require('@tryghost/color-utils');
 const logging = require('@tryghost/logging');
+const urlService = require('../../services/url');
 
 const ALLOWED_REPLACEMENTS = ['first_name'];
 
@@ -74,6 +77,27 @@ const createUnsubscribeUrl = (uuid, newsletterUuid) => {
     return unsubscribeUrl.href;
 };
 
+/**
+ * createPostSignupUrl
+ *
+ * Takes a post object. Returns the url that should be used to signup from newsletter
+ *
+ * @param {Object} post post object
+ */
+const createPostSignupUrl = (post) => {
+    let url = urlService.getUrlByResourceId(post.id, {absolute: true});
+
+    // For email-only posts, use site url as base
+    if (post.status !== 'published' && url.match(/\/404\//)) {
+        url = urlUtils.getSiteUrl();
+    }
+
+    const signupUrl = new URL(url);
+    signupUrl.hash = `/portal/signup`;
+
+    return signupUrl.href;
+};
+
 // NOTE: serialization is needed to make sure we do post transformations such as image URL transformation from relative to absolute
 const serializePostModel = async (model) => {
     // fetch mobiledoc rather than html and plaintext so we can render email-specific contents
@@ -297,18 +321,87 @@ const serialize = async (postModel, newsletter, options = {isBrowserPreview: fal
         html: formatHtmlForEmail(htmlTemplate),
         plaintext: post.plaintext
     });
-
-    return {
+    const data = {
         subject: post.email_subject || post.title,
         html,
         plaintext
     };
+    if (labs.isSet('newsletterPaywall')) {
+        data.post = post;
+    }
+    return data;
 };
 
+/**
+ * renderPaywallCTA
+ *
+ * outputs html for rendering paywall CTA in newsletter
+ *
+ * @param {Object} post Post Object
+ */
+
+function renderPaywallCTA(post) {
+    const accentColor = settingsCache.get('accent_color');
+    const siteTitle = settingsCache.get('title') || 'Ghost';
+    const signupUrl = createPostSignupUrl(post);
+
+    return `<div class="align-center" style="text-align: center;">
+    <hr
+        style="position: relative; display: block; width: 100%; margin: 3em 0; padding: 0; height: 1px; border: 0; border-top: 1px solid #e5eff5;">
+    <h2
+        style="margin-top: 0; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; line-height: 1.11em; font-weight: 700; text-rendering: optimizeLegibility; margin: 1.5em 0 0.5em 0; font-size: 26px;">
+        Subscribe to <span style="white-space: nowrap; font-size: 26px !important;">continue reading.</span></h2>
+    <p style="margin: 0 auto 1.5em auto; line-height: 1.6em; max-width: 440px;">Become a paid member of ${siteTitle} to get access to all 
+    <span style="white-space: nowrap;">subscriber-only content.</span></p>
+    <div class="btn btn-accent" style="box-sizing: border-box; width: 100%; display: table;">
+        <table border="0" cellspacing="0" cellpadding="0" align="center"
+            style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: auto;">
+            <tbody>
+                <tr>
+                    <td align="center"
+                        style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; vertical-align: top; text-align: center; border-radius: 5px;"
+                        valign="top" bgcolor="${accentColor}">
+                        <a href="${signupUrl}"
+                            style="overflow-wrap: anywhere; border: solid 1px #3498db; border-radius: 5px; box-sizing: border-box; cursor: pointer; display: inline-block; font-size: 14px; font-weight: bold; margin: 0; padding: 12px 25px; text-decoration: none; background-color: ${accentColor}; border-color: ${accentColor}; color: #FFFFFF;"
+                            target="_blank">Subscribe
+                        </a>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+    </div>
+    <p style="margin: 0 0 1.5em 0; line-height: 1.6em;"></p>
+</div>`;
+}
+
 function renderEmailForSegment(email, memberSegment) {
     const cheerio = require('cheerio');
 
     const result = {...email};
+
+    /** Checks and hides content for newsletter behind paywall card
+     *  based on member's status and post access
+     *  Adds CTA in case content is hidden.
+    */
+    if (labs.isSet('newsletterPaywall')) {
+        const paywallIndex = (result.html || '').indexOf('<!--members-only-->');
+        if (paywallIndex !== -1 && memberSegment && result.post) {
+            let statusFilter = memberSegment === 'status:free' ? {status: 'free'} : {status: 'paid'};
+            const postVisiblity = result.post.visibility;
+
+            // For newsletter paywall, specific tiers visibility is considered on par to paid tiers
+            result.post.visibility = postVisiblity === 'tiers' ? 'paid' : postVisiblity;
+
+            const memberHasAccess = membersService.contentGating.checkPostAccess(result.post, statusFilter);
+
+            if (!memberHasAccess) {
+                const postContentEndIdx = result.html.search(/[\s\n\r]+?<!-- POST CONTENT END -->/);
+                result.html = result.html.slice(0, paywallIndex) + renderPaywallCTA(result.post) + result.html.slice(postContentEndIdx);
+                result.plaintext = htmlToPlaintext.excerpt(result.html);
+            }
+        }
+    }
+
     const $ = cheerio.load(result.html);
 
     $('[data-gh-segment]').get().forEach((node) => {
@@ -322,6 +415,7 @@ function renderEmailForSegment(email, memberSegment) {
 
     result.html = formatHtmlForEmail($.html());
     result.plaintext = htmlToPlaintext.email(result.html);
+    delete result.post;
 
     return result;
 }
@@ -329,6 +423,7 @@ function renderEmailForSegment(email, memberSegment) {
 module.exports = {
     serialize,
     createUnsubscribeUrl,
+    createPostSignupUrl,
     renderEmailForSegment,
     parseReplacements,
     // Export for tests

package/core/server/services/mega/segment-parser.js

@@ -1,11 +1,20 @@
+const labs = require('../../../shared/labs');
+
 const getSegmentsFromHtml = (html) => {
     const cheerio = require('cheerio');
     const $ = cheerio.load(html);
 
-    const allSegments = $('[data-gh-segment]')
+    let allSegments = $('[data-gh-segment]')
         .get()
         .map(el => el.attribs['data-gh-segment']);
 
+    /**
+     * Always add free and paid segments if email has paywall card
+     */
+    if (labs.isSet('newsletterPaywall') && html.indexOf('<!--members-only-->') !== -1) {
+        allSegments = allSegments.concat(['status:free', 'status:-free']);
+    }
+
     // only return unique elements
     return [...new Set(allSegments)];
 };

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

@@ -148,10 +148,15 @@ module.exports = {
             }
         })();
 
-        try {
-            await stripeService.migrations.execute();
-        } catch (err) {
-            logging.error(err);
+        const membersMigrationJobName = 'members-migrations';
+        if (!(await jobsService.hasExecutedSuccessfully(membersMigrationJobName))) {
+            jobsService.addOneOffJob({
+                name: membersMigrationJobName,
+                offloaded: false,
+                job: stripeService.migrations.execute.bind(stripeService.migrations)
+            });
+
+            await jobsService.awaitCompletion(membersMigrationJobName);
         }
     },
     contentGating: require('./content-gating'),

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

@@ -1,4 +1,5 @@
 const debug = require('@tryghost/debug')('web:admin:app');
+const path = require('path');
 const express = require('../../../shared/express');
 const serveStatic = express.static;
 const config = require('../../../shared/config');
@@ -16,8 +17,9 @@ module.exports = function setupAdminApp() {
     // Admin assets
     // @TODO ensure this gets a local 404 error handler
     const configMaxAge = config.get('caching:admin:maxAge');
+    const envDir = config.get('env') === 'production' ? 'production' : 'development';
     adminApp.use('/assets', serveStatic(
-        config.get('paths').adminAssets,
+        path.join(config.get('paths').adminAssets, envDir, 'assets'),
         {maxAge: (configMaxAge || configMaxAge === 0) ? configMaxAge : constants.ONE_YEAR_MS, fallthrough: false}
     ));
 

package/core/server/web/admin/controller.js

@@ -29,8 +29,8 @@ module.exports = function adminController(req, res) {
     // CASE: trigger update check unit and let it run in background, don't block the admin rendering
     updateCheck();
 
-    const defaultTemplate = config.get('env') === 'production' ? 'default-prod.html' : 'default.html';
-    const templatePath = path.resolve(config.get('paths').adminViews, defaultTemplate);
+    const envDir = config.get('env') === 'production' ? 'production' : 'development';
+    const templatePath = path.resolve(config.get('paths').adminAssets, envDir, 'index.html');
     const headers = {};
 
     try {

package/core/server/web/comments/routes.js

@@ -13,18 +13,18 @@ module.exports = function apiRoutes() {
     // Global handling for member session, ensures a member is logged in to the frontend
     router.use(membersService.middleware.loadMemberSession);
 
-    router.post('/counts', http(api.commentsComments.counts));
+    router.post('/counts', http(api.commentsMembers.counts));
 
-    router.get('/', http(api.commentsComments.browse));
-    router.get('/:id', http(api.commentsComments.read));
-    router.post('/', http(api.commentsComments.add));
-    router.put('/:id', http(api.commentsComments.edit));
-    router.delete('/:id', http(api.commentsComments.destroy));
+    router.get('/', http(api.commentsMembers.browse));
+    router.get('/:id', http(api.commentsMembers.read));
+    router.post('/', http(api.commentsMembers.add));
+    router.put('/:id', http(api.commentsMembers.edit));
+    router.delete('/:id', http(api.commentsMembers.destroy));
 
-    router.post('/:id/like', http(api.commentsComments.like));
-    router.delete('/:id/like', http(api.commentsComments.unlike));
+    router.post('/:id/like', http(api.commentsMembers.like));
+    router.delete('/:id/like', http(api.commentsMembers.unlike));
 
-    router.post('/:id/report', http(api.commentsComments.report));
+    router.post('/:id/report', http(api.commentsMembers.report));
 
     return router;
 };

package/core/shared/config/defaults.json

@@ -147,7 +147,7 @@
         "version": "0.2"
     },
     "editor": {
-        "url": ""
+        "url": "https://cdn.jsdelivr.net/npm/@tryghost/koenig-react/dist/umd/koenig-react.min.js"
     },
     "tenor": {
         "publicReadOnlyApiKey": null,

package/core/shared/config/overrides.json

@@ -2,10 +2,9 @@
     "paths": {
         "appRoot": ".",
         "corePath": "core/",
-        "adminAssets": "core/built/assets",
+        "adminAssets": "core/built/admin",
         "adminAuthAssets": "content/public/admin-auth",
         "helperTemplates": "core/frontend/helpers/tpl/",
-        "adminViews": "core/server/web/admin/views/",
         "defaultViews": "core/server/views/",
         "defaultRouteSettings": "core/server/services/route-settings/",
         "internalAppPath": "core/frontend/apps/",

package/core/shared/html-to-plaintext.js

@@ -34,6 +34,7 @@ const baseSettings = {
 
 let excerptConverter;
 let emailConverter;
+let commentConverter;
 
 const loadConverters = () => {
     if (excerptConverter && emailConverter) {
@@ -63,8 +64,19 @@ const loadConverters = () => {
         ]
     });
 
+    const commentSettings = mergeSettings({
+        preserveNewlines: false,
+        selectors: [
+            // equiv hideLinkHrefIfSameAsText: true
+            {selector: 'a', options: {hideLinkHrefIfSameAsText: true}},
+            // No space between <p> tags. An empty <p> is needed
+            {selector: 'p', options: {leadingLineBreaks: 1, trailingLineBreaks: 1}}
+        ]
+    });
+
     excerptConverter = compile(excerptSettings);
     emailConverter = compile(emailSettings);
+    commentConverter = compile(commentSettings);
 };
 
 module.exports.excerpt = (html) => {
@@ -78,3 +90,9 @@ module.exports.email = (html) => {
 
     return emailConverter(html);
 };
+
+module.exports.comment = (html) => {
+    loadConverters();
+
+    return commentConverter(html);
+};

package/core/shared/labs.js

@@ -14,7 +14,9 @@ const messages = {
 };
 
 // flags in this list always return `true`, allows quick global enable prior to full flag removal
-const GA_FEATURES = [];
+const GA_FEATURES = [
+    'newsletterPaywall'
+];
 
 // NOTE: this allowlist is meant to be used to filter out any unexpected
 //       input for the "labs" setting value
@@ -25,7 +27,9 @@ const BETA_FEATURES = [
 const ALPHA_FEATURES = [
     'urlCache',
     'beforeAfterCard',
-    'comments'
+    'comments',
+    'explore',
+    'freeTrial'
 ];
 
 module.exports.GA_KEYS = [...GA_FEATURES];

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

@@ -4,77 +4,91 @@
 const debug = require('@tryghost/debug')('settings:cache');
 const _ = require('lodash');
 
-const publicSettings = require('./public');
-
-// Local function, only ever used for initializing
-// We deliberately call "set" on each model so that set is a consistent interface
-const updateSettingFromModel = function updateSettingFromModel(settingModel) {
-    debug('Auto updating', settingModel.get('key'));
-    module.exports.set(settingModel.get('key'), settingModel.toJSON());
-};
-
-const updateCalculatedField = function updateCalculatedField(field) {
-    return () => {
-        debug('Auto updating', field.key);
-        module.exports.set(field.key, field.getSetting());
-    };
-};
-
 /**
- * ## Cache
- * Holds cached settings
- * Keyed by setting.key
- * Contains the JSON version of the model
- * @type {{}} - object of objects
+ * Why hasn't this been moved to @tryghost/settings-cache yet?
+ *
+ * - It currently still couples the frontend and server together in a weird way via the event system
+ * - See the notes in core/server/lib/common/events
+ * - There's also a plan to introduce a proper caching layer, and rewrite this on top of that
  */
-let settingsCache = {};
-let _calculatedFields = [];
+class CacheManager {
+    /**
+     * @prop {Object} options
+     * @prop {{}} options.cache - object of objects. Holds cached settings, keyed by setting.key, contains the JSON version of the model
+     * @prop {Object} options.publicSettings - key/value pairs of settings which are publicly accessible
+     */
+    constructor({cache, publicSettings}) {
+        this.settingsCache = cache;
+        this.publicSettings = publicSettings;
+        this.calculatedFields = [];
+
+        this.get = this.get.bind(this);
+        this.set = this.set.bind(this);
+        this.getAll = this.getAll.bind(this);
+        this.getPublic = this.getPublic.bind(this);
+        this.reset = this.reset.bind(this);
+        this._doGet = this._doGet.bind(this);
+        this._updateSettingFromModel = this._updateSettingFromModel.bind(this);
+        this._updateCalculatedField = this._updateCalculatedField.bind(this);
+    }
 
-const doGet = (key, options) => {
-    if (!settingsCache[key]) {
-        return;
+    // Local function, only ever used for initializing
+    // We deliberately call "set" on each model so that set is a consistent interface
+    _updateSettingFromModel(settingModel) {
+        debug('Auto updating', settingModel.get('key'));
+        this.set(settingModel.get('key'), settingModel.toJSON());
     }
 
-    // Don't try to resolve to the value of the setting
-    if (options && options.resolve === false) {
-        return settingsCache[key];
+    _updateCalculatedField(field) {
+        return () => {
+            debug('Auto updating', field.key);
+            this.set(field.key, field.getSetting());
+        };
     }
 
-    // Default behaviour is to try to resolve the value and return that
-    try {
-        // CASE: handle literal false
-        if (settingsCache[key].value === false || settingsCache[key].value === 'false') {
-            return false;
+    _doGet(key, options) {
+        if (!this.settingsCache[key]) {
+            return;
         }
 
-        // CASE: if a string contains a number e.g. "1", JSON.parse will auto convert into integer
-        if (!isNaN(Number(settingsCache[key].value))) {
-            return settingsCache[key].value || null;
+        // Don't try to resolve to the value of the setting
+        if (options && options.resolve === false) {
+            return this.settingsCache[key];
         }
 
-        return JSON.parse(settingsCache[key].value) || null;
-    } catch (err) {
-        return settingsCache[key].value || null;
+        // Default behaviour is to try to resolve the value and return that
+        try {
+            // CASE: handle literal false
+            if (this.settingsCache[key].value === false || this.settingsCache[key].value === 'false') {
+                return false;
+            }
+
+            // CASE: if a string contains a number e.g. "1", JSON.parse will auto convert into integer
+            if (!isNaN(Number(this.settingsCache[key].value))) {
+                return this.settingsCache[key].value || null;
+            }
+
+            return JSON.parse(this.settingsCache[key].value) || null;
+        } catch (err) {
+            return this.settingsCache[key].value || null;
+        }
     }
-};
 
-/**
- *
- * IMPORTANT:
- * We store settings with a type and a key in the database.
- *
- * {
- *   type: core
- *   key: db_hash
- *   value: ...
- * }
- *
- * But the settings cache does not allow requesting a value by type, only by key.
- * e.g. settingsCache.get('db_hash')
- */
-module.exports = {
     /**
-     * Get a key from the settingsCache
+     *
+     * IMPORTANT:
+     * We store settings with a type and a key in the database.
+     *
+     * {
+     *   type: core
+     *   key: db_hash
+     *   value: ...
+     * }
+     *
+     * But the settings cache does not allow requesting a value by type, only by key.
+     * e.g. settingsCache.get('db_hash')
+     *
+     * Get a key from the this.settingsCache
      * Will resolve to the value, including parsing JSON, unless {resolve: false} is passed in as an option
      * In which case the full JSON version of the model will be resolved
      *
@@ -83,8 +97,9 @@ module.exports = {
      * @return {*}
      */
     get(key, options) {
-        return doGet(key, options);
-    },
+        return this._doGet(key, options);
+    }
+
     /**
      * Set a key on the cache
      * The only way to get an object into the cache
@@ -93,16 +108,17 @@ module.exports = {
      * @param {object} value json version of settings model
      */
     set(key, value) {
-        settingsCache[key] = _.cloneDeep(value);
-    },
+        this.settingsCache[key] = _.cloneDeep(value);
+    }
+
     /**
      * Get the entire cache object
      * Uses clone to prevent modifications from being reflected
      * @return {object} cache
      */
     getAll() {
-        return _.cloneDeep(settingsCache);
-    },
+        return _.cloneDeep(this.settingsCache);
+    }
 
     /**
      * Get all the publically accessible cache entries with their correct names
@@ -112,12 +128,13 @@ module.exports = {
     getPublic() {
         let settings = {};
 
-        _.each(publicSettings, (key, newKey) => {
-            settings[newKey] = doGet(key) ?? null;
+        _.each(this.publicSettings, (key, newKey) => {
+            settings[newKey] = this._doGet(key) ?? null;
         });
 
         return settings;
-    },
+    }
+
     /**
      * Initialise the cache
      *
@@ -134,45 +151,47 @@ module.exports = {
 
         // // if we have been passed a collection of settings, use this to populate the cache
         if (settingsCollection && settingsCollection.models) {
-            _.each(settingsCollection.models, updateSettingFromModel);
+            _.each(settingsCollection.models, this._updateSettingFromModel);
         }
 
-        _calculatedFields = Array.isArray(calculatedFields) ? calculatedFields : [];
+        this.calculatedFields = Array.isArray(calculatedFields) ? calculatedFields : [];
 
         // Bind to events to automatically keep up-to-date
-        events.on('settings.edited', updateSettingFromModel);
-        events.on('settings.added', updateSettingFromModel);
-        events.on('settings.deleted', updateSettingFromModel);
+        events.on('settings.edited', this._updateSettingFromModel);
+        events.on('settings.added', this._updateSettingFromModel);
+        events.on('settings.deleted', this._updateSettingFromModel);
 
         // set and bind calculated fields
-        _calculatedFields.forEach((field) => {
-            updateCalculatedField(field)();
+        this.calculatedFields.forEach((field) => {
+            this._updateCalculatedField(field)();
             field.dependents.forEach((dependent) => {
-                events.on(`settings.${dependent}.edited`, updateCalculatedField(field));
+                events.on(`settings.${dependent}.edited`, this._updateCalculatedField(field));
             });
         });
 
-        return settingsCache;
-    },
+        return this.settingsCache;
+    }
 
     /**
      * Reset both the cache and the listeners, must be called during init
      * @param {EventEmitter} events
      */
     reset(events) {
-        settingsCache = {};
+        this.settingsCache = {};
 
-        events.removeListener('settings.edited', updateSettingFromModel);
-        events.removeListener('settings.added', updateSettingFromModel);
-        events.removeListener('settings.deleted', updateSettingFromModel);
+        events.removeListener('settings.edited', this._updateSettingFromModel);
+        events.removeListener('settings.added', this._updateSettingFromModel);
+        events.removeListener('settings.deleted', this._updateSettingFromModel);
 
         //unbind calculated fields
-        _calculatedFields.forEach((field) => {
+        this.calculatedFields.forEach((field) => {
             field.dependents.forEach((dependent) => {
-                events.removeListener(`settings.${dependent}.edited`, updateCalculatedField(field));
+                events.removeListener(`settings.${dependent}.edited`, this._updateCalculatedField(field));
             });
         });
 
-        _calculatedFields = [];
+        this.calculatedFields = [];
     }
-};
+}
+
+module.exports = CacheManager;

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

@@ -1,9 +1,7 @@
-/**
- * Why hasn't this been moved to @tryghost/settings-cache yet?
- *
- * - It currently still couples the frontend and server together in a weird way via the event system
- * - See the notes in core/server/lib/common/events
- * - There's also a plan to introduce a proper caching layer, and rewrite this on top of that
- * - Finally, I'm not sure if this shouldn't be two things - a cache, and a cache manager (the update system)
- */
-module.exports = require('./cache');
+const CacheManager = require('./cache');
+const publicSettings = require('./public');
+const cache = {};
+
+const cacheManager = new CacheManager({cache, publicSettings});
+
+module.exports = cacheManager;