15a38a129SAndreas Gohr<?php 25a38a129SAndreas Gohr 35a38a129SAndreas Gohrnamespace dokuwiki\plugin\config\core; 40a5b05ebSAndreas Gohruse dokuwiki\plugin\config\core\Setting\Setting; 55a5180beSAmmar Abdulhamiduse dokuwiki\Logger; 65a38a129SAndreas Gohr 75a38a129SAndreas Gohr/** 85a38a129SAndreas Gohr * Writes the settings to the correct local file 95a38a129SAndreas Gohr */ 108c7c53b0SAndreas Gohrclass Writer 118c7c53b0SAndreas Gohr{ 125a38a129SAndreas Gohr /** @var string header info */ 135a38a129SAndreas Gohr protected $header = 'Dokuwiki\'s Main Configuration File - Local Settings'; 145a38a129SAndreas Gohr 155a38a129SAndreas Gohr /** @var string the file where the config will be saved to */ 165a38a129SAndreas Gohr protected $savefile; 175a38a129SAndreas Gohr 185a38a129SAndreas Gohr /** 195a38a129SAndreas Gohr * Writer constructor. 205a38a129SAndreas Gohr */ 21*d868eb89SAndreas Gohr public function __construct() 22*d868eb89SAndreas Gohr { 235a38a129SAndreas Gohr global $config_cascade; 245a38a129SAndreas Gohr $this->savefile = end($config_cascade['main']['local']); 255a38a129SAndreas Gohr } 265a38a129SAndreas Gohr 275a38a129SAndreas Gohr /** 285a38a129SAndreas Gohr * Save the given settings 295a38a129SAndreas Gohr * 305a38a129SAndreas Gohr * @param Setting[] $settings 315a38a129SAndreas Gohr * @throws \Exception 325a38a129SAndreas Gohr */ 33*d868eb89SAndreas Gohr public function save($settings) 34*d868eb89SAndreas Gohr { 355a38a129SAndreas Gohr global $conf; 365a38a129SAndreas Gohr if($this->isLocked()) throw new \Exception('no save'); 375a38a129SAndreas Gohr 385a38a129SAndreas Gohr // backup current file (remove any existing backup) 395a38a129SAndreas Gohr if(file_exists($this->savefile)) { 4049bcbaeeSAndreas Gohr if(file_exists($this->savefile . '.bak.php')) @unlink($this->savefile . '.bak.php'); 4149bcbaeeSAndreas Gohr if(!io_rename($this->savefile, $this->savefile . '.bak.php')) throw new \Exception('no backup'); 425a38a129SAndreas Gohr } 435a38a129SAndreas Gohr 445a38a129SAndreas Gohr if(!$fh = @fopen($this->savefile, 'wb')) { 4549bcbaeeSAndreas Gohr io_rename($this->savefile . '.bak.php', $this->savefile); // problem opening, restore the backup 465a38a129SAndreas Gohr throw new \Exception('no save'); 475a38a129SAndreas Gohr } 485a38a129SAndreas Gohr 490772dde2SAndreas Gohr $out = ''; 505a38a129SAndreas Gohr foreach($settings as $setting) { 51f00299d8SAndreas Gohr if($setting->shouldBeSaved()) { 525a38a129SAndreas Gohr $out .= $setting->out('conf', 'php'); 535a38a129SAndreas Gohr } 54f00299d8SAndreas Gohr } 555a38a129SAndreas Gohr 560772dde2SAndreas Gohr if($out === '') { 570772dde2SAndreas Gohr throw new \Exception('empty config'); 580772dde2SAndreas Gohr } 590772dde2SAndreas Gohr $out = $this->getHeader() . $out; 600772dde2SAndreas Gohr 615a38a129SAndreas Gohr fwrite($fh, $out); 625a38a129SAndreas Gohr fclose($fh); 635a38a129SAndreas Gohr if($conf['fperm']) chmod($this->savefile, $conf['fperm']); 6470b28bcfSAndreas Gohr $this->opcacheUpdate($this->savefile); 655a38a129SAndreas Gohr } 665a38a129SAndreas Gohr 675a38a129SAndreas Gohr /** 685a38a129SAndreas Gohr * Update last modified time stamp of the config file 695a38a129SAndreas Gohr * 705a38a129SAndreas Gohr * Will invalidate all DokuWiki caches 715a38a129SAndreas Gohr * 725a38a129SAndreas Gohr * @throws \Exception when the config isn't writable 735a38a129SAndreas Gohr */ 74*d868eb89SAndreas Gohr public function touch() 75*d868eb89SAndreas Gohr { 765a38a129SAndreas Gohr if($this->isLocked()) throw new \Exception('no save'); 775a38a129SAndreas Gohr @touch($this->savefile); 7870b28bcfSAndreas Gohr $this->opcacheUpdate($this->savefile); 7970b28bcfSAndreas Gohr } 8070b28bcfSAndreas Gohr 8170b28bcfSAndreas Gohr /** 825a5180beSAmmar Abdulhamid * Invalidate the opcache of the given file (if possible) 8370b28bcfSAndreas Gohr * 8470b28bcfSAndreas Gohr * @todo this should probably be moved to core 8570b28bcfSAndreas Gohr * @param string $file 8670b28bcfSAndreas Gohr */ 87*d868eb89SAndreas Gohr protected function opcacheUpdate($file) 88*d868eb89SAndreas Gohr { 8970b28bcfSAndreas Gohr if(!function_exists('opcache_invalidate')) return; 905a5180beSAmmar Abdulhamid set_error_handler(function ($errNo, $errMsg) { 915a5180beSAmmar Abdulhamid Logger::debug('Unable to invalidate opcache: ' . $errMsg); } 925a5180beSAmmar Abdulhamid ); 935a5180beSAmmar Abdulhamid opcache_invalidate($file); 945a5180beSAmmar Abdulhamid restore_error_handler(); 955a38a129SAndreas Gohr } 965a38a129SAndreas Gohr 975a38a129SAndreas Gohr /** 985a38a129SAndreas Gohr * Configuration is considered locked if there is no local settings filename 995a38a129SAndreas Gohr * or the directory its in is not writable or the file exists and is not writable 1005a38a129SAndreas Gohr * 1015a38a129SAndreas Gohr * @return bool true: locked, false: writable 1025a38a129SAndreas Gohr */ 103*d868eb89SAndreas Gohr public function isLocked() 104*d868eb89SAndreas Gohr { 1055a38a129SAndreas Gohr if(!$this->savefile) return true; 1065a38a129SAndreas Gohr if(!is_writable(dirname($this->savefile))) return true; 1075a38a129SAndreas Gohr if(file_exists($this->savefile) && !is_writable($this->savefile)) return true; 1085a38a129SAndreas Gohr return false; 1095a38a129SAndreas Gohr } 1105a38a129SAndreas Gohr 1115a38a129SAndreas Gohr /** 1125a38a129SAndreas Gohr * Returns the PHP intro header for the config file 1135a38a129SAndreas Gohr * 1145a38a129SAndreas Gohr * @return string 1155a38a129SAndreas Gohr */ 116*d868eb89SAndreas Gohr protected function getHeader() 117*d868eb89SAndreas Gohr { 118467c1427SAndreas Gohr return implode( 1195a38a129SAndreas Gohr "\n", 120467c1427SAndreas Gohr [ 1215a38a129SAndreas Gohr '<?php', 1225a38a129SAndreas Gohr '/*', 1235a38a129SAndreas Gohr ' * ' . $this->header, 1245a38a129SAndreas Gohr ' * Auto-generated by config plugin', 125467c1427SAndreas Gohr ' * Run for user: ' . ($_SERVER['REMOTE_USER'] ?? 'Unknown'), 1265a38a129SAndreas Gohr ' * Date: ' . date('r'), 1275a38a129SAndreas Gohr ' */', 1285a38a129SAndreas Gohr '', 1295a38a129SAndreas Gohr '' 130467c1427SAndreas Gohr ] 1315a38a129SAndreas Gohr ); 1325a38a129SAndreas Gohr } 1335a38a129SAndreas Gohr} 134