2017-11-07 23:00:03 +03:00
|
|
|
var downsize = require('downsize'),
|
2018-09-10 12:39:38 +03:00
|
|
|
Promise = require('bluebird'),
|
2017-11-07 23:00:03 +03:00
|
|
|
RSS = require('rss'),
|
2017-12-11 21:14:05 +03:00
|
|
|
urlService = require('../../services/url'),
|
2017-11-07 23:00:03 +03:00
|
|
|
generateFeed,
|
2017-11-10 10:36:39 +03:00
|
|
|
generateItem,
|
2017-11-07 23:00:03 +03:00
|
|
|
generateTags;
|
|
|
|
|
|
|
|
generateTags = function generateTags(data) {
|
|
|
|
if (data.tags) {
|
|
|
|
return data.tags.reduce(function (tags, tag) {
|
|
|
|
if (tag.visibility !== 'internal') {
|
|
|
|
tags.push(tag.name);
|
|
|
|
}
|
|
|
|
return tags;
|
|
|
|
}, []);
|
|
|
|
}
|
|
|
|
|
|
|
|
return [];
|
|
|
|
};
|
|
|
|
|
2017-11-10 10:36:39 +03:00
|
|
|
generateItem = function generateItem(post, siteUrl, secure) {
|
✨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 20:02:20 +03:00
|
|
|
var itemUrl = urlService.getUrlByResourceId(post.id, {secure: secure, absolute: true}),
|
2017-12-15 00:32:34 +03:00
|
|
|
htmlContent = urlService.utils.makeAbsoluteUrls(post.html, siteUrl, itemUrl),
|
2017-11-10 10:36:39 +03:00
|
|
|
item = {
|
|
|
|
title: post.title,
|
|
|
|
// @TODO: DRY this up with data/meta/index & other excerpt code
|
|
|
|
description: post.custom_excerpt || post.meta_description || downsize(htmlContent.html(), {words: 50}),
|
|
|
|
guid: post.id,
|
|
|
|
url: itemUrl,
|
|
|
|
date: post.published_at,
|
|
|
|
categories: generateTags(post),
|
2018-03-27 17:16:15 +03:00
|
|
|
author: post.primary_author ? post.primary_author.name : null,
|
2017-11-10 10:36:39 +03:00
|
|
|
custom_elements: []
|
|
|
|
},
|
|
|
|
imageUrl;
|
2017-11-07 23:00:03 +03:00
|
|
|
|
2017-11-10 10:36:39 +03:00
|
|
|
if (post.feature_image) {
|
2017-12-11 21:14:05 +03:00
|
|
|
imageUrl = urlService.utils.urlFor('image', {image: post.feature_image, secure: secure}, true);
|
2017-11-07 23:00:03 +03:00
|
|
|
|
2017-11-10 10:36:39 +03:00
|
|
|
// Add a media content tag
|
|
|
|
item.custom_elements.push({
|
|
|
|
'media:content': {
|
|
|
|
_attr: {
|
|
|
|
url: imageUrl,
|
|
|
|
medium: 'image'
|
2017-11-07 23:00:03 +03:00
|
|
|
}
|
2017-11-10 10:36:39 +03:00
|
|
|
}
|
|
|
|
});
|
2017-11-07 23:00:03 +03:00
|
|
|
|
2017-11-10 10:36:39 +03:00
|
|
|
// Also add the image to the content, because not all readers support media:content
|
|
|
|
htmlContent('p').first().before('<img src="' + imageUrl + '" />');
|
|
|
|
htmlContent('img').attr('alt', post.title);
|
|
|
|
}
|
|
|
|
|
|
|
|
item.custom_elements.push({
|
|
|
|
'content:encoded': {
|
|
|
|
_cdata: htmlContent.html()
|
2017-11-07 23:00:03 +03:00
|
|
|
}
|
2017-11-10 10:36:39 +03:00
|
|
|
});
|
2017-11-07 23:00:03 +03:00
|
|
|
|
2017-11-10 10:36:39 +03:00
|
|
|
return item;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Generate Feed
|
|
|
|
*
|
✨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 20:02:20 +03:00
|
|
|
* Data is an object which contains the res.locals + results from fetching a collection, but without related data.
|
2017-11-10 10:36:39 +03:00
|
|
|
*
|
|
|
|
* @param {string} baseUrl
|
|
|
|
* @param {{title, description, safeVersion, secure, posts}} data
|
|
|
|
*/
|
|
|
|
generateFeed = function generateFeed(baseUrl, data) {
|
2018-09-10 12:39:38 +03:00
|
|
|
const siteUrl = urlService.utils.urlFor('home', {secure: data.secure}, true);
|
|
|
|
const feed = new RSS({
|
|
|
|
title: data.title,
|
|
|
|
description: data.description,
|
|
|
|
generator: 'Ghost ' + data.safeVersion,
|
|
|
|
feed_url: urlService.utils.urlFor({relativeUrl: baseUrl, secure: data.secure}, true),
|
|
|
|
site_url: siteUrl,
|
|
|
|
image_url: urlService.utils.urlFor({relativeUrl: 'favicon.png'}, true),
|
|
|
|
ttl: '60',
|
|
|
|
custom_namespaces: {
|
|
|
|
content: 'http://purl.org/rss/1.0/modules/content/',
|
|
|
|
media: 'http://search.yahoo.com/mrss/'
|
|
|
|
}
|
2017-11-07 23:00:03 +03:00
|
|
|
});
|
|
|
|
|
2018-09-10 12:39:38 +03:00
|
|
|
return data.posts.reduce((feedPromise, post) => {
|
|
|
|
return feedPromise.then(() => {
|
|
|
|
const item = generateItem(post, siteUrl, data.secure);
|
2019-04-15 17:15:32 +03:00
|
|
|
return feed.item(item);
|
2018-09-10 12:39:38 +03:00
|
|
|
});
|
|
|
|
}, Promise.resolve()).then(() => {
|
2019-04-15 17:15:32 +03:00
|
|
|
return feed.xml();
|
2017-11-07 23:00:03 +03:00
|
|
|
});
|
|
|
|
};
|
|
|
|
|
|
|
|
module.exports = generateFeed;
|