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

101 lines
3.5 KiB
JavaScript
Raw Normal View History

var express = require('express'),
_ = require('lodash'),
config = require('../../config'),
errors = require('../../errors'),
🎨 configurable logging with bunyan (#7431) - 🛠 add bunyan and prettyjson, remove morgan - ✨ add logging module - GhostLogger class that handles setup of bunyan - PrettyStream for stdout - ✨ config for logging - @TODO: testing level fatal? - ✨ log each request via GhostLogger (express middleware) - @TODO: add errors to output - 🔥 remove errors.updateActiveTheme - we can read the value from config - 🔥 remove 15 helper functions in core/server/errors/index.js - all these functions get replaced by modules: 1. logging 2. error middleware handling for html/json 3. error creation (which will be part of PR #7477) - ✨ add express error handler for html/json - one true error handler for express responses - contains still some TODO's, but they are not high priority for first implementation/integration - this middleware only takes responsibility of either rendering html responses or return json error responses - 🎨 use new express error handler in middleware/index - 404 and 500 handling - 🎨 return error instead of error message in permissions/index.js - the rule for error handling should be: if you call a unit, this unit should return a custom Ghost error - 🎨 wrap serve static module - rule: if you call a module/unit, you should always wrap this error - it's always the same rule - so the caller never has to worry about what comes back - it's always a clear error instance - in this case: we return our notfounderror if serve static does not find the resource - this avoid having checks everywhere - 🎨 replace usages of errors/index.js functions and adapt tests - use logging.error, logging.warn - make tests green - remove some usages of logging and throwing api errors -> because when a request is involved, logging happens automatically - 🐛 return errorDetails to Ghost-Admin - errorDetails is used for Theme error handling - 🎨 use 500er error for theme is missing error in theme-handler - 🎨 extend file rotation to 1w
2016-10-04 18:33:43 +03:00
i18n = require('../../i18n'),
rss = require('../../data/xml/rss'),
utils = require('../../utils'),
channelConfig = require('./channel-config'),
renderChannel = require('./render-channel'),
rssRouter,
channelRouter;
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.redirect301(res, req.originalUrl.replace(rssRegex, '/rss/'));
} else {
return utils.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();
}
}
rssRouter = function rssRouter(channelConfig) {
function rssConfigMiddleware(req, res, next) {
res.locals.channel.isRSS = true;
next();
}
// @TODO move this to an RSS module
var router = express.Router({mergeParams: true}),
stack = [channelConfig, rssConfigMiddleware, rss],
baseRoute = '/rss/';
router.get(baseRoute, stack);
router.get(utils.url.urlJoin(baseRoute, ':page(\\d+)/'), stack);
router.get('/feed/', function redirectToRSS(req, res) {
return utils.redirect301(res, utils.url.urlJoin(utils.url.getSubdir(), req.baseUrl, baseRoute));
});
router.param('page', handlePageParam);
return router;
};
channelRouter = function router() {
function channelConfigMiddleware(channel) {
return function doChannelConfig(req, res, next) {
res.locals.channel = _.cloneDeep(channel);
next();
};
}
var channelsRouter = express.Router({mergeParams: true}),
baseRoute = '/',
pageRoute = utils.url.urlJoin('/', config.get('routeKeywords').page, ':page(\\d+)/');
_.each(channelConfig.list(), function (channel) {
var channelRouter = express.Router({mergeParams: true}),
configChannel = channelConfigMiddleware(channel);
// @TODO figure out how to collapse this into a single rule
channelRouter.get(baseRoute, configChannel, renderChannel);
// @TODO improve config and add defaults to make this simpler
if (channel.paged !== false) {
channelRouter.param('page', handlePageParam);
channelRouter.get(pageRoute, configChannel, renderChannel);
}
// @TODO improve config and add defaults to make this simpler
if (channel.rss !== false) {
channelRouter.use(rssRouter(configChannel));
}
if (channel.editRedirect) {
channelRouter.get('/edit/', function redirect(req, res) {
res.redirect(utils.url.urlJoin(utils.url.getSubdir(), channel.editRedirect.replace(':slug', req.params.slug)));
});
}
// Mount this channel router on the parent channels router
channelsRouter.use(channel.route, channelRouter);
});
return channelsRouter;
};
module.exports.router = channelRouter;