ghost 4.43.1 → 4.46.0

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

@@ -15,7 +15,9 @@ const jobsService = require('../jobs');
 const db = require('../../data/db');
 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');
@@ -25,27 +27,22 @@ const messages = {
     unexpectedFilterError: 'Unexpected {property} value "{value}", expected an NQL equivalent',
     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.'
+    sendEmailRequestFailed: 'The email service was unable to send an email batch.',
+    newsletterVisibilityError: 'Unexpected visibility value "{value}". Use one of the valid: "members", "paid".'
 };
 
-const getFromAddress = () => {
-    let fromAddress = membersService.config.getEmailFromAddress();
-
+const getFromAddress = (senderName, fromAddress) => {
     if (/@localhost$/.test(fromAddress) || /@ghost.local$/.test(fromAddress)) {
         const localAddress = 'localhost@example.com';
         logging.warn(`Rewriting bulk email from address ${fromAddress} to ${localAddress}`);
         fromAddress = localAddress;
     }
 
-    const siteTitle = settingsCache.get('title') ? settingsCache.get('title').replace(/"/g, '\\"') : '';
-
-    return siteTitle ? `"${siteTitle}"<${fromAddress}>` : fromAddress;
+    return senderName ? `"${senderName}"<${fromAddress}>` : fromAddress;
 };
 
-const getReplyToAddress = () => {
-    const fromAddress = membersService.config.getEmailFromAddress();
+const getReplyToAddress = (fromAddress, replyAddressOption) => {
     const supportAddress = membersService.config.getEmailSupportAddress();
-    const replyAddressOption = settingsCache.get('members_reply_address');
 
     return (replyAddressOption === 'support') ? supportAddress : fromAddress;
 };
@@ -57,14 +54,28 @@ const getReplyToAddress = () => {
  * @param {ValidAPIVersion} options.apiVersion - api version to be used when serializing email data
  */
 const getEmailData = async (postModel, options) => {
-    const {subject, html, plaintext} = await postEmailSerializer.serialize(postModel, options);
+    let newsletter = await postModel.related('newsletter').fetch();
+    if (!newsletter) {
+        newsletter = await models.Newsletter.getDefaultNewsletter();
+    }
+    const {subject, html, plaintext} = await postEmailSerializer.serialize(postModel, newsletter, options);
+
+    let senderName = settingsCache.get('title') ? settingsCache.get('title').replace(/"/g, '\\"') : '';
+    if (newsletter.get('sender_name')) {
+        senderName = newsletter.get('sender_name');
+    }
+
+    let fromAddress = membersService.config.getEmailFromAddress();
+    if (newsletter.get('sender_email')) {
+        fromAddress = newsletter.get('sender_email');
+    }
 
     return {
         subject,
         html,
         plaintext,
-        from: getFromAddress(),
-        replyTo: getReplyToAddress()
+        from: getFromAddress(senderName, fromAddress),
+        replyTo: getReplyToAddress(fromAddress, newsletter.get('sender_reply_to'))
     };
 };
 
@@ -126,7 +137,15 @@ const sendTestEmail = async (postModel, toEmails, apiVersion, memberSegment) =>
  * @param {string} emailRecipientFilter NQL filter for members
  * @param {object} options
  */
-const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'email_recipient_filter'} = {}) => {
+const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'email_recipient_filter'} = {}, newsletter = null) => {
+    let filter = [];
+
+    if (!newsletter) {
+        filter.push(`subscribed:true`);
+    } else {
+        filter.push(`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':
@@ -138,7 +157,7 @@ const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'e
             })
         });
     case 'all':
-        return 'subscribed:true';
+        break;
     case 'none':
         throw new errors.InternalServerError({
             message: tpl(messages.noneFilterError, {
@@ -146,8 +165,29 @@ const transformEmailRecipientFilter = (emailRecipientFilter, {errorProperty = 'e
             })
         });
     default:
-        return `subscribed:true+(${emailRecipientFilter})`;
+        filter.push(`(${emailRecipientFilter})`);
+        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
+                })
+            });
+        }
     }
+
+    return filter.join('+');
 };
 
 /**
@@ -159,6 +199,7 @@ 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) => {
@@ -175,12 +216,16 @@ const addEmail = async (postModel, options) => {
     const knexOptions = _.pick(options, ['transacting', 'forUpdate']);
     const filterOptions = Object.assign({}, knexOptions, {limit: 1});
 
+    let newsletter;
+    if (labsService.isSet('multipleNewsletters')) {
+        newsletter = await postModel.related('newsletter').fetch(Object.assign({}, {require: false}, _.pick(options, ['transacting'])));
+    }
     const emailRecipientFilter = postModel.get('email_recipient_filter');
-    filterOptions.filter = transformEmailRecipientFilter(emailRecipientFilter, {errorProperty: 'email_recipient_filter'});
+    filterOptions.filter = transformEmailRecipientFilter(emailRecipientFilter, {errorProperty: 'email_recipient_filter'}, newsletter);
 
     const startRetrieve = Date.now();
     debug('addEmail: retrieving members count');
-    const {meta: {pagination: {total: membersCount}}} = await membersService.api.members.list(Object.assign({}, knexOptions, filterOptions));
+    const {meta: {pagination: {total: membersCount}}} = await membersService.api.members.list({...knexOptions, ...filterOptions});
     debug(`addEmail: retrieved members count - ${membersCount} members (${Date.now() - startRetrieve}ms)`);
 
     // NOTE: don't create email object when there's nobody to send the email to
@@ -211,7 +256,8 @@ const addEmail = async (postModel, options) => {
             plaintext: emailData.plaintext,
             submitted_at: moment().toDate(),
             track_opens: !!settingsCache.get('email_track_opens'),
-            recipient_filter: emailRecipientFilter
+            recipient_filter: emailRecipientFilter,
+            newsletter_id: options.newsletter_id
         }, knexOptions);
     } else {
         return existing;
@@ -271,7 +317,11 @@ async function handleUnsubscribeRequest(req) {
     }
 
     try {
-        const memberModel = await membersService.api.members.update({subscribed: false}, {id: member.id});
+        let memberData = {subscribed: false};
+        if (labs.isSet('multipleNewsletters')) {
+            memberData.newsletters = [];
+        }
+        const memberModel = await membersService.api.members.update(memberData, {id: member.id});
         return memberModel.toJSON();
     } catch (err) {
         throw new errors.InternalServerError({
@@ -296,11 +346,14 @@ async function pendingEmailHandler(emailModel, options) {
     const emailAnalyticsJobs = require('../email-analytics/jobs');
     emailAnalyticsJobs.scheduleRecurringJobs();
 
-    return jobsService.addJob({
-        job: sendEmailJob,
-        data: {emailModel},
-        offloaded: false
-    });
+    // @TODO move this into the jobService
+    if (!process.env.NODE_ENV.startsWith('test')) {
+        return jobsService.addJob({
+            job: sendEmailJob,
+            data: {emailModel},
+            offloaded: false
+        });
+    }
 }
 
 async function sendEmailJob({emailModel, options}) {
@@ -375,7 +428,11 @@ async function getEmailMemberRows({emailModel, memberSegment, options}) {
     const knexOptions = _.pick(options, ['transacting', 'forUpdate']);
     const filterOptions = Object.assign({}, knexOptions);
 
-    const recipientFilter = transformEmailRecipientFilter(emailModel.get('recipient_filter'), {errorProperty: 'recipient_filter'});
+    let newsletter = null;
+    if (labsService.isSet('multipleNewsletters')) {
+        newsletter = await emailModel.related('newsletter').fetch(Object.assign({}, {require: false}, _.pick(options, ['transacting'])));
+    }
+    const recipientFilter = transformEmailRecipientFilter(emailModel.get('recipient_filter'), {errorProperty: 'recipient_filter'}, newsletter);
     filterOptions.filter = recipientFilter;
 
     if (memberSegment) {
@@ -552,7 +609,9 @@ module.exports = {
     // NOTE: below are only exposed for testing purposes
     _transformEmailRecipientFilter: transformEmailRecipientFilter,
     _partitionMembersBySegment: partitionMembersBySegment,
-    _getEmailMemberRows: getEmailMemberRows
+    _getEmailMemberRows: getEmailMemberRows,
+    _getFromAddress: getFromAddress,
+    _getReplyToAddress: getReplyToAddress
 };
 
 /**

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

@@ -169,21 +169,22 @@ const parseReplacements = (email) => {
     return replacements;
 };
 
-const getTemplateSettings = async () => {
+const getTemplateSettings = async (newsletter) => {
     const accentColor = settingsCache.get('accent_color');
     const adjustedAccentColor = accentColor && darkenToContrastThreshold(accentColor, '#ffffff', 2).hex();
     const adjustedAccentContrastColor = accentColor && textColorForBackgroundColor(adjustedAccentColor).hex();
 
     const templateSettings = {
-        headerImage: settingsCache.get('newsletter_header_image'),
-        showHeaderIcon: settingsCache.get('newsletter_show_header_icon') && settingsCache.get('icon'),
-        showHeaderTitle: settingsCache.get('newsletter_show_header_title'),
-        showFeatureImage: settingsCache.get('newsletter_show_feature_image'),
-        titleFontCategory: settingsCache.get('newsletter_title_font_category'),
-        titleAlignment: settingsCache.get('newsletter_title_alignment'),
-        bodyFontCategory: settingsCache.get('newsletter_body_font_category'),
-        showBadge: settingsCache.get('newsletter_show_badge'),
-        footerContent: settingsCache.get('newsletter_footer_content'),
+        headerImage: newsletter.get('header_image'),
+        showHeaderIcon: newsletter.get('show_header_icon') && settingsCache.get('icon'),
+        showHeaderTitle: newsletter.get('show_header_title'),
+        showFeatureImage: newsletter.get('show_feature_image'),
+        titleFontCategory: newsletter.get('title_font_category'),
+        titleAlignment: newsletter.get('title_alignment'),
+        bodyFontCategory: newsletter.get('body_font_category'),
+        showBadge: newsletter.get('show_badge'),
+        footerContent: newsletter.get('footer_content'),
+        showHeaderName: newsletter.get('show_header_name'),
         accentColor,
         adjustedAccentColor,
         adjustedAccentContrastColor
@@ -221,7 +222,7 @@ const getTemplateSettings = async () => {
     return templateSettings;
 };
 
-const serialize = async (postModel, options = {isBrowserPreview: false, apiVersion: 'v4'}) => {
+const serialize = async (postModel, newsletter, options = {isBrowserPreview: false, apiVersion: 'v4'}) => {
     const post = await serializePostModel(postModel, options.apiVersion);
 
     const timezone = settingsCache.get('timezone');
@@ -290,11 +291,11 @@ const serialize = async (postModel, options = {isBrowserPreview: false, apiVersi
         }
     }
 
-    const templateSettings = await getTemplateSettings();
+    const templateSettings = await getTemplateSettings(newsletter);
 
     const render = template;
 
-    let htmlTemplate = render({post, site: getSite(), templateSettings});
+    let htmlTemplate = render({post, site: getSite(), templateSettings, newsletter: newsletter.toJSON()});
 
     if (options.isBrowserPreview) {
         const previewUnsubscribeUrl = createUnsubscribeUrl(null);
@@ -339,5 +340,7 @@ module.exports = {
     serialize,
     createUnsubscribeUrl,
     renderEmailForSegment,
-    parseReplacements
+    parseReplacements,
+    // Export for tests
+    _getTemplateSettings: getTemplateSettings
 };

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

@@ -1,6 +1,6 @@
 /* eslint indent: warn, no-irregular-whitespace: warn */
 const iff = (cond, yes, no) => (cond ? yes : no);
-module.exports = ({post, site, templateSettings}) => {
+module.exports = ({post, site, newsletter, templateSettings}) => {
     const date = new Date();
     const hasFeatureImageCaption = templateSettings.showFeatureImage && post.feature_image && post.feature_image_caption;
     return `<!doctype html>
@@ -322,6 +322,9 @@ figure blockquote p {
     font-weight: 700;
     text-transform: uppercase;
     text-align: center;
+}
+
+.site-url-bottom-padding {
     padding-bottom: 50px;
 }
 
@@ -329,6 +332,13 @@ figure blockquote p {
     color: #15212A;
 }
 
+.site-subtitle {
+    color: #8695a4;
+    font-size: 14px;
+    font-weight: 400;
+    text-transform: none;
+}
+
 .post-title {
     padding-bottom: 10px;
     font-size: 42px;
@@ -1158,7 +1168,7 @@ ${ templateSettings.showBadge ? `
                                     ` : ''}
 
 
-                                    ${ templateSettings.showHeaderIcon || templateSettings.showHeaderTitle ? `
+                                    ${ templateSettings.showHeaderIcon || templateSettings.showHeaderTitle || templateSettings.showHeaderName ? `
                                     <tr>
                                         <td class="${templateSettings.showHeaderTitle ? `site-info-bordered` : `site-info`}" width="100%" align="center">
                                             <table role="presentation" border="0" cellpadding="0" cellspacing="0">
@@ -1169,9 +1179,20 @@ ${ templateSettings.showBadge ? `
                                                 ` : ``}
                                                 ${ templateSettings.showHeaderTitle ? `
                                                 <tr>
-                                                    <td class="site-url"><div style="width: 100% !important;"><a href="${site.url}" class="site-title">${site.title}</a></div></td>
+                                                    <td class="site-url ${!templateSettings.showHeaderName ? 'site-url-bottom-padding' : ''}"><div style="width: 100% !important;"><a href="${site.url}" class="site-title">${site.title}</a></div></td>
                                                 </tr>
                                                 ` : ``}
+                                                ${ templateSettings.showHeaderName && templateSettings.showHeaderTitle ? `
+                                                <tr>
+                                                    <td class="site-url site-url-bottom-padding"><div style="width: 100% !important;"><a href="${site.url}" class="site-subtitle">${newsletter.name}</a></div></td>
+                                                </tr>
+                                                ` : ``}
+                                                ${ templateSettings.showHeaderName && !templateSettings.showHeaderTitle ? `
+                                                <tr>
+                                                    <td class="site-url site-url-bottom-padding"><div style="width: 100% !important;"><a href="${site.url}" class="site-title">${newsletter.name}</a></div></td>
+                                                </tr>
+                                                ` : ``}
+
                                             </table>
                                         </td>
                                     </tr>

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

@@ -13,7 +13,7 @@ const SingleUseTokenProvider = require('./SingleUseTokenProvider');
 const urlUtils = require('../../../shared/url-utils');
 const labsService = require('../../../shared/labs');
 const offersService = require('../offers');
-const getNewslettersServiceInstance = require('../newsletters');
+const newslettersService = require('../newsletters');
 
 const MAGIC_LINK_TOKEN_VALIDITY = 24 * 60 * 60 * 1000;
 
@@ -197,7 +197,7 @@ function createApiInstance(config) {
         stripeAPIService: stripeService.api,
         offersAPI: offersService.api,
         labsService: labsService,
-        newslettersService: getNewslettersServiceInstance({NewsletterModel: models.Newsletter})
+        newslettersService: newslettersService
     });
 
     return membersApiInstance;

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

@@ -9,6 +9,7 @@ const settingsCache = require('../../../shared/settings-cache');
 const {formattedMemberResponse} = require('./utils');
 const labsService = require('../../../shared/labs');
 const config = require('../../../shared/config');
+const newslettersService = require('../newsletters');
 
 // @TODO: This piece of middleware actually belongs to the frontend, not to the member app
 // Need to figure a way to separate these things (e.g. frontend actually talks to members API)
@@ -68,6 +69,65 @@ const getOfferData = async function (req, res) {
     });
 };
 
+const getMemberNewsletters = async function (req, res) {
+    try {
+        const memberUuid = req.query.uuid;
+
+        if (!memberUuid) {
+            res.writeHead(400);
+            return res.end('Invalid member uuid');
+        }
+
+        const memberData = await membersService.api.members.get({
+            uuid: memberUuid
+        }, {
+            withRelated: ['newsletters']
+        });
+
+        if (!memberData) {
+            res.writeHead(404);
+            return res.end('Email address not found.');
+        }
+
+        const data = _.pick(memberData.toJSON(), 'uuid', 'email', 'name', 'newsletters', 'status');
+        return res.json(data);
+    } catch (err) {
+        res.writeHead(400);
+        res.end('Failed to unsubscribe this email address');
+    }
+};
+
+const updateMemberNewsletters = async function (req, res) {
+    try {
+        const memberUuid = req.query.uuid;
+        if (!memberUuid) {
+            res.writeHead(400);
+            return res.end('Invalid member uuid');
+        }
+
+        const data = _.pick(req.body, 'newsletters');
+        const memberData = await membersService.api.members.get({
+            uuid: memberUuid
+        });
+        if (!memberData) {
+            res.writeHead(404);
+            return res.end('Email address not found.');
+        }
+
+        const options = {
+            id: memberData.get('id'),
+            withRelated: ['newsletters']
+        };
+
+        const updatedMember = await membersService.api.members.update(data, options);
+        const updatedMemberData = _.pick(updatedMember.toJSON(), ['uuid', 'email', 'name', 'newsletters', 'status']);
+        res.json(updatedMemberData);
+    } catch (err) {
+        res.writeHead(400);
+        res.end('Failed to update newsletters');
+    }
+};
+
 const updateMemberData = async function (req, res) {
     try {
         const data = _.pick(req.body, 'name', 'subscribed', 'newsletters');
@@ -134,8 +194,13 @@ const getPortalProductPrices = async function () {
 };
 
 const getSiteNewsletters = async function () {
-    const newsletters = await models.Newsletter.findAll();
-    return newsletters.toJSON();
+    try {
+        return await newslettersService.browse({filter: 'status:active', limit: 'all'});
+    } catch (err) {
+        logging.warn('Failed to fetch site newsletters');
+        logging.warn(err.message);
+        return [];
+    }
 };
 
 const getMemberSiteData = async function (req, res) {
@@ -264,9 +329,11 @@ module.exports = {
     loadMemberSession,
     createSessionFromMagicLink,
     getIdentityToken,
+    getMemberNewsletters,
     getMemberData,
     getOfferData,
     updateMemberData,
+    updateMemberNewsletters,
     getMemberSiteData,
     deleteSession
 };

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

@@ -53,22 +53,17 @@ const membersImporter = new MembersCSVImporter({
     isSet: labsService.isSet.bind(labsService),
     addJob: jobsService.addJob.bind(jobsService),
     knex: db.knex,
-    urlFor: urlUtils.urlFor.bind(urlUtils)
+    urlFor: urlUtils.urlFor.bind(urlUtils),
+    context: {
+        importer: true
+    }
 });
 
 const processImport = async (options) => {
     const result = await membersImporter.process(options);
-    const importSize = result.meta.originalImportSize;
-    delete result.meta.originalImportSize;
-
-    const importThreshold = await verificationTrigger.getImportThreshold();
-    if (importSize > importThreshold) {
-        await verificationTrigger.startVerificationProcess({
-            amountImported: importSize,
-            throwOnTrigger: true,
-            source: 'import'
-        });
-    }
+
+    // Check whether all imports in last 30 days > threshold
+    await verificationTrigger.testImportThreshold();
 
     return result;
 };