ghost 6.54.0 → 6.55.0

package/core/server/services/route-settings/default-settings-manager.js

@@ -1,63 +0,0 @@
-const fs = require('fs-extra');
-const path = require('path');
-const debug = require('@tryghost/debug')('frontend:services:settings:ensure-settings');
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-
-const messages = {
-    ensureSettings: 'Error trying to access settings files in {path}.'
-};
-
-class DefaultSettingsManager {
-    /**
-     *
-     * @param {Object} options
-     * @param {string} options.type - name of the setting file
-     * @param {string} options.extension - settings file extension
-     * @param {string} options.destinationFolderPath - path to store the default setting config
-     * @param {string} options.sourceFolderPath - path where the default config can be seeded from
-     */
-    constructor({type, extension, destinationFolderPath, sourceFolderPath}) {
-        this.type = type;
-        this.extension = extension;
-        this.destinationFolderPath = destinationFolderPath;
-        this.sourceFolderPath = sourceFolderPath;
-    }
-
-    /**
-     *
-     * Makes sure the destination folder either contains a file or copies over a default file.
-     * @returns {Promise<any>}
-     */
-    async ensureSettingsFileExists() {
-        const fileName = this.type + this.extension;
-        const defaultFileName = `default-${fileName}`;
-
-        const destinationFilePath = path.join(this.destinationFolderPath, fileName);
-        const defaultFilePath = path.join(this.sourceFolderPath, defaultFileName);
-
-        return Promise.resolve(fs.readFile(destinationFilePath, 'utf8'))
-            .catch((err) => {
-                if (err.code === 'ENOENT') {
-                    // CASE: file doesn't exist, copy it from our defaults
-                    return fs.copy(
-                        defaultFilePath,
-                        destinationFilePath
-                    ).then(() => {
-                        debug(`'${defaultFileName}' copied to ${this.destinationFolderPath}.`);
-                    });
-                } else {
-                    // CASE: we might have a permission error, as we can't access the directory
-                    throw new errors.InternalServerError({
-                        message: tpl(messages.ensureSettings, {
-                            path: this.destinationFolderPath
-                        }),
-                        err: err,
-                        context: err.path
-                    });
-                }
-            });
-    }
-}
-
-module.exports = DefaultSettingsManager;

package/core/server/services/route-settings/route-settings.js

@@ -1,170 +0,0 @@
-const fs = require('fs-extra');
-const crypto = require('crypto');
-const urlService = require('../url');
-
-const debug = require('@tryghost/debug')('services:route-settings');
-const errors = require('@tryghost/errors');
-const tpl = require('@tryghost/tpl');
-const bridge = require('../../../bridge');
-
-const messages = {
-    loadError: 'Could not load routes.yaml file.'
-};
-
-/**
- * The `routes.yaml` file offers a way to configure your Ghost blog. It's currently a setting feature
- * we have added. That's why the `routes.yaml` file is treated as a "setting" right now.
- * If we want to add single permissions for this file (e.g. upload/download routes.yaml), we can add later.
- *
- * How does it work?
- *
- * - we first reset all url generators (each url generator belongs to one express router)
- *   - we don't destroy the resources, we only release them (this avoids reloading all resources from the db again)
- * - then we reload the whole site app, which will reset all routers and re-create the url generators
- */
-
-class RouteSettings {
-    /**
-     *
-     * @param {Object} options
-     * @param {Object} options.settingsLoader
-     * @param {string} options.settingsPath
-     * @param {string} options.backupPath
-     */
-    constructor({settingsLoader, settingsPath, backupPath}) {
-        /**
-         * md5 hashes of default routes settings
-         * @private
-         */
-        this.defaultRoutesSettingHash = '3d180d52c663d173a6be791ef411ed01';
-
-        this.settingsLoader = settingsLoader;
-        this.settingsPath = settingsPath;
-        this.backupPath = backupPath;
-    }
-
-    /**
-     * @private
-     * @param {string} settingsPath
-     * @param {string} backupPath
-     */
-    async createBackupFile(settingsPath, backupPath) {
-        return await fs.copy(settingsPath, backupPath);
-    }
-
-    /**
-     * @private
-     * @param {string} settingsPath
-     * @param {string} backupPath
-     */
-    async restoreBackupFile(settingsPath, backupPath) {
-        return await fs.copy(backupPath, settingsPath);
-    }
-
-    /**
-     * @private
-     * @param {string} filePath
-     * @param {string} settingsPath
-     */
-    async saveFile(filePath, settingsPath) {
-        return await fs.copy(filePath, settingsPath);
-    }
-
-    /**
-     * @private
-     * @param {string} settingsFilePath
-     */
-    async readFile(settingsFilePath) {
-        return fs.readFile(settingsFilePath, 'utf-8')
-            .catch((err) => {
-                if (err.code === 'ENOENT') {
-                    return Promise.resolve([]);
-                }
-
-                if (errors.utils.isGhostError(err)) {
-                    throw err;
-                }
-
-                throw new errors.NotFoundError({
-                    err: err
-                });
-            });
-    }
-
-    async setFromFilePath(filePath) {
-        await this.createBackupFile(this.settingsPath, this.backupPath);
-        await this.saveFile(filePath, this.settingsPath);
-
-        urlService.resetGenerators({releaseResourcesOnly: true});
-
-        const bringBackValidRoutes = async () => {
-            urlService.resetGenerators({releaseResourcesOnly: true});
-
-            await this.restoreBackupFile(this.settingsPath, this.backupPath);
-
-            return bridge.reloadFrontend();
-        };
-
-        try {
-            await bridge.reloadFrontend();
-        } catch (err) {
-            return bringBackValidRoutes()
-                .finally(() => {
-                    throw err;
-                });
-        }
-
-        // @TODO: how can we get rid of this from here?
-        let tries = 0;
-
-        function isBlogRunning() {
-            debug('waiting for blog running');
-            return new Promise((resolve) => {
-                setTimeout(resolve, 1000);
-            })
-                .then(() => {
-                    debug('waited for blog running');
-                    if (!urlService.hasFinished()) {
-                        if (tries > 5) {
-                            throw new errors.InternalServerError({
-                                message: tpl(messages.loadError)
-                            });
-                        }
-
-                        tries = tries + 1;
-                        return isBlogRunning();
-                    }
-                });
-        }
-
-        return isBlogRunning()
-            .catch((err) => {
-                return bringBackValidRoutes()
-                    .finally(() => {
-                        throw err;
-                    });
-            });
-    }
-
-    async get() {
-        return this.readFile(this.settingsPath);
-    }
-
-    calculateHash(data) {
-        return crypto.createHash('md5')
-            .update(data, 'binary')
-            .digest('hex');
-    }
-
-    getDefaultHash() {
-        return this.defaultRoutesSettingHash;
-    }
-
-    async getCurrentHash() {
-        const data = await this.settingsLoader.loadSettings();
-
-        return this.calculateHash(JSON.stringify(data));
-    }
-}
-
-module.exports = RouteSettings;

package/core/server/services/route-settings/settings-loader.js

@@ -1,60 +0,0 @@
-const fs = require('fs-extra');
-const debug = require('@tryghost/debug')('frontend:services:settings:settings-loader');
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-const validate = require('./validate');
-
-const messages = {
-    settingsLoaderError: `Error trying to load YAML setting for {setting} from '{path}'.`
-};
-
-class SettingsLoader {
-    /**
-     * @param {Object} options
-     * @param {Function} options.parseYaml yaml parser
-     * @param {string} options.settingFilePath routes settings file path
-     */
-    constructor({parseYaml, settingFilePath}) {
-        this.parseYaml = parseYaml;
-
-        this.settingFilePath = settingFilePath;
-    }
-
-    /**
-     * Reads the routes.yaml settings file and passes the
-    * file to the YAML parser which then returns a JSON object.
-     * @returns {Promise<RouteSettings>} settingsFileContents
-     */
-    async loadSettings() {
-        try {
-            const file = await fs.readFile(this.settingFilePath, 'utf8');
-            debug('routes settings file found for:', this.settingFilePath);
-
-            const object = this.parseYaml(file);
-            debug('YAML settings file parsed:', this.settingFilePath);
-
-            return validate(object);
-        } catch (err) {
-            if (errors.utils.isGhostError(err)) {
-                throw err;
-            }
-
-            throw new errors.InternalServerError({
-                message: tpl(messages.settingsLoaderError, {
-                    setting: 'routes',
-                    path: this.settingFilePath
-                }),
-                err: err
-            });
-        }
-    }
-}
-
-module.exports = SettingsLoader;
-
-/**
- * @typedef {Object} RouteSettings
- * @property {Object} routes
- * @property {Object} collections
- * @property {Object} taxonomies
- */

package/core/server/services/route-settings/settings-path-manager.js

@@ -1,47 +0,0 @@
-const path = require('path');
-const tpl = require('@tryghost/tpl');
-const format = require('date-fns/format');
-const {IncorrectUsageError} = require('@tryghost/errors');
-
-const messages = {
-    incorrectPathsParameter: 'Attempted to setup settings path manager without paths values.'
-};
-
-class SettingsPathManager {
-    /**
-     *
-     * @param {Object} options
-     * @param {String[]} options.paths - file location paths ordered in priority by where to locate them first
-     * @param {string} options.type setting file type, e.g: 'routes' or 'redirects'
-     * @param {String[]} [options.extensions] the supported file extensions with 'yaml' and 'json' defaults. Note 'yml' extension is ignored on purpose
-    */
-    constructor({type, paths, extensions = ['yaml', 'json']}) {
-        if (!paths || !paths.length) {
-            throw new IncorrectUsageError({
-                message: tpl(messages.incorrectPathsParameter)
-            });
-        }
-
-        this.type = type;
-        this.filename = type;
-
-        this.paths = paths;
-        this.defaultPath = paths[0];
-
-        this.extensions = extensions;
-        this.defaultExtension = extensions[0];
-    }
-
-    getDefaultFilePath() {
-        const settingsFolder = this.defaultPath;
-        return path.join(settingsFolder, `${this.filename}.${this.defaultExtension}`);
-    }
-
-    getBackupFilePath() {
-        const settingsFolder = this.defaultPath;
-        const dateStamp = format(new Date(), 'yyyy-MM-dd-HH-mm-ss');
-        return path.join(settingsFolder, `${this.filename}-${dateStamp}.${this.defaultExtension}`);
-    }
-}
-
-module.exports = SettingsPathManager;