mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-14 18:52:05 +03:00
ed16998461
refs #6421, #6525 - The configuration API endpoint was a bit of an animal: - It's used currently in two ways, once for general config, another for the about page. - These two things are different, and would require different permissions in future. - There was also both a browse and a read version, even though only browse was used. - The response from the browse was being artificially turned into many objects, when its really just one with multiple keys - The new version treats each type of config as a different single object with several keys - The new version therefore only has a 'read' request - A basic read request with no key will return basic config that any client would need - A read request with the about key returns the about config - A read request with a different key could therefore return some other config
66 lines
1.8 KiB
JavaScript
66 lines
1.8 KiB
JavaScript
// # Configuration API
|
|
// RESTful API for browsing the configuration
|
|
var _ = require('lodash'),
|
|
config = require('../config'),
|
|
Promise = require('bluebird'),
|
|
|
|
configuration;
|
|
|
|
function labsFlag(key) {
|
|
return {
|
|
value: (config[key] === true),
|
|
type: 'bool'
|
|
};
|
|
}
|
|
|
|
function getAboutConfig() {
|
|
return {
|
|
version: config.ghostVersion,
|
|
environment: process.env.NODE_ENV,
|
|
database: config.database.client,
|
|
mail: _.isObject(config.mail) ? config.mail.transport : ''
|
|
};
|
|
}
|
|
|
|
function getBaseConfig() {
|
|
return {
|
|
fileStorage: {value: (config.fileStorage !== false), type: 'bool'},
|
|
useGoogleFonts: {value: !config.isPrivacyDisabled('useGoogleFonts'), type: 'bool'},
|
|
useGravatar: {value: !config.isPrivacyDisabled('useGravatar'), type: 'bool'},
|
|
publicAPI: labsFlag('publicAPI'),
|
|
blogUrl: {value: config.url.replace(/\/$/, ''), type: 'string'},
|
|
blogTitle: {value: config.theme.title, type: 'string'},
|
|
routeKeywords: {value: JSON.stringify(config.routeKeywords), type: 'json'}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* ## Configuration API Methods
|
|
*
|
|
* **See:** [API Methods](index.js.html#api%20methods)
|
|
*/
|
|
configuration = {
|
|
|
|
/**
|
|
* Always returns {configuration: []}
|
|
* Sometimes the array contains configuration items
|
|
* @param {Object} options
|
|
* @returns {Promise<Object>}
|
|
*/
|
|
read: function read(options) {
|
|
options = options || {};
|
|
|
|
if (!options.key) {
|
|
return Promise.resolve({configuration: [getBaseConfig()]});
|
|
}
|
|
|
|
if (options.key === 'about') {
|
|
return Promise.resolve({configuration: [getAboutConfig()]});
|
|
}
|
|
|
|
return Promise.resolve({configuration: []});
|
|
}
|
|
};
|
|
|
|
module.exports = configuration;
|