ghost 4.48.0 → 5.0.0

package/core/server/services/auth/setup.js

@@ -108,8 +108,8 @@ async function doSettings(data, settingsAPI) {
 }
 
 // Update names for default product and newsletter to site title
-async function doProductAndNewsletter(data, api) {
-    const {products: productsAPI, newsletters: newslettersAPI} = api;
+async function doTiersAndNewsletter(data, api) {
+    const {tiers: tiersAPI, newsletters: newslettersAPI} = api;
     const context = {context: {user: data.user.id}};
     const user = data.user;
     const blogTitle = data.userData.blogTitle;
@@ -118,16 +118,16 @@ async function doProductAndNewsletter(data, api) {
         return user;
     }
     try {
-        const productPage = await productsAPI.browse({limit: 'all'});
+        const tierPage = await tiersAPI.browse({limit: 'all'});
         const newsletterPage = await newslettersAPI.browse({limit: 'all'});
 
-        const defaultProduct = productPage.products.find(p => p.slug === 'default-product');
+        const defaultTier = tierPage.tiers.find(p => p.slug === 'default-product');
         const defaultNewsletter = newsletterPage.newsletters.find(p => p.slug === 'default-newsletter');
 
-        if (defaultProduct) {
-            await productsAPI.edit({products: [{
+        if (defaultTier) {
+            await tiersAPI.edit({tiers: [{
                 name: blogTitle.trim()
-            }]}, {context: context.context, id: defaultProduct.id});
+            }]}, {context: context.context, id: defaultTier.id});
         }
 
         if (defaultNewsletter) {
@@ -231,7 +231,7 @@ module.exports = {
     assertSetupCompleted: assertSetupCompleted,
     setupUser: setupUser,
     doSettings: doSettings,
-    doProductAndNewsletter: doProductAndNewsletter,
+    doProductAndNewsletter: doTiersAndNewsletter,
     installTheme: installTheme,
     doFixtures: doFixtures,
     sendWelcomeEmail: sendWelcomeEmail

package/core/server/services/bulk-email/bulk-email-processor.js

@@ -167,6 +167,9 @@ module.exports = {
         await emailBatchModel.save({status: 'submitting'}, knexOptions);
 
         try {
+            // Load newsletter data on email
+            await emailBatchModel.relations.email.related('newsletter').fetch(Object.assign({}, {require: false}, knexOptions));
+
             // send the email
             const sendResponse = await this.send(emailBatchModel.relations.email.toJSON(), recipientRows, memberSegment);
 
@@ -217,11 +220,12 @@ module.exports = {
 
         // collate static and dynamic data for each recipient ready for provider
         const recipientData = {};
+        const newsletterUuid = emailData.newsletter ? emailData.newsletter.uuid : null;
         recipients.forEach((recipient) => {
             // static data for every recipient
             const data = {
                 unique_id: recipient.member_uuid,
-                unsubscribe_url: postEmailSerializer.createUnsubscribeUrl(recipient.member_uuid)
+                unsubscribe_url: postEmailSerializer.createUnsubscribeUrl(recipient.member_uuid, newsletterUuid)
             };
 
             // computed properties on recipients - TODO: better way of handling these

package/core/server/services/frontend-data-service/frontend-data-service.js

@@ -0,0 +1,27 @@
+const errors = require('@tryghost/errors');
+const logging = require('@tryghost/logging');
+
+class FrontendDataService {
+    constructor({IntegrationModel}) {
+        this.IntegrationModel = IntegrationModel;
+        this.frontendKey = null;
+    }
+
+    async getFrontendKey() {
+        if (this.frontendKey) {
+            return this.frontendKey;
+        }
+
+        try {
+            const key = await this.IntegrationModel.getInternalFrontendKey();
+            this.frontendKey = key.toJSON().api_keys[0].secret;
+        } catch (error) {
+            this.frontendKey = null;
+            logging.error(new errors.InternalServerError({message: 'Unable to find the internal frontend key', err: error}));
+        }
+
+        return this.frontendKey;
+    }
+}
+
+module.exports = FrontendDataService;

package/core/server/services/frontend-data-service/index.js

@@ -0,0 +1,6 @@
+const models = require('../../models');
+const FrontendDataService = require('./frontend-data-service');
+
+module.exports.init = () => {
+    return new FrontendDataService({IntegrationModel: models.Integration});
+};

package/core/server/services/mail/index.js

@@ -1,2 +1,15 @@
+const path = require('path');
+const urlUtils = require('../../../shared/url-utils');
+const settingsCache = require('../../../shared/settings-cache');
+const EmailContentGenerator = require('@tryghost/email-content-generator');
+
+const emailContentGenerator = new EmailContentGenerator({
+    getSiteUrl: () => urlUtils.urlFor('home', true),
+    getSiteTitle: () => settingsCache.get('title'),
+    templatesDir: path.resolve(__dirname, '..', 'mail', 'templates')
+});
+
 exports.GhostMailer = require('./GhostMailer');
-exports.utils = require('./utils');
+exports.utils = {
+    generateContent: emailContentGenerator.getContent.bind(emailContentGenerator)
+};

package/core/server/services/mega/email-preview.js

@@ -2,26 +2,25 @@ const postEmailSerializer = require('./post-email-serializer');
 const models = require('../../models');
 
 class EmailPreview {
-    /**
-     * @constructor
-     * @param {Object} options
-     * @param {String} options.apiVersion
-     */
-    constructor({apiVersion}) {
-        this.apiVersion = apiVersion;
-    }
-
     /**
      * @param {Object} post - Post model object instance
-     * @param {String} memberSegment - member segment filter
+     * @param {Object} options
+     * @param {String} options.newsletter - newsletter slug
+     * @param {String} options.memberSegment - member segment filter
      * @returns {Promise<Object>}
      */
-    async generateEmailContent(post, memberSegment) {
-        const newsletter = await models.Newsletter.getDefaultNewsletter();
+    async generateEmailContent(post, {newsletter, memberSegment} = {}) {
+        let newsletterModel = post.relations.newsletter ?? await post.related('newsletter').fetch();
+        if (!newsletterModel) {
+            if (newsletter) {
+                newsletterModel = await models.Newsletter.findOne({slug: newsletter});
+            } else {
+                newsletterModel = await models.Newsletter.getDefaultNewsletter();
+            }
+        }
 
-        let emailContent = await postEmailSerializer.serialize(post, newsletter, {
-            isBrowserPreview: true,
-            apiVersion: this.apiVersion
+        let emailContent = await postEmailSerializer.serialize(post, newsletterModel, {
+            isBrowserPreview: true
         });
 
         if (memberSegment) {

package/core/server/services/mega/mega.js

@@ -17,7 +17,6 @@ const models = require('../../models');
 const postEmailSerializer = require('./post-email-serializer');
 const labs = require('../../../shared/labs');
 const {getSegmentsFromHtml} = require('./segment-parser');
-const labsService = require('../../../shared/labs');
 
 // Used to listen to email.added and email.edited model events originally, I think to offload this - ideally would just use jobs now if possible
 const events = require('../../lib/common/events');
@@ -28,6 +27,7 @@ const messages = {
     noneFilterError: 'Cannot send email to "none" {property}',
     emailSendingDisabled: `Email sending is temporarily disabled because your account is currently in review. You should have an email about this from us already, but you can also reach us any time at support@ghost.org`,
     sendEmailRequestFailed: 'The email service was unable to send an email batch.',
+    archivedNewsletterError: 'Cannot send email to archived newsletters',
     newsletterVisibilityError: 'Unexpected visibility value "{value}". Use one of the valid: "members", "paid".'
 };
 
@@ -51,11 +51,11 @@ const getReplyToAddress = (fromAddress, replyAddressOption) => {
  *
  * @param {Object} postModel - post model instance
  * @param {Object} options
- * @param {ValidAPIVersion} options.apiVersion - api version to be used when serializing email data
  */
 const getEmailData = async (postModel, options) => {
-    let newsletter = postModel.relations.newsletter ? postModel.relations.newsletter : (await postModel.related('newsletter').fetch());
+    let newsletter = postModel.relations.newsletter ?? await postModel.related('newsletter').fetch();
     if (!newsletter) {
+        // The postModel doesn't have a newsletter in test emails
         newsletter = await models.Newsletter.getDefaultNewsletter();
     }
     const {subject, html, plaintext} = await postEmailSerializer.serialize(postModel, newsletter, options);
@@ -83,11 +83,10 @@ const getEmailData = async (postModel, options) => {
  *
  * @param {Object} postModel - post model instance
  * @param {[string]} toEmails - member email addresses to send email to
- * @param {ValidAPIVersion} apiVersion - api version to be used when serializing email data
  * @param {ValidMemberSegment} [memberSegment]
  */
-const sendTestEmail = async (postModel, toEmails, apiVersion, memberSegment) => {
-    let emailData = await getEmailData(postModel, {apiVersion});
+const sendTestEmail = async (postModel, toEmails, memberSegment) => {
+    let emailData = await getEmailData(postModel);
     emailData.subject = `[Test] ${emailData.subject}`;
 
     if (memberSegment) {
@@ -134,28 +133,14 @@ const sendTestEmail = async (postModel, toEmails, apiVersion, memberSegment) =>
  *
  * Accepts a filter string, errors on unexpected legacy filter syntax and enforces subscribed:true
  *
+ * @param {Object} newsletter
  * @param {string} emailRecipientFilter NQL filter for members
- * @param {object} options
+ * @param {string} errorProperty
  */
-const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'email_recipient_filter'} = {}, newsletter = null) => {
-    let filter = [];
-
-    if (!newsletter) {
-        filter.push(`subscribed:true`);
-    } else {
-        filter.push(`newsletters.id:${newsletter.id}`);
-    }
+const transformEmailRecipientFilter = (newsletter, emailRecipientFilter, errorProperty) => {
+    const filter = [`newsletters.id:${newsletter.id}`];
 
     switch (emailRecipientFilter) {
-    // `paid` and `free` were swapped out for NQL filters in 4.5.0, we shouldn't see them here now
-    case 'paid':
-    case 'free':
-        throw new errors.InternalServerError({
-            message: tpl(messages.unexpectedFilterError, {
-                property: errorProperty,
-                value: emailRecipientFilter
-            })
-        });
     case 'all':
         break;
     case 'none':
@@ -169,22 +154,20 @@ const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'e
         break;
     }
 
-    if (newsletter) {
-        const visibility = newsletter.get('visibility');
-        switch (visibility) {
-        case 'members':
-            // No need to add a member status filter as the email is available to all members
-            break;
-        case 'paid':
-            filter.push(`status:-free`);
-            break;
-        default:
-            throw new errors.InternalServerError({
-                message: tpl(messages.newsletterVisibilityError, {
-                    value: visibility
-                })
-            });
-        }
+    const visibility = newsletter.get('visibility');
+    switch (visibility) {
+    case 'members':
+        // No need to add a member status filter as the email is available to all members
+        break;
+    case 'paid':
+        filter.push(`status:-free`);
+        break;
+    default:
+        throw new errors.InternalServerError({
+            message: tpl(messages.newsletterVisibilityError, {
+                value: visibility
+            })
+        });
     }
 
     return filter.join('+');
@@ -198,8 +181,6 @@ const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'e
  *
  * @param {object} postModel Post Model Object
  * @param {object} options
- * @param {ValidAPIVersion} options.apiVersion - api version to be used when serializing email data
- * @param {string} options.newsletter_id - the newsletter_id to send the email to
  */
 
 const addEmail = async (postModel, options) => {
@@ -216,10 +197,19 @@ const addEmail = async (postModel, options) => {
     const knexOptions = _.pick(options, ['transacting', 'forUpdate']);
     const filterOptions = {...knexOptions, limit: 1};
 
-    const newsletter = postModel.relations.newsletter ? postModel.relations.newsletter : (await postModel.related('newsletter').fetch({require: true, ..._.pick(options, ['transacting'])}));
+    // TODO: this is a hack for https://github.com/TryGhost/Team/issues/1626
+    const newsletter = postModel.relations.newsletter ?? await postModel.related('newsletter').fetch({require: true, ..._.pick(options, ['transacting'])});
+
+    if (newsletter.get('status') !== 'active') {
+        // A post might have been scheduled to an archived newsletter.
+        // Don't send it (people can't unsubscribe any longer).
+        throw new errors.EmailError({
+            message: tpl(messages.archivedNewsletterError)
+        });
+    }
 
     const emailRecipientFilter = postModel.get('email_recipient_filter');
-    filterOptions.filter = transformEmailRecipientFilter(emailRecipientFilter, {errorProperty: 'email_recipient_filter'}, newsletter);
+    filterOptions.filter = transformEmailRecipientFilter(newsletter, emailRecipientFilter, 'email_segment');
 
     const startRetrieve = Date.now();
     debug('addEmail: retrieving members count');
@@ -426,11 +416,8 @@ async function getEmailMemberRows({emailModel, memberSegment, options}) {
     const knexOptions = _.pick(options, ['transacting', 'forUpdate']);
     const filterOptions = Object.assign({}, knexOptions);
 
-    let newsletter = null;
-    if (labsService.isSet('multipleNewsletters')) {
-        newsletter = emailModel.relations.newsletter ? emailModel.relations.newsletter : (await emailModel.related('newsletter').fetch(Object.assign({}, {require: false}, _.pick(options, ['transacting']))));
-    }
-    const recipientFilter = transformEmailRecipientFilter(emailModel.get('recipient_filter'), {errorProperty: 'recipient_filter'}, newsletter);
+    const newsletter = emailModel.relations.newsletter ?? await emailModel.related('newsletter').fetch(Object.assign({}, {require: true}, _.pick(options, ['transacting'])));
+    const recipientFilter = transformEmailRecipientFilter(newsletter, emailModel.get('recipient_filter'), 'recipient_filter');
     filterOptions.filter = recipientFilter;
 
     if (memberSegment) {
@@ -609,11 +596,9 @@ module.exports = {
     _partitionMembersBySegment: partitionMembersBySegment,
     _getEmailMemberRows: getEmailMemberRows,
     _getFromAddress: getFromAddress,
-    _getReplyToAddress: getReplyToAddress,
-    _sendEmailJob: sendEmailJob
+    _getReplyToAddress: getReplyToAddress
 };
 
 /**
- * @typedef {'v2' | 'v3' | 'v4' | 'canary' } ValidAPIVersion
  * @typedef {'status:free' | 'status:-free'} ValidMemberSegment
  */

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

@@ -3,10 +3,11 @@ const template = require('./template');
 const settingsCache = require('../../../shared/settings-cache');
 const urlUtils = require('../../../shared/url-utils');
 const moment = require('moment-timezone');
-const api = require('../../api');
+const api = require('../../api').endpoints;
+const apiShared = require('../../api').shared;
 const {URL} = require('url');
 const mobiledocLib = require('../../lib/mobiledoc');
-const htmlToText = require('html-to-text');
+const htmlToPlaintext = require('../../../shared/html-to-plaintext');
 const {isUnsplashImage, isLocalContentImage} = require('@tryghost/kg-default-cards/lib/utils');
 const {textColorForBackgroundColor, darkenToContrastThreshold} = require('@tryghost/color-utils');
 const logging = require('@tryghost/logging');
@@ -48,29 +49,16 @@ const getSite = () => {
     });
 };
 
-const htmlToPlaintext = (html) => {
-    // same options as used in Post model for generating plaintext but without `wordwrap: 80`
-    // to avoid replacement strings being split across lines and for mail clients to handle
-    // word wrapping based on user preferences
-    return htmlToText.fromString(html, {
-        wordwrap: false,
-        ignoreImage: true,
-        hideLinkHrefIfSameAsText: true,
-        preserveNewlines: true,
-        returnDomByDefault: true,
-        uppercaseHeadings: false
-    });
-};
-
 /**
  * createUnsubscribeUrl
  *
- * Takes a member uuid and returns the url that should be used to unsubscribe
+ * Takes a member and newsletter uuid. Returns the url that should be used to unsubscribe
  * In case of no member uuid, generates the preview unsubscribe url - `?preview=1`
  *
- * @param {string} uuid
+ * @param {string} uuid post uuid
+ * @param {string} newsletterUuid newsletter uuid
  */
-const createUnsubscribeUrl = (uuid) => {
+const createUnsubscribeUrl = (uuid, newsletterUuid) => {
     const siteUrl = urlUtils.getSiteUrl();
     const unsubscribeUrl = new URL(siteUrl);
     unsubscribeUrl.pathname = `${unsubscribeUrl.pathname}/unsubscribe/`.replace('//', '/');
@@ -79,21 +67,23 @@ const createUnsubscribeUrl = (uuid) => {
     } else {
         unsubscribeUrl.searchParams.set('preview', '1');
     }
+    if (newsletterUuid) {
+        unsubscribeUrl.searchParams.set('newsletter', newsletterUuid);
+    }
 
     return unsubscribeUrl.href;
 };
 
-// NOTE: serialization is needed to make sure we are using current API and do post transformations
-//       such as image URL transformation from relative to absolute
-const serializePostModel = async (model, apiVersion = 'v4') => {
+// 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
     const frame = {options: {context: {user: true}, formats: 'mobiledoc'}};
     const docName = 'posts';
 
-    await api.shared
+    await apiShared
         .serializers
         .handle
-        .output(model, {docName: docName, method: 'read'}, api[apiVersion].serializers.output, frame);
+        .output(model, {docName: docName, method: 'read'}, api.serializers.output, frame);
 
     return frame.response[docName][0];
 };
@@ -222,8 +212,8 @@ const getTemplateSettings = async (newsletter) => {
     return templateSettings;
 };
 
-const serialize = async (postModel, newsletter, options = {isBrowserPreview: false, apiVersion: 'v4'}) => {
-    const post = await serializePostModel(postModel, options.apiVersion);
+const serialize = async (postModel, newsletter, options = {isBrowserPreview: false}) => {
+    const post = await serializePostModel(postModel);
 
     const timezone = settingsCache.get('timezone');
     const momentDate = post.published_at ? moment(post.published_at) : moment();
@@ -258,7 +248,7 @@ const serialize = async (postModel, newsletter, options = {isBrowserPreview: fal
     `).remove();
     post.html = _cheerio('body').html();
 
-    post.plaintext = htmlToPlaintext(post.html);
+    post.plaintext = htmlToPlaintext.email(post.html);
 
     // Outlook will render feature images at full-size breaking the layout.
     // Content images fix this by rendering max 600px images - do the same for feature image here
@@ -331,7 +321,7 @@ function renderEmailForSegment(email, memberSegment) {
     });
 
     result.html = formatHtmlForEmail($.html());
-    result.plaintext = htmlToPlaintext(result.html);
+    result.plaintext = htmlToPlaintext.email(result.html);
 
     return result;
 }

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

@@ -170,9 +170,6 @@ function createApiInstance(config) {
                 }
             }
         },
-        paymentConfig: {
-            stripe: config.getStripePaymentConfig()
-        },
         models: {
             EmailRecipient: models.EmailRecipient,
             StripeCustomer: models.MemberStripeCustomer,

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

@@ -53,36 +53,6 @@ class MembersConfigProvider {
         return this.getEmailSupportAddress() || this.getEmailFromAddress();
     }
 
-    getPublicPlans() {
-        const defaultPriceData = {
-            monthly: 0,
-            yearly: 0,
-            currency: 'USD'
-        };
-
-        try {
-            const plans = this._settingsCache.get('stripe_plans') || [];
-
-            const priceData = plans.reduce((prices, plan) => {
-                const numberAmount = 0 + plan.amount;
-                const dollarAmount = numberAmount ? Math.round(numberAmount / 100) : 0;
-                return Object.assign(prices, {
-                    [plan.name.toLowerCase()]: dollarAmount
-                });
-            }, {});
-
-            priceData.currency = plans[0].currency || 'USD';
-
-            if (Number.isInteger(priceData.monthly) && Number.isInteger(priceData.yearly)) {
-                return priceData;
-            }
-
-            return defaultPriceData;
-        } catch (err) {
-            return defaultPriceData;
-        }
-    }
-
     /**
      * @param {'direct' | 'connect'} type - The "type" of keys to fetch from settings
      * @returns {{publicKey: string, secretKey: string} | null}
@@ -128,25 +98,6 @@ class MembersConfigProvider {
         return this.getActiveStripeKeys() !== null;
     }
 
-    getStripePaymentConfig() {
-        if (!this.isStripeConnected()) {
-            return null;
-        }
-
-        const stripeApiKeys = this.getActiveStripeKeys();
-
-        if (!stripeApiKeys) {
-            return null;
-        }
-
-        return {
-            product: {
-                name: this._settingsCache.get('stripe_product_name')
-            },
-            plans: this._settingsCache.get('stripe_plans') || []
-        };
-    }
-
     getAuthSecret() {
         const hexSecret = this._settingsCache.get('members_email_auth_secret');
         if (!hexSecret) {

package/core/server/services/members/exporter/query.js

@@ -22,7 +22,7 @@ module.exports = async function (options) {
             // Include mongoTransformer to apply subscribed:{true|false} => newsletter relation mapping
             Object.assign(filterOptions, _.pick(options, ['filter', 'search', 'mongoTransformer']));
         }
-        
+
         const memberRows = await models.Member.getFilteredCollectionQuery(filterOptions)
             .select('members.id')
             .distinct();
@@ -42,7 +42,7 @@ module.exports = async function (options) {
             END) as subscribed
         `))
         .select(knex.raw(`
-            (SELECT GROUP_CONCAT(product_id) FROM members_products f WHERE f.member_id = members.id) as products
+            (SELECT GROUP_CONCAT(product_id) FROM members_products f WHERE f.member_id = members.id) as tiers
         `))
         .select(knex.raw(`
             (SELECT GROUP_CONCAT(label_id) FROM members_labels f WHERE f.member_id = members.id) as labels
@@ -57,14 +57,14 @@ module.exports = async function (options) {
 
     const rows = await query;
     for (const row of rows) {
-        const productIds = row.products ? row.products.split(',') : [];
-        const products = productIds.map((id) => {
-            const product = allProducts.find(p => p.id === id);
+        const tierIds = row.tiers ? row.tiers.split(',') : [];
+        const tiers = tierIds.map((id) => {
+            const tier = allProducts.find(p => p.id === id);
             return {
-                name: product.get('name')
+                name: tier.get('name')
             };
         });
-        row.products = products;
+        row.tiers = tiers;
 
         const labelIds = row.labels ? row.labels.split(',') : [];
         const labels = labelIds.map((id) => {