ghost 4.45.0 → 4.46.2

package/core/frontend/apps/amp/lib/views/amp.hbs

@@ -987,7 +987,7 @@
     <header class="page-header">
         <a href="{{@site.url}}">
             {{#if @site.icon}}
-                <amp-img class="site-icon" src="{{img_url @site.icon absolute="true"}}" width="50" height="50" layout="fixed"></amp-img>
+                <amp-img class="site-icon" src="{{img_url @site.icon absolute="true"}}" width="50" height="50" layout="fixed" alt="{{@site.title}}"></amp-img>
             {{else}}
                 {{@site.title}}
             {{/if}}
@@ -1006,7 +1006,9 @@
             </header>
             {{#if feature_image}}
             <figure class="post-image">
-                <amp-img src="{{img_url feature_image absolute="true"}}" width="600" height="340" layout="responsive"></amp-img>
+                <amp-img src="{{img_url feature_image absolute="true"}}" width="600" height="340" layout="responsive" 
+                alt="{{#if feature_image_alt}}{{feature_image_alt}}{{else}}{{title}}{{/if}}"
+                ></amp-img>
             </figure>
             {{/if}}
             <section class="post-content">
@@ -1020,7 +1022,7 @@
     {{/post}}
     <footer class="page-footer">
         {{#if @site.icon}}
-            <amp-img class="site-icon" src="{{img_url @site.icon absolute="true"}}" width="50" height="50" layout="fixed"></amp-img>
+            <amp-img class="site-icon" src="{{img_url @site.icon absolute="true"}}" width="50" height="50" layout="fixed" alt="{{@site.title}}"></amp-img>
         {{/if}}
         <h3>{{@site.title}}</h3>
         {{#if @site.description}}

package/core/frontend/helpers/get.js

@@ -80,7 +80,7 @@ function resolvePaths(globals, data, value) {
         path = path.replace(/\.\[/g, '[');
 
         if (path.charAt(0) === '@') {
-            result = jsonpath.query(globals, path.substr(1));
+            result = jsonpath.query(globals, path.slice(1));
         } else {
             // Do the query, which always returns an array of matches
             result = jsonpath.query(data, path);

package/core/frontend/services/routing/controllers/unsubscribe.js

@@ -1,11 +1,33 @@
 const debug = require('@tryghost/debug')('services:routing:controllers:unsubscribe');
 const path = require('path');
+const url = require('url');
+
+const urlUtils = require('../../../../shared/url-utils');
 const megaService = require('../../../../server/services/mega');
 const renderer = require('../../rendering');
+const labs = require('../../../../shared/labs');
 
 module.exports = async function unsubscribeController(req, res) {
     debug('unsubscribeController');
 
+    if (labs.isSet('multipleNewslettersUI')) {
+        const {query} = url.parse(req.url, true);
+
+        if (!query || !query.uuid) {
+            res.writeHead(400);
+            return res.end('Email address not found.');
+        }
+
+        const redirectUrl = new URL(urlUtils.urlFor('home', true));
+        redirectUrl.searchParams.append('uuid', query.uuid);
+        if (query.newsletter) {
+            redirectUrl.searchParams.append('newsletter', query.newsletter);
+        }
+        redirectUrl.searchParams.append('action', 'unsubscribe');
+
+        return res.redirect(302, redirectUrl.href);
+    }
+
     let data = {};
 
     try {

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

@@ -366,6 +366,9 @@ module.exports = {
             if (labsService.isSet('multipleProducts')) {
                 frame.options.withRelated.push('products');
             }
+            if (labsService.isSet('multipleNewsletters')) {
+                frame.options.withRelated.push('newsletters');
+            }
             const page = await membersService.api.members.list(frame.options);
 
             return page;

package/core/server/api/canary/newsletters.js

@@ -1,22 +1,32 @@
 const models = require('../../models');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
+const allowedIncludes = ['count.posts', 'count.members'];
 
 const messages = {
     newsletterNotFound: 'Newsletter not found.'
 };
+const newslettersService = require('../../services/newsletters');
 
 module.exports = {
     docName: 'newsletters',
 
     browse: {
         options: [
+            'include',
             'filter',
             'fields',
             'limit',
             'order',
             'page'
         ],
+        validation: {
+            options: {
+                include: {
+                    values: allowedIncludes
+                }
+            }
+        },
         permissions: true,
         query(frame) {
             return models.Newsletter.findPage(frame.options);
@@ -25,6 +35,7 @@ module.exports = {
 
     read: {
         options: [
+            'include',
             'fields',
             'debug',
             // NOTE: only for internal context
@@ -36,6 +47,13 @@ module.exports = {
             'slug',
             'uuid'
         ],
+        validation: {
+            options: {
+                include: {
+                    values: allowedIncludes
+                }
+            }
+        },
         permissions: true,
         async query(frame) {
             const newsletter = models.Newsletter.findOne(frame.data, frame.options);
@@ -51,27 +69,59 @@ module.exports = {
 
     add: {
         statusCode: 201,
+        headers: {
+            cacheInvalidate: true
+        },
+        options: [
+            'include',
+            'opt_in_existing'
+        ],
+        validation: {
+            options: {
+                include: {
+                    values: allowedIncludes
+                }
+            }
+        },
         permissions: true,
         async query(frame) {
-            return models.Newsletter.add(frame.data.newsletters[0], frame.options);
+            return newslettersService.add(frame.data.newsletters[0], frame.options);
         }
     },
 
     edit: {
-        headers: {},
+        headers: {
+            cacheInvalidate: true
+        },
         options: [
-            'id'
+            'id',
+            'include'
         ],
         validation: {
             options: {
                 id: {
                     required: true
+                },
+                include: {
+                    values: allowedIncludes
                 }
             }
         },
         permissions: true,
         async query(frame) {
-            return models.Newsletter.edit(frame.data.newsletters[0], frame.options);
+            return newslettersService.edit(frame.data.newsletters[0], frame.options);
+        }
+    },
+
+    verifyPropertyUpdate: {
+        permissions: {
+            method: 'edit'
+        },
+        data: [
+            'token'
+        ],
+        async query(frame) {
+            return newslettersService.verifyPropertyUpdate(frame.data.token);
         }
     }
 };

package/core/server/api/canary/stats.js

@@ -19,5 +19,14 @@ module.exports = {
         async query() {
             return await statsService.getMRRHistory();
         }
+    },
+    subscriptions: {
+        permissions: {
+            docName: 'members',
+            method: 'browse'
+        },
+        async query() {
+            return await statsService.getSubscriptionCountHistory();
+        }
     }
 };

package/core/server/api/canary/utils/serializers/input/members.js

@@ -1,5 +1,7 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:members');
+const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
+const labsService = require('../../../../../../shared/labs');
 
 function defaultRelations(frame) {
     if (frame.options.withRelated) {
@@ -17,6 +19,26 @@ module.exports = {
     browse(apiConfig, frame) {
         debug('browse');
         defaultRelations(frame);
+
+        if (!frame.options.order) {
+            frame.options.autoOrder = 'created_at DESC, id DESC';
+        }
+
+        if (labsService.isSet('multipleNewsletters')) {
+            frame.options.mongoTransformer = mapNQLKeyValues({
+                key: {
+                    from: 'subscribed',
+                    to: 'newsletters.status'
+                },
+                values: [{
+                    from: true,
+                    to: 'active'
+                }, {
+                    from: false,
+                    to: {$ne: 'active'}
+                }]
+            });
+        }
     },
 
     read() {

package/core/server/api/canary/utils/serializers/output/mappers/pages.js

@@ -6,6 +6,7 @@ module.exports = async (model, frame, options) => {
     delete jsonModel.email_subject;
     delete jsonModel.email_recipient_filter;
     delete jsonModel.email_only;
+    delete jsonModel.newsletter_id;
 
     return jsonModel;
 };

package/core/server/api/canary/utils/serializers/output/mappers/posts.js

@@ -57,6 +57,8 @@ module.exports = async (model, frame, options = {}) => {
         }
         date.forPost(jsonModel);
         gating.forPost(jsonModel, frame);
+
+        delete jsonModel.newsletter_id;
     }
 
     // Transforms post/page metadata to flat structure

package/core/server/api/canary/utils/serializers/output/members.js

@@ -132,11 +132,19 @@ function serializeMember(member, options) {
         serialized.products = json.products;
     }
 
-    if (json.newsletters && labsService.isSet('multipleNewsletters')) {
-        json.newsletters.sort((a, b) => {
-            return a.sort_order - b.sort_order;
-        });
-        serialized.newsletters = json.newsletters;
+    if (labsService.isSet('multipleNewsletters')) {
+        if (json.newsletters) {
+            serialized.newsletters = json.newsletters
+                .filter(newsletter => newsletter.status === 'active')
+                .sort((a, b) => {
+                    return a.sort_order - b.sort_order;
+                });
+        }
+        // override the `subscribed` param to mean "subscribed to any active newsletter"
+        serialized.subscribed = false;
+        if (Array.isArray(serialized.newsletters) && serialized.newsletters.length > 0) {
+            serialized.subscribed = true;
+        }
     }
 
     return serialized;

package/core/server/api/shared/http.js

@@ -82,9 +82,6 @@ const http = (apiImpl) => {
             res.status(statusCode);
 
             // CASE: generate headers based on the api ctrl configuration
-            if (req && req.headers && req.headers['accept-version'] && res.locals) {
-                headers['Content-Version'] = `v${res.locals.safeVersion}`;
-            }
             res.set(headers);
 
             const send = (format) => {

package/core/server/api/v2/utils/serializers/output/utils/mapper.js

@@ -48,6 +48,8 @@ const mapPost = (model, frame) => {
         }
         date.forPost(jsonModel);
         gating.forPost(jsonModel, frame);
+
+        delete jsonModel.newsletter_id;
     }
 
     // Transforms post/page metadata to flat structure

package/core/server/api/v3/utils/serializers/output/utils/mapper.js

@@ -45,6 +45,8 @@ const mapPost = (model, frame) => {
         }
         date.forPost(jsonModel);
         gating.forPost(jsonModel, frame);
+
+        delete jsonModel.newsletter_id;
     }
 
     if (typeof jsonModel.email_recipient_filter === 'undefined') {
@@ -100,6 +102,7 @@ const mapPage = (model, frame) => {
     delete jsonModel.email_subject;
     delete jsonModel.send_email_when_published;
     delete jsonModel.email_recipient_filter;
+    delete jsonModel.newsletter_id;
 
     return jsonModel;
 };

package/core/server/data/migrations/utils.js

@@ -440,6 +440,44 @@ function createDropColumnMigration(table, column, columnDefinition) {
     );
 }
 
+/**
+ * @param {string} table
+ * @param {string} column
+ *
+ * @returns {Migration}
+ */
+function createSetNullableMigration(table, column) {
+    return createNonTransactionalMigration(
+        async function up(knex) {
+            logging.info(`Setting nullable: ${table}.${column}`);
+            await commands.setNullable(table, column, knex);
+        },
+        async function down(knex) {
+            logging.info(`Dropping nullable:  ${table}.${column}`);
+            await commands.dropNullable(table, column, knex);
+        }
+    );
+}
+
+/**
+ * @param {string} table
+ * @param {string} column
+ *
+ * @returns {Migration}
+ */
+function createDropNullableMigration(table, column) {
+    return createNonTransactionalMigration(
+        async function up(knex) {
+            logging.info(`Dropping nullable: ${table}.${column}`);
+            await commands.dropNullable(table, column, knex);
+        },
+        async function down(knex) {
+            logging.info(`Setting nullable: ${table}.${column}`);
+            await commands.setNullable(table, column, knex);
+        }
+    );
+}
+
 /**
  * Creates a migration which will insert a new setting in settings table
  * @param {object} settingSpec - setting key, value, group and type
@@ -505,6 +543,8 @@ module.exports = {
     combineNonTransactionalMigrations,
     createAddColumnMigration,
     createDropColumnMigration,
+    createSetNullableMigration,
+    createDropNullableMigration,
     meta: {
         MIGRATION_USER
     }

package/core/server/data/migrations/versions/4.43/2022-03-28-19-26-recreate-newsletter-table.js

@@ -8,7 +8,7 @@ module.exports = recreateTable('newsletters', {
     sender_name: {type: 'string', maxlength: 191, nullable: false},
     sender_email: {type: 'string', maxlength: 191, nullable: true},
     sender_reply_to: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'newsletter', validations: {isIn: [['newsletter', 'support']]}},
-    status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
+    status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active', validations: {isIn: [['active', 'archived']]}},
     visibility: {
         type: 'string',
         maxlength: 50,

package/core/server/data/migrations/versions/4.46/2022-04-13-12-00-add-created-at-newsletters.js

@@ -0,0 +1,6 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('newsletters', 'created_at', {
+    type: 'dateTime',
+    nullable: true
+});

package/core/server/data/migrations/versions/4.46/2022-04-13-12-01-add-updated-at-newsletters.js

@@ -0,0 +1,6 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('newsletters', 'updated_at', {
+    type: 'dateTime',
+    nullable: true
+});

package/core/server/data/migrations/versions/4.46/2022-04-13-12-02-fill-created-at-newsletters.js

@@ -0,0 +1,19 @@
+const logging = require('@tryghost/logging');
+
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Setting missing created_at values for existing newsletters');
+
+        const now = knex.raw('CURRENT_TIMESTAMP');
+        const updatedRows = await knex('newsletters')
+            .where('created_at', null)
+            .update('created_at', now);
+
+        logging.info(`Updated ${updatedRows} newsletters with created_at = now`);
+    },
+    async function down() {
+        // Not required: we would lose information here.
+    }
+);

package/core/server/data/migrations/versions/4.46/2022-04-13-12-03-drop-nullable-created-at-newsletters.js

@@ -0,0 +1,3 @@
+const {createDropNullableMigration} = require('../../utils');
+
+module.exports = createDropNullableMigration('newsletters', 'created_at');

package/core/server/data/migrations/versions/4.46/2022-04-13-12-08-newsletters-show-header-name.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('newsletters', 'show_header_name', {
+    type: 'boolean',
+    nullable: false,
+    defaultTo: true
+});

package/core/server/data/migrations/versions/4.46/2022-04-13-12-57-add-uuid-column-to-newsletters.js

@@ -0,0 +1,8 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('newsletters', 'uuid', {
+    type: 'string',
+    maxlength: 36,
+    nullable: true,
+    unique: true
+});

package/core/server/data/migrations/versions/4.46/2022-04-13-12-58-fill-uuid-for-newsletters.js

@@ -0,0 +1,19 @@
+const logging = require('@tryghost/logging');
+const uuid = require('uuid');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const newslettersWithoutUUID = await knex.select('id').from('newsletters').whereNull('uuid');
+
+        logging.info(`Adding uuid field value to ${newslettersWithoutUUID.length} newsletters.`);
+
+        // eslint-disable-next-line no-restricted-syntax
+        for (const newsletter of newslettersWithoutUUID) {
+            await knex('newsletters').update('uuid', uuid.v4()).where('id', newsletter.id);
+        }
+    },
+    async function down() {
+        // Not required: we would lose information here.
+    }
+);

package/core/server/data/migrations/versions/4.46/2022-04-13-12-59-drop-nullable-uuid-newsletters.js

@@ -0,0 +1,3 @@
+const {createDropNullableMigration} = require('../../utils');
+
+module.exports = createDropNullableMigration('newsletters', 'uuid');

package/core/server/data/migrations/versions/4.46/2022-04-13-13-00-add-default-newsletter.js

@@ -0,0 +1,92 @@
+const ObjectId = require('bson-objectid');
+const uuid = require('uuid');
+const logging = require('@tryghost/logging');
+const startsWith = require('lodash/startsWith');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        // This uses the default settings from core/server/data/schema/default-settings/default-settings.json
+        const newsletter = {
+            id: (new ObjectId()).toHexString(),
+            uuid: uuid.v4(),
+            name: 'Ghost',
+            description: '',
+            slug: 'default-newsletter',
+            sender_name: null,
+            sender_email: null,
+            sender_reply_to: 'newsletter',
+            status: 'active',
+            visibility: 'members',
+            subscribe_on_signup: true,
+            sort_order: 0,
+            body_font_category: 'sans_serif',
+            footer_content: '',
+            header_image: null,
+            show_badge: true,
+            show_feature_image: true,
+            show_header_icon: true,
+            show_header_title: true,
+            show_header_name: false,
+            title_alignment: 'center',
+            title_font_category: 'sans_serif',
+            created_at: knex.raw('CURRENT_TIMESTAMP')
+        };
+
+        // Make sure the newsletter table is empty
+        const newsletters = await knex('newsletters').count('*', {as: 'total'});
+
+        if (newsletters[0].total !== 0) {
+            logging.warn('Skipping adding the default newsletter - There is already at least one newsletter');
+            return;
+        }
+
+        // Get all settings in one query
+        const settings = await knex('settings')
+            .whereIn('key', [
+                'title',
+                'description',
+                'newsletter_body_font_category',
+                'newsletter_footer_content',
+                'newsletter_header_image',
+                'newsletter_show_badge',
+                'newsletter_show_feature_image',
+                'newsletter_show_header_icon',
+                'newsletter_show_header_title',
+                'newsletter_title_alignment',
+                'newsletter_title_font_category'
+            ])
+            .select(['key', 'value']);
+
+        // eslint-disable-next-line no-restricted-syntax
+        for (let {key, value} of settings) {
+            // Use site title for the newsletter name
+            if (key === 'title') {
+                key = 'name';
+            }
+            // Settings have a `newsletter_` prefix which isn't present on the newsletters table
+            if (startsWith(key, 'newsletter_')) {
+                key = key.slice(11);
+            }
+
+            if (value === null && ['name', 'body_font_category', 'show_badge', 'show_feature_image', 'show_header_icon', 'show_header_title', 'title_alignment', 'title_font_category'].includes(key)) {
+                // Prevent setting null to non-nullable columns
+                // Default to defaults above in that case
+                continue;
+            }
+
+            if (typeof newsletter[key] === 'boolean') {
+                newsletter[key] = value === 'true';
+            } else {
+                newsletter[key] = value;
+            }
+        }
+
+        logging.info('Adding the default newsletter');
+        await knex('newsletters').insert(newsletter);
+    },
+    async function down(knex) {
+        logging.info(`Removing newsletters`);
+        await knex('newsletters').delete();
+    }
+);

package/core/server/data/migrations/versions/4.46/2022-04-20-08-39-map-subscribers-to-default-newsletter.js

@@ -0,0 +1,66 @@
+const logging = require('@tryghost/logging');
+const ObjectID = require('bson-objectid');
+
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Adding existing subscribers to default newsletter');
+
+        const newsletter = await knex('newsletters')
+            .orderBy('sort_order', 'asc')
+            .orderBy('created_at', 'asc')
+            .first('id', 'name');
+
+        if (!newsletter) {
+            logging.info(`Default newsletter not found - skipping`);
+            return;
+        }
+
+        // This is at the start of the up() instead of at the end of the down()
+        // to maintain idempotency
+        logging.info('Removing existing newsletter subscriptions');
+        await knex('members_newsletters').delete();
+
+        logging.info(`Subscribing members to newsletter '${newsletter.name}'`);
+
+        const memberIds = await knex('members')
+            .where({subscribed: true})
+            .pluck('id');
+
+        if (!memberIds.length) {
+            logging.info(`No members to subscribe - skipping`);
+            return;
+        }
+
+        logging.info(`Found ${memberIds.length} members to subscribe`);
+
+        const pivotRows = memberIds.map((memberId) => {
+            return {
+                id: ObjectID().toHexString(),
+                member_id: memberId,
+                newsletter_id: newsletter.id
+            };
+        });
+
+        await knex.batchInsert('members_newsletters', pivotRows);
+    },
+    async function down(knex) {
+        logging.info('Syncing subscriptions from newsletters -> members.subscribed');
+        await knex('members')
+            .whereIn('id', function () {
+                this.select('member_id').from('members_newsletters');
+            })
+            .update({
+                subscribed: true
+            });
+        logging.info('Syncing unsubscribes from newsletters -> members.subscribed');
+        await knex('members')
+            .whereNotIn('id', function () {
+                this.select('member_id').from('members_newsletters');
+            })
+            .update({
+                subscribed: false
+            });
+    }
+);

package/core/server/data/migrations/versions/4.46/2022-04-22-07-43-add-newsletter-id-to-subscribe-events.js

@@ -0,0 +1,9 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_subscribe_events', 'newsletter_id', {
+    type: 'string', 
+    maxlength: 24,
+    nullable: true,
+    references: 'newsletters.id', 
+    cascadeDelete: false
+});