2018-09-10 16:06:41 +07:00
|
|
|
const path = require('path'),
|
2017-12-11 22:47:46 +01:00
|
|
|
_ = require('lodash'),
|
2018-09-10 16:06:41 +07:00
|
|
|
express = require('express'),
|
2017-12-11 22:47:46 +01:00
|
|
|
subscribeRouter = express.Router(),
|
|
|
|
bodyParser = require('body-parser'),
|
2016-04-21 16:37:52 +01:00
|
|
|
// Dirty requires
|
2017-12-11 22:47:46 +01:00
|
|
|
common = require('../../../lib/common'),
|
✨Dynamic Routing Beta (#9596)
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
2018-06-05 19:02:20 +02:00
|
|
|
urlService = require('../../../services/url'),
|
2017-12-11 22:47:46 +01:00
|
|
|
validator = require('../../../data/validation').validator,
|
✨Dynamic Routing Beta (#9596)
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
2018-06-05 19:02:20 +02:00
|
|
|
routing = require('../../../services/routing'),
|
2017-11-10 12:44:29 +00:00
|
|
|
templateName = 'subscribe';
|
2016-04-14 18:33:22 +01:00
|
|
|
|
2017-11-05 12:45:43 +00:00
|
|
|
function _renderer(req, res) {
|
2018-06-26 01:12:50 +02:00
|
|
|
res.routerOptions = {
|
2017-11-10 12:44:29 +00:00
|
|
|
type: 'custom',
|
2018-06-21 15:46:42 +02:00
|
|
|
templates: templateName,
|
2018-09-10 16:06:41 +07:00
|
|
|
defaultTemplate: path.resolve(__dirname, 'views', `${templateName}.hbs`)
|
2017-11-10 12:44:29 +00:00
|
|
|
};
|
|
|
|
|
2017-11-05 12:45:43 +00:00
|
|
|
// Renderer begin
|
|
|
|
// Format data
|
2018-09-10 16:06:41 +07:00
|
|
|
const data = req.body;
|
2017-11-05 12:45:43 +00:00
|
|
|
|
|
|
|
// Render Call
|
✨Dynamic Routing Beta (#9596)
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
2018-06-05 19:02:20 +02:00
|
|
|
return routing.helpers.renderer(req, res, data);
|
2016-04-14 18:33:22 +01:00
|
|
|
}
|
|
|
|
|
2017-04-05 23:02:16 +02:00
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2016-04-21 16:37:52 +01:00
|
|
|
function errorHandler(error, req, res, next) {
|
2017-04-05 23:02:16 +02:00
|
|
|
req.body.email = '';
|
2018-10-29 10:19:45 +01:00
|
|
|
req.body.subscribed_url = santizeUrl(req.body.subscribed_url);
|
|
|
|
req.body.subscribed_referrer = santizeUrl(req.body.subscribed_referrer);
|
2017-04-05 23:02:16 +02:00
|
|
|
|
2016-04-21 16:37:52 +01:00
|
|
|
if (error.statusCode !== 404) {
|
|
|
|
res.locals.error = error;
|
2017-11-05 12:45:43 +00:00
|
|
|
return _renderer(req, res);
|
2016-04-21 16:37:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
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();
|
|
|
|
}
|
|
|
|
|
2016-10-14 15:31:20 +01:00
|
|
|
function santizeUrl(url) {
|
2017-04-05 23:02:16 +02:00
|
|
|
return validator.isEmptyOrURL(url || '') ? url : '';
|
2016-10-14 15:31:20 +01:00
|
|
|
}
|
|
|
|
|
2016-04-21 16:37:52 +01:00
|
|
|
function handleSource(req, res, next) {
|
2016-10-14 15:31:20 +01:00
|
|
|
req.body.subscribed_url = santizeUrl(req.body.location);
|
|
|
|
req.body.subscribed_referrer = santizeUrl(req.body.referrer);
|
✨Dynamic Routing Beta (#9596)
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
2018-06-05 19:02:20 +02:00
|
|
|
|
2016-04-21 16:37:52 +01:00
|
|
|
delete req.body.location;
|
|
|
|
delete req.body.referrer;
|
2016-05-07 10:33:04 +02:00
|
|
|
|
2018-06-12 17:36:58 +02:00
|
|
|
const resource = urlService.getResource(urlService.utils.absoluteToRelative(req.body.subscribed_url, {withoutSubdirectory: true}));
|
✨Dynamic Routing Beta (#9596)
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
2018-06-05 19:02:20 +02:00
|
|
|
|
|
|
|
if (resource) {
|
|
|
|
req.body.post_id = resource.data.id;
|
|
|
|
}
|
|
|
|
|
|
|
|
next();
|
2016-04-21 16:37:52 +01:00
|
|
|
}
|
2016-04-14 22:44:05 +02:00
|
|
|
|
|
|
|
function storeSubscriber(req, res, next) {
|
2016-04-21 16:37:52 +01:00
|
|
|
req.body.status = 'subscribed';
|
2018-10-17 09:23:59 +02:00
|
|
|
|
|
|
|
const api = require('../../../api')[res.locals.apiVersion];
|
2016-04-21 16:37:52 +01:00
|
|
|
|
2016-05-08 16:49:12 +02:00
|
|
|
if (_.isEmpty(req.body.email)) {
|
2017-12-11 22:47:46 +01:00
|
|
|
return next(new common.errors.ValidationError({message: 'Email cannot be blank.'}));
|
2016-12-21 16:52:47 +07:00
|
|
|
} else if (!validator.isEmail(req.body.email)) {
|
2017-12-11 22:47:46 +01:00
|
|
|
return next(new common.errors.ValidationError({message: 'Invalid email.'}));
|
2016-05-08 16:49:12 +02:00
|
|
|
}
|
|
|
|
|
2016-04-21 16:37:52 +01:00
|
|
|
return api.subscribers.add({subscribers: [req.body]}, {context: {external: true}})
|
2018-09-10 16:06:41 +07:00
|
|
|
.then(() => {
|
2016-04-21 16:37:52 +01:00
|
|
|
res.locals.success = true;
|
|
|
|
next();
|
|
|
|
})
|
2018-09-10 16:06:41 +07:00
|
|
|
.catch(() => {
|
2016-05-08 16:49:12 +02:00
|
|
|
// we do not expose any information
|
|
|
|
res.locals.success = true;
|
|
|
|
next();
|
2016-04-21 16:37:52 +01:00
|
|
|
});
|
2016-04-14 22:44:05 +02:00
|
|
|
}
|
|
|
|
|
2016-04-14 18:33:22 +01:00
|
|
|
// subscribe frontend route
|
2017-11-10 12:44:29 +00:00
|
|
|
subscribeRouter
|
|
|
|
.route('/')
|
2016-04-14 18:33:22 +01:00
|
|
|
.get(
|
2017-11-05 12:45:43 +00:00
|
|
|
_renderer
|
2016-04-14 18:33:22 +01:00
|
|
|
)
|
|
|
|
.post(
|
2016-10-11 09:36:00 +01:00
|
|
|
bodyParser.urlencoded({extended: true}),
|
2016-04-21 16:37:52 +01:00
|
|
|
honeyPot,
|
|
|
|
handleSource,
|
2016-04-14 22:44:05 +02:00
|
|
|
storeSubscriber,
|
2017-11-05 12:45:43 +00:00
|
|
|
_renderer
|
2016-04-14 18:33:22 +01:00
|
|
|
);
|
|
|
|
|
2016-04-21 16:37:52 +01:00
|
|
|
// configure an error handler just for subscribe problems
|
|
|
|
subscribeRouter.use(errorHandler);
|
|
|
|
|
2016-04-14 18:33:22 +01:00
|
|
|
module.exports = subscribeRouter;
|
2017-03-01 13:02:53 +01:00
|
|
|
module.exports.storeSubscriber = storeSubscriber;
|