mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-10 23:36:14 -05:00
b392d1925a
refs #9601 ### Dynamic Routing This is the beta version of dynamic routing. - we had a initial implementation of "channels" available in the codebase - we have removed and moved this implementation - there is now a centralised place for dynamic routing - server/services/routing - each routing component is represented by a router type e.g. collections, routes, static pages, taxonomies, rss, preview of posts - keep as much as possible logic of routing helpers, middlewares and controllers - ensure test coverage - connect all the things together - yaml file + validation - routing + routers - url service - sitemaps - url access - deeper implementation of yaml validations - e.g. hard require slashes - ensure routing hierarchy/order - e.g. you enable the subscriber app - you have a custom static page, which lives under the same slug /subscribe - static pages are stronger than apps - e.g. the first collection owns the post it has filtered - a post cannot live in two collections - ensure apps are still working and hook into the routers layer (or better said: and register in the routing service) - put as much as possible comments to the code base for better understanding - ensure a clean debug log - ensure we can unmount routes - e.g. you have a collection permalink of /:slug/ represented by {globals.permalink} - and you change the permalink in the admin to dated permalink - the express route get's refreshed from /:slug/ to /:year/:month/:day/:slug/ - unmount without server restart, yey - ensure we are backwards compatible - e.g. render home.hbs for collection index if collection route is / - ensure you can access your configured permalink from the settings table with {globals.permalink} ### Render 503 if url service did not finish - return 503 if the url service has not finished generating the resource urls ### Rewrite sitemaps - we have rewritten the sitemaps "service", because the url generator does no longer happen on runtime - we generate all urls on bootstrap - the sitemaps service will consume created resource and router urls - these urls will be shown on the xml pages - we listen on url events - we listen on router events - we no longer have to fetch the resources, which is nice - the urlservice pre-fetches resources and emits their urls - the urlservice is the only component who knows which urls are valid - i made some ES6 adaptions - we keep the caching logic -> only regenerate xml if there is a change - updated tests - checked test coverage (100%) ### Re-work usage of Url utility - replace all usages of `urlService.utils.urlFor` by `urlService.getByResourceId` - only for resources e.g. post, author, tag - this is important, because with dynamic routing we no longer create static urls based on the settings permalink on runtime - adapt url utility - adapt tests
118 lines
3.1 KiB
JavaScript
118 lines
3.1 KiB
JavaScript
var path = require('path'),
|
|
express = require('express'),
|
|
_ = require('lodash'),
|
|
subscribeRouter = express.Router(),
|
|
bodyParser = require('body-parser'),
|
|
|
|
// Dirty requires
|
|
api = require('../../../api'),
|
|
common = require('../../../lib/common'),
|
|
urlService = require('../../../services/url'),
|
|
validator = require('../../../data/validation').validator,
|
|
routing = require('../../../services/routing'),
|
|
|
|
templateName = 'subscribe';
|
|
|
|
function _renderer(req, res) {
|
|
// Note: this is super similar to the config middleware used in channels
|
|
// @TODO refactor into to something explicit & DRY this up
|
|
res._route = {
|
|
type: 'custom',
|
|
templateName: templateName,
|
|
defaultTemplate: path.resolve(__dirname, 'views', templateName + '.hbs')
|
|
};
|
|
|
|
// Renderer begin
|
|
// Format data
|
|
var data = req.body;
|
|
|
|
// Render Call
|
|
return routing.helpers.renderer(req, res, data);
|
|
}
|
|
|
|
/**
|
|
* Takes care of sanitizing the email input.
|
|
* XSS prevention.
|
|
* For success cases, we don't have to worry, because then the input contained a valid email address.
|
|
*/
|
|
function errorHandler(error, req, res, next) {
|
|
req.body.email = '';
|
|
|
|
if (error.statusCode !== 404) {
|
|
res.locals.error = error;
|
|
return _renderer(req, res);
|
|
}
|
|
|
|
next(error);
|
|
}
|
|
|
|
function honeyPot(req, res, next) {
|
|
if (!req.body.hasOwnProperty('confirm') || req.body.confirm !== '') {
|
|
return next(new Error('Oops, something went wrong!'));
|
|
}
|
|
|
|
// we don't need this anymore
|
|
delete req.body.confirm;
|
|
next();
|
|
}
|
|
|
|
function santizeUrl(url) {
|
|
return validator.isEmptyOrURL(url || '') ? url : '';
|
|
}
|
|
|
|
function handleSource(req, res, next) {
|
|
req.body.subscribed_url = santizeUrl(req.body.location);
|
|
req.body.subscribed_referrer = santizeUrl(req.body.referrer);
|
|
|
|
delete req.body.location;
|
|
delete req.body.referrer;
|
|
|
|
const resource = urlService.getResource(urlService.utils.absoluteToRelative(req.body.subscribed_url));
|
|
|
|
if (resource) {
|
|
req.body.post_id = resource.data.id;
|
|
}
|
|
|
|
next();
|
|
}
|
|
|
|
function storeSubscriber(req, res, next) {
|
|
req.body.status = 'subscribed';
|
|
|
|
if (_.isEmpty(req.body.email)) {
|
|
return next(new common.errors.ValidationError({message: 'Email cannot be blank.'}));
|
|
} else if (!validator.isEmail(req.body.email)) {
|
|
return next(new common.errors.ValidationError({message: 'Invalid email.'}));
|
|
}
|
|
|
|
return api.subscribers.add({subscribers: [req.body]}, {context: {external: true}})
|
|
.then(function () {
|
|
res.locals.success = true;
|
|
next();
|
|
})
|
|
.catch(function () {
|
|
// we do not expose any information
|
|
res.locals.success = true;
|
|
next();
|
|
});
|
|
}
|
|
|
|
// subscribe frontend route
|
|
subscribeRouter
|
|
.route('/')
|
|
.get(
|
|
_renderer
|
|
)
|
|
.post(
|
|
bodyParser.urlencoded({extended: true}),
|
|
honeyPot,
|
|
handleSource,
|
|
storeSubscriber,
|
|
_renderer
|
|
);
|
|
|
|
// configure an error handler just for subscribe problems
|
|
subscribeRouter.use(errorHandler);
|
|
|
|
module.exports = subscribeRouter;
|
|
module.exports.storeSubscriber = storeSubscriber;
|