src/Core/Config/Factory/Config.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\Core\Config\Factory;
  23
  24 use Friendica\Core\Config\Capability;
  25 use Friendica\Core\Config\Repository;
  26 use Friendica\Core\Config\Type;
  27 use Friendica\Core\Config\Util;
  28 use Friendica\Core\Config\ValueObject\Cache;
  29
  30 class Config
  31 {
  32         /**
  33          * The key of the $_SERVER variable to override the config directory
  34          *
  35          * @var string
  36          */
  37         const CONFIG_DIR_ENV = 'FRIENDICA_CONFIG_DIR';
  38
  39         /**
  40          * The Sub directory of the config-files
  41          *
  42          * @var string
  43          */
  44         const CONFIG_DIR = 'config';
  45
  46         /**
  47          * The Sub directory of the static config-files
  48          *
  49          * @var string
  50          */
  51         const STATIC_DIR = 'static';
  52
  53         /**
  54          * @param string $basePath The basepath of FRIENDICA
  55          * @param array  $server   The $_SERVER array
  56          *
  57          * @return Util\ConfigFileLoader
  58          */
  59         public function createConfigFileLoader(string $basePath, array $server = []): Util\ConfigFileLoader
  60         {
  61                 if (!empty($server[self::CONFIG_DIR_ENV]) && is_dir($server[self::CONFIG_DIR_ENV])) {
  62                         $configDir = $server[self::CONFIG_DIR_ENV];
  63                 } else {
  64                         $configDir = $basePath . DIRECTORY_SEPARATOR . self::CONFIG_DIR;
  65                 }
  66                 $staticDir = $basePath . DIRECTORY_SEPARATOR . self::STATIC_DIR;
  67
  68                 return new Util\ConfigFileLoader($basePath, $configDir, $staticDir);
  69         }
  70
  71         /**
  72          * @param Util\ConfigFileLoader $loader The Config Cache loader (INI/config/.htconfig)
  73          * @param array                 $server
  74          *
  75          * @return Cache
  76          */
  77         public function createCache(Util\ConfigFileLoader $loader, array $server = []): Cache
  78         {
  79                 $configCache = new Cache();
  80                 $loader->setupCache($configCache, $server);
  81
  82                 return $configCache;
  83         }
  84
  85         /**
  86          * @param Cache $configCache The config cache of this adapter
  87          * @param Repository\Config $configRepo  The configuration repository
  88          *
  89          * @return Capability\IManageConfigValues
  90          */
  91         public function create(Cache $configCache, Repository\Config $configRepo)
  92         {
  93                 if ($configCache->get('system', 'config_adapter') === 'preload') {
  94                         $configuration = new Type\PreloadConfig($configCache, $configRepo);
  95                 } else {
  96                         $configuration = new Type\JitConfig($configCache, $configRepo);
  97                 }
  98
  99                 return $configuration;
 100         }
 101 }