ghost 4.18.0 → 4.20.1

package/core/frontend/services/routing/bootstrap.js

@@ -1,114 +0,0 @@
-const debug = require('@tryghost/debug')('routing');
-const _ = require('lodash');
-const StaticRoutesRouter = require('./StaticRoutesRouter');
-const StaticPagesRouter = require('./StaticPagesRouter');
-const CollectionRouter = require('./CollectionRouter');
-const TaxonomyRouter = require('./TaxonomyRouter');
-const PreviewRouter = require('./PreviewRouter');
-const ParentRouter = require('./ParentRouter');
-const EmailRouter = require('./EmailRouter');
-const UnsubscribeRouter = require('./UnsubscribeRouter');
-
-// This emits its own routing events
-const events = require('../../../server/lib/common/events');
-
-const defaultApiVersion = 'v4';
-
-const registry = require('./registry');
-let siteRouter;
-
-/**
- * @description The `init` function will return the wrapped parent express router and will start creating all
- *              routers if you pass the option "start: true".
- *
- * CASES:
- *   - if Ghost starts, it will first init the site app with the wrapper router and then call `start`
- *     separately, because it could be that your blog goes into maintenance mode
- *   - if you change your route settings, we will re-initialise routing
- *
- * @param {Object} options
- * @returns {ExpressRouter}
- */
-module.exports.init = ({start = false, routerSettings, apiVersion}) => {
-    debug('bootstrap init', start, apiVersion, routerSettings);
-
-    registry.resetAllRouters();
-    registry.resetAllRoutes();
-
-    events.emit('routers.reset');
-
-    siteRouter = new ParentRouter('SiteRouter');
-    registry.setRouter('siteRouter', siteRouter);
-
-    if (start) {
-        apiVersion = apiVersion || defaultApiVersion;
-        this.start(apiVersion, routerSettings);
-    }
-
-    return siteRouter.router();
-};
-
-/**
- * @description This function will create the routers based on the route settings
- *
- * The routers are created in a specific order. This order defines who can get a resource first or
- * who can dominant other routers.
- *
- * 1. Preview + Unsubscribe Routers: Strongest inbuilt features, which you can never override.
- * 2. Static Routes: Very strong, because you can override any urls and redirect to a static route.
- * 3. Taxonomies: Stronger than collections, because it's an inbuilt feature.
- * 4. Collections
- * 5. Static Pages: Weaker than collections, because we first try to find a post slug and fallback to lookup a static page.
- * 6. Internal Apps: Weakest
- *
- * @param {string} apiVersion
- * @param {object} routerSettings
- */
-module.exports.start = (apiVersion, routerSettings) => {
-    debug('bootstrap start', apiVersion, routerSettings);
-    const RESOURCE_CONFIG = require(`./config/${apiVersion}`);
-
-    const unsubscribeRouter = new UnsubscribeRouter();
-    siteRouter.mountRouter(unsubscribeRouter.router());
-    registry.setRouter('unsubscribeRouter', unsubscribeRouter);
-
-    const emailRouter = new EmailRouter(RESOURCE_CONFIG);
-    siteRouter.mountRouter(emailRouter.router());
-    registry.setRouter('emailRouter', emailRouter);
-
-    const previewRouter = new PreviewRouter(RESOURCE_CONFIG);
-    siteRouter.mountRouter(previewRouter.router());
-    registry.setRouter('previewRouter', previewRouter);
-
-    _.each(routerSettings.routes, (value, key) => {
-        const staticRoutesRouter = new StaticRoutesRouter(key, value);
-        siteRouter.mountRouter(staticRoutesRouter.router());
-
-        registry.setRouter(staticRoutesRouter.identifier, staticRoutesRouter);
-    });
-
-    _.each(routerSettings.collections, (value, key) => {
-        const collectionRouter = new CollectionRouter(key, value, RESOURCE_CONFIG);
-        siteRouter.mountRouter(collectionRouter.router());
-        registry.setRouter(collectionRouter.identifier, collectionRouter);
-    });
-
-    const staticPagesRouter = new StaticPagesRouter(RESOURCE_CONFIG);
-    siteRouter.mountRouter(staticPagesRouter.router());
-
-    registry.setRouter('staticPagesRouter', staticPagesRouter);
-
-    _.each(routerSettings.taxonomies, (value, key) => {
-        const taxonomyRouter = new TaxonomyRouter(key, value, RESOURCE_CONFIG);
-        siteRouter.mountRouter(taxonomyRouter.router());
-
-        registry.setRouter(taxonomyRouter.identifier, taxonomyRouter);
-    });
-
-    const appRouter = new ParentRouter('AppsRouter');
-    siteRouter.mountRouter(appRouter.router());
-
-    registry.setRouter('appRouter', appRouter);
-
-    debug('Routes:', registry.getAllRoutes());
-};

package/core/server/web/site/index.js

@@ -1 +0,0 @@
-module.exports = require('./app');

package/core/server/web/site/routes.js

@@ -1,9 +0,0 @@
-const debug = require('@tryghost/debug')('routing');
-const routing = require('../../../frontend/services/routing');
-const routeSettings = require('../../services/route-settings');
-
-module.exports = function siteRoutes(options = {}) {
-    debug('site Routes', options);
-    options.routerSettings = routeSettings.loadRouteSettingsSync();
-    return routing.bootstrap.init(options);
-};

package/core/shared/i18n/i18n.js

@@ -1,312 +0,0 @@
-const errors = require('@tryghost/errors');
-const fs = require('fs-extra');
-const path = require('path');
-const MessageFormat = require('intl-messageformat');
-const jp = require('jsonpath');
-const isString = require('lodash/isString');
-const isObject = require('lodash/isObject');
-const isEqual = require('lodash/isEqual');
-const isNil = require('lodash/isNil');
-const merge = require('lodash/merge');
-const get = require('lodash/get');
-
-class I18n {
-    /**
-     * @param {objec} [options]
-     * @param {string} basePath - the base path to the translations directory
-     * @param {string} [locale] - a locale string
-     * @param {{dot|fulltext}} [stringMode] - which mode our translation keys use
-     * @param {{object}} [logging] - logging method
-     */
-    constructor(options = {}) {
-        this._basePath = options.basePath || __dirname;
-        this._locale = options.locale || this.defaultLocale();
-        this._stringMode = options.stringMode || 'dot';
-        this._logging = options.logging || console;
-
-        this._strings = null;
-    }
-
-    /**
-     * BasePath getter & setter used for testing
-     */
-    set basePath(basePath) {
-        this._basePath = basePath;
-    }
-
-    /**
-         * Need to call init after this
-         */
-    get basePath() {
-        return this._basePath;
-    }
-
-    /**
-     * English is our default locale
-     */
-    defaultLocale() {
-        return 'en';
-    }
-
-    supportedLocales() {
-        return [this.defaultLocale()];
-    }
-
-    /**
-     * Exporting the current locale (e.g. "en") to make it available for other files as well,
-     * such as core/frontend/helpers/date.js and core/frontend/helpers/lang.js
-     */
-    locale() {
-        return this._locale;
-    }
-
-    /**
-     * Helper method to find and compile the given data context with a proper string resource.
-     *
-     * @param {string} translationPath Path within the JSON language file to desired string (ie: "errors.init.jsNotBuilt")
-     * @param {object} [bindings]
-     * @returns {string}
-     */
-    t(translationPath, bindings) {
-        let string;
-        let msg;
-
-        string = this._findString(translationPath);
-
-        // If the path returns an array (as in the case with anything that has multiple paragraphs such as emails), then
-        // loop through them and return an array of translated/formatted strings. Otherwise, just return the normal
-        // translated/formatted string.
-        if (Array.isArray(string)) {
-            msg = [];
-            string.forEach(function (s) {
-                msg.push(this._formatMessage(s, bindings));
-            });
-        } else {
-            msg = this._formatMessage(string, bindings);
-        }
-
-        return msg;
-    }
-
-    /**
-     * Setup i18n support:
-     *  - Load proper language file into memory
-     */
-    init() {
-        this._strings = this._loadStrings();
-
-        this._initializeIntl();
-    }
-
-    /**
-     * Attempt to load strings from a file
-     *
-     * @param {sting} [locale]
-     * @returns {object} strings
-     */
-    _loadStrings(locale) {
-        locale = locale || this.locale();
-
-        try {
-            return this._readTranslationsFile(locale);
-        } catch (err) {
-            if (err.code === 'ENOENT') {
-                this._handleMissingFileError(locale, err);
-
-                if (locale !== this.defaultLocale()) {
-                    this._handleFallbackToDefault();
-                    return this._loadStrings(this.defaultLocale());
-                }
-            } else if (err instanceof SyntaxError) {
-                this._handleInvalidFileError(locale, err);
-            } else {
-                throw err;
-            }
-
-            // At this point we've done all we can and strings must be an object
-            return {};
-        }
-    }
-
-    /**
-     * Do the lookup within the JSON file using jsonpath
-     *
-     * @param {String} msgPath
-     */
-    _getCandidateString(msgPath) {
-        // Our default string mode is "dot" for dot-notation, e.g. $.something.like.this used in the backend
-        // Both jsonpath's dot-notation and bracket-notation start with '$' E.g.: $.store.book.title or $['store']['book']['title']
-        // While bracket-notation allows any Unicode characters in keys (i.e. for themes / fulltext mode) E.g. $['Read more']
-        // dot-notation allows only word characters in keys for backend messages (that is \w or [A-Za-z0-9_] in RegExp)
-        let jsonPath = `$.${msgPath}`;
-        let fallback = null;
-
-        if (this._stringMode === 'fulltext') {
-            jsonPath = jp.stringify(['$', msgPath]);
-            // In fulltext mode we can use the passed string as a fallback
-            fallback = msgPath;
-        }
-
-        try {
-            return jp.value(this._strings, jsonPath) || fallback;
-        } catch (err) {
-            this._handleInvalidKeyError(msgPath, err);
-        }
-    }
-
-    /**
-     * Parse JSON file for matching locale, returns string giving path.
-     *
-     * @param {string} msgPath Path with in the JSON language file to desired string (ie: "errors.init.jsNotBuilt")
-     * @returns {string}
-     */
-    _findString(msgPath, opts) {
-        const options = merge({log: true}, opts || {});
-        let candidateString;
-        let matchingString;
-
-        // no path? no string
-        if (msgPath.length === 0 || !isString(msgPath)) {
-            this._handleEmptyKeyError();
-            return '';
-        }
-
-        // If not in memory, load translations for core
-        if (isNil(this._strings)) {
-            this._handleUninitialisedError(msgPath);
-        }
-
-        candidateString = this._getCandidateString(msgPath);
-
-        matchingString = candidateString || {};
-
-        if (isObject(matchingString) || isEqual(matchingString, {})) {
-            if (options.log) {
-                this._handleMissingKeyError(msgPath);
-            }
-
-            matchingString = this._fallbackError();
-        }
-
-        return matchingString;
-    }
-
-    _translationFileDirs() {
-        return [this.basePath];
-    }
-
-    // If we are passed a locale, use that, else use this.locale
-    _translationFileName(locale) {
-        return `${locale || this.locale()}.json`;
-    }
-
-    /**
-     * Read the translations file
-     * Error handling to be done by consumer
-     *
-     * @param  {string} locale
-     */
-    _readTranslationsFile(locale) {
-        const filePath = path.join(...this._translationFileDirs(), this._translationFileName(locale));
-        const content = fs.readFileSync(filePath);
-        return JSON.parse(content);
-    }
-
-    /**
-     * Format the string using the correct locale and applying any bindings
-     * @param {String} string
-     * @param {Object} bindings
-     */
-    _formatMessage(string, bindings) {
-        let currentLocale = this.locale();
-        let msg = new MessageFormat(string, currentLocale);
-
-        try {
-            msg = msg.format(bindings);
-        } catch (err) {
-            this._handleFormatError(err);
-
-            // fallback
-            msg = new MessageFormat(this._fallbackError(), currentLocale);
-            msg = msg.format();
-        }
-
-        return msg;
-    }
-
-    /**
-     * [Private] Setup i18n support:
-     *  - Polyfill node.js if it does not have Intl support or support for a particular locale
-     */
-    _initializeIntl() {
-        let hasBuiltInLocaleData;
-        let IntlPolyfill;
-
-        if (global.Intl) {
-            // Determine if the built-in `Intl` has the locale data we need.
-            hasBuiltInLocaleData = this.supportedLocales().every(function (locale) {
-                return Intl.NumberFormat.supportedLocalesOf(locale)[0] === locale &&
-                    Intl.DateTimeFormat.supportedLocalesOf(locale)[0] === locale;
-            });
-            if (!hasBuiltInLocaleData) {
-                // `Intl` exists, but it doesn't have the data we need, so load the
-                // polyfill and replace the constructors with need with the polyfill's.
-                IntlPolyfill = require('intl');
-                Intl.NumberFormat = IntlPolyfill.NumberFormat;
-                Intl.DateTimeFormat = IntlPolyfill.DateTimeFormat;
-            }
-        } else {
-            // No `Intl`, so use and load the polyfill.
-            global.Intl = require('intl');
-        }
-    }
-
-    _handleUninitialisedError(key) {
-        this._logging.warn(`i18n was used before it was initialised with key ${key}`);
-        this.init();
-    }
-
-    _handleFormatError(err) {
-        this._logging.error(err.message);
-    }
-
-    _handleFallbackToDefault() {
-        this._logging.warn(`i18n is falling back to ${this.defaultLocale()}.json.`);
-    }
-
-    _handleMissingFileError(locale) {
-        this._logging.warn(`i18n was unable to find ${locale}.json.`);
-    }
-    _handleInvalidFileError(locale, err) {
-        this._logging.error(new errors.IncorrectUsageError({
-            err,
-            message: `i18n was unable to parse ${locale}.json. Please check that it is valid JSON.`
-        }));
-    }
-
-    _handleEmptyKeyError() {
-        this._logging.warn('i18n.t() was called without a key');
-    }
-
-    _handleMissingKeyError(key) {
-        this._logging.error(new errors.IncorrectUsageError({
-            message: `i18n.t() was called with a key that could not be found: ${key}`
-        }));
-    }
-
-    _handleInvalidKeyError(key, err) {
-        throw new errors.IncorrectUsageError({
-            err,
-            message: `i18n.t() called with an invalid key: ${key}`
-        });
-    }
-
-    /**
-     * A really basic error for if everything goes wrong
-     */
-    _fallbackError() {
-        return get(this._strings, 'errors.errors.anErrorOccurred', 'An error occurred');
-    }
-}
-
-module.exports = I18n;

package/core/shared/i18n/index.js

@@ -1,6 +0,0 @@
-const path = require('path');
-const logging = require('@tryghost/logging');
-const I18n = require('./i18n');
-
-module.exports = new I18n({logging, basePath: path.join(__dirname, 'translations')});
-module.exports.I18n = I18n;