Ghost/core/server/services/apps/proxy.js
Hannah Wolfe 7656d0bdda
Wrapped express router & expose from route service (#9206)
refs #9192

- Moving towards a centralised concept of routing / routes
- The base router now wraps express router, and offers us the features we need
- Site Router is the parent router, it gets initialised with all of our default routing
- App Router is a sub router for apps - apps register their routes/routers onto it.
- TODO: refactor channels subrouter to work this same way
- MAYBE: move the app router to the apps service
2017-11-09 10:08:11 +00:00

111 lines
3.9 KiB
JavaScript

var _ = require('lodash'),
api = require('../../api'),
helpers = require('../../helpers/register'),
filters = require('../../filters'),
i18n = require('../../i18n'),
router = require('../route').appRouter,
generateProxyFunctions;
generateProxyFunctions = function (name, permissions, isInternal) {
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(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', router.mountRouter.bind(router))
},
// 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(i18n.t('errors.apps.mustProvideAppName.error'));
}
if (!options.permissions) {
throw new Error(i18n.t('errors.apps.mustProvideAppPermissions.error'));
}
_.extend(this, generateProxyFunctions(options.name, options.permissions, options.internal));
}
module.exports = AppProxy;