ghost 4.20.2 → 4.22.0

package/core/server/services/redirects/settings.js

@@ -1,234 +0,0 @@
-const fs = require('fs-extra');
-const path = require('path');
-const moment = require('moment-timezone');
-const yaml = require('js-yaml');
-const Promise = require('bluebird');
-
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-
-const validation = require('./validation');
-const config = require('../../../shared/config');
-
-const messages = {
-    jsonParse: 'Could not parse JSON: {context}.',
-    yamlParse: 'YAML input cannot be a plain string. Check the format of your YAML file.',
-    yamlParseHelp: 'https://ghost.org/docs/themes/routing/#redirects'
-};
-
-/**
- * Redirect configuration object
- * @typedef {Object} RedirectConfig
- * @property {String} from - Defines the relative incoming URL or pattern (regex)
- * @property {String} to - Defines where the incoming traffic should be redirected to, which can be a static URL, or a dynamic value using regex (example: "to": "/$1/")
- * @property {boolean} permanent - Can be defined with true for a permanent HTTP 301 redirect, or false for a temporary HTTP 302 redirect
- */
-
-const readRedirectsFile = (redirectsPath) => {
-    return fs.readFile(redirectsPath, 'utf-8')
-        .catch((err) => {
-            if (err.code === 'ENOENT') {
-                return Promise.resolve([]);
-            }
-
-            if (errors.utils.isIgnitionError(err)) {
-                throw err;
-            }
-
-            throw new errors.NotFoundError({
-                err: err
-            });
-        });
-};
-
-/**
- *
- * @param {String} content serialized JSON or YAML configuration
- * @param {String} ext one of `.json` or `.yaml` extensions
- *
- * @returns {RedirectConfig[]} of parsed redirect config objects
- */
-const parseRedirectsFile = (content, ext) => {
-    if (ext === '.json') {
-        let redirects;
-
-        try {
-            redirects = JSON.parse(content);
-        } catch (err) {
-            throw new errors.BadRequestError({
-                message: tpl(messages.jsonParse, {context: err.message})
-            });
-        }
-
-        return redirects;
-    }
-
-    if (ext === '.yaml') {
-        let redirects = [];
-        let configYaml = yaml.load(content);
-
-        // yaml.load passes almost every yaml code.
-        // Because of that, it's hard to detect if there's an error in the file.
-        // But one of the obvious errors is the plain string output.
-        // Here we check if the user made this mistake.
-        if (typeof configYaml === 'string') {
-            throw new errors.BadRequestError({
-                message: tpl(messages.yamlParse),
-                help: tpl(messages.yamlParseHelp)
-            });
-        }
-
-        /**
-         * 302: Temporary redirects
-         */
-        for (const redirect in configYaml['302']) {
-            redirects.push({
-                from: redirect,
-                to: configYaml['302'][redirect],
-                permanent: false
-            });
-        }
-
-        /**
-         * 301: Permanent redirects
-         */
-        for (const redirect in configYaml['301']) {
-            redirects.push({
-                from: redirect,
-                to: configYaml['301'][redirect],
-                permanent: true
-            });
-        }
-
-        return redirects;
-    }
-
-    throw new errors.IncorrectUsageError();
-};
-
-const createRedirectsFilePath = (ext) => {
-    return path.join(config.getContentPath('data'), `redirects${ext}`);
-};
-
-const getRedirectsFilePath = async () => {
-    const yamlPath = createRedirectsFilePath('.yaml');
-    const jsonPath = createRedirectsFilePath('.json');
-
-    const yamlExists = await fs.pathExists(yamlPath);
-
-    if (yamlExists) {
-        return yamlPath;
-    }
-
-    const jsonExist = await fs.pathExists(jsonPath);
-
-    if (jsonExist) {
-        return jsonPath;
-    }
-
-    return null;
-};
-
-const getCurrentRedirectsFilePathSync = () => {
-    const yamlPath = createRedirectsFilePath('.yaml');
-    const jsonPath = createRedirectsFilePath('.json');
-
-    if (fs.existsSync(yamlPath)) {
-        return yamlPath;
-    }
-
-    if (fs.existsSync(jsonPath)) {
-        return jsonPath;
-    }
-
-    return null;
-};
-
-const getBackupRedirectsFilePath = (filePath) => {
-    const {dir, name, ext} = path.parse(filePath);
-
-    return path.join(dir, `${name}-${moment().format('YYYY-MM-DD-HH-mm-ss')}${ext}`);
-};
-
-// '.json' is the default here because 'yaml' redirects file format is added later in v3.
-// @TODO: change the default to '.yaml' in v4. It may be even removed if '.json' format is deprecated.
-const setFromFilePath = (filePath, ext = '.json') => {
-    return getRedirectsFilePath()
-        .then((redirectsFilePath) => {
-            if (!redirectsFilePath) {
-                return null;
-            }
-
-            const backupRedirectsPath = getBackupRedirectsFilePath(redirectsFilePath);
-
-            return fs.pathExists(backupRedirectsPath)
-                .then((backupExists) => {
-                    if (!backupExists) {
-                        return null;
-                    }
-
-                    return fs.unlink(backupRedirectsPath);
-                })
-                .then(() => {
-                    return fs.move(redirectsFilePath, backupRedirectsPath);
-                });
-        })
-        .then(() => {
-            return readRedirectsFile(filePath)
-                .then((content) => {
-                    return parseRedirectsFile(content, ext);
-                })
-                .then((content) => {
-                    validation.validate(content);
-
-                    if (ext === '.json') {
-                        return fs.writeFile(createRedirectsFilePath('.json'), JSON.stringify(content), 'utf-8');
-                    }
-
-                    if (ext === '.yaml') {
-                        return fs.copy(filePath, createRedirectsFilePath('.yaml'));
-                    }
-                });
-        });
-};
-
-// @TODO: When yaml has been changed as the default redirects file format,
-// change this like `const defaultRedirectsContent = ''`.
-// Default json content is []. But the default YAML content is an empty string.
-const defaultJsonFileContent = [];
-
-const get = () => {
-    return getRedirectsFilePath().then((filePath) => {
-        if (filePath === null) {
-            return defaultJsonFileContent;
-        }
-
-        return readRedirectsFile(filePath).then((content) => {
-            return path.extname(filePath) === '.json'
-                ? parseRedirectsFile(content, '.json')
-                : content;
-        });
-    });
-};
-
-/**
- * Syncrounously loads current oncifg file and parses it's content
- *
- * @returns {{RedirectConfig[]}} of parsed redirect configurations
- */
-const loadRedirectsFile = () => {
-    const filePath = getCurrentRedirectsFilePathSync();
-
-    if (filePath === null) {
-        return defaultJsonFileContent;
-    }
-
-    const content = fs.readFileSync(filePath);
-
-    return parseRedirectsFile(content, path.extname(filePath));
-};
-
-module.exports.get = get;
-module.exports.setFromFilePath = setFromFilePath;
-module.exports.getRedirectsFilePath = getRedirectsFilePath;
-module.exports.loadRedirectsFile = loadRedirectsFile;

package/core/server/web/shared/middlewares/custom-redirects.js

@@ -1,128 +0,0 @@
-const express = require('../../../../shared/express');
-const url = require('url');
-const querystring = require('querystring');
-const debug = require('@tryghost/debug')('web:shared:mw:custom-redirects');
-const config = require('../../../../shared/config');
-const urlUtils = require('../../../../shared/url-utils');
-const errors = require('@tryghost/errors');
-const logging = require('@tryghost/logging');
-const redirectsService = require('../../../services/redirects');
-
-const messages = {
-    customRedirectsRegistrationFailure: 'Could not register custom redirects.'
-};
-
-const _private = {};
-
-let customRedirectsRouter;
-
-/**
- *
- * @param {Object} router instance of Express Router to decorate with redirects
- * @param {Object} redirects valid redirects JSON
- *
- * @returns {Object} instance of express.Router express router handling redirects based on config
- */
-_private.registerRoutes = (router, redirects) => {
-    debug('redirects loading');
-
-    redirects.forEach((redirect) => {
-        /**
-         * Detect case insensitive modifier when regex is enclosed by
-         * / ... /i
-         */
-        let options = '';
-        if (redirect.from.match(/^\/.*\/i$/)) {
-            redirect.from = redirect.from.slice(1, -2);
-            options = 'i';
-        }
-
-        /**
-         * always delete trailing slashes, doesn't matter if regex or not
-         * Example:
-         *   - you define /my-blog-post-1/ as from property
-         *   - /my-blog-post-1 or /my-blog-post-1/ should work
-         */
-
-        if (redirect.from.match(/\/$/)) {
-            redirect.from = redirect.from.slice(0, -1);
-        }
-
-        if (redirect.from[redirect.from.length - 1] !== '$') {
-            redirect.from += '/?$';
-        }
-
-        debug('register', redirect.from);
-        router.get(new RegExp(redirect.from, options), function (req, res) {
-            const maxAge = redirect.permanent ? config.get('caching:customRedirects:maxAge') : 0;
-            const toURL = url.parse(redirect.to);
-            const toURLParams = querystring.parse(toURL.query);
-            const currentURL = url.parse(req.url);
-            const currentURLParams = querystring.parse(currentURL.query);
-            const params = Object.assign({}, currentURLParams, toURLParams);
-            const search = querystring.stringify(params);
-
-            toURL.pathname = currentURL.pathname.replace(new RegExp(redirect.from, options), toURL.pathname);
-            toURL.search = search !== '' ? `?${search}` : null;
-
-            /**
-             * Only if the URL is internal should we prepend the Ghost subdirectory
-             * @see https://github.com/TryGhost/Ghost/issues/10776
-             */
-            if (!toURL.hostname) {
-                toURL.pathname = urlUtils.urlJoin(urlUtils.getSubdir(), toURL.pathname);
-            }
-
-            res.set({
-                'Cache-Control': `public, max-age=${maxAge}`
-            });
-
-            res.redirect(redirect.permanent ? 301 : 302, url.format(toURL));
-        });
-    });
-
-    debug('redirects loaded');
-
-    return router;
-};
-
-const loadRoutes = () => {
-    try {
-        customRedirectsRouter = express.Router('redirects');
-
-        const redirects = redirectsService.loadRedirectsFile();
-        redirectsService.validate(redirects);
-
-        _private.registerRoutes(customRedirectsRouter, redirects);
-    } catch (err) {
-        if (errors.utils.isIgnitionError(err)) {
-            logging.error(err);
-        } else {
-            logging.error(new errors.IncorrectUsageError({
-                message: messages.customRedirectsRegistrationFailure,
-                context: err.message,
-                help: 'https://ghost.org/docs/themes/routing/#redirects',
-                err
-            }));
-        }
-    }
-};
-
-/**
- * - you can extend Ghost with a custom redirects file
- * - see https://github.com/TryGhost/Ghost/issues/7707 and https://ghost.org/docs/themes/routing/#redirects
- * - file loads synchronously, because we need to register the routes before anything else
- */
-exports.use = function use(siteApp) {
-    loadRoutes();
-
-    // Recommended approach by express, see https://github.com/expressjs/express/issues/2596#issuecomment-81353034.
-    // As soon as the express router get's re-instantiated, the old router instance is not used anymore.
-    siteApp.use(function customRedirect(req, res, next) {
-        customRedirectsRouter(req, res, next);
-    });
-};
-
-exports.reload = function reload() {
-    loadRoutes();
-};