ghost 4.18.0 → 4.20.1

package/core/server/lib/image/image-utils.js

@@ -4,12 +4,12 @@ const Gravatar = require('./gravatar');
 const ImageSize = require('./image-size');
 
 class ImageUtils {
-    constructor({config, logging, tpl, urlUtils, settingsCache, storageUtils, storage, validator, request}) {
-        this.blogIcon = new BlogIcon({config, tpl, urlUtils, settingsCache, storageUtils});
-        this.imageSize = new ImageSize({config, tpl, storage, storageUtils, validator, urlUtils, request});
+    constructor({config, logging, urlUtils, settingsCache, storageUtils, storage, validator, request}) {
+        this.blogIcon = new BlogIcon({config, urlUtils, settingsCache, storageUtils});
+        this.imageSize = new ImageSize({config, storage, storageUtils, validator, urlUtils, request});
         this.cachedImageSizeFromUrl = new CachedImageSizeFromUrl({logging, imageSize: this.imageSize});
         this.gravatar = new Gravatar({config, request});
     }
 }
 
-module.exports = ImageUtils;
+module.exports = ImageUtils;

package/core/server/lib/image/index.js

@@ -5,8 +5,7 @@ const storageUtils = require('../../adapters/storage/utils');
 const validator = require('@tryghost/validator');
 const config = require('../../../shared/config');
 const logging = require('@tryghost/logging');
-const tpl = require('@tryghost/tpl');
 const settingsCache = require('../../../shared/settings-cache');
 const ImageUtils = require('./image-utils');
 
-module.exports = new ImageUtils({config, logging, tpl, urlUtils, settingsCache, storageUtils, storage, validator, request});
+module.exports = new ImageUtils({config, logging, urlUtils, settingsCache, storageUtils, storage, validator, request});

package/core/server/lib/mobiledoc.js

@@ -3,7 +3,6 @@ const errors = require('@tryghost/errors');
 const logging = require('@tryghost/logging');
 const config = require('../../shared/config');
 const storage = require('../adapters/storage');
-const imageTransform = require('@tryghost/image-transform');
 
 let cardFactory;
 let cards;
@@ -34,11 +33,13 @@ module.exports = {
                 siteUrl: config.get('url'),
                 imageOptimization: config.get('imageOptimization'),
                 canTransformImage(storagePath) {
+                    const imageTransform = require('@tryghost/image-transform');
                     const {ext} = path.parse(storagePath);
 
+                    // NOTE: the "saveRaw" check is smelly
                     return imageTransform.canTransformFiles()
                         && imageTransform.canTransformFileExtension(ext)
-                        && typeof storage.getStorage().saveRaw === 'function';
+                        && typeof storage.getStorage('images').saveRaw === 'function';
                 }
             });
 

package/core/server/models/action.js

@@ -3,13 +3,16 @@ const ghostBookshelf = require('./base');
 
 const candidates = [];
 
-_.each(ghostBookshelf.registry.models, (model) => {
-    candidates.push([model, model.prototype.tableName.replace(/s$/, '')]);
-});
-
 const Action = ghostBookshelf.Model.extend({
     tableName: 'actions',
 
+    initialize: function initialize() {
+        _.each(ghostBookshelf.registry.models, (model) => {
+            candidates.push([model, model.prototype.tableName.replace(/s$/, '')]);
+        });
+        this.constructor.__super__.initialize.apply(this, arguments);
+    },
+
     actor() {
         return this.morphTo('actor', ['actor_type', 'actor_id'], ...candidates);
     },

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

@@ -19,15 +19,24 @@ module.exports = function (Bookshelf) {
             const originalInsertSync = parentSync.insert;
             const self = this;
 
-            // deep clone attrs to avoid modifying underlying model attributes by reference
             parentSync.update = function update(attrs) {
-                attrs = self.formatOnWrite(_.cloneDeep(attrs));
-                return originalUpdateSync.apply(this, [attrs]);
+                self._isWriting = true;
+
+                const originalPromise = originalUpdateSync.apply(this, [attrs]);
+
+                return originalPromise.finally(function () {
+                    self._isWriting = false;
+                });
             };
 
-            parentSync.insert = function insert(attrs) {
-                attrs = self.formatOnWrite(_.cloneDeep(attrs));
-                return originalInsertSync.apply(this, [attrs]);
+            parentSync.insert = function insert() {
+                self._isWriting = true;
+
+                const originalPromise = originalInsertSync.apply(this);
+
+                return originalPromise.finally(function () {
+                    self._isWriting = false;
+                });
             };
 
             return parentSync;
@@ -42,6 +51,10 @@ module.exports = function (Bookshelf) {
 
         // format date before writing to DB, bools work
         format: function format(attrs) {
+            if (this._isWriting) {
+                attrs = this.formatOnWrite(attrs);
+            }
+
             return this.fixDatesWhenSave(attrs);
         },
 

package/core/server/models/custom-theme-setting.js

@@ -1,7 +1,62 @@
+const _ = require('lodash');
 const ghostBookshelf = require('./base');
+const urlUtils = require('../../shared/url-utils');
 
 const CustomThemeSetting = ghostBookshelf.Model.extend({
-    tableName: 'custom_theme_settings'
+    tableName: 'custom_theme_settings',
+
+    parse() {
+        const attrs = ghostBookshelf.Model.prototype.parse.apply(this, arguments);
+        const settingType = attrs.type;
+
+        // transform "0" to false for boolean type
+        if (settingType === 'boolean' && (attrs.value === '0' || attrs.value === '1')) {
+            attrs.value = !!+attrs.value;
+        }
+
+        // transform "false" to false for boolean type
+        if (settingType === 'boolean' && (attrs.value === 'false' || attrs.value === 'true')) {
+            attrs.value = JSON.parse(attrs.value);
+        }
+
+        // transform URLs to absolute for image settings
+        if (settingType === 'image' && attrs.value) {
+            attrs.value = urlUtils.transformReadyToAbsolute(attrs.value);
+        }
+
+        return attrs;
+    },
+
+    format() {
+        const attrs = ghostBookshelf.Model.prototype.format.apply(this, arguments);
+        const settingType = attrs.type;
+
+        if (settingType === 'boolean') {
+            // CASE: Ensure we won't forward strings, otherwise model events or model interactions can fail
+            if (attrs.value === '0' || attrs.value === '1') {
+                attrs.value = !!+attrs.value;
+            }
+
+            // CASE: Ensure we won't forward strings, otherwise model events or model interactions can fail
+            if (attrs.value === 'false' || attrs.value === 'true') {
+                attrs.value = JSON.parse(attrs.value);
+            }
+
+            if (_.isBoolean(attrs.value)) {
+                attrs.value = attrs.value.toString();
+            }
+        }
+
+        return attrs;
+    },
+
+    formatOnWrite(attrs) {
+        if (attrs.type === 'image' && attrs.value) {
+            attrs.value = urlUtils.toTransformReady(attrs.value);
+        }
+
+        return attrs;
+    }
 });
 
 module.exports = {

package/core/server/models/index.js

@@ -3,6 +3,7 @@
  */
 
 const _ = require('lodash');
+const glob = require('glob');
 
 // enable event listeners
 require('./base/listeners');
@@ -12,54 +13,12 @@ require('./base/listeners');
  */
 exports = module.exports;
 
-const models = [
-    'permission',
-    'post',
-    'role',
-    'settings',
-    'custom-theme-setting',
-    'session',
-    'tag',
-    'tag-public',
-    'user',
-    'author',
-    'invite',
-    'webhook',
-    'integration',
-    'api-key',
-    'mobiledoc-revision',
-    'member',
-    'offer',
-    'product',
-    'benefit',
-    'stripe-product',
-    'stripe-price',
-    'member-subscribe-event',
-    'member-paid-subscription-event',
-    'member-login-event',
-    'member-email-change-event',
-    'member-payment-event',
-    'member-status-event',
-    'member-product-event',
-    'member-analytic-event',
-    'posts-meta',
-    'member-stripe-customer',
-    'stripe-customer-subscription',
-    'email',
-    'email-batch',
-    'email-recipient',
-    'label',
-    'single-use-token',
-    'snippet',
-    // Action model MUST be loaded last as it loops through all of the registered models
-    // Please do not append items to this array.
-    'action'
-];
-
 function init() {
     exports.Base = require('./base');
 
-    models.forEach(function (name) {
+    let modelsFiles = glob.sync('!(index).js', {cwd: __dirname});
+    modelsFiles.forEach((model) => {
+        const name = model.replace(/.js$/, '');
         _.extend(exports, require('./' + name));
     });
 }

package/core/server/models/member.js

@@ -94,6 +94,11 @@ const Member = ghostBookshelf.Model.extend({
             });
     },
 
+    offerRedemptions() {
+        return this.hasMany('OfferRedemption', 'member_id', 'id')
+            .query('orderBy', 'created_at', 'DESC');
+    },
+
     labels: function labels() {
         return this.belongsToMany('Label', 'members_labels', 'member_id', 'label_id')
             .withPivot('sort_order')

package/core/server/models/offer-redemption.js

@@ -0,0 +1,10 @@
+const ghostBookshelf = require('./base');
+
+const OfferRedemption = ghostBookshelf.Model.extend({
+    tableName: 'offer_redemptions'
+});
+
+module.exports = {
+    OfferRedemption: ghostBookshelf.model('OfferRedemption', OfferRedemption)
+};
+

package/core/server/models/user.js

@@ -8,7 +8,6 @@ const limitService = require('../services/limits');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const security = require('@tryghost/security');
-const {gravatar} = require('../lib/image');
 const {pipeline} = require('@tryghost/promise');
 const validatePassword = require('../lib/validate-password');
 const permissions = require('../services/permissions');
@@ -191,6 +190,8 @@ User = ghostBookshelf.Model.extend({
         // If the user's email is set & has changed & we are not importing
         if (self.hasChanged('email') && self.get('email') && !options.importing) {
             tasks.gravatar = (function lookUpGravatar() {
+                const {gravatar} = require('../lib/image');
+
                 return gravatar.lookup({
                     email: self.get('email')
                 }).then(function (response) {

package/core/server/overrides.js

@@ -5,13 +5,17 @@
  */
 process.env.BLUEBIRD_DEBUG = 0;
 
+const luxon = require('luxon');
 const moment = require('moment-timezone');
 
 /**
  * force UTC
- *   - you can require moment or moment-timezone, both is configured to UTC
+ *   - old way: you can require moment or moment-timezone
+ *   - new way: you should use Luxon - work is in progress to switch from moment.
+ *
  *   - you are allowed to use new Date() to instantiate datetime values for models, because they are transformed into UTC in the model layer
  *   - be careful when not working with models, every value from the native JS Date is local TZ
- *   - be careful when you work with date operations, therefor always wrap a date into moment
+ *   - be careful when you work with date operations, therefore always wrap a date with our timezone library
  */
+luxon.Settings.defaultZone = 'UTC';
 moment.tz.setDefault('UTC');

package/core/server/run-update-check.js

@@ -52,9 +52,6 @@ if (parentPort) {
 
     const settings = require('./services/settings');
     await settings.init();
-
-    const i18n = require('../shared/i18n');
-    i18n.init();
     // Finished INIT
 
     await updateCheck({logging});

package/core/server/services/adapter-manager/config.js

@@ -1,4 +1,5 @@
 /**
+ * Maps configuration from the config file to a unified adapter config in following form:
  * {
  *   [adapterType]: {
  *     active: [adapterName],

package/core/server/services/adapter-manager/index.js

@@ -1,5 +1,6 @@
 const AdapterManager = require('@tryghost/adapter-manager');
 const getAdapterServiceConfig = require('./config');
+const resolveAdapterOptions = require('./options-resolver');
 const config = require('../../../shared/config');
 
 const adapterManager = new AdapterManager({
@@ -16,13 +17,16 @@ adapterManager.registerAdapter('scheduling', require('../../adapters/scheduling/
 adapterManager.registerAdapter('sso', require('../../adapters/sso/Base'));
 
 module.exports = {
-    getAdapter(adapterType) {
+    /**
+     *
+     * @param {String} name - one of 'storage', 'scheduling', 'sso' etc. Or can contain a "resource" extension like "storage:image"
+     * @returns {Object} instance of an adapter
+     */
+    getAdapter(name) {
         const adapterServiceConfig = getAdapterServiceConfig(config);
 
-        const adapterSettings = adapterServiceConfig[adapterType];
-        const activeAdapter = adapterSettings.active;
-        const activeAdapterConfig = adapterSettings[activeAdapter];
+        const {adapterType, adapterName, adapterConfig} = resolveAdapterOptions(name, adapterServiceConfig);
 
-        return adapterManager.getAdapter(adapterType, activeAdapter, activeAdapterConfig);
+        return adapterManager.getAdapter(adapterType, adapterName, adapterConfig);
     }
 };

package/core/server/services/adapter-manager/options-resolver.js

@@ -0,0 +1,18 @@
+module.exports = function resolveAdapterOptions(name, adapterServiceConfig) {
+    const [adapterType, feature] = name.split(':');
+    const adapterSettings = adapterServiceConfig[adapterType];
+
+    let adapterName;
+    let adapterConfig;
+
+    // CASE: load resource-specific adapter when there is an adapter feature name specified as well as custom feature config
+    if (feature && adapterSettings[feature] && adapterSettings[adapterSettings[feature]]) {
+        adapterName = adapterSettings[feature];
+        adapterConfig = adapterSettings[adapterName];
+    } else {
+        adapterName = adapterSettings.active;
+        adapterConfig = adapterSettings[adapterName];
+    }
+
+    return {adapterType, adapterName, adapterConfig};
+};

package/core/server/services/bulk-email/bulk-email-processor.js

@@ -2,7 +2,7 @@ const _ = require('lodash');
 const Promise = require('bluebird');
 const moment = require('moment-timezone');
 const errors = require('@tryghost/errors');
-const i18n = require('../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const logging = require('@tryghost/logging');
 const models = require('../../models');
 const mailgunProvider = require('./mailgun');
@@ -10,6 +10,10 @@ const sentry = require('../../../shared/sentry');
 const debug = require('@tryghost/debug')('mega');
 const postEmailSerializer = require('../mega/post-email-serializer');
 
+const messages = {
+    error: 'The email service was unable to send an email batch.'
+};
+
 const BATCH_SIZE = mailgunProvider.BATCH_SIZE;
 
 /**
@@ -239,7 +243,7 @@ module.exports = {
             // REF: possible mailgun errors https://documentation.mailgun.com/en/latest/api-intro.html#errors
             let ghostError = new errors.EmailError({
                 err: error,
-                context: i18n.t('errors.services.mega.requestFailed.error'),
+                context: tpl(messages.error),
                 code: 'BULK_EMAIL_SEND_FAILED'
             });
 

package/core/server/services/bulk-email/mailgun.js

@@ -1,6 +1,5 @@
 const _ = require('lodash');
 const {URL} = require('url');
-const mailgun = require('mailgun-js');
 const logging = require('@tryghost/logging');
 const configService = require('../../../shared/config');
 const settingsCache = require('../../../shared/settings-cache');
@@ -8,6 +7,7 @@ const settingsCache = require('../../../shared/settings-cache');
 const BATCH_SIZE = 1000;
 
 function createMailgun(config) {
+    const mailgun = require('mailgun-js');
     const baseUrl = new URL(config.baseUrl);
 
     return mailgun({

package/core/server/services/custom-theme-settings.js

@@ -2,7 +2,13 @@ const {Service: CustomThemeSettingsService} = require('@tryghost/custom-theme-se
 const customThemeSettingsCache = require('../../shared/custom-theme-settings-cache');
 const models = require('../models');
 
-module.exports = new CustomThemeSettingsService({
-    model: models.CustomThemeSetting,
-    cache: customThemeSettingsCache
-});
+class CustomThemeSettingsServiceWrapper {
+    init() {
+        this.api = new CustomThemeSettingsService({
+            model: models.CustomThemeSetting,
+            cache: customThemeSettingsCache
+        });
+    }
+}
+
+module.exports = new CustomThemeSettingsServiceWrapper();

package/core/server/services/invites/index.js

@@ -1,5 +1,4 @@
 const settingsCache = require('../../../shared/settings-cache');
-const tpl = require('@tryghost/tpl');
 const mailService = require('../../services/mail');
 const logging = require('@tryghost/logging');
 const urlUtils = require('../../../shared/url-utils');
@@ -7,7 +6,6 @@ const Invites = require('./invites');
 
 module.exports = new Invites({
     settingsCache,
-    tpl,
     logging,
     mailService,
     urlUtils

package/core/server/services/invites/invites.js

@@ -1,4 +1,5 @@
 const security = require('@tryghost/security');
+const tpl = require('@tryghost/tpl');
 
 const messages = {
     invitedByName: '{invitedByName} has invited you to join {blogName}',
@@ -9,9 +10,8 @@ const messages = {
 };
 
 class Invites {
-    constructor({settingsCache, tpl, logging, mailService, urlUtils}) {
+    constructor({settingsCache, logging, mailService, urlUtils}) {
         this.settingsCache = settingsCache;
-        this.tpl = tpl;
         this.logging = logging;
         this.mailService = mailService;
         this.urlUtils = urlUtils;
@@ -52,7 +52,7 @@ class Invites {
                     mail: [{
                         message: {
                             to: invite.get('email'),
-                            subject: this.tpl(messages.invitedByName, {
+                            subject: tpl(messages.invitedByName, {
                                 invitedByName: emailData.invitedByName,
                                 blogName: emailData.blogName
                             }),
@@ -75,10 +75,10 @@ class Invites {
             })
             .catch((err) => {
                 if (err && err.errorType === 'EmailError') {
-                    const errorMessage = this.tpl(messages.errorSendingEmail.error, {
+                    const errorMessage = tpl(messages.errorSendingEmail.error, {
                         message: err.message
                     });
-                    const helpText = this.tpl(messages.errorSendingEmail.help);
+                    const helpText = tpl(messages.errorSendingEmail.help);
                     err.message = `${errorMessage} ${helpText}`;
                     this.logging.warn(err.message);
                 }

package/core/server/services/mail/GhostMailer.js

@@ -4,9 +4,17 @@ const _ = require('lodash');
 const validator = require('@tryghost/validator');
 const config = require('../../../shared/config');
 const errors = require('@tryghost/errors');
-const i18n = require('../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const settingsCache = require('../../../shared/settings-cache');
 const urlUtils = require('../../../shared/url-utils');
+const messages = {
+    title: 'Ghost at {domain}',
+    checkEmailConfigInstructions: 'Please see {url} for instructions on configuring email.',
+    failedSendingEmailError: 'Failed to send email.',
+    incompleteMessageDataError: 'Incomplete message data.',
+    reason: ' Reason: {reason}.',
+    messageSent: 'Message sent. Double check inbox and spam folder!'
+};
 
 function getDomain() {
     const domain = urlUtils.urlFor('home', true).match(new RegExp('^https?://([^/:?#]+)(?:[/:?#]|$)', 'i'));
@@ -25,7 +33,7 @@ function getFromAddress(requestedFromAddress) {
 
     // If we do have a from address, and it's just an email
     if (validator.isEmail(address, {require_tld: false})) {
-        const defaultSiteTitle = settingsCache.get('title') ? settingsCache.get('title').replace(/"/g, '\\"') : i18n.t('common.mail.title', {domain: getDomain()});
+        const defaultSiteTitle = settingsCache.get('title') ? settingsCache.get('title').replace(/"/g, '\\"') : tpl(messages.title, {domain: getDomain()});
         return `"${defaultSiteTitle}" <${address}>`;
     }
 
@@ -51,8 +59,8 @@ function createMessage(message) {
 }
 
 function createMailError({message, err, ignoreDefaultMessage} = {message: ''}) {
-    const helpMessage = i18n.t('errors.api.authentication.checkEmailConfigInstructions', {url: 'https://ghost.org/docs/config/#mail'});
-    const defaultErrorMessage = i18n.t('errors.mail.failedSendingEmail.error');
+    const helpMessage = tpl(messages.checkEmailConfigInstructions, {url: 'https://ghost.org/docs/config/#mail'});
+    const defaultErrorMessage = tpl(messages.failedSendingEmailError);
 
     const fullErrorMessage = defaultErrorMessage + message;
     let statusCode = (err && err.name === 'RecipientError') ? 400 : 500;
@@ -95,7 +103,7 @@ module.exports = class GhostMailer {
     async send(message) {
         if (!(message && message.subject && message.html && message.to)) {
             throw createMailError({
-                message: i18n.t('errors.mail.incompleteMessageData.error'),
+                message: tpl(messages.incompleteMessageDataError),
                 ignoreDefaultMessage: true
             });
         }
@@ -117,7 +125,7 @@ module.exports = class GhostMailer {
             return response;
         } catch (err) {
             throw createMailError({
-                message: i18n.t('errors.mail.reason', {reason: err.message || err}),
+                message: tpl(messages.reason, {reason: err.message || err}),
                 err
             });
         }
@@ -125,21 +133,21 @@ module.exports = class GhostMailer {
 
     handleDirectTransportResponse(response) {
         if (!response) {
-            return i18n.t('notices.mail.messageSent');
+            return tpl(messages.messageSent);
         }
 
         if (response.pending.length > 0) {
             throw createMailError({
-                message: i18n.t('errors.mail.reason', {reason: 'Email has been temporarily rejected'})
+                message: tpl(messages.reason, {reason: 'Email has been temporarily rejected'})
             });
         }
 
         if (response.errors.length > 0) {
             throw createMailError({
-                message: i18n.t('errors.mail.reason', {reason: response.errors[0].message})
+                message: tpl(messages.reason, {reason: response.errors[0].message})
             });
         }
 
-        return i18n.t('notices.mail.messageSent');
+        return tpl(messages.messageSent);
     }
 };

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

@@ -6,7 +6,6 @@ const url = require('url');
 const moment = require('moment');
 const ObjectID = require('bson-objectid');
 const errors = require('@tryghost/errors');
-const i18n = require('../../../shared/i18n');
 const logging = require('@tryghost/logging');
 const settingsCache = require('../../../shared/settings-cache');
 const membersService = require('../members');
@@ -25,7 +24,8 @@ const messages = {
     invalidSegment: 'Invalid segment value. Use one of the valid:"status:free" or "status:-free" values.',
     unexpectedFilterError: 'Unexpected {property} value "{value}", expected an NQL equivalent',
     noneFilterError: 'Cannot send email to "none" {property}',
-    emailSendingDisabled: `Email sending is temporarily disabled because your account is currently in review. You should have an email about this from us already, but you can also reach us any time at support@ghost.org`
+    emailSendingDisabled: `Email sending is temporarily disabled because your account is currently in review. You should have an email about this from us already, but you can also reach us any time at support@ghost.org`,
+    sendEmailRequestFailed: 'The email service was unable to send an email batch.'
 };
 
 const getFromAddress = () => {
@@ -354,7 +354,7 @@ async function sendEmailJob({emailModel, options}) {
 
         throw new errors.GhostError({
             err: error,
-            context: i18n.t('errors.services.mega.requestFailed.error')
+            context: tpl(messages.sendEmailRequestFailed)
         });
     }
 }

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

@@ -1,5 +1,4 @@
 const _ = require('lodash');
-const juice = require('juice');
 const template = require('./template');
 const settingsCache = require('../../../shared/settings-cache');
 const urlUtils = require('../../../shared/url-utils');
@@ -20,6 +19,7 @@ const ALLOWED_REPLACEMENTS = ['first_name'];
 const formatHtmlForEmail = function formatHtmlForEmail(html) {
     const juiceOptions = {inlinePseudoElements: true};
 
+    const juice = require('juice');
     let juicedHtml = juice(html, juiceOptions);
 
     // convert juiced HTML to a DOM-like interface for further manipulation
@@ -227,7 +227,7 @@ const serialize = async (postModel, options = {isBrowserPreview: false, apiVersi
     const momentDate = post.published_at ? moment(post.published_at) : moment();
     post.published_at = momentDate.tz(timezone).format('DD MMM YYYY');
 
-    post.authors = post.authors && post.authors.map(author => author.name).join(',');
+    post.authors = post.authors && post.authors.map(author => author.name).join(', ');
     if (post.posts_meta) {
         post.email_subject = post.posts_meta.email_subject;
     }