ghost 4.48.0 → 5.0.2

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"],

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

@@ -51,7 +51,7 @@ module.exports = {
         feature_image: {type: 'string', maxlength: 2000, nullable: true},
         featured: {type: 'bool', nullable: false, defaultTo: false},
         type: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'post', validations: {isIn: [['post', 'page']]}},
-        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'draft'},
+        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'draft', validations: {isIn: [['published', 'draft', 'scheduled', 'sent']]}},
         // NOTE: unused at the moment and reserved for future features
         locale: {type: 'string', maxlength: 6, nullable: true},
         visibility: {
@@ -63,14 +63,8 @@ module.exports = {
         email_recipient_filter: {
             type: 'text',
             maxlength: 1000000000,
-            nullable: false,
-            defaultTo: 'none'
+            nullable: false
         },
-        /**
-         * @deprecated: single authors was superceded by multiple authors in Ghost 1.22.0
-         * If we keep it, then only, because you can easier query post.author_id than posts_authors[*].sort_order.
-         */
-        author_id: {type: 'string', maxlength: 24, nullable: false},
         created_at: {type: 'dateTime', nullable: false},
         /**
          * @deprecated: https://github.com/TryGhost/Ghost/issues/10286
@@ -109,6 +103,7 @@ module.exports = {
         feature_image_caption: {type: 'text', maxlength: 65535, nullable: true},
         email_only: {type: 'bool', nullable: false, defaultTo: false}
     },
+    // NOTE: this is the staff table
     users: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         name: {type: 'string', maxlength: 191, nullable: false},
@@ -123,10 +118,23 @@ module.exports = {
         facebook: {type: 'string', maxlength: 2000, nullable: true},
         twitter: {type: 'string', maxlength: 2000, nullable: true},
         accessibility: {type: 'text', maxlength: 65535, nullable: true},
-        // TODO: would be good to add validation here to control for all possible status values.
-        //       The ones that come up by reviewing the user model are:
-        //       'active', 'inactive', 'locked', 'warn-1', 'warn-2', 'warn-3', 'warn-4'
-        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
+        status: {
+            type: 'string',
+            maxlength: 50,
+            nullable: false,
+            defaultTo: 'active',
+            validations: {
+                isIn: [[
+                    'active',
+                    'inactive',
+                    'locked',
+                    'warn-1',
+                    'warn-2',
+                    'warn-3',
+                    'warn-4'
+                ]]
+            }
+        },
         // NOTE: unused at the moment and reserved for future features
         locale: {type: 'string', maxlength: 6, nullable: true},
         visibility: {
@@ -145,16 +153,6 @@ module.exports = {
         updated_at: {type: 'dateTime', nullable: true},
         updated_by: {type: 'string', maxlength: 24, nullable: true}
     },
-    oauth: {
-        id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-        provider: {type: 'string', maxlength: 50, nullable: false},
-        provider_id: {type: 'string', maxlength: 191, nullable: false},
-        access_token: {type: 'text', maxlength: 65535, nullable: true},
-        refresh_token: {type: 'text', maxlength: 2000, nullable: true},
-        created_at: {type: 'dateTime', nullable: false},
-        updated_at: {type: 'dateTime', nullable: true},
-        user_id: {type: 'string', maxlength: 24, nullable: false, references: 'users.id'}
-    },
     posts_authors: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         post_id: {type: 'string', maxlength: 24, nullable: false, references: 'posts.id'},
@@ -337,13 +335,12 @@ module.exports = {
         target_url: {type: 'string', maxlength: 2000, nullable: false},
         name: {type: 'string', maxlength: 191, nullable: true},
         secret: {type: 'string', maxlength: 191, nullable: true},
-        // NOTE: the defaultTo does not make sense to set on DB layer as it leads to unnecessary maintenance every major release
-        //       it might make sense to introduce "isIn" validation checking if it's a valid version e.g: 'v3', 'v4', 'canary'
+        // @NOTE: the defaultTo does not make sense to set on DB layer as it leads to unnecessary maintenance every major release
+        //       would be ideal if we can remove the default and instead have "isIn" validation checking if it's a valid version e.g: 'v3', 'v4', 'canary'
         api_version: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'v2'},
         // NOTE: integration_id column needs "nullable: true" -> "nullable: false" migration (recreate table with nullable: false)
         // CASE: Ghost instances initialized pre 4.0 will have this column set to nullable: true in db schema
         integration_id: {type: 'string', maxlength: 24, nullable: false, references: 'integrations.id', cascadeDelete: true},
-        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'available'},
         last_triggered_at: {type: 'dateTime', nullable: true},
         last_triggered_status: {type: 'string', maxlength: 50, nullable: true},
         last_triggered_error: {type: 'string', maxlength: 50, nullable: true},
@@ -397,7 +394,6 @@ module.exports = {
         name: {type: 'string', maxlength: 191, nullable: true},
         note: {type: 'string', maxlength: 2000, nullable: true},
         geolocation: {type: 'string', maxlength: 2000, nullable: true},
-        subscribed: {type: 'bool', nullable: true, defaultTo: true},
         email_count: {type: 'integer', unsigned: true, nullable: false, defaultTo: 0},
         email_opened_count: {type: 'integer', unsigned: true, nullable: false, defaultTo: 0},
         email_open_rate: {type: 'integer', unsigned: true, nullable: true, index: true},
@@ -407,10 +403,12 @@ module.exports = {
         updated_at: {type: 'dateTime', nullable: true},
         updated_by: {type: 'string', maxlength: 24, nullable: true}
     },
+    // NOTE: this is the tiers table
     products: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         name: {type: 'string', maxlength: 191, nullable: false},
         slug: {type: 'string', maxlength: 191, nullable: false, unique: true},
+        // @deprecated: use a status enum with isIn validation, not aan ctive boolean
         active: {type: 'boolean', nullable: false, defaultTo: true},
         welcome_page_url: {type: 'string', maxlength: 2000, nullable: true},
         visibility: {
@@ -429,6 +427,7 @@ module.exports = {
     },
     offers: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+        // @deprecated: use a status enum with isIn validation, not aan ctive boolean
         active: {type: 'boolean', nullable: false, defaultTo: true},
         name: {type: 'string', maxlength: 191, nullable: false, unique: true},
         code: {type: 'string', maxlength: 191, nullable: false, unique: true},
@@ -651,8 +650,7 @@ module.exports = {
         recipient_filter: {
             type: 'text',
             maxlength: 1000000000,
-            nullable: false,
-            defaultTo: 'status:-free'
+            nullable: false
         },
         error: {type: 'string', maxlength: 2000, nullable: true},
         error_data: {type: 'text', maxlength: 1000000000, fieldtype: 'long', nullable: true},
@@ -720,16 +718,6 @@ module.exports = {
         updated_at: {type: 'dateTime', nullable: true},
         updated_by: {type: 'string', maxlength: 24, nullable: true}
     },
-    temp_member_analytic_events: {
-        id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-        event_name: {type: 'string', maxlength: 50, nullable: false},
-        created_at: {type: 'dateTime', nullable: false},
-        member_id: {type: 'string', maxlength: 24, nullable: false},
-        member_status: {type: 'string', maxlength: 50, nullable: false},
-        entry_id: {type: 'string', maxlength: 24, nullable: true},
-        source_url: {type: 'string', maxlength: 2000, nullable: true},
-        metadata: {type: 'string', maxlength: 191, nullable: true}
-    },
     custom_theme_settings: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         theme: {type: 'string', maxlength: 191, nullable: false},

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

@@ -45,6 +45,8 @@ function validateSchema(tableName, model, options) {
         // check nullable
         if (Object.prototype.hasOwnProperty.call(schema[tableName][columnKey], 'nullable') &&
             schema[tableName][columnKey].nullable !== true &&
+            Object.prototype.hasOwnProperty.call(schema[tableName][columnKey], 'type') &&
+            schema[tableName][columnKey].type !== 'text' &&
             !Object.prototype.hasOwnProperty.call(schema[tableName][columnKey], 'defaultTo')
         ) {
             if (validator.isEmpty(strVal)) {

package/core/server/ghost-server.js

@@ -1,12 +1,6 @@
 // # Ghost Server
 // Handles the creation of an HTTP Server for Ghost
 const debug = require('@tryghost/debug')('server');
-
-const Promise = require('bluebird');
-const fs = require('fs-extra');
-const path = require('path');
-const _ = require('lodash');
-const config = require('../shared/config');
 const errors = require('@tryghost/errors');
 const tpl = require('@tryghost/tpl');
 const logging = require('@tryghost/logging');
@@ -42,14 +36,25 @@ const messages = {
  * ## GhostServer
  */
 class GhostServer {
-    constructor({url}) {
+    /**
+     *
+     * @param {Object}  options
+     * @param {String}  options.url
+     * @param {String}  options.env development|production|testing
+     * @param {Object}  options.serverConfig
+     * @param {String}  options.serverConfig.host
+     * @param {Number}  options.serverConfig.port
+     * @param {Number}  options.serverConfig.shutdownTimeout
+     * @param {Boolean} options.serverConfig.testmode
+     */
+    constructor({url, env, serverConfig}) {
         this.url = url;
+        this.env = env;
+        this.serverConfig = serverConfig;
+
         this.rootApp = null;
         this.httpServer = null;
 
-        // Expose config module for use externally.
-        this.config = config;
-
         // Tasks that should be run before the server exits
         this.cleanupTasks = [];
     }
@@ -66,42 +71,16 @@ class GhostServer {
      */
     start(rootApp) {
         debug('Starting...');
-        const self = this;
-        self.rootApp = rootApp;
-        let socketConfig;
+        this.rootApp = rootApp;
 
-        const socketValues = {
-            path: path.join(config.get('paths').contentPath, config.get('env') + '.socket'),
-            permissions: '660'
-        };
+        const {host, port, testmode, shutdownTimeout} = this.serverConfig;
+        const self = this;
 
         return new Promise(function (resolve, reject) {
-            if (_.has(config.get('server'), 'socket')) {
-                socketConfig = config.get('server').socket;
-
-                if (_.isString(socketConfig)) {
-                    socketValues.path = socketConfig;
-                } else if (_.isObject(socketConfig)) {
-                    socketValues.path = socketConfig.path || socketValues.path;
-                    socketValues.permissions = socketConfig.permissions || socketValues.permissions;
-                }
-
-                // Make sure the socket is gone before trying to create another
-                try {
-                    fs.unlinkSync(socketValues.path);
-                } catch (e) {
-                    // We can ignore this.
-                }
-
-                self.httpServer = rootApp.listen(socketValues.path);
-                fs.chmod(socketValues.path, socketValues.permissions);
-                config.set('server:socket', socketValues);
-            } else {
-                self.httpServer = rootApp.listen(
-                    config.get('server').port,
-                    config.get('server').host
-                );
-            }
+            self.httpServer = rootApp.listen(
+                port,
+                host
+            );
 
             self.httpServer.on('error', function (error) {
                 let ghostError;
@@ -109,7 +88,7 @@ class GhostServer {
                 if (error.code === 'EADDRINUSE') {
                     ghostError = new errors.InternalServerError({
                         message: tpl(messages.addressInUse.error),
-                        context: tpl(messages.addressInUse.context, {port: config.get('server').port}),
+                        context: tpl(messages.addressInUse.context, {port}),
                         help: tpl(messages.addressInUse.help)
                     });
                 } else {
@@ -132,7 +111,7 @@ class GhostServer {
                 self._logStartMessages();
 
                 // Debug logs output in testmode only
-                if (config.get('server:testmode')) {
+                if (testmode) {
                     self._startTestMode();
                 }
 
@@ -143,7 +122,7 @@ class GhostServer {
                     });
             });
 
-            stoppable(self.httpServer, config.get('server:shutdownTimeout'));
+            stoppable(self.httpServer, shutdownTimeout);
 
             // ensure that Ghost exits correctly on Ctrl+C and SIGTERM
             process
@@ -177,7 +156,7 @@ class GhostServer {
      * Stops the server & handles cleanup, but does not exit the process
      * Used in tests for quick start/stop actions
      * Called by shutdown to handle server stop and cleanup before exiting
-     * @returns {Promise} Resolves once Ghost has stopped
+     * @returns {Promise<any>} Resolves once Ghost has stopped
      */
     async stop() {
         try {
@@ -221,22 +200,13 @@ class GhostServer {
      * If server.shutdownTimeout is reached, requests are terminated in-flight
      */
     async _stopServer() {
-        return new Promise((resolve, reject) => {
-            this.httpServer
-                .stop((error, status) => {
-                    if (error) {
-                        return reject(error);
-                    }
-
-                    return resolve(status);
-                });
-        });
+        const util = require('util');
+        return util.promisify(this.httpServer.stop)();
     }
 
     async _cleanup() {
         // Wait for all cleanup tasks to finish
-        await Promise
-            .all(this.cleanupTasks.map(task => task()));
+        return Promise.all(this.cleanupTasks.map(task => task()));
     }
 
     /**
@@ -281,14 +251,14 @@ class GhostServer {
      * Log Start Messages
      */
     _logStartMessages() {
-        logging.info(tpl(messages.ghostIsRunningIn, {env: config.get('env')}));
+        logging.info(tpl(messages.ghostIsRunningIn, {env: this.env}));
 
-        if (config.get('env') === 'production') {
+        if (this.env === 'production') {
             logging.info(tpl(messages.yourBlogIsAvailableOn, {url: this.url}));
         } else {
             logging.info(tpl(messages.listeningOn, {
-                host: config.get('server').socket || config.get('server').host,
-                port: config.get('server').port
+                host: this.serverConfig.host,
+                port: this.serverConfig.port
             }));
             logging.info(tpl(messages.urlConfiguredAs, {url: this.url}));
         }
@@ -303,7 +273,7 @@ class GhostServer {
         logging.warn(tpl(messages.ghostHasShutdown));
 
         // Extra clear message for production mode
-        if (config.get('env') === 'production') {
+        if (this.env === 'production') {
             logging.warn(tpl(messages.yourBlogIsNowOffline));
         }