mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-22 18:31:57 +03: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
4.0 KiB
JavaScript
118 lines
4.0 KiB
JavaScript
const _ = require('lodash'),
|
|
api = require('../../api'),
|
|
helpers = require('../../helpers/register'),
|
|
filters = require('../../filters'),
|
|
common = require('../../lib/common'),
|
|
routingService = require('../routing');
|
|
|
|
let generateProxyFunctions;
|
|
|
|
generateProxyFunctions = function (name, permissions, isInternal) {
|
|
const appRouter = routingService.registry.getRouter('appRouter');
|
|
|
|
var getPermission = function (perm) {
|
|
return permissions[perm];
|
|
},
|
|
getPermissionToMethod = function (perm, method) {
|
|
var perms = getPermission(perm);
|
|
|
|
if (!perms) {
|
|
return false;
|
|
}
|
|
|
|
return _.find(perms, function (name) {
|
|
return name === method;
|
|
});
|
|
},
|
|
runIfPermissionToMethod = function (perm, method, wrappedFunc, context, args) {
|
|
// internal apps get all permissions
|
|
if (isInternal) {
|
|
return wrappedFunc.apply(context, args);
|
|
}
|
|
|
|
var permValue = getPermissionToMethod(perm, method);
|
|
|
|
if (!permValue) {
|
|
throw new Error(common.i18n.t('errors.apps.accessResourceWithoutPermission.error', {
|
|
name: name,
|
|
perm: perm,
|
|
method: method
|
|
}));
|
|
}
|
|
|
|
return wrappedFunc.apply(context, args);
|
|
},
|
|
checkRegisterPermissions = function (perm, registerMethod) {
|
|
return _.wrap(registerMethod, function (origRegister, name) {
|
|
return runIfPermissionToMethod(perm, name, origRegister, this, _.toArray(arguments).slice(1));
|
|
});
|
|
},
|
|
passThruAppContextToApi = function (perm, apiMethods) {
|
|
var appContext = {
|
|
app: name
|
|
};
|
|
|
|
return _.reduce(apiMethods, function (memo, apiMethod, methodName) {
|
|
memo[methodName] = function () {
|
|
var args = _.toArray(arguments),
|
|
options = args[args.length - 1];
|
|
|
|
if (_.isObject(options)) {
|
|
options.context = _.clone(appContext);
|
|
}
|
|
return apiMethod.apply({}, args);
|
|
};
|
|
|
|
return memo;
|
|
}, {});
|
|
},
|
|
proxy;
|
|
|
|
proxy = {
|
|
filters: {
|
|
register: checkRegisterPermissions('filters', filters.registerFilter.bind(filters)),
|
|
deregister: checkRegisterPermissions('filters', filters.deregisterFilter.bind(filters))
|
|
},
|
|
helpers: {
|
|
register: checkRegisterPermissions('helpers', helpers.registerThemeHelper.bind(helpers)),
|
|
registerAsync: checkRegisterPermissions('helpers', helpers.registerAsyncThemeHelper.bind(helpers))
|
|
},
|
|
// Expose the route service...
|
|
routeService: {
|
|
// This allows for mounting an entirely new Router at a path...
|
|
registerRouter: checkRegisterPermissions('routes', appRouter.mountRouter.bind(appRouter))
|
|
},
|
|
// Mini proxy to the API - needs review
|
|
api: {
|
|
posts: passThruAppContextToApi('posts',
|
|
_.pick(api.posts, 'browse', 'read', 'edit', 'add', 'destroy')
|
|
),
|
|
tags: passThruAppContextToApi('tags',
|
|
_.pick(api.tags, 'browse')
|
|
),
|
|
notifications: passThruAppContextToApi('notifications',
|
|
_.pick(api.notifications, 'browse', 'add', 'destroy')
|
|
),
|
|
settings: passThruAppContextToApi('settings',
|
|
_.pick(api.settings, 'browse', 'read', 'edit')
|
|
)
|
|
}
|
|
};
|
|
|
|
return proxy;
|
|
};
|
|
|
|
function AppProxy(options) {
|
|
if (!options.name) {
|
|
throw new Error(common.i18n.t('errors.apps.mustProvideAppName.error'));
|
|
}
|
|
|
|
if (!options.permissions) {
|
|
throw new Error(common.i18n.t('errors.apps.mustProvideAppPermissions.error'));
|
|
}
|
|
|
|
_.extend(this, generateProxyFunctions(options.name, options.permissions, options.internal));
|
|
}
|
|
|
|
module.exports = AppProxy;
|