ghost 4.15.0 → 4.17.1

package/core/frontend/services/redirects/index.js

@@ -1,9 +0,0 @@
-module.exports = {
-    get settings() {
-        return require('./settings');
-    },
-
-    get validation() {
-        return require('./validation');
-    }
-};

package/core/frontend/services/redirects/validation.js

@@ -1,28 +0,0 @@
-const _ = require('lodash');
-const i18n = require('../../../shared/i18n');
-const errors = require('@tryghost/errors');
-
-/**
- * Redirects are file based at the moment, but they will live in the database in the future.
- * See V2 of https://github.com/TryGhost/Ghost/issues/7707.
- */
-const validate = (redirects) => {
-    if (!_.isArray(redirects)) {
-        throw new errors.ValidationError({
-            message: i18n.t('errors.utils.redirectsWrongFormat'),
-            help: 'https://ghost.org/docs/themes/routing/#redirects'
-        });
-    }
-
-    _.each(redirects, function (redirect) {
-        if (!redirect.from || !redirect.to) {
-            throw new errors.ValidationError({
-                message: i18n.t('errors.utils.redirectsWrongFormat'),
-                context: redirect,
-                help: 'https://ghost.org/docs/themes/routing/#redirects'
-            });
-        }
-    });
-};
-
-module.exports.validate = validate;

package/core/frontend/services/settings/ensure-settings.js

@@ -1,47 +0,0 @@
-const fs = require('fs-extra');
-const Promise = require('bluebird');
-const path = require('path');
-const debug = require('@tryghost/debug')('frontend:services:settings:ensure-settings');
-const {i18n} = require('../proxy');
-const errors = require('@tryghost/errors');
-const config = require('../../../shared/config');
-
-/**
- * Makes sure that all supported settings files are in the
- * `/content/settings` directory. If not, copy the default files
- * over.
- * @param {Array} knownSettings
- * @returns {Promise}
- * @description Reads the `/settings` folder of the content path and makes
- * sure that the associated yaml file for each setting exists. If it doesn't
- * copy the default yaml file over.
- */
-module.exports = function ensureSettingsFiles(knownSettings) {
-    const contentPath = config.getContentPath('settings');
-    const defaultSettingsPath = config.get('paths').defaultSettings;
-
-    return Promise.each(knownSettings, function (setting) {
-        const fileName = `${setting}.yaml`;
-        const defaultFileName = `default-${fileName}`;
-        const filePath = path.join(contentPath, fileName);
-
-        return Promise.resolve(fs.readFile(filePath, 'utf8'))
-            .catch({code: 'ENOENT'}, () => {
-                const defaultFilePath = path.join(defaultSettingsPath, defaultFileName);
-                // CASE: file doesn't exist, copy it from our defaults
-                return fs.copy(
-                    defaultFilePath,
-                    filePath
-                ).then(() => {
-                    debug(`'${defaultFileName}' copied to ${contentPath}.`);
-                });
-            }).catch((error) => {
-                // CASE: we might have a permission error, as we can't access the directory
-                throw new errors.GhostError({
-                    message: i18n.t('errors.services.settings.ensureSettings', {path: contentPath}),
-                    err: error,
-                    context: error.path
-                });
-            });
-    });
-};

package/core/frontend/services/settings/index.js

@@ -1,104 +0,0 @@
-const _ = require('lodash');
-const crypto = require('crypto');
-const debug = require('@tryghost/debug')('frontend:services:settings:index');
-const SettingsLoader = require('./loader');
-const ensureSettingsFiles = require('./ensure-settings');
-
-const errors = require('@tryghost/errors');
-
-/**
- * md5 hashes of default settings
- */
-const defaultHashes = {
-    routes: '3d180d52c663d173a6be791ef411ed01'
-};
-
-const calculateHash = (data) => {
-    return crypto.createHash('md5')
-        .update(data, 'binary')
-        .digest('hex');
-};
-
-module.exports = {
-    init: function () {
-        const knownSettings = this.knownSettings();
-
-        debug('init settings service for:', knownSettings);
-
-        // Make sure that supported settings files are available
-        // inside of the `content/setting` directory
-        return ensureSettingsFiles(knownSettings);
-    },
-
-    /**
-    * Global place to switch on more available settings.
-    */
-    knownSettings: function knownSettings() {
-        return ['routes'];
-    },
-
-    /**
-     * Getter for YAML settings.
-     * Example: `settings.get('routes').then(...)`
-     * will return an Object like this:
-     * {routes: {}, collections: {}, resources: {}}
-     * @param {String} setting type of supported setting.
-     * @returns {Object} settingsFile
-     * @description Returns settings object as defined per YAML files in
-     * `/content/settings` directory.
-     */
-    get: function get(setting) {
-        const knownSettings = this.knownSettings();
-
-        // CASE: this should be an edge case and only if internal usage of the
-        // getter is incorrect.
-        if (!setting || _.indexOf(knownSettings, setting) < 0) {
-            throw new errors.IncorrectUsageError({
-                message: `Requested setting is not supported: '${setting}'.`,
-                help: `Please use only the supported settings: ${knownSettings}.`
-            });
-        }
-
-        return SettingsLoader(setting);
-    },
-
-    /**
-     * Getter for all YAML settings.
-     * Example: `settings.getAll().then(...)`
-     * will return an Object like this (assuming we're supporting `routes`
-     * and `globals`):
-     * {
-     *     routes: {
-     *         routes: null,
-     *         collections: { '/': [Object] },
-     *         resources: { tag: '/tag/{slug}/', author: '/author/{slug}/' }
-     *     },
-     *     globals: {
-     *         config: { url: 'testblog.com' }
-     *     }
-     * }
-     * @returns {Object} settingsObject
-     * @description Returns all settings object as defined per YAML files in
-     * `/content/settings` directory.
-     */
-    getAll: function getAll() {
-        const knownSettings = this.knownSettings();
-        const settingsToReturn = {};
-
-        _.each(knownSettings, function (setting) {
-            settingsToReturn[setting] = SettingsLoader(setting);
-        });
-
-        return settingsToReturn;
-    },
-
-    getDefaulHash: (setting) => {
-        return defaultHashes[setting];
-    },
-
-    getCurrentHash: async (setting) => {
-        const data = await SettingsLoader.loadSettings(setting);
-
-        return calculateHash(JSON.stringify(data));
-    }
-};

package/core/frontend/services/settings/loader.js

@@ -1,89 +0,0 @@
-const fs = require('fs-extra');
-const path = require('path');
-const debug = require('@tryghost/debug')('frontend:services:settings:settings-loader');
-const {i18n} = require('../proxy');
-const errors = require('@tryghost/errors');
-const config = require('../../../shared/config');
-const yamlParser = require('./yaml-parser');
-const validate = require('./validate');
-
-const getSettingFilePath = (setting) => {
-    // we only support the `yaml` file extension. `yml` will be ignored.
-    const fileName = `${setting}.yaml`;
-    const contentPath = config.getContentPath('settings');
-    const filePath = path.join(contentPath, fileName);
-
-    return {
-        fileName,
-        contentPath,
-        filePath
-    };
-};
-
-/**
- * Functionally same as loadSettingsSync with exception of loading
- * settigs asyncronously. This method is used at new places to read settings
- * to prevent blocking the eventloop
- *
- * @param {String} setting the requested settings as defined in setting knownSettings
- * @returns {Object} settingsFile
- */
-const loadSettings = async (setting) => {
-    const {fileName, contentPath, filePath} = getSettingFilePath(setting);
-
-    try {
-        const file = await fs.readFile(filePath, 'utf8');
-        debug('settings file found for', setting);
-
-        const object = yamlParser(file, fileName);
-        return validate(object);
-    } catch (err) {
-        if (errors.utils.isIgnitionError(err)) {
-            throw err;
-        }
-
-        throw new errors.GhostError({
-            message: i18n.t('errors.services.settings.loader', {
-                setting: setting,
-                path: contentPath
-            }),
-            context: filePath,
-            err: err
-        });
-    }
-};
-
-/**
- * Reads the desired settings YAML file and passes the
- * file to the YAML parser which then returns a JSON object.
- * NOTE: loading happens syncronously
- *
- * @param {String} setting the requested settings as defined in setting knownSettings
- * @returns {Object} settingsFile
- */
-module.exports = function loadSettingsSync(setting) {
-    const {fileName, contentPath, filePath} = getSettingFilePath(setting);
-
-    try {
-        const file = fs.readFileSync(filePath, 'utf8');
-        debug('settings file found for', setting);
-
-        const object = yamlParser(file, fileName);
-        return validate(object);
-    } catch (err) {
-        if (errors.utils.isIgnitionError(err)) {
-            throw err;
-        }
-
-        throw new errors.GhostError({
-            message: i18n.t('errors.services.settings.loader', {
-                setting: setting,
-                path: contentPath
-            }),
-            context: filePath,
-            err: err
-        });
-    }
-};
-
-module.exports.loadSettings = loadSettings;

package/core/frontend/services/settings/yaml-parser.js

@@ -1,31 +0,0 @@
-const yaml = require('js-yaml');
-const debug = require('@tryghost/debug')('frontend:services:settings:yaml-parser');
-const {i18n} = require('../proxy');
-const errors = require('@tryghost/errors');
-
-/**
- * Takes a YAML file, parses it and returns a JSON Object
- * @param {YAML} file the YAML file utf8 encoded
- * @param {String} fileName the name of the file incl. extension
- * @returns {Object} parsed
- */
-module.exports = function parseYaml(file, fileName) {
-    try {
-        const parsed = yaml.load(file);
-
-        debug('YAML settings file parsed:', fileName);
-
-        return parsed;
-    } catch (error) {
-        // CASE: parsing failed, `js-yaml` tells us exactly what and where in the
-        // `reason` property as well as in the message.
-        // As the file uploaded is invalid, the person uploading must fix this - it's a 4xx error
-        throw new errors.IncorrectUsageError({
-            message: i18n.t('errors.services.settings.yaml.error', {file: fileName, context: error.reason}),
-            code: 'YAML_PARSER_ERROR',
-            context: error.message,
-            err: error,
-            help: i18n.t('errors.services.settings.yaml.help', {file: fileName})
-        });
-    }
-};