Ghost/core/server/controllers/frontend/channels.js

var express = require('express'),
    _       = require('lodash'),
    config  = require('../../config'),
    errors  = require('../../errors'),
    i18n    = require('../../i18n'),
    rss     = require('../../data/xml/rss'),
    utils   = require('../../utils'),
    channelConfig = require('./channel-config'),
    renderChannel = require('./render-channel'),
    rssRouter,
    channelsRouter;

function handlePageParam(req, res, next, page) {
    var pageRegex = new RegExp('/' + config.get('routeKeywords').page + '/(.*)?/'),
        rssRegex = new RegExp('/rss/(.*)?/');

    page = parseInt(page, 10);

    if (page === 1) {
        // Page 1 is an alias, do a permanent 301 redirect
        if (rssRegex.test(req.url)) {
            return utils.url.redirect301(res, req.originalUrl.replace(rssRegex, '/rss/'));
        } else {
            return utils.url.redirect301(res, req.originalUrl.replace(pageRegex, '/'));
        }
    } else if (page < 1 || isNaN(page)) {
        // Nothing less than 1 is a valid page number, go straight to a 404
        return next(new errors.NotFoundError({message: i18n.t('errors.errors.pageNotFound')}));
    } else {
        // Set req.params.page to the already parsed number, and continue
        req.params.page = page;
        return next();
    }
}

function rssConfigMiddleware(req, res, next) {
    res.locals.channel.isRSS = true;
    next();
}

function channelConfigMiddleware(channel) {
    return function doChannelConfig(req, res, next) {
        res.locals.channel = _.cloneDeep(channel);
        next();
    };
}

rssRouter = function rssRouter(channelMiddleware) {
    // @TODO move this to an RSS module
    var router = express.Router({mergeParams: true}),
        baseRoute = '/rss/',
        pageRoute = utils.url.urlJoin(baseRoute, ':page(\\d+)/');

    // @TODO figure out how to collapse this into a single rule
    router.get(baseRoute, channelMiddleware, rssConfigMiddleware, rss);
    router.get(pageRoute, channelMiddleware, rssConfigMiddleware, rss);
    // Extra redirect rule
    router.get('/feed/', function redirectToRSS(req, res) {
        return utils.url.redirect301(res, utils.url.urlJoin(utils.url.getSubdir(), req.baseUrl, baseRoute));
    });

    router.param('page', handlePageParam);
    return router;
};

function buildChannelRouter(channel) {
    var channelRouter = express.Router({mergeParams: true}),
        baseRoute = '/',
        pageRoute = utils.url.urlJoin('/', config.get('routeKeywords').page, ':page(\\d+)/'),
        middleware = [channelConfigMiddleware(channel)];

    // @TODO figure out how to collapse this into a single rule
    channelRouter.get(baseRoute, middleware, renderChannel);

    // @TODO improve config and add defaults to make this simpler
    if (channel.paged !== false) {
        channelRouter.param('page', handlePageParam);
        channelRouter.get(pageRoute, middleware, renderChannel);
    }

    // @TODO improve config and add defaults to make this simpler
    if (channel.rss !== false) {
        channelRouter.use(rssRouter(middleware));
    }

    if (channel.editRedirect) {
        channelRouter.get('/edit/', function redirect(req, res) {
            utils.url.redirectToAdmin(302, res, channel.editRedirect.replace(':slug', req.params.slug));
        });
    }

    return channelRouter;
}

channelsRouter = function router() {
    var channelsRouter = express.Router({mergeParams: true});

    _.each(channelConfig.list(), function (channel) {
        var channelRoute = channel.route.replace(/:rkw-([a-zA-Z]+)/, function (fullMatch, keyword) {
            return config.get('routeKeywords')[keyword];
        });

        // Mount this channel router on the parent channels router
        channelsRouter.use(channelRoute, buildChannelRouter(channel));
    });

    return channelsRouter;
};

module.exports.router = channelsRouter;