Ghost/core/server/services/routing/controllers/channel.js
kirrg001 ab49d1eed6 Added comments for routing service
no issue

- jsdoc
- inline comments
2019-04-21 23:55:22 +02:00

71 lines
2.4 KiB
JavaScript

const _ = require('lodash'),
debug = require('ghost-ignition').debug('services:routing:controllers:channel'),
common = require('../../../lib/common'),
security = require('../../../lib/security'),
themes = require('../../themes'),
helpers = require('../helpers');
/**
* @description Channel controller.
*
* @TODO: The collection+rss controller do almost the same. Merge!
*
* @param {Object} req
* @param {Object} res
* @param {Function} next
* @returns {Promise}
*/
module.exports = function channelController(req, res, next) {
debug('channelController', req.params, res.routerOptions);
const pathOptions = {
page: req.params.page !== undefined ? req.params.page : 1,
slug: req.params.slug ? security.string.safe(req.params.slug) : undefined
};
if (pathOptions.page) {
// CASE 1: routes.yaml `limit` is stronger than theme definition
// CASE 2: use `posts_per_page` config from theme as `limit` value
if (res.routerOptions.limit) {
themes.getActive().updateTemplateOptions({
data: {
config: {
posts_per_page: res.routerOptions.limit
}
}
});
pathOptions.limit = res.routerOptions.limit;
} else {
const postsPerPage = parseInt(themes.getActive().config('posts_per_page'));
if (!isNaN(postsPerPage) && postsPerPage > 0) {
pathOptions.limit = postsPerPage;
}
}
}
return helpers.fetchData(pathOptions, res.routerOptions, res.locals)
.then(function handleResult(result) {
// CASE: requested page is greater than number of pages we have
if (pathOptions.page > result.meta.pagination.pages) {
return next(new common.errors.NotFoundError({
message: common.i18n.t('errors.errors.pageNotFound')
}));
}
// Format data 1
// @TODO: See helpers/secure for explanation.
helpers.secure(req, result.posts);
// @TODO: See helpers/secure for explanation.
_.each(result.data, function (data) {
helpers.secure(req, data);
});
const renderer = helpers.renderEntries(req, res);
return renderer(result);
})
.catch(helpers.handleError(next));
};