aboutsummaryrefslogtreecommitdiffhomepage
path: root/application/config/ConfigManager.php
blob: a663a0718689fb4a3e7a0d17de8d6f2216832c6b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
<?php

// FIXME! Namespaces...
require_once 'ConfigIO.php';
require_once 'ConfigPhp.php';
require_once 'ConfigJson.php';

/**
 * Class ConfigManager
 *
 * Singleton, manages all Shaarli's settings.
 */
class ConfigManager
{
    /**
     * @var ConfigManager instance.
     */
    protected static $instance = null;

    /**
     * @var string Config folder.
     */
    public static $CONFIG_FILE = 'data/config';

    /**
     * @var string Flag telling a setting is not found.
     */
    protected static $NOT_FOUND = 'NOT_FOUND';

    /**
     * @var array Loaded config array.
     */
    protected $loadedConfig;

    /**
     * @var ConfigIO implementation instance.
     */
    protected $configIO;

    /**
     * Private constructor: new instances not allowed.
     */
    private function __construct() {}

    /**
     * Cloning isn't allowed either.
     */
    private function __clone() {}

    /**
     * Return existing instance of PluginManager, or create it.
     *
     * @return ConfigManager instance.
     */
    public static function getInstance()
    {
        if (!(self::$instance instanceof self)) {
            self::$instance = new self();
            self::$instance->initialize();
        }

        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->load();
    }

    /**
     * Initialize the ConfigIO and loaded the conf.
     */
    protected function initialize()
    {
        if (! file_exists(self::$CONFIG_FILE .'.php')) {
            $this->configIO = new ConfigJson();
        } else {
            $this->configIO = new ConfigPhp();
        }
        $this->load();
    }

    /**
     * Load configuration in the ConfigurationManager.
     */
    protected function load()
    {
        $this->loadedConfig = $this->configIO->read($this->getConfigFile());
        $this->setDefaultValues();
    }

    /**
     * Get a setting.
     *
     * Supports nested settings with dot separated keys.
     * Eg. 'config.stuff.option' will find $conf[config][stuff][option],
     * or in JSON:
     *   { "config": { "stuff": {"option": "mysetting" } } } }
     *
     * @param string $setting Asked setting, keys separated with dots.
     * @param string $default Default value if not found.
     *
     * @return mixed Found setting, or the default value.
     */
    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) {
            return $default;
        }
        return $value;
    }

    /**
     * Set a setting, and eventually write it.
     *
     * Supports nested settings with dot separated keys.
     *
     * @param string $setting    Asked setting, keys separated with dots.
     * @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) {
            $this->write($isLoggedIn);
        }
    }

    /**
     * Check if a settings exists.
     *
     * Supports nested settings with dot separated keys.
     *
     * @param string $setting    Asked setting, keys separated with dots.
     *
     * @return bool true if the setting exists, false otherwise.
     */
    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) {
            return false;
        }
        return true;
    }

    /**
     * Call the config writer.
     *
     * @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.
     */
    public function write($isLoggedIn)
    {
        // These fields are required in configuration.
        $mandatoryFields = array(
            '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.
        if (is_file(self::$CONFIG_FILE) && !$isLoggedIn) {
            throw new UnauthorizedConfigException();
        }

        // Check that all mandatory fields are provided in $conf.
        foreach ($mandatoryFields as $field) {
            if (! $this->exists($field)) {
                throw new MissingFieldConfigException($field);
            }
        }

        return $this->configIO->write($this->getConfigFile(), $this->loadedConfig);
    }

    /**
     * Get the configuration file path.
     *
     * @return string Config file path.
     */
    public function getConfigFile()
    {
        return self::$CONFIG_FILE . $this->configIO->getExtension();
    }

    /**
     * Recursive function which find asked setting in the loaded config.
     *
     * @param array $settings Ordered array which contains keys to find.
     * @param array $conf   Loaded settings, then sub-array.
     *
     * @return mixed Found setting or NOT_FOUND flag.
     */
    protected static function getConfig($settings, $conf)
    {
        if (!is_array($settings) || count($settings) == 0) {
            return self::$NOT_FOUND;
        }

        $setting = array_shift($settings);
        if (!isset($conf[$setting])) {
            return self::$NOT_FOUND;
        }

        if (count($settings) > 0) {
            return self::getConfig($settings, $conf[$setting]);
        }
        return $conf[$setting];
    }

    /**
     * Recursive function which find asked setting in the loaded config.
     *
     * @param array $settings Ordered array which contains keys to find.
     * @param mixed $value
     * @param array $conf   Loaded settings, then sub-array.
     *
     * @return mixed Found setting or NOT_FOUND flag.
     */
    protected static function setConfig($settings, $value, &$conf)
    {
        if (!is_array($settings) || count($settings) == 0) {
            return self::$NOT_FOUND;
        }

        $setting = array_shift($settings);
        if (count($settings) > 0) {
            return self::setConfig($settings, $value, $conf[$setting]);
        }
        $conf[$setting] = $value;
    }

    /**
     * Set a bunch of default values allowing Shaarli to start without a config file.
     */
    protected function setDefaultValues()
    {
        // Data subdirectory
        $this->setEmpty('path.data_dir', 'data');

        // Main configuration file
        $this->setEmpty('path.config', 'data/config.php');

        // Link datastore
        $this->setEmpty('path.datastore', 'data/datastore.php');

        // Banned IPs
        $this->setEmpty('path.ban_file', 'data/ipbans.php');

        // Processed updates file.
        $this->setEmpty('path.updates', 'data/updates.txt');

        // Access log
        $this->setEmpty('path.log', 'data/log.txt');

        // For updates check of Shaarli
        $this->setEmpty('path.update_check', 'data/lastupdatecheck.txt');

        // Set ENABLE_UPDATECHECK to disabled by default.
        $this->setEmpty('general.check_updates', false);

        // RainTPL cache directory (keep the trailing slash!)
        $this->setEmpty('path.raintpl_tmp', 'tmp/');
        // Raintpl template directory (keep the trailing slash!)
        $this->setEmpty('path.raintpl_tpl', 'tpl/');

        // Thumbnail cache directory
        $this->setEmpty('path.thumbnails_cache', 'cache');

        // Atom & RSS feed cache directory
        $this->setEmpty('path.page_cache', 'pagecache');

        // Ban IP after this many failures
        $this->setEmpty('security.ban_after', 4);
        // Ban duration for IP address after login failures (in seconds)
        $this->setEmpty('security.ban_after', 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('general.rss_permalinks', true);
        // If true, an extra "ATOM feed" button will be displayed in the toolbar
        $this->setEmpty('extras.show_atom', false);

        // Link display options
        $this->setEmpty('extras.hide_public_links', false);
        $this->setEmpty('extras.hide_timestamps', false);
        $this->setEmpty('general.links_per_page', 20);

        // Private checkbox is checked by default
        $this->setEmpty('general.default_private_links', false);

        // Open Shaarli (true): anyone can add/edit/delete links without having to login
        $this->setEmpty('extras.open_shaarli', false);

        // Thumbnails
        // Display thumbnails in links
        $this->setEmpty('general.enable_thumbnails', true);
        // Store thumbnails in a local cache
        $this->setEmpty('general.enable_localcache', true);

        // Update check frequency for Shaarli. 86400 seconds=24 hours
        $this->setEmpty('general.check_updates_branch', 'stable');
        $this->setEmpty('general.check_updates_interval', 86400);

        $this->setEmpty('extras.redirector', '');
        $this->setEmpty('extras.redirector_encode_url', true);

        // Enabled plugins.
        $this->setEmpty('general.enabled_plugins', array('qrcode'));

        // Initialize plugin parameters array.
        $this->setEmpty('plugins', array());
    }

    /**
     * Set only if the setting does not exists.
     *
     * @param string $key   Setting key.
     * @param mixed  $value Setting value.
     */
    protected 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;
    }
}

/**
 * Exception used if a mandatory field is missing in given configuration.
 */
class MissingFieldConfigException extends Exception
{
    public $field;

    /**
     * Construct exception.
     *
     * @param string $field field name missing.
     */
    public function __construct($field)
    {
        $this->field = $field;
        $this->message = 'Configuration value is required for '. $this->field;
    }
}

/**
 * Exception used if an unauthorized attempt to edit configuration has been made.
 */
class UnauthorizedConfigException extends Exception
{
    /**
     * Construct exception.
     */
    public function __construct()
    {
        $this->message = 'You are not authorized to alter config.';
    }
}