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 */ 10*8c7c53b0SAndreas Gohrclass Writer 11*8c7c53b0SAndreas 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 */ 215a38a129SAndreas Gohr public function __construct() { 225a38a129SAndreas Gohr global $config_cascade; 235a38a129SAndreas Gohr $this->savefile = end($config_cascade['main']['local']); 245a38a129SAndreas Gohr } 255a38a129SAndreas Gohr 265a38a129SAndreas Gohr /** 275a38a129SAndreas Gohr * Save the given settings 285a38a129SAndreas Gohr * 295a38a129SAndreas Gohr * @param Setting[] $settings 305a38a129SAndreas Gohr * @throws \Exception 315a38a129SAndreas Gohr */ 325a38a129SAndreas Gohr public function save($settings) { 335a38a129SAndreas Gohr global $conf; 345a38a129SAndreas Gohr if($this->isLocked()) throw new \Exception('no save'); 355a38a129SAndreas Gohr 365a38a129SAndreas Gohr // backup current file (remove any existing backup) 375a38a129SAndreas Gohr if(file_exists($this->savefile)) { 3849bcbaeeSAndreas Gohr if(file_exists($this->savefile . '.bak.php')) @unlink($this->savefile . '.bak.php'); 3949bcbaeeSAndreas Gohr if(!io_rename($this->savefile, $this->savefile . '.bak.php')) throw new \Exception('no backup'); 405a38a129SAndreas Gohr } 415a38a129SAndreas Gohr 425a38a129SAndreas Gohr if(!$fh = @fopen($this->savefile, 'wb')) { 4349bcbaeeSAndreas Gohr io_rename($this->savefile . '.bak.php', $this->savefile); // problem opening, restore the backup 445a38a129SAndreas Gohr throw new \Exception('no save'); 455a38a129SAndreas Gohr } 465a38a129SAndreas Gohr 470772dde2SAndreas Gohr $out = ''; 485a38a129SAndreas Gohr foreach($settings as $setting) { 49f00299d8SAndreas Gohr if($setting->shouldBeSaved()) { 505a38a129SAndreas Gohr $out .= $setting->out('conf', 'php'); 515a38a129SAndreas Gohr } 52f00299d8SAndreas Gohr } 535a38a129SAndreas Gohr 540772dde2SAndreas Gohr if($out === '') { 550772dde2SAndreas Gohr throw new \Exception('empty config'); 560772dde2SAndreas Gohr } 570772dde2SAndreas Gohr $out = $this->getHeader() . $out; 580772dde2SAndreas Gohr 595a38a129SAndreas Gohr fwrite($fh, $out); 605a38a129SAndreas Gohr fclose($fh); 615a38a129SAndreas Gohr if($conf['fperm']) chmod($this->savefile, $conf['fperm']); 6270b28bcfSAndreas Gohr $this->opcacheUpdate($this->savefile); 635a38a129SAndreas Gohr } 645a38a129SAndreas Gohr 655a38a129SAndreas Gohr /** 665a38a129SAndreas Gohr * Update last modified time stamp of the config file 675a38a129SAndreas Gohr * 685a38a129SAndreas Gohr * Will invalidate all DokuWiki caches 695a38a129SAndreas Gohr * 705a38a129SAndreas Gohr * @throws \Exception when the config isn't writable 715a38a129SAndreas Gohr */ 725a38a129SAndreas Gohr public function touch() { 735a38a129SAndreas Gohr if($this->isLocked()) throw new \Exception('no save'); 745a38a129SAndreas Gohr @touch($this->savefile); 7570b28bcfSAndreas Gohr $this->opcacheUpdate($this->savefile); 7670b28bcfSAndreas Gohr } 7770b28bcfSAndreas Gohr 7870b28bcfSAndreas Gohr /** 795a5180beSAmmar Abdulhamid * Invalidate the opcache of the given file (if possible) 8070b28bcfSAndreas Gohr * 8170b28bcfSAndreas Gohr * @todo this should probably be moved to core 8270b28bcfSAndreas Gohr * @param string $file 8370b28bcfSAndreas Gohr */ 8470b28bcfSAndreas Gohr protected function opcacheUpdate($file) { 8570b28bcfSAndreas Gohr if(!function_exists('opcache_invalidate')) return; 865a5180beSAmmar Abdulhamid set_error_handler(function ($errNo, $errMsg) { 875a5180beSAmmar Abdulhamid Logger::debug('Unable to invalidate opcache: ' . $errMsg); } 885a5180beSAmmar Abdulhamid ); 895a5180beSAmmar Abdulhamid opcache_invalidate($file); 905a5180beSAmmar Abdulhamid restore_error_handler(); 915a38a129SAndreas Gohr } 925a38a129SAndreas Gohr 935a38a129SAndreas Gohr /** 945a38a129SAndreas Gohr * Configuration is considered locked if there is no local settings filename 955a38a129SAndreas Gohr * or the directory its in is not writable or the file exists and is not writable 965a38a129SAndreas Gohr * 975a38a129SAndreas Gohr * @return bool true: locked, false: writable 985a38a129SAndreas Gohr */ 995a38a129SAndreas Gohr public function isLocked() { 1005a38a129SAndreas Gohr if(!$this->savefile) return true; 1015a38a129SAndreas Gohr if(!is_writable(dirname($this->savefile))) return true; 1025a38a129SAndreas Gohr if(file_exists($this->savefile) && !is_writable($this->savefile)) return true; 1035a38a129SAndreas Gohr return false; 1045a38a129SAndreas Gohr } 1055a38a129SAndreas Gohr 1065a38a129SAndreas Gohr /** 1075a38a129SAndreas Gohr * Returns the PHP intro header for the config file 1085a38a129SAndreas Gohr * 1095a38a129SAndreas Gohr * @return string 1105a38a129SAndreas Gohr */ 1115a38a129SAndreas Gohr protected function getHeader() { 112467c1427SAndreas Gohr return implode( 1135a38a129SAndreas Gohr "\n", 114467c1427SAndreas Gohr [ 1155a38a129SAndreas Gohr '<?php', 1165a38a129SAndreas Gohr '/*', 1175a38a129SAndreas Gohr ' * ' . $this->header, 1185a38a129SAndreas Gohr ' * Auto-generated by config plugin', 119467c1427SAndreas Gohr ' * Run for user: ' . ($_SERVER['REMOTE_USER'] ?? 'Unknown'), 1205a38a129SAndreas Gohr ' * Date: ' . date('r'), 1215a38a129SAndreas Gohr ' */', 1225a38a129SAndreas Gohr '', 1235a38a129SAndreas Gohr '' 124467c1427SAndreas Gohr ] 1255a38a129SAndreas Gohr ); 1265a38a129SAndreas Gohr } 1275a38a129SAndreas Gohr} 128