xref: /dokuwiki/lib/plugins/config/core/Writer.php (revision 0a5b05eba6ee3c7824187b015b4e1bbc9658bb5d) 
1<?php
2
3namespace dokuwiki\plugin\config\core;
4use dokuwiki\plugin\config\core\Setting\Setting;
5
6/**
7 * Writes the settings to the correct local file
8 */
9class Writer {
10    /** @var string header info */
11    protected $header = 'Dokuwiki\'s Main Configuration File - Local Settings';
12
13    /** @var string the file where the config will be saved to */
14    protected $savefile;
15
16    /**
17     * Writer constructor.
18     */
19    public function __construct() {
20        global $config_cascade;
21        $this->savefile = end($config_cascade['main']['local']);
22    }
23
24    /**
25     * Save the given settings
26     *
27     * @param Setting[] $settings
28     * @throws \Exception
29     */
30    public function save($settings) {
31        global $conf;
32        if($this->isLocked()) throw new \Exception('no save');
33
34        // backup current file (remove any existing backup)
35        if(file_exists($this->savefile)) {
36            if(file_exists($this->savefile . '.bak')) @unlink($this->savefile . '.bak');
37            if(!io_rename($this->savefile, $this->savefile . '.bak')) throw new \Exception('no backup');
38        }
39
40        if(!$fh = @fopen($this->savefile, 'wb')) {
41            io_rename($this->savefile . '.bak', $this->savefile); // problem opening, restore the backup
42            throw new \Exception('no save');
43        }
44
45        $out = $this->getHeader();
46        foreach($settings as $setting) {
47            $out .= $setting->out('conf', 'php');
48        }
49
50        fwrite($fh, $out);
51        fclose($fh);
52        if($conf['fperm']) chmod($this->savefile, $conf['fperm']);
53        @opcache_invalidate($this->savefile);
54    }
55
56    /**
57     * Update last modified time stamp of the config file
58     *
59     * Will invalidate all DokuWiki caches
60     *
61     * @throws \Exception when the config isn't writable
62     */
63    public function touch() {
64        if($this->isLocked()) throw new \Exception('no save');
65        @touch($this->savefile);
66        @opcache_invalidate($this->savefile);
67    }
68
69    /**
70     * Configuration is considered locked if there is no local settings filename
71     * or the directory its in is not writable or the file exists and is not writable
72     *
73     * @return bool true: locked, false: writable
74     */
75    public function isLocked() {
76        if(!$this->savefile) return true;
77        if(!is_writable(dirname($this->savefile))) return true;
78        if(file_exists($this->savefile) && !is_writable($this->savefile)) return true;
79        return false;
80    }
81
82    /**
83     * Returns the PHP intro header for the config file
84     *
85     * @return string
86     */
87    protected function getHeader() {
88        return join(
89            "\n",
90            array(
91                '<?php',
92                '/*',
93                ' * ' . $this->header,
94                ' * Auto-generated by config plugin',
95                ' * Run for user: ' . $_SERVER['REMOTE_USER'],
96                ' * Date: ' . date('r'),
97                ' */',
98                '',
99                ''
100            )
101        );
102    }
103}
104