mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-10 23:36:14 -05:00
0b333765d4
- shutdown removed listeners, which should really be done before adding them anyway! - reset sets the cache back to an empty object, which was already done by init - merge these into one reset function that fully resets the cache - all instances of shutdown were called before an init call, and now called during init, therefore these can be removed - acceptance utils had an instance of calling shutdown and reset together as part of stopping Ghost, reworked that to be clearer
61 lines
1.7 KiB
JavaScript
61 lines
1.7 KiB
JavaScript
/**
|
|
* Settings Lib
|
|
* A collection of utilities for handling settings including a cache
|
|
*/
|
|
const models = require('../../models');
|
|
const SettingsCache = require('./cache');
|
|
|
|
// The string returned when a setting is set as write-only
|
|
const obfuscatedSetting = '••••••••';
|
|
|
|
// The function used to decide whether a setting is write-only
|
|
function isSecretSetting(setting) {
|
|
return /secret/.test(setting.key);
|
|
}
|
|
|
|
// The function that obfuscates a write-only setting
|
|
function hideValueIfSecret(setting) {
|
|
if (setting.value && isSecretSetting(setting)) {
|
|
return {...setting, value: obfuscatedSetting};
|
|
}
|
|
return setting;
|
|
}
|
|
|
|
module.exports = {
|
|
/**
|
|
* Initialise the cache, used in boot and in testing
|
|
*/
|
|
async init() {
|
|
const settingsCollection = await models.Settings.populateDefaults();
|
|
SettingsCache.init(settingsCollection);
|
|
},
|
|
|
|
/**
|
|
* Shutdown the cache, used in force boot during testing
|
|
*/
|
|
shutdown() {
|
|
SettingsCache.reset();
|
|
},
|
|
|
|
/**
|
|
* Handles syncronization of routes.yaml hash loaded in the frontend with
|
|
* the value stored in the settings table.
|
|
* getRoutesHash is a function to allow keeping "frontend" decoupled from settings
|
|
*
|
|
* @param {function} getRoutesHash function fetching currently loaded routes file hash
|
|
*/
|
|
async syncRoutesHash(getRoutesHash) {
|
|
const currentRoutesHash = await getRoutesHash();
|
|
|
|
if (SettingsCache.get('routes_hash') !== currentRoutesHash) {
|
|
return await models.Settings.edit([{
|
|
key: 'routes_hash',
|
|
value: currentRoutesHash
|
|
}], {context: {internal: true}});
|
|
}
|
|
},
|
|
|
|
obfuscatedSetting,
|
|
isSecretSetting,
|
|
hideValueIfSecret
|
|
};
|