Ghost/core/server/middleware/theme-handler.js

var _      = require('lodash'),
    hbs    = require('express-hbs'),
    config = require('../config'),
    utils = require('../utils'),
    errors = require('../errors'),
    i18n = require('../i18n'),
    settingsCache = require('../settings/cache'),
    themeUtils = require('../themes'),
    themeHandler;

themeHandler = {
    // ### configHbsForContext Middleware
    // Setup handlebars for the current context (admin or theme)
    configHbsForContext: function configHbsForContext(req, res, next) {
        // Static information, same for every request unless the settings change
        // @TODO: bind this once and then update based on events?
        var blogData = {
                title: settingsCache.get('title'),
                description: settingsCache.get('description'),
                facebook: settingsCache.get('facebook'),
                twitter: settingsCache.get('twitter'),
                timezone: settingsCache.get('activeTimezone'),
                navigation: settingsCache.get('navigation'),
                icon: settingsCache.get('icon'),
                cover: settingsCache.get('cover'),
                logo: settingsCache.get('logo'),
                amp: settingsCache.get('amp')
            },
            labsData = _.cloneDeep(settingsCache.get('labs')),
            themeData = {};

        if (themeUtils.getActive()) {
            themeData.posts_per_page = themeUtils.getActive().config('posts_per_page');
        }

        // Request-specific information
        // These things are super dependent on the request, so they need to be in middleware
        blogData.url = utils.url.urlFor('home', {secure: req.secure}, true);

        // 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;

        // @TODO: only do this if something changed?
        hbs.updateTemplateOptions({
            data: {
                blog: blogData,
                labs: labsData,
                config: themeData
            }
        });

        next();
    },

    // ### Activate Theme
    // Helper for updateActiveTheme
    activateTheme: function activateTheme(blogApp) {
        var hbsOptions = {
                partialsDir: [config.get('paths').helperTemplates],
                onCompile: function onCompile(exhbs, source) {
                    return exhbs.handlebars.compile(source, {preventIndent: true});
                }
            };

        if (themeUtils.getActive().hasPartials()) {
            hbsOptions.partialsDir.push(themeUtils.getActive().partialsPath);
        }

        // reset the asset hash
        config.set('assetHash', null);
        // clear the view cache
        blogApp.cache = {};
        // Set the views and engine
        blogApp.set('views', themeUtils.getActive().path);
        blogApp.engine('hbs', hbs.express3(hbsOptions));

        // Set active theme variable on the express server
        // Note: this is effectively the "mounted" theme, which has been loaded into the express app
        blogApp.set('activeTheme', themeUtils.getActive().name);
    },

    // ### updateActiveTheme
    // Updates the blogApp's activeTheme variable and subsequently
    // activates that theme's views with the hbs templating engine if it
    // is not yet activated.
    updateActiveTheme: function updateActiveTheme(req, res, next) {
        var blogApp = req.app,
            // 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.
            activeThemeName = settingsCache.get('activeTheme'),
            mountedThemeName = blogApp.get('activeTheme');

        // This means that the theme hasn't been loaded yet i.e. there is no active theme
        if (!themeUtils.getActive()) {
            // 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({
                message: i18n.t('errors.middleware.themehandler.missingTheme', {theme: activeThemeName})
            }));

            // If there is an active theme AND it has changed, call activate
        } else if (activeThemeName !== mountedThemeName) {
            // This is effectively "mounting" a theme into express, the theme is already "active"
            themeHandler.activateTheme(blogApp);
        }

        next();
    }
};

module.exports = themeHandler;