ghost 5.38.0 → 5.40.0

package/core/server/api/endpoints/posts.js

@@ -9,7 +9,7 @@ const allowedIncludes = [
     'email',
     'tiers',
     'newsletter',
-    'count.conversions', 
+    'count.conversions',
     'count.signups',
     'count.paid_conversions',
     'count.clicks',
@@ -57,6 +57,35 @@ module.exports = {
         }
     },
 
+    exportCSV: {
+        options: [
+            'limit',
+            'filter',
+            'order'
+        ],
+        headers: {
+            disposition: {
+                type: 'csv',
+                value() {
+                    const datetime = (new Date()).toJSON().substring(0, 10);
+                    return `posts.${datetime}.csv`;
+                }
+            }
+        },
+        response: {
+            format: 'plain'
+        },
+        permissions: {
+            method: 'browse'
+        },
+        validation: {},
+        async query(frame) {
+            return {
+                data: await postsService.export(frame)
+            };
+        }
+    },
+
     read: {
         options: [
             'include',

package/core/server/api/endpoints/utils/serializers/output/mappers/emails.js

@@ -7,7 +7,8 @@ module.exports = (model, frame) => {
 
     // Ensure we're not outputting unwanted replacement strings when viewing email contents
     // TODO: extract this to a utility, it's duplicated in the email-preview API controller
-    if (jsonModel.html) {
+    if (jsonModel.html && emailService.renderer && emailService.service) {
+        // In worker threads the renderer and servie service are not available, but we don't need to do this, so okay to skip.
         const replacements = emailService.renderer.buildReplacementDefinitions({html: jsonModel.html, newsletterUuid: 'preview'});
         const exampleMember = emailService.service.getDefaultExampleMember();
 

package/core/server/api/endpoints/utils/serializers/output/posts.js

@@ -1,6 +1,7 @@
 const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:posts');
 const mappers = require('./mappers');
 const membersService = require('../../../../../services/members');
+const papaparse = require('papaparse');
 
 module.exports = {
     async all(models, apiConfig, frame) {
@@ -32,5 +33,9 @@ module.exports = {
         frame.response = {
             posts: [post]
         };
+    },
+
+    exportCSV(models, apiConfig, frame) {
+        frame.response = papaparse.unparse(models.data);
     }
 };

package/core/server/data/importer/import-manager.js

@@ -61,6 +61,7 @@ class ImportManager {
             //        in the importer, so we need to keep it as general "content" unless
             //        it becomes a strict requirement
             directories: ['media', 'content'],
+            ignoreRootFolderFiles: true,
             extensions: config.get('uploads').media.extensions,
             contentTypes: config.get('uploads').media.contentTypes,
             contentPath: config.getContentPath('media'),
@@ -74,6 +75,7 @@ class ImportManager {
             //        in the importer, so we need to keep it as general "content" unless
             //        it becomes a strict requirement
             directories: ['files', 'content'],
+            ignoreRootFolderFiles: true,
             extensions: config.get('uploads').files.extensions,
             contentTypes: config.get('uploads').files.contentTypes,
             contentPath: config.getContentPath('files'),
@@ -301,14 +303,7 @@ class ImportManager {
         const baseDir = this.getBaseDirectory(zipDirectory);
 
         for (const handler of this.handlers) {
-            let files = [];
-            if (handler.directories?.length > 0) {
-                for (const dir of handler.directories) {
-                    files.push(...this.getFilesFromZip(handler, path.join(zipDirectory, (baseDir || ''), dir)));
-                }
-            } else {
-                files.push(...this.getFilesFromZip(handler, zipDirectory));
-            }
+            const files = this.getFilesFromZip(handler, zipDirectory);
 
             debug('handler', handler.type, files);
 

package/core/server/data/migrations/versions/5.39/2023-03-13-09-29-add-newsletter-show-post-title-section.js

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

package/core/server/data/migrations/versions/5.39/2023-03-13-13-11-add-newsletter-show-comment-cta.js

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

package/core/server/data/migrations/versions/5.39/2023-03-13-14-30-add-newsletter-show-subscription-details.js

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

package/core/server/data/migrations/versions/5.39/2023-03-14-12-26-add-last-mentions-email-report-timestamp-setting.js

@@ -0,0 +1,8 @@
+const {addSetting} = require('../../utils');
+
+module.exports = addSetting({
+    key: 'last_mentions_report_email_timestamp',
+    value: null,
+    type: 'number',
+    group: 'core'
+});

package/core/server/data/migrations/versions/5.40/2023-03-13-14-05-add-newsletter-show-latest-posts.js

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

package/core/server/data/migrations/versions/5.40/2023-03-21-18-42-add-self-serve-integration-role.js

@@ -0,0 +1,31 @@
+const logging = require('@tryghost/logging');
+const {default: ObjectID} = require('bson-objectid');
+const {createTransactionalMigration, meta} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Creating "Self-Serve Migration Integration" role');
+        const existingRole = await knex('roles').where({
+            name: 'Self-Serve Migration Integration'
+        }).first();
+
+        if (existingRole) {
+            logging.warn('"Self-Serve Migration Integration" role already exists, skipping');
+            return;
+        }
+
+        await knex('roles').insert({
+            id: (new ObjectID()).toHexString(),
+            name: 'Self-Serve Migration Integration',
+            description: 'Core Integration for the Ghost Explore directory',
+            created_by: meta.MIGRATION_USER,
+            created_at: knex.raw('current_timestamp')
+        });
+    },
+    async function down(knex) {
+        logging.info('Deleting role "Self-Serve Migration Integration"');
+        await knex('roles').where({
+            name: 'Self-Serve Migration Integration'
+        }).del();
+    }
+);

package/core/server/data/migrations/versions/5.40/2023-03-21-18-43-add-self-serve-migration-and-permissions.js

@@ -0,0 +1,25 @@
+const {combineTransactionalMigrations, addPermissionWithRoles} = require('../../utils');
+
+module.exports = combineTransactionalMigrations(
+    addPermissionWithRoles({
+        name: 'Import database',
+        action: 'importContent',
+        object: 'db'
+    }, [
+        'Self-Serve Migration Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Add Members',
+        action: 'add',
+        object: 'member'
+    }, [
+        'Self-Serve Migration Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Read tags',
+        action: 'read',
+        object: 'tag'
+    }, [
+        'Self-Serve Migration Integration'
+    ])
+);

package/core/server/data/migrations/versions/5.40/2023-03-21-18-52-add-self-serve-integration.js

@@ -0,0 +1,37 @@
+const logging = require('@tryghost/logging');
+const {default: ObjectID} = require('bson-objectid');
+const {createTransactionalMigration, meta} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Creating "Self-Serve Migration Integration"');
+        const existingIntegration = await knex('integrations').where({
+            name: 'Self-Serve Migration Integration',
+            slug: 'self-serve-migration'
+        }).first();
+
+        if (existingIntegration) {
+            logging.warn('Integration already exists, skipping');
+            return;
+        }
+
+        await knex('integrations').insert({
+            id: (new ObjectID()).toHexString(),
+            type: 'core',
+            name: 'Self-Serve Migration Integration',
+            description: 'Core Integration for the Self-Serve migration tool',
+            slug: 'self-serve-migration',
+            created_at: knex.raw('current_timestamp'),
+            created_by: meta.MIGRATION_USER
+        });
+    },
+    async function down(knex) {
+        logging.info('Deleting "Self-Serve Migration Integration"');
+
+        await knex('integrations').where({
+            type: 'core',
+            name: 'Self-Serve Migration Integration',
+            slug: 'self-serve-migration'
+        }).del();
+    }
+);

package/core/server/data/migrations/versions/5.40/2023-03-21-19-02-add-self-serve-integration-api-key.js

@@ -0,0 +1,72 @@
+const {InternalServerError} = require('@tryghost/errors');
+const logging = require('@tryghost/logging');
+const security = require('@tryghost/security');
+const {default: ObjectID} = require('bson-objectid');
+const {createTransactionalMigration, meta} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Adding Admin API key for "Self-Serve Migration Integration"');
+
+        const integration = await knex('integrations').where({
+            slug: 'self-serve-migration',
+            name: 'Self-Serve Migration Integration'
+        }).first();
+
+        if (!integration) {
+            throw new InternalServerError('Could not find "Self-Serve Migration Integration"');
+        }
+
+        const role = await knex('roles').where({
+            name: 'Self-Serve Migration Integration'
+        }).first();
+
+        if (!role) {
+            throw new InternalServerError('Could not find "Self-Serve Migration Integration" Role');
+        }
+
+        const existingKey = await knex('api_keys').where({
+            integration_id: integration.id,
+            role_id: role.id
+        }).first();
+
+        if (existingKey) {
+            logging.warn('Admin API key for "Self-Serve Migration Integration" already exists');
+            return;
+        }
+
+        await knex('api_keys').insert({
+            id: (new ObjectID()).toHexString(),
+            type: 'core',
+            secret: security.secret.create('admin'),
+            role_id: role.id,
+            integration_id: integration.id,
+            created_at: knex.raw('current_timestamp'),
+            created_by: meta.MIGRATION_USER
+        });
+    },
+    async function down(knex) {
+        logging.info('Removing "Self-Serve Migration Integration" API key');
+
+        const integration = await knex('integrations').where({
+            slug: 'self-serve-migration',
+            type: 'core',
+            name: 'Self-Serve Migration Integration'
+        }).first();
+
+        const role = await knex('roles').where({
+            name: 'Self-Serve Migration Integration'
+        }).first();
+
+        if (!role || !integration) {
+            logging.warn('Could not delete "Self-Serve Migration Integration" API key');
+            return;
+        }
+
+        logging.info('Deleting "Self-Serve Migration Integration" API Key');
+        await knex('api_keys').where({
+            integration_id: integration.id,
+            role_id: role.id
+        }).del();
+    }
+);

package/core/server/data/schema/default-settings/default-settings.json

@@ -1,5 +1,9 @@
 {
     "core": {
+        "last_mentions_report_email_timestamp": {
+            "defaultValue": null,
+            "type": "number"
+        },
         "db_hash": {
             "defaultValue": null,
             "type": "string"

package/core/server/data/schema/fixtures/fixtures.json

@@ -76,6 +76,10 @@
                     "name": "Ghost Explore Integration",
                     "description": "Internal Integration for the Ghost Explore directory"
                 },
+                {
+                    "name": "Self-Serve Migration Integration",
+                    "description": "Internal Integration for the Self-Serve migration tool"
+                },
                 {
                     "name": "DB Backup Integration",
                     "description": "Internal DB Backup Client"
@@ -701,6 +705,18 @@
                     "type": "core",
                     "api_keys": [{"type": "admin", "role": "Ghost Explore Integration"}]
                 },
+                {
+                    "slug": "self-serve-migration",
+                    "name": "Self-Serve Migration Integration",
+                    "description": "Core Self-Serve Migration integration",
+                    "type": "core",
+                    "api_keys": [
+                        {
+                            "type": "admin",
+                            "role": "Self-Serve Migration Integration"
+                        }
+                    ]
+                },
                 {
                     "slug": "ghost-backup",
                     "name": "Ghost Backup",
@@ -780,6 +796,11 @@
                 "Ghost Explore Integration": {
                     "explore": "read"
                 },
+                "Self-Serve Migration Integration": {
+                    "db": "importContent",
+                    "member": "add",
+                    "tag": "read"
+                },
                 "Admin Integration": {
                     "mail": "all",
                     "notification": "all",

package/core/server/data/schema/schema.js

@@ -37,6 +37,10 @@ module.exports = {
         footer_content: {type: 'text', maxlength: 1000000000, nullable: true},
         show_badge: {type: 'boolean', nullable: false, defaultTo: true},
         show_header_name: {type: 'boolean', nullable: false, defaultTo: true},
+        show_post_title_section: {type: 'boolean', nullable: false, defaultTo: true},
+        show_comment_cta: {type: 'boolean', nullable: false, defaultTo: true},
+        show_subscription_details: {type: 'boolean', nullable: false, defaultTo: false},
+        show_latest_posts: {type: 'boolean', nullable: false, defaultTo: false},
         created_at: {type: 'dateTime', nullable: false},
         updated_at: {type: 'dateTime', nullable: true}
     },

package/core/server/lib/request-external.js

@@ -48,15 +48,19 @@ async function errorIfInvalidUrl(options) {
 
 // same as our normal request lib but if any request in a redirect chain resolves
 // to a private IP address it will be blocked before the request is made.
-const externalRequest = got.extend({
+const gotOpts = {
     headers: {
         'user-agent': 'Ghost(https://github.com/TryGhost/Ghost)'
     },
     timeout: 10000, // default is no timeout
     hooks: {
-        beforeRequest: [errorIfInvalidUrl,errorIfHostnameResolvesToPrivateIp],
+        beforeRequest: [errorIfInvalidUrl, errorIfHostnameResolvesToPrivateIp],
         beforeRedirect: [errorIfHostnameResolvesToPrivateIp]
     }
-});
+};
 
-module.exports = externalRequest;
+if (process.env.NODE_ENV?.startsWith('test')) {
+    gotOpts.retry = 0;
+}
+
+module.exports = got.extend(gotOpts);

package/core/server/models/base/plugins/relations.js

@@ -1,3 +1,5 @@
+const errors = require('@tryghost/errors');
+
 /**
  * @param {import('bookshelf')} Bookshelf
  */
@@ -9,6 +11,7 @@ module.exports = function (Bookshelf) {
          * @param {string} name Name of the relation to load
          * @param {Object} [options] Options to pass to the fetch when not yet loaded (or when force refreshing)
          * @param {boolean} [options.forceRefresh] If true, the relation will be fetched again even if it has already been loaded.
+         * @param {boolean} [options.require] Off by default. Throws an error if relation is not found.
          * @returns {Promise<import('bookshelf').Model|import('bookshelf').Collection|null>}
          */
         getLazyRelation: async function (name, options = {}) {
@@ -18,13 +21,32 @@ module.exports = function (Bookshelf) {
             }
 
             if (!this[name]) {
+                if (options.require) {
+                    throw new errors.NotFoundError();
+                }
                 return undefined;
             }
+
+            // Explicitly set require to false if it's not set, because default for .fetch is true (not false)
+            if (options.require) {
+                options.require = true;
+            } else {
+                options.require = false;
+            }
+
             // Not yet loaded, or force refresh
             // Note that we don't use .refresh on the relation on options.forceRefresh
             // Because the relation can also be a collection, which doesn't have a refresh method
             const instance = this[name]();
             await instance.fetch(options);
+
+            if (!instance.id && !(instance instanceof Bookshelf.Collection)) {
+                // Some weird behaviour in Bookshelf allows to just return a newly created model instance instead of throwing an error
+                if (options.require) {
+                    throw new errors.NotFoundError();
+                }
+                return undefined;
+            }
             this.relations[name] = instance;
             return instance;
         }

package/core/server/models/base/plugins/sanitize.js

@@ -41,7 +41,7 @@ module.exports = function (Bookshelf) {
             case 'add':
                 return baseOptions.concat(extraOptions, ['autoRefresh']);
             case 'edit':
-                return baseOptions.concat(extraOptions, ['id', 'require']);
+                return baseOptions.concat(extraOptions, ['id', 'require', 'autoRefresh']);
             case 'findOne':
                 return baseOptions.concat(extraOptions, ['columns', 'require', 'mongoTransformer']);
             case 'findAll':

package/core/server/models/newsletter.js

@@ -22,6 +22,10 @@ const Newsletter = ghostBookshelf.Model.extend({
             show_header_icon: true,
             show_header_title: true,
             show_header_name: true,
+            show_post_title_section: true,
+            show_comment_cta: true,
+            show_subscription_details: false,
+            show_latest_posts: false,
             feedback_enabled: false
         };
     },

package/core/server/services/email-service/wrapper.js

@@ -25,6 +25,7 @@ class EmailServiceWrapper {
         const sentry = require('../../../shared/sentry');
         const membersRepository = membersService.api.members;
         const limitService = require('../limits');
+        const labs = require('../../../shared/labs');
 
         const mobiledocLib = require('../../lib/mobiledoc');
         const lexicalLib = require('../../lib/lexical');
@@ -68,7 +69,9 @@ class EmailServiceWrapper {
             linkTracking,
             memberAttributionService: memberAttribution.service,
             audienceFeedbackService: audienceFeedback.service,
-            outboundLinkTagger: memberAttribution.outboundLinkTagger
+            outboundLinkTagger: memberAttribution.outboundLinkTagger,
+            labs,
+            models: {Post}
         });
 
         const sendingService = new SendingService({

package/core/server/services/i18n.js

@@ -0,0 +1,14 @@
+//const debug = require('@tryghost/debug')('i18n');
+const i18n = require('@tryghost/i18n');
+
+module.exports.init = function () {
+    //const events = require('../lib/common/events');
+    //const settingsCache = require('../../shared/settings-cache');
+
+    module.exports = i18n(/* settingsCache.get('locale') */ 'en', 'ghost');
+
+    /*events.on('settings.locale.edited', (model) => {
+        debug('locale changed, updating i18n to', model.get('value'));
+        i18nInstance.changeLanguage(model.get('value'));
+    });*/
+};

package/core/server/services/member-attribution/index.js

@@ -2,6 +2,7 @@ const urlService = require('../url');
 const urlUtils = require('../../../shared/url-utils');
 const settingsCache = require('../../../shared/settings-cache');
 const labs = require('../../../shared/labs');
+const config = require('../../../shared/config');
 
 class MemberAttributionServiceWrapper {
     init() {
@@ -35,7 +36,7 @@ class MemberAttributionServiceWrapper {
 
         this.outboundLinkTagger = new OutboundLinkTagger({
             isEnabled: () => !labs.isSet('outboundLinkTagging') || !!settingsCache.get('outbound_link_tagging'),
-            getSiteTitle: () => settingsCache.get('title'),
+            getSiteUrl: () => config.getSiteUrl(),
             urlUtils
         });