2017-04-04 19:07:35 +03:00
|
|
|
// This file defines everything that helpers "require"
|
|
|
|
// With the exception of modules like lodash, Bluebird
|
|
|
|
// We can later refactor to enforce this something like we do in apps
|
2017-12-14 05:01:23 +03:00
|
|
|
var hbs = require('../services/themes/engine'),
|
2019-06-19 12:30:28 +03:00
|
|
|
settingsCache = require('../../server/services/settings/cache'),
|
|
|
|
config = require('../../server/config');
|
2017-04-04 19:07:35 +03:00
|
|
|
|
|
|
|
// Direct requires:
|
|
|
|
// - lodash
|
|
|
|
// - bluebird
|
|
|
|
// - downsize
|
|
|
|
// - moment-timezone
|
|
|
|
// - jsonpath
|
|
|
|
|
|
|
|
module.exports = {
|
|
|
|
hbs: hbs,
|
|
|
|
SafeString: hbs.SafeString,
|
|
|
|
escapeExpression: hbs.escapeExpression,
|
|
|
|
|
|
|
|
// TODO: Expose less of the API to make this safe
|
2019-06-19 12:30:28 +03:00
|
|
|
api: require('../../server/api'),
|
2017-12-13 15:19:51 +03:00
|
|
|
|
2017-04-04 19:07:35 +03:00
|
|
|
// TODO: Only expose "get"
|
|
|
|
settingsCache: settingsCache,
|
|
|
|
|
|
|
|
// These 3 are kind of core and required all the time
|
2019-06-19 12:30:28 +03:00
|
|
|
errors: require('../../server/lib/common/errors'),
|
|
|
|
i18n: require('../../server/lib/common/i18n'),
|
|
|
|
logging: require('../../server/lib/common/logging'),
|
2017-04-04 19:07:35 +03:00
|
|
|
|
|
|
|
// This is used to detect if "isPost" is true in prevNext.
|
2019-06-19 12:30:28 +03:00
|
|
|
checks: require('../../server/data/schema').checks,
|
2017-04-04 19:07:35 +03:00
|
|
|
|
|
|
|
// Config!
|
|
|
|
// Keys used:
|
|
|
|
// isPrivacyDisabled & referrerPolicy used in ghost_head
|
|
|
|
config: {
|
|
|
|
get: config.get.bind(config),
|
|
|
|
isPrivacyDisabled: config.isPrivacyDisabled.bind(config)
|
|
|
|
},
|
|
|
|
|
|
|
|
// Labs utils for enabling/disabling helpers
|
2019-06-19 12:30:28 +03:00
|
|
|
labs: require('../../server/services/labs'),
|
2017-04-04 19:07:35 +03:00
|
|
|
|
|
|
|
// Things required from data/meta
|
|
|
|
metaData: {
|
2019-06-19 12:30:28 +03:00
|
|
|
get: require('../meta'), // ghost_head
|
|
|
|
getAssetUrl: require('../meta/asset_url'), // asset
|
|
|
|
getMetaDataExcerpt: require('../meta/excerpt'), // excerpt
|
|
|
|
getMetaDataDescription: require('../meta/description'), // meta_desc
|
|
|
|
getMetaDataTitle: require('../meta/title'), // meta_title
|
|
|
|
getPaginatedUrl: require('../meta/paginated_url'), // page_url
|
|
|
|
getMetaDataUrl: require('../meta/url') // url
|
2017-04-04 19:07:35 +03:00
|
|
|
},
|
|
|
|
|
|
|
|
// The local template thing, should this be merged with the channels one?
|
|
|
|
templates: require('./template'),
|
|
|
|
|
|
|
|
// Various utils, needs cleaning up / simplifying
|
2019-06-06 18:01:03 +03:00
|
|
|
socialUrls: require('@tryghost/social-urls'),
|
2019-06-19 12:30:28 +03:00
|
|
|
blogIcon: require('../../server/lib/image/blog-icon'),
|
✨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
|
|
|
urlService: require('../services/url'),
|
2019-06-19 12:30:28 +03:00
|
|
|
urlUtils: require('../../server/lib/url-utils'),
|
2017-12-13 16:05:53 +03:00
|
|
|
localUtils: require('./utils')
|
2017-04-04 19:07:35 +03:00
|
|
|
};
|