ghost 4.48.0 → 5.0.0

package/core/server/data/migrations/versions/5.0/2022-05-09-14-17-cleanup-invalid-users-status.js

@@ -0,0 +1,17 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info(`Updating users with invalid statuses to 'inactive'`);
+
+        const affectedRows = await knex('users')
+            .update('status', 'inactive')
+            .whereNotIn('status', ['active', 'inactive', 'locked', 'warn-1', 'warn-2', 'warn-3', 'warn-4']);
+
+        logging.info(`Updated ${affectedRows} users with invalid statuses to 'inactive'`);
+    },
+    async function down() {
+        // no-op: we don't want to revert users back to an invalid status
+    }
+);

package/core/server/data/migrations/versions/5.0/2022-05-10-08-33-drop-members-analytics-table.js

@@ -0,0 +1,3 @@
+const {dropTables} = require('../../utils');
+
+module.exports = dropTables(['temp_member_analytic_events']);

package/core/server/data/migrations/versions/5.0/2022-05-10-14-57-cleanup-invalid-posts-status.js

@@ -0,0 +1,17 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info(`Updating posts with invalid statuses to 'draft'`);
+
+        const affectedRows = await knex('posts')
+            .update('status', 'draft')
+            .whereNotIn('status', ['published', 'draft', 'scheduled', 'sent']);
+
+        logging.info(`Updated ${affectedRows} posts with invalid statuses to 'draft'`);
+    },
+    async function down() {
+        // no-op: we don't want to set posts back to invalid statuses
+    }
+);

package/core/server/data/migrations/versions/5.0/2022-05-11-12-08-drop-webhooks-status-column.js

@@ -0,0 +1,18 @@
+const {createDropColumnMigration} = require('../../utils');
+
+// Preferably I could use `createIrreversibleMigration` here like
+// `createIrreversibleMigration(createDropColumnMigration(...).up)` but
+// that seems to throw some obscure error that I'm not sure about... something
+// to look into for the future
+module.exports = {
+    ...createDropColumnMigration('webhooks', 'status', {}),
+
+    down: async () => {
+        // no-op: we're setting this migration to irreversible so we won't
+        // execute the `down`
+    },
+
+    config: {
+        irreversible: true
+    }
+};

package/core/server/data/migrations/versions/5.0/2022-05-11-13-12-rename-settings.js

@@ -0,0 +1,51 @@
+const logging = require('@tryghost/logging');
+const _ = require('lodash');
+const {createTransactionalMigration} = require('../../utils');
+
+const renameMappings = [{
+    from: 'lang',
+    to: 'locale'
+}, {
+    from: 'session_secret',
+    to: 'admin_session_secret'
+}];
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const keys = _.flatMap(renameMappings, (m) => {
+            return [m.from, m.to];
+        });
+
+        const settings = await knex('settings').select('key', 'value').whereIn('key', keys);
+
+        // eslint-disable-next-line no-restricted-syntax
+        for (const renameMapping of renameMappings) {
+            if (_.find(settings, {key: renameMapping.to}) && _.find(settings, {key: renameMapping.from})) {
+                let updatedValue = _.find(settings, {key: renameMapping.from}).value;
+                // CASE: default settings were added already, update them with old values & remove old settings
+                logging.info(`Updating ${renameMapping.to} with value from ${renameMapping.from}`);
+                await knex('settings')
+                    .where('key', renameMapping.to)
+                    .update('value', updatedValue);
+
+                logging.info(`Deleting ${renameMapping.from}`);
+                await knex('settings')
+                    .where('key', renameMapping.from)
+                    .del();
+            } else if (_.find(settings, {key: renameMapping.from})) {
+                // CASE: old settings exist, update them
+                logging.info(`Renaming ${renameMapping.from} to ${renameMapping.to}`);
+                await knex('settings')
+                    .where('key', renameMapping.from)
+                    .update('key', renameMapping.to);
+            } else {
+                // CASE: old settings don't exist, let default settings create them
+                logging.warn(`Setting ${renameMapping.from} is missing, skipping update`);
+            }
+        }
+    },
+
+    async function down() {
+        // no-op: we can't rollback as there are irreversible migrations in 5.0
+    }
+);

package/core/server/data/migrations/versions/5.0/2022-05-11-16-36-remove-unused-settings.js

@@ -0,0 +1,54 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+const settingsToRemove = [
+    'editor_is_launch_complete',
+    'members_free_price_name',
+    'members_free_price_description',
+    'members_paid_signup_redirect',
+    'members_free_signup_redirect',
+    'members_from_address',
+    'members_reply_address',
+    'stripe_product_name',
+    'newsletter_show_badge',
+    'newsletter_header_image',
+    'newsletter_show_header_icon',
+    'newsletter_show_header_title',
+    'newsletter_title_alignment',
+    'newsletter_title_font_category',
+    'newsletter_show_feature_image',
+    'newsletter_body_font_category',
+    'newsletter_footer_content',
+    'oauth_client_id',
+    'oauth_client_secret'
+];
+
+// Settings that cannot be removed, but should not be used anymore
+// 'members_monthly_price_id',
+// 'members_yearly_price_id',
+// 'portal_products',
+// 'stripe_plans'
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const existingSettings = await knex('settings')
+            .whereIn('key', settingsToRemove)
+            .pluck('key');
+
+        const settingsInDatabase = settingsToRemove.filter(s => existingSettings.includes(s));
+        if (settingsInDatabase.length) {
+            logging.info(`Deleting settings: ${settingsInDatabase.join(', ')}`);
+            await knex('settings')
+                .whereIn('key', settingsInDatabase)
+                .del();
+        }
+
+        const settingsNotInDatabase = settingsToRemove.filter(s => !existingSettings.includes(s));
+        if (settingsNotInDatabase.length) {
+            logging.warn(`Unable to delete missing settings: ${settingsNotInDatabase.join(', ')}`);
+        }
+    },
+    async function down() {
+        // no-op: we don't want to recreate these settings without values
+    }
+);

package/core/server/data/migrations/versions/5.0/2022-05-12-10-29-add-newsletter-permissions-for-editors-and-authors.js

@@ -0,0 +1,20 @@
+const {combineTransactionalMigrations, addPermissionToRole} = require('../../utils');
+
+module.exports = combineTransactionalMigrations(
+    addPermissionToRole({
+        permission: 'Browse newsletters',
+        role: 'Editor'
+    }),
+    addPermissionToRole({
+        permission: 'Read newsletters',
+        role: 'Editor'
+    }),
+    addPermissionToRole({
+        permission: 'Browse newsletters',
+        role: 'Author'
+    }),
+    addPermissionToRole({
+        permission: 'Read newsletters',
+        role: 'Author'
+    })
+);

package/core/server/data/migrations/versions/5.0/2022-05-12-13-51-add-label-permissions-for-authors.js

@@ -0,0 +1,12 @@
+const {combineTransactionalMigrations, addPermissionToRole} = require('../../utils');
+
+module.exports = combineTransactionalMigrations(
+    addPermissionToRole({
+        permission: 'Browse labels',
+        role: 'Author'
+    }),
+    addPermissionToRole({
+        permission: 'Read labels',
+        role: 'Author'
+    })
+);

package/core/server/data/migrations/versions/5.0/2022-05-13-11-38-drop-none-email-recipient-filter.js

@@ -0,0 +1,28 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        // The 'none' value is no longer supported/used
+        logging.info(`Updating posts with email_recipient_filter 'none' to 'all' and newsletter_id to null`);
+
+        const affectedRows = await knex('posts')
+            .update({
+                email_recipient_filter: 'all',
+                newsletter_id: null
+            })
+            .where('email_recipient_filter', 'none');
+
+        logging.info(`Updated ${affectedRows} posts' email_recipient_filter to 'all' and newsletter_id to null`);
+    },
+    async function down(knex) {
+        // In previous versions, none meant that no email was sent.
+        logging.info(`Updating posts' email_recipient_filter to 'none' if they have no newsletter`);
+
+        const affectedRows = await knex('posts')
+            .update('email_recipient_filter', 'none')
+            .where('newsletter_id', null);
+
+        logging.info(`Updated ${affectedRows} posts' email_recipient_filter to 'none'`);
+    }
+);

package/core/server/data/migrations/versions/5.0/2022-05-21-00-00-regenerate-posts-html.js

@@ -0,0 +1,70 @@
+const logging = require('@tryghost/logging');
+const {createIrreversibleMigration} = require('../../utils');
+const mobiledocLib = require('../../../../lib/mobiledoc');
+const htmlToPlaintext = require('../../../../../shared/html-to-plaintext');
+
+module.exports = createIrreversibleMigration(async (knex) => {
+    logging.info(`Starting regeneration of posts HTML`);
+
+    await knex.transaction(async (trx) => {
+        // get list of posts ids, use .forUpdate to lock rows until the transaction is finished
+        const postIdRows = await knex('posts')
+            .transacting(trx)
+            .forUpdate()
+            .select('id')
+            .where('mobiledoc', 'like', '%["video%')
+            .orWhere('mobiledoc', 'like', '%["product%');
+
+        logging.info(`Updating HTML for ${postIdRows.length} posts`);
+
+        // transform each post individually to avoid dumping all posts into memory and
+        // pushing all queries into the query builder buffer in parallel
+        // https://stackoverflow.com/questions/54105280/how-to-loop-through-multi-line-sql-query-and-use-them-in-knex-transactions
+
+        // eslint-disable-next-line no-restricted-syntax
+        for (const postIdRow of postIdRows) {
+            const {id} = postIdRow;
+            const [post] = await knex('posts')
+                .transacting(trx)
+                .where({id})
+                .select('mobiledoc', 'html', 'plaintext');
+
+            let mobiledoc;
+
+            try {
+                mobiledoc = JSON.parse(post.mobiledoc || null);
+
+                if (!mobiledoc) {
+                    logging.warn(`No mobiledoc for ${id}. Skipping.`);
+                    continue;
+                }
+            } catch (err) {
+                logging.warn(`Invalid JSON structure for ${id}. Skipping`);
+                continue;
+            }
+
+            const html = mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc);
+
+            const updatedAttrs = {
+                html
+            };
+
+            if (html !== post.html || !post.plaintext) {
+                const plaintext = htmlToPlaintext.excerpt(html);
+
+                if (plaintext !== post.plaintext) {
+                    updatedAttrs.plaintext = plaintext;
+                }
+            }
+
+            await knex('posts')
+                .transacting(trx)
+                .where({id})
+                .update(updatedAttrs);
+        }
+
+        return 'transaction complete';
+    });
+
+    logging.info('Finished regeneration of posts HTML');
+});

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

@@ -71,10 +71,26 @@ function dropNullable(tableName, column, transaction = db.knex) {
     });
 }
 
-function addColumn(tableName, column, transaction = db.knex, columnSpec) {
-    return transaction.schema.table(tableName, function (table) {
+async function addColumn(tableName, column, transaction = db.knex, columnSpec) {
+    const addColumnBuilder = transaction.schema.table(tableName, function (table) {
         addTableColumn(tableName, table, column, columnSpec);
     });
+
+    // Use the default flow for SQLite because .toSQL() is tricky with SQLite when
+    // it does the table dance
+    if (DatabaseInfo.isSQLite(transaction)) {
+        await addColumnBuilder;
+        return;
+    }
+
+    let sql = addColumnBuilder.toSQL()[0].sql;
+
+    if (DatabaseInfo.isMySQL(transaction)) {
+        // Guard against an ending semicolon
+        sql = sql.replace(/;\s*$/, '') + ', algorithm=copy';
+    }
+
+    await transaction.raw(sql);
 }
 
 async function dropColumn(tableName, column, transaction = db.knex, columnSpec = {}) {
@@ -83,9 +99,25 @@ async function dropColumn(tableName, column, transaction = db.knex, columnSpec =
         await dropForeign({fromTable: tableName, fromColumn: column, toTable, toColumn, transaction});
     }
 
-    return transaction.schema.table(tableName, function (table) {
+    const dropTableBuilder = transaction.schema.table(tableName, function (table) {
         table.dropColumn(column);
     });
+
+    // Use the default flow for SQLite because .toSQL() is tricky with SQLite when
+    // it does the table dance
+    if (DatabaseInfo.isSQLite(transaction)) {
+        await dropTableBuilder;
+        return;
+    }
+
+    let sql = dropTableBuilder.toSQL()[0].sql;
+
+    if (DatabaseInfo.isMySQL(transaction)) {
+        // Guard against an ending semicolon
+        sql = sql.replace(/;\s*$/, '') + ', algorithm=copy';
+    }
+
+    await transaction.raw(sql);
 }
 
 /**

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

@@ -20,7 +20,7 @@
             "defaultValue": "[]",
             "type": "array"
         },
-        "session_secret": {
+        "admin_session_secret": {
             "defaultValue": null,
             "type": "string"
         },
@@ -98,7 +98,7 @@
             },
             "type": "string"
         },
-        "lang": {
+        "locale": {
             "defaultValue": "en",
             "validations": {
                 "isEmpty": false
@@ -251,36 +251,11 @@
             },
             "type": "string"
         },
-        "members_from_address": {
-            "defaultValue": "noreply",
-            "flags": "RO",
-            "type": "string"
-        },
         "members_support_address": {
             "defaultValue": "noreply",
             "flags": "PUBLIC,RO",
             "type": "string"
         },
-        "members_reply_address": {
-            "defaultValue": "newsletter",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [["newsletter", "support"]]
-            },
-            "type": "string"
-        },
-        "members_free_signup_redirect": {
-            "defaultValue": "/",
-            "type": "string"
-        },
-        "members_paid_signup_redirect": {
-            "defaultValue": "/",
-            "type": "string"
-        },
-        "stripe_product_name": {
-            "defaultValue": "Ghost Subscription",
-            "type": "string"
-        },
         "stripe_secret_key": {
             "defaultValue": null,
             "type": "string"
@@ -313,14 +288,6 @@
             "defaultValue": null,
             "type": "string"
         },
-        "members_free_price_name": {
-            "defaultValue": "Free",
-            "type": "string"
-        },
-        "members_free_price_description": {
-            "defaultValue": "Free preview",
-            "type": "string"
-        },
         "members_monthly_price_id": {
             "defaultValue": null,
             "type": "string"
@@ -466,122 +433,6 @@
             "type": "array"
         }
     },
-    "newsletter": {
-        "newsletter_show_badge": {
-            "defaultValue": "true",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "true",
-                        "false"
-                    ]
-                ]
-            },
-            "type": "boolean"
-        },
-        "newsletter_header_image": {
-            "defaultValue": null,
-            "validations": {
-                "isLength": {
-                    "max": 2000
-                }
-            },
-            "type": "string"
-        },
-        "newsletter_show_header_icon": {
-            "defaultValue": "true",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "true",
-                        "false"
-                    ]
-                ]
-            },
-            "type": "boolean"
-        },
-        "newsletter_show_header_title": {
-            "defaultValue": "true",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "true",
-                        "false"
-                    ]
-                ]
-            },
-            "type": "boolean"
-        },
-        "newsletter_title_alignment": {
-            "defaultValue": "center",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "center",
-                        "left"
-                    ]
-                ]
-            },
-            "type": "string"
-        },
-        "newsletter_title_font_category": {
-            "defaultValue": "sans_serif",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "serif",
-                        "sans_serif"
-                    ]
-                ]
-            },
-            "type": "string"
-        },
-        "newsletter_show_feature_image": {
-            "defaultValue": "true",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "true",
-                        "false"
-                    ]
-                ]
-            },
-            "type": "boolean"
-        },
-        "newsletter_body_font_category": {
-            "defaultValue": "sans_serif",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [
-                    [
-                        "serif",
-                        "sans_serif"
-                    ]
-                ]
-            },
-            "type": "string"
-        },
-        "newsletter_footer_content": {
-            "defaultValue": "",
-            "type": "string"
-        }
-    },
-    "oauth": {
-        "oauth_client_id" : {
-            "defaultValue": null,
-            "type": "string"
-        },
-        "oauth_client_secret" : {
-            "defaultValue": null,
-            "type": "string"
-        }
-    },
     "editor": {
         "editor_default_email_recipients": {
             "defaultValue": "visibility",
@@ -598,14 +449,6 @@
         "editor_default_email_recipients_filter": {
             "defaultValue": "all",
             "type": "string"
-        },
-        "editor_is_launch_complete": {
-            "defaultValue": "false",
-            "validations": {
-                "isEmpty": false,
-                "isIn": [["true", "false"]]
-            },
-            "type": "boolean"
         }
     }
 }

package/core/server/data/schema/fixtures/fixture-manager.js

@@ -74,13 +74,22 @@ class FixtureManager {
             migrating: true
         }, options);
 
-        await Promise.mapSeries(this.fixtures.models, (model) => {
+        const roleModel = this.fixtures.models.find(m => m.name === 'Role');
+        await this.addFixturesForModel(roleModel, localOptions);
+
+        const userModel = this.fixtures.models.find(m => m.name === 'User');
+        await this.addFixturesForModel(userModel, localOptions);
+
+        const userRolesRelation = this.fixtures.relations.find(r => r.from.relation === 'roles');
+        await this.addFixturesForRelation(userRolesRelation, localOptions);
+
+        await Promise.mapSeries(this.fixtures.models.filter(m => !['User', 'Role'].includes(m.name)), (model) => {
             logging.info('Model: ' + model.name);
 
             return this.addFixturesForModel(model, localOptions);
         });
 
-        await Promise.mapSeries(this.fixtures.relations, (relation) => {
+        await Promise.mapSeries(this.fixtures.relations.filter(r => r.from.relation !== 'roles'), (relation) => {
             logging.info('Relation: ' + relation.from.model + ' to ' + relation.to.model);
             return this.addFixturesForRelation(relation, localOptions);
         });

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

@@ -589,8 +589,7 @@
                     "status": "published",
                     "visibility": "public",
                     "created_by": "1",
-                    "published_by": "1",
-                    "author_id": "1"
+                    "published_by": "1"
                 },
                 {
                     "title": "About this site",
@@ -601,8 +600,7 @@
                     "status": "published",
                     "visibility": "public",
                     "created_by": "1",
-                    "published_by": "1",
-                    "author_id": "1"
+                    "published_by": "1"
                 }
             ]
         },
@@ -629,6 +627,13 @@
                     "description": "Internal Scheduler integration",
                     "type": "internal",
                     "api_keys": [{"type": "admin", "role": "Scheduler Integration"}]
+                },
+                {
+                    "slug": "ghost-internal-frontend",
+                    "name": "Ghost Internal Frontend",
+                    "description": "Internal frontend integration",
+                    "type": "internal",
+                    "api_keys": [{"type": "content"}]
                 }
             ]
         }
@@ -701,7 +706,8 @@
                     "email": "all",
                     "snippet": "all",
                     "product": ["browse", "read", "add", "edit"],
-                    "offer": ["browse", "read", "add", "edit"]
+                    "offer": ["browse", "read", "add", "edit"],
+                    "newsletter": ["browse", "read", "add", "edit"]
                 },
                 "Editor": {
                     "notification": "all",
@@ -717,7 +723,8 @@
                     "email": "all",
                     "snippet": "all",
                     "label": ["browse", "read"],
-                    "product": ["browse", "read"]
+                    "product": ["browse", "read"],
+                    "newsletter": ["browse", "read"]
                 },
                 "Author": {
                     "post": ["browse", "read", "add"],
@@ -730,7 +737,9 @@
                     "email_preview": "read",
                     "email": "read",
                     "snippet": ["browse", "read"],
-                    "product": ["browse", "read"]
+                    "label": ["browse", "read"],
+                    "product": ["browse", "read"],
+                    "newsletter": ["browse", "read"]
                 },
                 "Contributor": {
                     "post": ["browse", "read", "add"],