// FIXME! Namespaces...
require_once 'ConfigIO.php';
require_once 'ConfigPhp.php';
-#require_once 'ConfigJson.php';
+require_once 'ConfigJson.php';
/**
* Class ConfigManager
*
* Singleton, manages all Shaarli's settings.
+ * See the documentation for more information on settings:
+ * - doc/Shaarli-configuration.html
+ * - https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration
*/
class ConfigManager
{
return self::$instance;
}
+ /**
+ * Reset the ConfigManager instance.
+ */
+ public static function reset()
+ {
+ self::$instance = null;
+ return self::getInstance();
+ }
+
/**
* Rebuild the loaded config array from config files.
*/
public function reload()
{
- $this->initialize();
+ $this->load();
}
/**
- * Initialize loaded conf in ConfigManager.
+ * Initialize the ConfigIO and loaded the conf.
*/
protected function initialize()
{
- /*if (! file_exists(self::$CONFIG_FILE .'.php')) {
+ if (! file_exists(self::$CONFIG_FILE .'.php')) {
$this->configIO = new ConfigJson();
} else {
$this->configIO = new ConfigPhp();
- }*/
- $this->configIO = new ConfigPhp();
- $this->loadedConfig = $this->configIO->read(self::$CONFIG_FILE);
+ }
+ $this->load();
+ }
+
+ /**
+ * Load configuration in the ConfigurationManager.
+ */
+ protected function load()
+ {
+ $this->loadedConfig = $this->configIO->read($this->getConfigFile());
$this->setDefaultValues();
}
*/
public function get($setting, $default = '')
{
+ // During the ConfigIO transition, map legacy settings to the new ones.
+ if ($this->configIO instanceof ConfigPhp && isset(ConfigPhp::$LEGACY_KEYS_MAPPING[$setting])) {
+ $setting = ConfigPhp::$LEGACY_KEYS_MAPPING[$setting];
+ }
+
$settings = explode('.', $setting);
$value = self::getConfig($settings, $this->loadedConfig);
if ($value === self::$NOT_FOUND) {
* @param string $value Value to set.
* @param bool $write Write the new setting in the config file, default false.
* @param bool $isLoggedIn User login state, default false.
+ *
+ * @throws Exception Invalid
*/
public function set($setting, $value, $write = false, $isLoggedIn = false)
{
+ if (empty($setting) || ! is_string($setting)) {
+ throw new Exception('Invalid setting key parameter. String expected, got: '. gettype($setting));
+ }
+
+ // During the ConfigIO transition, map legacy settings to the new ones.
+ if ($this->configIO instanceof ConfigPhp && isset(ConfigPhp::$LEGACY_KEYS_MAPPING[$setting])) {
+ $setting = ConfigPhp::$LEGACY_KEYS_MAPPING[$setting];
+ }
+
$settings = explode('.', $setting);
self::setConfig($settings, $value, $this->loadedConfig);
if ($write) {
*/
public function exists($setting)
{
+ // During the ConfigIO transition, map legacy settings to the new ones.
+ if ($this->configIO instanceof ConfigPhp && isset(ConfigPhp::$LEGACY_KEYS_MAPPING[$setting])) {
+ $setting = ConfigPhp::$LEGACY_KEYS_MAPPING[$setting];
+ }
+
$settings = explode('.', $setting);
$value = self::getConfig($settings, $this->loadedConfig);
if ($value === self::$NOT_FOUND) {
*
* @param bool $isLoggedIn User login state.
*
+ * @return bool True if the configuration has been successfully written, false otherwise.
+ *
* @throws MissingFieldConfigException: a mandatory field has not been provided in $conf.
* @throws UnauthorizedConfigException: user is not authorize to change configuration.
* @throws IOException: an error occurred while writing the new config file.
{
// These fields are required in configuration.
$mandatoryFields = array(
- 'login', 'hash', 'salt', 'timezone', 'title', 'titleLink',
- 'redirector', 'disablesessionprotection', 'privateLinkByDefault'
+ 'credentials.login',
+ 'credentials.hash',
+ 'credentials.salt',
+ 'security.session_protection_disabled',
+ 'general.timezone',
+ 'general.title',
+ 'general.header_link',
+ 'general.default_private_links',
+ 'extras.redirector',
);
// Only logged in user can alter config.
}
}
- $this->configIO->write(self::$CONFIG_FILE, $this->loadedConfig);
+ return $this->configIO->write($this->getConfigFile(), $this->loadedConfig);
}
/**
*/
protected function setDefaultValues()
{
- // Data subdirectory
- $this->setEmpty('config.DATADIR', 'data');
-
- // Main configuration file
- $this->setEmpty('config.CONFIG_FILE', 'data/config.php');
-
- // Link datastore
- $this->setEmpty('config.DATASTORE', 'data/datastore.php');
-
- // Banned IPs
- $this->setEmpty('config.IPBANS_FILENAME', 'data/ipbans.php');
-
- // Processed updates file.
- $this->setEmpty('config.UPDATES_FILE', 'data/updates.txt');
+ $this->setEmpty('path.data_dir', 'data');
+ $this->setEmpty('path.config', 'data/config.php');
+ $this->setEmpty('path.datastore', 'data/datastore.php');
+ $this->setEmpty('path.ban_file', 'data/ipbans.php');
+ $this->setEmpty('path.updates', 'data/updates.txt');
+ $this->setEmpty('path.log', 'data/log.txt');
+ $this->setEmpty('path.update_check', 'data/lastupdatecheck.txt');
+ $this->setEmpty('path.raintpl_tpl', 'tpl/');
+ $this->setEmpty('path.raintpl_tmp', 'tmp/');
+ $this->setEmpty('path.thumbnails_cache', 'cache');
+ $this->setEmpty('path.page_cache', 'pagecache');
+
+ $this->setEmpty('security.ban_after', 4);
+ $this->setEmpty('security.ban_after', 1800);
+ $this->setEmpty('security.session_protection_disabled', false);
+
+ $this->setEmpty('general.check_updates', false);
+ $this->setEmpty('general.rss_permalinks', true);
+ $this->setEmpty('general.links_per_page', 20);
+ $this->setEmpty('general.default_private_links', false);
+ $this->setEmpty('general.enable_thumbnails', true);
+ $this->setEmpty('general.enable_localcache', true);
+ $this->setEmpty('general.check_updates_branch', 'stable');
+ $this->setEmpty('general.check_updates_interval', 86400);
+ $this->setEmpty('general.header_link', '?');
+ $this->setEmpty('general.enabled_plugins', array('qrcode'));
+
+ $this->setEmpty('extras.show_atom', false);
+ $this->setEmpty('extras.hide_public_links', false);
+ $this->setEmpty('extras.hide_timestamps', false);
+ $this->setEmpty('extras.open_shaarli', false);
+ $this->setEmpty('extras.redirector', '');
+ $this->setEmpty('extras.redirector_encode_url', true);
- // Access log
- $this->setEmpty('config.LOG_FILE', 'data/log.txt');
-
- // For updates check of Shaarli
- $this->setEmpty('config.UPDATECHECK_FILENAME', 'data/lastupdatecheck.txt');
-
- // Set ENABLE_UPDATECHECK to disabled by default.
- $this->setEmpty('config.ENABLE_UPDATECHECK', false);
-
- // RainTPL cache directory (keep the trailing slash!)
- $this->setEmpty('config.RAINTPL_TMP', 'tmp/');
- // Raintpl template directory (keep the trailing slash!)
- $this->setEmpty('config.RAINTPL_TPL', 'tpl/');
-
- // Thumbnail cache directory
- $this->setEmpty('config.CACHEDIR', 'cache');
-
- // Atom & RSS feed cache directory
- $this->setEmpty('config.PAGECACHE', 'pagecache');
-
- // Ban IP after this many failures
- $this->setEmpty('config.BAN_AFTER', 4);
- // Ban duration for IP address after login failures (in seconds)
- $this->setEmpty('config.BAN_DURATION', 1800);
-
- // Feed options
- // Enable RSS permalinks by default.
- // This corresponds to the default behavior of shaarli before this was added as an option.
- $this->setEmpty('config.ENABLE_RSS_PERMALINKS', true);
- // If true, an extra "ATOM feed" button will be displayed in the toolbar
- $this->setEmpty('config.SHOW_ATOM', false);
-
- // Link display options
- $this->setEmpty('config.HIDE_PUBLIC_LINKS', false);
- $this->setEmpty('config.HIDE_TIMESTAMPS', false);
- $this->setEmpty('config.LINKS_PER_PAGE', 20);
-
- // Open Shaarli (true): anyone can add/edit/delete links without having to login
- $this->setEmpty('config.OPEN_SHAARLI', false);
-
- // Thumbnails
- // Display thumbnails in links
- $this->setEmpty('config.ENABLE_THUMBNAILS', true);
- // Store thumbnails in a local cache
- $this->setEmpty('config.ENABLE_LOCALCACHE', true);
-
- // Update check frequency for Shaarli. 86400 seconds=24 hours
- $this->setEmpty('config.UPDATECHECK_BRANCH', 'stable');
- $this->setEmpty('config.UPDATECHECK_INTERVAL', 86400);
-
- $this->setEmpty('redirector', '');
- $this->setEmpty('config.REDIRECTOR_URLENCODE', true);
-
- // Enabled plugins.
- $this->setEmpty('config.ENABLED_PLUGINS', array('qrcode'));
-
- // Initialize plugin parameters array.
$this->setEmpty('plugins', array());
}
* @param string $key Setting key.
* @param mixed $value Setting value.
*/
- protected function setEmpty($key, $value)
+ public function setEmpty($key, $value)
{
if (! $this->exists($key)) {
$this->set($key, $value);
}
}
+
+ /**
+ * @return ConfigIO
+ */
+ public function getConfigIO()
+ {
+ return $this->configIO;
+ }
+
+ /**
+ * @param ConfigIO $configIO
+ */
+ public function setConfigIO($configIO)
+ {
+ $this->configIO = $configIO;
+ }
}
/**
projects / github / shaarli / Shaarli.git / blobdiff