3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core\Config\Util;
24 use Friendica\Core\Addon;
25 use Friendica\Core\Config\Exception\ConfigFileException;
26 use Friendica\Core\Config\ValueObject\Cache;
29 * The ConfigFileLoader loads config-files and stores them in a ConfigCache ( @see Cache )
31 * It is capable of loading the following config files:
32 * - *.config.php (current)
33 * - *.ini.php (deprecated)
34 * - *.htconfig.php (deprecated)
36 class ConfigFileLoader
39 * The default name of the user defined ini file
43 const CONFIG_INI = 'local';
46 * The default name of the user defined legacy config file
50 const CONFIG_HTCONFIG = 'htconfig';
53 * The sample string inside the configs, which shouldn't get loaded
57 const SAMPLE_END = '-sample';
73 * @param string $baseDir The base
74 * @param string $configDir
75 * @param string $staticDir
77 public function __construct(string $baseDir, string $configDir, string $staticDir)
79 $this->baseDir = $baseDir;
80 $this->configDir = $configDir;
81 $this->staticDir = $staticDir;
85 * Load the configuration files into an configuration cache
87 * First loads the default value for all the configuration keys, then the legacy configuration files, then the
88 * expected local.config.php
90 * @param Cache $config The config cache to load to
91 * @param array $server The $_SERVER array
92 * @param bool $raw Setup the raw config format
94 * @throws ConfigFileException
96 public function setupCache(Cache $config, array $server = [], bool $raw = false)
98 // Load static config files first, the order is important
99 $config->load($this->loadStaticConfig('defaults'), Cache::SOURCE_STATIC);
100 $config->load($this->loadStaticConfig('settings'), Cache::SOURCE_STATIC);
102 // try to load the legacy config first
103 $config->load($this->loadLegacyConfig('htpreconfig'), Cache::SOURCE_FILE);
104 $config->load($this->loadLegacyConfig('htconfig'), Cache::SOURCE_FILE);
106 // Now load every other config you find inside the 'config/' directory
107 $this->loadCoreConfig($config);
109 $config->load($this->loadEnvConfig($server), Cache::SOURCE_ENV);
111 // In case of install mode, add the found basepath (because there isn't a basepath set yet
112 if (!$raw && empty($config->get('system', 'basepath'))) {
113 // Setting at least the basepath we know
114 $config->set('system', 'basepath', $this->baseDir, Cache::SOURCE_FILE);
119 * Tries to load the static core-configuration and returns the config array.
121 * @param string $name The name of the configuration
123 * @return array The config array (empty if no config found)
125 * @throws ConfigFileException if the configuration file isn't readable
127 private function loadStaticConfig(string $name): array
129 $configName = $this->staticDir . DIRECTORY_SEPARATOR . $name . '.config.php';
130 $iniName = $this->staticDir . DIRECTORY_SEPARATOR . $name . '.ini.php';
132 if (file_exists($configName)) {
133 return $this->loadConfigFile($configName);
134 } elseif (file_exists($iniName)) {
135 return $this->loadINIConfigFile($iniName);
142 * Tries to load the specified core-configuration into the config cache.
144 * @param Cache $config The Config cache
146 * @throws ConfigFileException if the configuration file isn't readable
148 private function loadCoreConfig(Cache $config)
150 // try to load legacy ini-files first
151 foreach ($this->getConfigFiles(true) as $configFile) {
152 $config->load($this->loadINIConfigFile($configFile), Cache::SOURCE_FILE);
155 // try to load supported config at last to overwrite it
156 foreach ($this->getConfigFiles() as $configFile) {
157 $config->load($this->loadConfigFile($configFile), Cache::SOURCE_FILE);
162 * Tries to load the specified addon-configuration and returns the config array.
164 * @param string $name The name of the configuration
166 * @return array The config array (empty if no config found)
168 * @throws ConfigFileException if the configuration file isn't readable
170 public function loadAddonConfig(string $name): array
172 $filepath = $this->baseDir . DIRECTORY_SEPARATOR . // /var/www/html/
173 Addon::DIRECTORY . DIRECTORY_SEPARATOR . // addon/
174 $name . DIRECTORY_SEPARATOR . // openstreetmap/
175 'config'. DIRECTORY_SEPARATOR . // config/
176 $name . ".config.php"; // openstreetmap.config.php
178 if (file_exists($filepath)) {
179 return $this->loadConfigFile($filepath);
186 * Tries to load environment specific variables, based on the `env.config.php` mapping table
188 * @param array $server The $_SERVER variable
190 * @return array The config array (empty if no config was found)
192 * @throws ConfigFileException if the configuration file isn't readable
194 public function loadEnvConfig(array $server): array
196 $filepath = $this->staticDir . DIRECTORY_SEPARATOR . // /var/www/html/static/
197 "env.config.php"; // env.config.php
199 if (!file_exists($filepath)) {
203 $envConfig = $this->loadConfigFile($filepath);
207 foreach ($envConfig as $envKey => $configStructure) {
208 if (isset($server[$envKey])) {
209 $return[$configStructure[0]][$configStructure[1]] = $server[$envKey];
217 * Get the config files of the config-directory
219 * @param bool $ini True, if scan for ini-files instead of config files
223 private function getConfigFiles(bool $ini = false): array
225 $files = scandir($this->configDir);
228 $filePattern = ($ini ? '*.ini.php' : '*.config.php');
230 // Don't load sample files
231 $sampleEnd = self::SAMPLE_END . ($ini ? '.ini.php' : '.config.php');
233 foreach ($files as $filename) {
234 if (fnmatch($filePattern, $filename) && substr_compare($filename, $sampleEnd, -strlen($sampleEnd))) {
235 $found[] = $this->configDir . '/' . $filename;
243 * Tries to load the legacy config files (.htconfig.php, .htpreconfig.php) and returns the config array.
245 * @param string $name The name of the config file (default is empty, which means .htconfig.php)
247 * @return array The configuration array (empty if no config found)
249 * @deprecated since version 2018.09
251 private function loadLegacyConfig(string $name = ''): array
253 $name = !empty($name) ? $name : self::CONFIG_HTCONFIG;
254 $fullName = $this->baseDir . DIRECTORY_SEPARATOR . '.' . $name . '.php';
257 if (file_exists($fullName)) {
258 $a = new \stdClass();
262 $htConfigCategories = array_keys($a->config);
264 // map the legacy configuration structure to the current structure
265 foreach ($htConfigCategories as $htConfigCategory) {
266 if (is_array($a->config[$htConfigCategory])) {
267 $keys = array_keys($a->config[$htConfigCategory]);
269 foreach ($keys as $key) {
270 $config[$htConfigCategory][$key] = $a->config[$htConfigCategory][$key];
273 $config['config'][$htConfigCategory] = $a->config[$htConfigCategory];
279 if (isset($db_host)) {
280 $config['database']['hostname'] = $db_host;
283 if (isset($db_user)) {
284 $config['database']['username'] = $db_user;
287 if (isset($db_pass)) {
288 $config['database']['password'] = $db_pass;
291 if (isset($db_data)) {
292 $config['database']['database'] = $db_data;
295 if (isset($config['system']['db_charset'])) {
296 $config['database']['charset'] = $config['system']['db_charset'];
298 if (isset($pidfile)) {
299 $config['system']['pidfile'] = $pidfile;
302 if (isset($default_timezone)) {
303 $config['system']['default_timezone'] = $default_timezone;
304 unset($default_timezone);
307 $config['system']['language'] = $lang;
316 * Tries to load the specified legacy configuration file and returns the config array.
318 * @param string $filepath
320 * @return array The configuration array
321 * @throws ConfigFileException
322 * @deprecated since version 2018.12
324 private function loadINIConfigFile(string $filepath): array
326 $contents = include($filepath);
328 $config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
330 if ($config === false) {
331 throw new ConfigFileException('Error parsing INI config file ' . $filepath);
338 * Tries to load the specified configuration file and returns the config array.
340 * The config format is PHP array and the template for configuration files is the following:
348 * @param string $filepath The filepath of the
350 * @return array The config array0
352 * @throws ConfigFileException if the config cannot get loaded.
354 private function loadConfigFile(string $filepath): array
356 $config = include($filepath);
358 if (!is_array($config)) {
359 throw new ConfigFileException('Error loading config file ' . $filepath);