ghost 4.22.3 → 4.25.0

package/core/frontend/services/theme-engine/middleware.js

@@ -1,209 +0,0 @@
-const _ = require('lodash');
-const hbs = require('./engine');
-const urlUtils = require('../../../shared/url-utils');
-const {api} = require('../proxy');
-const errors = require('@tryghost/errors');
-const tpl = require('@tryghost/tpl');
-const settingsCache = require('../../../shared/settings-cache');
-const customThemeSettingsCache = require('../../../shared/custom-theme-settings-cache');
-const labs = require('../../../shared/labs');
-const activeTheme = require('./active');
-const preview = require('./preview');
-
-const messages = {
-    missingTheme: 'The currently active theme "{theme}" is missing.'
-};
-
-// ### Ensure Active Theme
-// Ensure there's a properly set & mounted active theme before attempting to serve a site request
-// If there is no active theme, throw an error
-// Else, ensure the active theme is mounted
-function ensureActiveTheme(req, res, next) {
-    // CASE: this means that the theme hasn't been loaded yet i.e. there is no active theme
-    if (!activeTheme.get()) {
-        // This is the one place we ACTUALLY throw an error for a missing theme as it's a request we cannot serve
-        return next(new errors.InternalServerError({
-            // We use the settingsCache here, because the setting will be set,
-            // even if the theme itself is not usable because it is invalid or missing.
-            message: tpl(messages.missingTheme, {theme: settingsCache.get('active_theme')})
-        }));
-    }
-
-    // If the active theme has not yet been mounted, mount it into express
-    if (!activeTheme.get().mounted) {
-        activeTheme.get().mount(req.app);
-    }
-
-    next();
-}
-
-function calculateLegacyPriceData(products) {
-    const defaultPrice = {
-        amount: 0,
-        currency: 'usd',
-        interval: 'year',
-        nickname: ''
-    };
-
-    function makePriceObject(price) {
-        const numberAmount = 0 + price.amount;
-        const dollarAmount = numberAmount ? Math.round(numberAmount / 100) : 0;
-        return {
-            valueOf() {
-                return dollarAmount;
-            },
-            amount: numberAmount,
-            currency: price.currency,
-            nickname: price.name,
-            interval: price.interval
-        };
-    }
-
-    const defaultProduct = products[0] || {};
-
-    const monthlyPrice = makePriceObject(defaultProduct.monthly_price || defaultPrice);
-
-    const yearlyPrice = makePriceObject(defaultProduct.yearly_price || defaultPrice);
-
-    const priceData = {
-        monthly: monthlyPrice,
-        yearly: yearlyPrice,
-        currency: monthlyPrice ? monthlyPrice.currency : defaultPrice.currency
-    };
-
-    return priceData;
-}
-
-async function getProductAndPricesData() {
-    try {
-        const page = await api.canary.productsPublic.browse({
-            include: ['monthly_price', 'yearly_price'],
-            limit: 'all'
-        });
-
-        return page.products;
-    } catch (err) {
-        return [];
-    }
-}
-
-function getSiteData() {
-    let siteData = settingsCache.getPublic();
-
-    // theme-only computed property added to @site
-    if (settingsCache.get('members_signup_access') === 'none') {
-        const escapedUrl = encodeURIComponent(urlUtils.urlFor({relativeUrl: '/rss/'}, true));
-        siteData.signup_url = `https://feedly.com/i/subscription/feed/${escapedUrl}`;
-    } else {
-        siteData.signup_url = '#/portal';
-    }
-
-    return siteData;
-}
-
-async function updateGlobalTemplateOptions(req, res, next) {
-    // Static information, same for every request unless the settings change
-    // @TODO: bind this once and then update based on events?
-    // @TODO: decouple theme layer from settings cache using the Content API
-    const siteData = getSiteData();
-    const labsData = labs.getAll();
-
-    const themeData = {
-        posts_per_page: activeTheme.get().config('posts_per_page'),
-        image_sizes: activeTheme.get().config('image_sizes')
-    };
-    const themeSettingsData = customThemeSettingsCache.getAll();
-    const productData = await getProductAndPricesData();
-    const priceData = calculateLegacyPriceData(productData);
-
-    let products = null;
-    let product = null;
-    if (productData.length === 1) {
-        product = productData[0];
-    } else {
-        products = productData;
-    }
-
-    // @TODO: only do this if something changed?
-    // @TODO: remove blog in a major where we are happy to break more themes
-    {
-        hbs.updateTemplateOptions({
-            data: {
-                blog: siteData,
-                site: siteData,
-                labs: labsData,
-                config: themeData,
-                price: priceData,
-                product,
-                products,
-                custom: themeSettingsData
-            }
-        });
-    }
-
-    next();
-}
-
-function updateLocalTemplateData(req, res, next) {
-    // Pass 'secure' flag to the view engine
-    // so that templates can choose to render https or http 'url', see url utility
-    res.locals.secure = req.secure;
-
-    next();
-}
-
-function updateLocalTemplateOptions(req, res, next) {
-    const localTemplateOptions = hbs.getLocalTemplateOptions(res.locals);
-
-    // adjust @site.url for http/https based on the incoming request
-    const siteData = {
-        url: urlUtils.urlFor('home', {secure: req.secure, trailingSlash: false}, true)
-    };
-
-    // @TODO: it would be nicer if this was proper middleware somehow...
-    const previewData = preview.handle(req, Object.keys(customThemeSettingsCache.getAll()));
-
-    // strip custom off of preview data so it doesn't get merged into @site
-    const customThemeSettingsPreviewData = previewData.custom;
-    delete previewData.custom;
-    let customData = {};
-    if (labs.isSet('customThemeSettings')) {
-        customData = customThemeSettingsPreviewData;
-    }
-
-    // update site data with any preview values from the request
-    Object.assign(siteData, previewData);
-
-    const member = req.member ? {
-        uuid: req.member.uuid,
-        email: req.member.email,
-        name: req.member.name,
-        firstname: req.member.name && req.member.name.split(' ')[0],
-        avatar_image: req.member.avatar_image,
-        subscriptions: req.member.subscriptions && req.member.subscriptions.map((sub) => {
-            return Object.assign({}, sub, {
-                default_payment_card_last4: sub.default_payment_card_last4 || '****'
-            });
-        }),
-        paid: req.member.status !== 'free'
-    } : null;
-
-    hbs.updateLocalTemplateOptions(res.locals, _.merge({}, localTemplateOptions, {
-        data: {
-            member: member,
-            site: siteData,
-            custom: customData,
-            // @deprecated: a gscan warning for @blog was added before 3.0 which replaced it with @site
-            blog: siteData
-        }
-    }));
-
-    next();
-}
-
-module.exports = [
-    ensureActiveTheme,
-    updateGlobalTemplateOptions,
-    updateLocalTemplateData,
-    updateLocalTemplateOptions
-];

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

@@ -1,321 +0,0 @@
-// # Fixture Utils
-// Standalone file which can be required to help with advanced operations on the fixtures.json file
-const _ = require('lodash');
-
-const Promise = require('bluebird');
-const logging = require('@tryghost/logging');
-const models = require('../../../models');
-const baseUtils = require('../../../models/base/utils');
-const {sequence} = require('@tryghost/promise');
-const moment = require('moment');
-const fixtures = require('./fixtures');
-
-/**
- * ### Match Func
- * Figures out how to match across various combinations of keys and values.
- * Match can be a string or an array containing 2 strings
- * Key and Value are the values to be found
- * Value can also be an array, in which case we look for a match in the array.
- * @api private
- * @param {String|Array} match
- * @param {String|Integer} key
- * @param {String|Array} [value]
- * @returns {Function} matching function
- */
-const matchFunc = function matchFunc(match, key, value) {
-    if (_.isArray(match)) {
-        return function (item) {
-            let valueTest = true;
-
-            if (_.isArray(value)) {
-                valueTest = value.indexOf(item.get(match[1])) > -1;
-            } else if (value !== 'all') {
-                valueTest = item.get(match[1]) === value;
-            }
-
-            return item.get(match[0]) === key && valueTest;
-        };
-    }
-
-    return function (item) {
-        key = key === 0 && value ? value : key;
-        return item.get(match) === key;
-    };
-};
-
-const matchObj = function matchObj(match, item) {
-    const matchedObj = {};
-
-    if (_.isArray(match)) {
-        _.each(match, (matchProp) => {
-            matchedObj[matchProp] = item.get(matchProp);
-        });
-    } else {
-        matchedObj[match] = item.get(match);
-    }
-
-    return matchedObj;
-};
-
-/**
- * ### Fetch Relation Data
- * Before we build relations we need to fetch all of the models from both sides so that we can
- * use filter and find to quickly locate the correct models.
- * @api private
- * @param {{from, to, entries}} relation
- * @returns {Promise<*>}
- */
-const fetchRelationData = function fetchRelationData(relation, options) {
-    const fromOptions = _.extend({}, options, {withRelated: [relation.from.relation]});
-
-    const props = {
-        from: models[relation.from.model].findAll(fromOptions),
-        to: models[relation.to.model].findAll(options)
-    };
-
-    return Promise.props(props);
-};
-
-/*
- * Find methods - use the local fixtures
- */
-
-/**
- * ### Find Model Fixture
- * Finds a model fixture based on model name
- * @api private
- * @param {String} modelName
- * @returns {Object} model fixture
- */
-const findModelFixture = function findModelFixture(modelName) {
-    return _.find(fixtures.models, (modelFixture) => {
-        return modelFixture.name === modelName;
-    });
-};
-
-/**
- * ### Find Model Fixture Entry
- * Find a single model fixture entry by model name & a matching expression for the FIND function
- * @param {String} modelName
- * @param {String|Object|Function} matchExpr
- * @returns {Object} model fixture entry
- */
-const findModelFixtureEntry = function findModelFixtureEntry(modelName, matchExpr) {
-    return _.find(findModelFixture(modelName).entries, matchExpr);
-};
-
-/**
- * ### Find Model Fixtures
- * Find a  model fixture name & a matching expression for the FILTER function
- * @param {String} modelName
- * @param {String|Object|Function} matchExpr
- * @returns {Object} model fixture
- */
-const findModelFixtures = function findModelFixtures(modelName, matchExpr) {
-    const foundModel = _.cloneDeep(findModelFixture(modelName));
-    foundModel.entries = _.filter(foundModel.entries, matchExpr);
-    return foundModel;
-};
-
-/**
- * ### Find Relation Fixture
- * Find a relation fixture by from & to models
- * @api private
- * @param {String} from
- * @param {String} to
- * @returns {Object} relation fixture
- */
-const findRelationFixture = function findRelationFixture(from, to) {
-    return _.find(fixtures.relations, (relation) => {
-        return relation.from.model === from && relation.to.model === to;
-    });
-};
-
-/**
- * ### Find Permission Relations For Object
- * Specialist function can return the permission relation fixture with only entries for a particular object.model
- * @param {String} objName
- * @returns {Object} fixture relation
- */
-const findPermissionRelationsForObject = function findPermissionRelationsForObject(objName, role) {
-    // Make a copy and delete any entries we don't want
-    const foundRelation = _.cloneDeep(findRelationFixture('Role', 'Permission'));
-
-    _.each(foundRelation.entries, (entry, key) => {
-        _.each(entry, (perm, obj) => {
-            if (obj !== objName) {
-                delete entry[obj];
-            }
-        });
-
-        if (_.isEmpty(entry) || (role && role !== key)) {
-            delete foundRelation.entries[key];
-        }
-    });
-
-    return foundRelation;
-};
-
-/*
- * Add and Remove Functions, require access to models
- */
-
-/**
- * ### Add Fixtures for Model
- * Takes a model fixture, with a name and some entries and processes these
- * into a sequence of promises to get each fixture added.
- *
- * @param {{name, entries}} modelFixture
- * @returns {Promise<any>}
- */
-const addFixturesForModel = async function addFixturesForModel(modelFixture, options = {}) {
-    // Clone the fixtures as they get changed in this function.
-    // The initial blog posts will be added a `published_at` property, which
-    // would change the fixturesHash.
-    modelFixture = _.cloneDeep(modelFixture);
-    // The Post model fixtures need a `published_at` date, where at least the seconds
-    // are different, otherwise `prev_post` and `next_post` helpers won't workd with
-    // them.
-    if (modelFixture.name === 'Post') {
-        _.forEach(modelFixture.entries, (post, index) => {
-            if (!post.published_at) {
-                post.published_at = moment().add(index, 'seconds');
-            }
-        });
-    }
-
-    const results = await Promise.mapSeries(modelFixture.entries, async (entry) => {
-        let data = {};
-
-        // CASE: if id is specified, only query by id
-        if (entry.id) {
-            data.id = entry.id;
-        } else if (entry.slug) {
-            data.slug = entry.slug;
-        } else {
-            data = _.cloneDeep(entry);
-        }
-
-        if (modelFixture.name === 'Post') {
-            data.status = 'all';
-        }
-
-        const found = await models[modelFixture.name].findOne(data, options);
-        if (!found) {
-            return models[modelFixture.name].add(entry, options);
-        }
-    });
-
-    return {expected: modelFixture.entries.length, done: _.compact(results).length};
-};
-
-/**
- * ## Add Fixtures for Relation
- * Takes a relation fixtures object, with a from, to and some entries and processes these
- * into a sequence of promises, to get each fixture added.
- *
- * @param {{from, to, entries}} relationFixture
- * @returns {Promise<any>}
- */
-const addFixturesForRelation = async function addFixturesForRelation(relationFixture, options) {
-    const ops = [];
-    let max = 0;
-
-    const data = await fetchRelationData(relationFixture, options);
-
-    _.each(relationFixture.entries, (entry, key) => {
-        const fromItem = data.from.find(matchFunc(relationFixture.from.match, key));
-
-        // CASE: You add new fixtures e.g. a new role in a new release.
-        // As soon as an **older** migration script wants to add permissions for any resource, it iterates over the
-        // permissions for each role. But if the role does not exist yet, it won't find the matching db entry and breaks.
-        if (!fromItem) {
-            logging.warn('Skip: Target database entry not found for key: ' + key);
-            return Promise.resolve();
-        }
-
-        _.each(entry, (value, entryKey) => {
-            let toItems = data.to.filter(matchFunc(relationFixture.to.match, entryKey, value));
-            max += toItems.length;
-
-            // Remove any duplicates that already exist in the collection
-            toItems = _.reject(toItems, (item) => {
-                return fromItem
-                    .related(relationFixture.from.relation)
-                    .find((model) => {
-                        const objectToMatch = matchObj(relationFixture.to.match, item);
-                        return Object.keys(objectToMatch).every((keyToCheck) => {
-                            return model.get(keyToCheck) === objectToMatch[keyToCheck];
-                        });
-                    });
-            });
-
-            if (toItems && toItems.length > 0) {
-                ops.push(function addRelationItems() {
-                    return baseUtils.attach(
-                        models[relationFixture.from.Model || relationFixture.from.model],
-                        fromItem.id,
-                        relationFixture.from.relation,
-                        toItems,
-                        options
-                    );
-                });
-            }
-        });
-    });
-
-    const result = await sequence(ops);
-    return {expected: max, done: _(result).map('length').sum()};
-};
-
-const removeFixturesForModel = async function removeFixturesForModel(modelFixture, options) {
-    const results = await Promise.mapSeries(modelFixture.entries, async (entry) => {
-        const found = models[modelFixture.name].findOne(entry.id ? {id: entry.id} : entry, options);
-        if (found) {
-            return models[modelFixture.name].destroy(_.extend(options, {id: found.id}));
-        }
-    });
-
-    return {expected: modelFixture.entries.length, done: results.length};
-};
-
-const removeFixturesForRelation = async function removeFixturesForRelation(relationFixture, options) {
-    const data = await fetchRelationData(relationFixture, options);
-    const ops = [];
-
-    _.each(relationFixture.entries, (entry, key) => {
-        const fromItem = data.from.find(matchFunc(relationFixture.from.match, key));
-
-        _.each(entry, (value, entryKey) => {
-            const toItems = data.to.filter(matchFunc(relationFixture.to.match, entryKey, value));
-
-            if (toItems && toItems.length > 0) {
-                ops.push(function detachRelation() {
-                    return baseUtils.detach(
-                        models[relationFixture.from.Model || relationFixture.from.model],
-                        fromItem.id,
-                        relationFixture.from.relation,
-                        toItems,
-                        options
-                    );
-                });
-            }
-        });
-    });
-
-    return await sequence(ops);
-};
-
-module.exports = {
-    // find
-    findModelFixtureEntry: findModelFixtureEntry,
-    findModelFixtures: findModelFixtures,
-    findRelationFixture: findRelationFixture,
-    findPermissionRelationsForObject: findPermissionRelationsForObject,
-
-    // add / remove
-    addFixturesForModel: addFixturesForModel,
-    addFixturesForRelation: addFixturesForRelation,
-    removeFixturesForModel: removeFixturesForModel,
-    removeFixturesForRelation: removeFixturesForRelation
-};

package/core/server/web/parent/vhost-utils.js

@@ -1,39 +0,0 @@
-const config = require('../../../shared/config');
-const escapeRegExp = require('lodash/escapeRegExp');
-const {URL} = require('url');
-
-const DEFAULT_HOST_ARG = /.*/;
-
-const getHostsFromConfig = () => {
-    const frontendHost = new URL(config.getSiteUrl()).hostname;
-
-    const backendHost = config.getAdminUrl() ? (new URL(config.getAdminUrl()).hostname) : '';
-    const hasSeparateBackendHost = backendHost && backendHost !== frontendHost;
-
-    return {
-        backendHost,
-        hasSeparateBackendHost
-    };
-};
-
-/**
- *
- * @returns {string|RegExp}
- */
-module.exports.getBackendHostArg = () => {
-    const {backendHost, hasSeparateBackendHost} = getHostsFromConfig();
-
-    // with a separate admin url only serve on that host, otherwise serve on all hosts
-    return (hasSeparateBackendHost) && backendHost ? backendHost : DEFAULT_HOST_ARG;
-};
-
-/**
- *
- * @returns {string|RegExp}
- */
-module.exports.getFrontendHostArg = () => {
-    const {backendHost, hasSeparateBackendHost} = getHostsFromConfig();
-
-    // with a separate admin url we adjust the frontend vhost to exclude requests to that host, otherwise serve on all hosts
-    return (hasSeparateBackendHost && backendHost) ? new RegExp(`^(?!${escapeRegExp(backendHost)}).*`) : DEFAULT_HOST_ARG;
-};