mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-22 02:11:44 +03:00
0bf1542bc6
refs #10790 refs #9528 - The settings service was designed to handle more settings then just routing, but till this day there wasn't anything else added. As routes.yaml is only being used by frontend router so conceptually it fits better to have this code in frontend, so that it doesn't have to reach out to server - The code left in server settings is the one that interacts with the database `settings` table and only partially provides information to frontend. That part is known as 'settings cache' and will be accessed through API controllers.
81 lines
2.6 KiB
JavaScript
81 lines
2.6 KiB
JavaScript
const _ = require('lodash');
|
|
const debug = require('ghost-ignition').debug('frontend:services:settings:index');
|
|
const SettingsLoader = require('./loader');
|
|
const ensureSettingsFiles = require('./ensure-settings');
|
|
|
|
const common = require('../../../server/lib/common');
|
|
|
|
module.exports = {
|
|
init: function () {
|
|
const knownSettings = this.knownSettings();
|
|
|
|
debug('init settings service for:', knownSettings);
|
|
|
|
// Make sure that supported settings files are available
|
|
// inside of the `content/setting` directory
|
|
return ensureSettingsFiles(knownSettings);
|
|
},
|
|
|
|
/**
|
|
* Global place to switch on more available settings.
|
|
*/
|
|
knownSettings: function knownSettings() {
|
|
return ['routes'];
|
|
},
|
|
|
|
/**
|
|
* Getter for YAML settings.
|
|
* Example: `settings.get('routes').then(...)`
|
|
* will return an Object like this:
|
|
* {routes: {}, collections: {}, resources: {}}
|
|
* @param {String} setting type of supported setting.
|
|
* @returns {Object} settingsFile
|
|
* @description Returns settings object as defined per YAML files in
|
|
* `/content/settings` directory.
|
|
*/
|
|
get: function get(setting) {
|
|
const knownSettings = this.knownSettings();
|
|
|
|
// CASE: this should be an edge case and only if internal usage of the
|
|
// getter is incorrect.
|
|
if (!setting || _.indexOf(knownSettings, setting) < 0) {
|
|
throw new common.errors.IncorrectUsageError({
|
|
message: `Requested setting is not supported: '${setting}'.`,
|
|
help: `Please use only the supported settings: ${knownSettings}.`
|
|
});
|
|
}
|
|
|
|
return SettingsLoader(setting);
|
|
},
|
|
|
|
/**
|
|
* Getter for all YAML settings.
|
|
* Example: `settings.getAll().then(...)`
|
|
* will return an Object like this (assuming we're supporting `routes`
|
|
* and `globals`):
|
|
* {
|
|
* routes: {
|
|
* routes: null,
|
|
* collections: { '/': [Object] },
|
|
* resources: { tag: '/tag/{slug}/', author: '/author/{slug}/' }
|
|
* },
|
|
* globals: {
|
|
* config: { url: 'testblog.com' }
|
|
* }
|
|
* }
|
|
* @returns {Object} settingsObject
|
|
* @description Returns all settings object as defined per YAML files in
|
|
* `/content/settings` directory.
|
|
*/
|
|
getAll: function getAll() {
|
|
const knownSettings = this.knownSettings(),
|
|
settingsToReturn = {};
|
|
|
|
_.each(knownSettings, function (setting) {
|
|
settingsToReturn[setting] = SettingsLoader(setting);
|
|
});
|
|
|
|
return settingsToReturn;
|
|
}
|
|
};
|