aboutsummaryrefslogtreecommitdiffhomepage
path: root/application/config/ConfigJson.php
blob: cbafbf6da07c3869c74151dbc7fbfc736560ff3d (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
<?php

/**
 * Class ConfigJson (ConfigIO implementation)
 *
 * Handle Shaarli's JSON configuration file.
 */
class ConfigJson implements ConfigIO
{
    /**
     * The JSON data is wrapped in a PHP file for security purpose.
     * This way, even if the file is accessible, credentials and configuration won't be exposed.
     *
     * @var string PHP start tag and comment tag.
     */
    public static $PHP_HEADER;

    public function __construct()
    {
        // The field can't be initialized directly with concatenation before PHP 5.6.
        self::$PHP_HEADER = '<?php /*'. PHP_EOL;
    }

    /**
     * @inheritdoc
     */
    function read($filepath)
    {
        if (! file_exists($filepath) || ! is_readable($filepath)) {
            return array();
        }
        $data = file_get_contents($filepath);
        $data = str_replace(self::$PHP_HEADER, '', $data);
        $data = json_decode($data, true);
        if ($data === null) {
            $error = json_last_error();
            throw new Exception('An error occured while parsing JSON file: error code #'. $error);
        }
        return $data;
    }

    /**
     * @inheritdoc
     */
    function write($filepath, $conf)
    {
        // JSON_PRETTY_PRINT is available from PHP 5.4.
        $print = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0;
        $data = self::$PHP_HEADER . json_encode($conf, $print);
        if (!file_put_contents($filepath, $data)) {
            throw new IOException(
                $filepath,
                'Shaarli could not create the config file.
                Please make sure Shaarli has the right to write in the folder is it installed in.'
            );
        }
    }

    /**
     * @inheritdoc
     */
    function getExtension()
    {
        return '.json.php';
    }
}