src/Factory/ConfigFactory.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Factory;
  23
  24 use Exception;
  25 use Friendica\Core\Config;
  26 use Friendica\Core\Config\Cache;
  27 use Friendica\Model\Config\Config as ConfigModel;
  28 use Friendica\Model\Config\PConfig as PConfigModel;
  29 use Friendica\Util\ConfigFileLoader;
  30
  31 class ConfigFactory
  32 {
  33         /**
  34          * The key of the $_SERVER variable to override the config directory
  35          *
  36          * @var string
  37          */
  38         const CONFIG_DIR_ENV = 'FRIENDICA_CONFIG_DIR';
  39
  40         /**
  41          * The Sub directory of the config-files
  42          *
  43          * @var string
  44          */
  45         const CONFIG_DIR = 'config';
  46
  47         /**
  48          * The Sub directory of the static config-files
  49          *
  50          * @var string
  51          */
  52         const STATIC_DIR = 'static';
  53
  54         /**
  55          * @param string $basePath The basepath of FRIENDICA
  56          * @param array $serer the $_SERVER array
  57          *
  58          * @return ConfigFileLoader
  59          */
  60         public function createConfigFileLoader(string $basePath, array $server = [])
  61         {
  62                 if (!empty($server[self::CONFIG_DIR_ENV]) && is_dir($server[self::CONFIG_DIR_ENV])) {
  63                         $configDir = $server[self::CONFIG_DIR_ENV];
  64                 } else {
  65                         $configDir = $basePath . DIRECTORY_SEPARATOR . self::CONFIG_DIR;
  66                 }
  67                 $staticDir = $basePath . DIRECTORY_SEPARATOR . self::STATIC_DIR;
  68
  69                 return new ConfigFileLoader($basePath, $configDir, $staticDir);
  70         }
  71
  72         /**
  73          * @param ConfigFileLoader $loader The Config Cache loader (INI/config/.htconfig)
  74          *
  75          * @return Cache
  76          *
  77          * @throws Exception
  78          */
  79         public function createCache(ConfigFileLoader $loader, array $server = [])
  80         {
  81                 $configCache = new Cache();
  82                 $loader->setupCache($configCache, $server);
  83
  84                 return $configCache;
  85         }
  86
  87         /**
  88          * @param Cache       $configCache The config cache of this adapter
  89          * @param ConfigModel $configModel The configuration model
  90          *
  91          * @return Config\IConfig
  92          */
  93         public function createConfig(Cache $configCache, ConfigModel $configModel)
  94         {
  95                 if ($configCache->get('system', 'config_adapter') === 'preload') {
  96                         $configuration = new Config\PreloadConfig($configCache, $configModel);
  97                 } else {
  98                         $configuration = new Config\JitConfig($configCache, $configModel);
  99                 }
 100
 101
 102                 return $configuration;
 103         }
 104
 105         /**
 106          * @param Cache                         $configCache  The config cache
 107          * @param \Friendica\Core\PConfig\Cache $pConfigCache The personal config cache
 108          * @param PConfigModel                  $configModel  The configuration model
 109          *
 110          * @return \Friendica\Core\PConfig\IPConfig
 111          */
 112         public function createPConfig(Cache $configCache, \Friendica\Core\PConfig\Cache $pConfigCache, PConfigModel $configModel)
 113         {
 114                 if ($configCache->get('system', 'config_adapter') === 'preload') {
 115                         $configuration = new \Friendica\Core\PConfig\PreloadPConfig($pConfigCache, $configModel);
 116                 } else {
 117                         $configuration = new \Friendica\Core\PConfig\JitPConfig($pConfigCache, $configModel);
 118                 }
 119
 120                 return $configuration;
 121         }
 122 }