2 namespace Shaarli\Config
;
7 * Manages all Shaarli's settings.
8 * See the documentation for more information on settings:
9 * - doc/Shaarli-configuration.html
10 * - https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration
15 * @var string Flag telling a setting is not found.
17 protected static $NOT_FOUND = 'NOT_FOUND';
19 public static $DEFAULT_PLUGINS = array('qrcode');
22 * @var string Config folder.
24 protected $configFile;
27 * @var array Loaded config array.
29 protected $loadedConfig;
32 * @var ConfigIO implementation instance.
39 * @param string $configFile Configuration file path without extension.
41 public function __construct($configFile = 'data/config')
43 $this->configFile
= $configFile;
48 * Reset the ConfigManager instance.
50 public function reset()
56 * Rebuild the loaded config array from config files.
58 public function reload()
64 * Initialize the ConfigIO and loaded the conf.
66 protected function initialize()
68 if (file_exists($this->configFile
. '.php')) {
69 $this->configIO
= new ConfigPhp();
71 $this->configIO
= new ConfigJson();
77 * Load configuration in the ConfigurationManager.
79 protected function load()
81 $this->loadedConfig
= $this->configIO
->read($this->getConfigFileExt());
82 $this->setDefaultValues();
88 * Supports nested settings with dot separated keys.
89 * Eg. 'config.stuff.option' will find $conf[config][stuff][option],
91 * { "config": { "stuff": {"option": "mysetting" } } } }
93 * @param string $setting Asked setting, keys separated with dots.
94 * @param string $default Default value if not found.
96 * @return mixed Found setting, or the default value.
98 public function get($setting, $default = '')
100 // During the ConfigIO transition, map legacy settings to the new ones.
101 if ($this->configIO
instanceof ConfigPhp
&& isset(ConfigPhp
::$LEGACY_KEYS_MAPPING[$setting])) {
102 $setting = ConfigPhp
::$LEGACY_KEYS_MAPPING[$setting];
105 $settings = explode('.', $setting);
106 $value = self
::getConfig($settings, $this->loadedConfig
);
107 if ($value === self
::$NOT_FOUND) {
114 * Set a setting, and eventually write it.
116 * Supports nested settings with dot separated keys.
118 * @param string $setting Asked setting, keys separated with dots.
119 * @param string $value Value to set.
120 * @param bool $write Write the new setting in the config file, default false.
121 * @param bool $isLoggedIn User login state, default false.
123 * @throws \Exception Invalid
125 public function set($setting, $value, $write = false, $isLoggedIn = false)
127 if (empty($setting) || ! is_string($setting)) {
128 throw new \
Exception('Invalid setting key parameter. String expected, got: '. gettype($setting));
131 // During the ConfigIO transition, map legacy settings to the new ones.
132 if ($this->configIO
instanceof ConfigPhp
&& isset(ConfigPhp
::$LEGACY_KEYS_MAPPING[$setting])) {
133 $setting = ConfigPhp
::$LEGACY_KEYS_MAPPING[$setting];
136 $settings = explode('.', $setting);
137 self
::setConfig($settings, $value, $this->loadedConfig
);
139 $this->write($isLoggedIn);
144 * Check if a settings exists.
146 * Supports nested settings with dot separated keys.
148 * @param string $setting Asked setting, keys separated with dots.
150 * @return bool true if the setting exists, false otherwise.
152 public function exists($setting)
154 // During the ConfigIO transition, map legacy settings to the new ones.
155 if ($this->configIO
instanceof ConfigPhp
&& isset(ConfigPhp
::$LEGACY_KEYS_MAPPING[$setting])) {
156 $setting = ConfigPhp
::$LEGACY_KEYS_MAPPING[$setting];
159 $settings = explode('.', $setting);
160 $value = self
::getConfig($settings, $this->loadedConfig
);
161 if ($value === self
::$NOT_FOUND) {
168 * Call the config writer.
170 * @param bool $isLoggedIn User login state.
172 * @return bool True if the configuration has been successfully written, false otherwise.
174 * @throws MissingFieldConfigException: a mandatory field has not been provided in $conf.
175 * @throws UnauthorizedConfigException: user is not authorize to change configuration.
176 * @throws \IOException: an error occurred while writing the new config file.
178 public function write($isLoggedIn)
180 // These fields are required in configuration.
181 $mandatoryFields = array(
185 'security.session_protection_disabled',
188 'general.header_link',
189 'privacy.default_private_links',
193 // Only logged in user can alter config.
194 if (is_file($this->getConfigFileExt()) && !$isLoggedIn) {
195 throw new UnauthorizedConfigException();
198 // Check that all mandatory fields are provided in $conf.
199 foreach ($mandatoryFields as $field) {
200 if (! $this->exists($field)) {
201 throw new MissingFieldConfigException($field);
205 return $this->configIO
->write($this->getConfigFileExt(), $this->loadedConfig
);
209 * Set the config file path (without extension).
211 * @param string $configFile File path.
213 public function setConfigFile($configFile)
215 $this->configFile
= $configFile;
219 * Return the configuration file path (without extension).
221 * @return string Config path.
223 public function getConfigFile()
225 return $this->configFile
;
229 * Get the configuration file path with its extension.
231 * @return string Config file path.
233 public function getConfigFileExt()
235 return $this->configFile
. $this->configIO
->getExtension();
239 * Recursive function which find asked setting in the loaded config.
241 * @param array $settings Ordered array which contains keys to find.
242 * @param array $conf Loaded settings, then sub-array.
244 * @return mixed Found setting or NOT_FOUND flag.
246 protected static function getConfig($settings, $conf)
248 if (!is_array($settings) || count($settings) == 0) {
249 return self
::$NOT_FOUND;
252 $setting = array_shift($settings);
253 if (!isset($conf[$setting])) {
254 return self
::$NOT_FOUND;
257 if (count($settings) > 0) {
258 return self
::getConfig($settings, $conf[$setting]);
260 return $conf[$setting];
264 * Recursive function which find asked setting in the loaded config.
266 * @param array $settings Ordered array which contains keys to find.
267 * @param mixed $value
268 * @param array $conf Loaded settings, then sub-array.
270 * @return mixed Found setting or NOT_FOUND flag.
272 protected static function setConfig($settings, $value, &$conf)
274 if (!is_array($settings) || count($settings) == 0) {
275 return self
::$NOT_FOUND;
278 $setting = array_shift($settings);
279 if (count($settings) > 0) {
280 return self
::setConfig($settings, $value, $conf[$setting]);
282 $conf[$setting] = $value;
286 * Set a bunch of default values allowing Shaarli to start without a config file.
288 protected function setDefaultValues()
290 $this->setEmpty('resource.data_dir', 'data');
291 $this->setEmpty('resource.config', 'data/config.php');
292 $this->setEmpty('resource.datastore', 'data/datastore.php');
293 $this->setEmpty('resource.ban_file', 'data/ipbans.php');
294 $this->setEmpty('resource.updates', 'data/updates.txt');
295 $this->setEmpty('resource.log', 'data/log.txt');
296 $this->setEmpty('resource.update_check', 'data/lastupdatecheck.txt');
297 $this->setEmpty('resource.raintpl_tpl', 'tpl/');
298 $this->setEmpty('resource.theme', 'default');
299 $this->setEmpty('resource.raintpl_tmp', 'tmp/');
300 $this->setEmpty('resource.thumbnails_cache', 'cache');
301 $this->setEmpty('resource.page_cache', 'pagecache');
303 $this->setEmpty('security.ban_after', 4);
304 $this->setEmpty('security.ban_duration', 1800);
305 $this->setEmpty('security.session_protection_disabled', false);
306 $this->setEmpty('security.open_shaarli', false);
308 $this->setEmpty('general.header_link', '?');
309 $this->setEmpty('general.links_per_page', 20);
310 $this->setEmpty('general.enabled_plugins', self
::$DEFAULT_PLUGINS);
312 $this->setEmpty('updates.check_updates', false);
313 $this->setEmpty('updates.check_updates_branch', 'stable');
314 $this->setEmpty('updates.check_updates_interval', 86400);
316 $this->setEmpty('feed.rss_permalinks', true);
317 $this->setEmpty('feed.show_atom', false);
319 $this->setEmpty('privacy.default_private_links', false);
320 $this->setEmpty('privacy.hide_public_links', false);
321 $this->setEmpty('privacy.hide_timestamps', false);
323 $this->setEmpty('thumbnail.enable_thumbnails', true);
324 $this->setEmpty('thumbnail.enable_localcache', true);
326 $this->setEmpty('redirector.url', '');
327 $this->setEmpty('redirector.encode_url', true);
329 $this->setEmpty('plugins', array());
333 * Set only if the setting does not exists.
335 * @param string $key Setting key.
336 * @param mixed $value Setting value.
338 public function setEmpty($key, $value)
340 if (! $this->exists($key)) {
341 $this->set($key, $value);
348 public function getConfigIO()
350 return $this->configIO
;
354 * @param ConfigIO $configIO
356 public function setConfigIO($configIO)
358 $this->configIO
= $configIO;
363 * Exception used if a mandatory field is missing in given configuration.
365 class MissingFieldConfigException
extends \Exception
370 * Construct exception.
372 * @param string $field field name missing.
374 public function __construct($field)
376 $this->field
= $field;
377 $this->message
= 'Configuration value is required for '. $this->field
;
382 * Exception used if an unauthorized attempt to edit configuration has been made.
384 class UnauthorizedConfigException
extends \Exception
387 * Construct exception.
389 public function __construct()
391 $this->message
= 'You are not authorized to alter config.';