mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-22 18:31:57 +03:00
add30f3d5b
refs https://linear.app/tryghost/issue/CORE-103/decouple-internal-frontend-code-from-url-module - By becoming a parameter in the routing bootstrap process URL is Service no longer a "require" inside the frontend controllers but rather becomes a part of the "internal API" of the bootstrapper. This is not the end form of it, rather a step closer to decouplint routing from the URL serivce. - The bootstrap module needs a facelift to have cleaner distinction between init/start methods. This is left for another time
96 lines
3.5 KiB
JavaScript
96 lines
3.5 KiB
JavaScript
const _ = require('lodash');
|
|
const debug = require('@tryghost/debug')('services:routing:controllers:collection');
|
|
const tpl = require('@tryghost/tpl');
|
|
const errors = require('@tryghost/errors');
|
|
const security = require('@tryghost/security');
|
|
const bootstrap = require('../bootstrap');
|
|
const themeEngine = require('../../theme-engine');
|
|
const helpers = require('../helpers');
|
|
|
|
const messages = {
|
|
pageNotFound: 'Page not found.'
|
|
};
|
|
|
|
/**
|
|
* @description Collection controller.
|
|
* @param {Object} req
|
|
* @param {Object} res
|
|
* @param {Function} next
|
|
* @returns {Promise}
|
|
*/
|
|
module.exports = function collectionController(req, res, next) {
|
|
debug('collectionController beging', 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) {
|
|
themeEngine.getActive().updateTemplateOptions({
|
|
data: {
|
|
config: {
|
|
posts_per_page: res.routerOptions.limit
|
|
}
|
|
}
|
|
});
|
|
|
|
pathOptions.limit = res.routerOptions.limit;
|
|
} else {
|
|
const postsPerPage = parseInt(themeEngine.getActive().config('posts_per_page'));
|
|
|
|
if (!isNaN(postsPerPage) && postsPerPage > 0) {
|
|
pathOptions.limit = postsPerPage;
|
|
}
|
|
}
|
|
}
|
|
|
|
debug('fetching data');
|
|
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 errors.NotFoundError({
|
|
message: tpl(messages.pageNotFound)
|
|
}));
|
|
}
|
|
|
|
debug(`posts in collection ${result.posts.length}`);
|
|
|
|
/**
|
|
* CASE:
|
|
*
|
|
* Does this post belong to this collection?
|
|
* A post can only live in one collection. If you make use of multiple collections and you mis-use your routes.yaml,
|
|
* it can happen that your database query will load the same posts, but we cannot show a post on two
|
|
* different urls. This helper is only a prevention, but it's not a solution for the user, because
|
|
* it will break pagination (e.g. you load 10 posts from database, but you only render 9).
|
|
*
|
|
* People should always invert their filters to ensure that the database query loads unique posts per collection.
|
|
*/
|
|
result.posts = _.filter(result.posts, (post) => {
|
|
if (bootstrap.internal.owns(res.routerOptions.identifier, post.id)) {
|
|
return post;
|
|
}
|
|
|
|
debug(`'${post.slug}' is not owned by this collection`);
|
|
});
|
|
|
|
// 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));
|
|
};
|