static/dependencies.config.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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  * The configuration defines "complex" dependencies inside Friendica
  21  * So this classes shouldn't be simple or their dependencies are already defined here.
  22  *
  23  * This kind of dependencies are NOT required to be defined here:
  24  *   - $a = new ClassA(new ClassB());
  25  *   - $a = new ClassA();
  26  *   - $a = new ClassA(Configuration $configuration);
  27  *
  28  * This kind of dependencies SHOULD be defined here:
  29  *   - $a = new ClassA();
  30  *     $b = $a->create();
  31  *
  32  *   - $a = new ClassA($creationPassedVariable);
  33  *
  34  */
  35
  36 use Dice\Dice;
  37 use Friendica\App;
  38 use Friendica\Core\Cache;
  39 use Friendica\Core\Config;
  40 use Friendica\Core\PConfig;
  41 use Friendica\Core\L10n;
  42 use Friendica\Core\Lock;
  43 use Friendica\Core\Session\Capability\IHandleSessions;
  44 use Friendica\Core\Session\Capability\IHandleUserSessions;
  45 use Friendica\Core\Storage\Repository\StorageManager;
  46 use Friendica\Database\Database;
  47 use Friendica\Database\Definition\DbaDefinition;
  48 use Friendica\Database\Definition\ViewDefinition;
  49 use Friendica\Factory;
  50 use Friendica\Core\Storage\Capability\ICanWriteToStorage;
  51 use Friendica\Model\User\Cookie;
  52 use Friendica\Model\Log\ParsedLogIterator;
  53 use Friendica\Network;
  54 use Friendica\Util;
  55 use Psr\Log\LoggerInterface;
  56
  57 return [
  58         '*'                             => [
  59                 // marks all class result as shared for other creations, so there's just
  60                 // one instance for the whole execution
  61                 'shared' => true,
  62         ],
  63         '$basepath'                     => [
  64                 'instanceOf'      => Util\BasePath::class,
  65                 'call'            => [
  66                         ['getPath', [], Dice::CHAIN_CALL],
  67                 ],
  68                 'constructParams' => [
  69                         dirname(__FILE__, 2),
  70                         $_SERVER
  71                 ]
  72         ],
  73         Util\BasePath::class         => [
  74                 'constructParams' => [
  75                         dirname(__FILE__, 2),
  76                         $_SERVER
  77                 ]
  78         ],
  79         Config\Util\ConfigFileLoader::class => [
  80                 'instanceOf' => Config\Factory\Config::class,
  81                 'call'       => [
  82                         ['createConfigFileLoader', [
  83                                 [Dice::INSTANCE => '$basepath'],
  84                                 $_SERVER,
  85                         ], Dice::CHAIN_CALL],
  86                 ],
  87         ],
  88         Config\ValueObject\Cache::class => [
  89                 'instanceOf' => Config\Factory\Config::class,
  90                 'call'       => [
  91                         ['createCache', [$_SERVER], Dice::CHAIN_CALL],
  92                 ],
  93         ],
  94         App\Mode::class              => [
  95                 'call' => [
  96                         ['determineRunMode', [true, $_SERVER], Dice::CHAIN_CALL],
  97                         ['determine', [], Dice::CHAIN_CALL],
  98                 ],
  99         ],
 100         Config\Capability\IManageConfigValues::class => [
 101                 'instanceOf' => Config\Factory\Config::class,
 102                 'call'       => [
 103                         ['create', [], Dice::CHAIN_CALL],
 104                 ],
 105         ],
 106         PConfig\Capability\IManagePersonalConfigValues::class => [
 107                 'instanceOf' => PConfig\Factory\PConfig::class,
 108                 'call'       => [
 109                         ['create', [], Dice::CHAIN_CALL],
 110                 ]
 111         ],
 112         DbaDefinition::class => [
 113                 'constructParams' => [
 114                         [Dice::INSTANCE => '$basepath'],
 115                 ],
 116                 'call' => [
 117                         ['load', [false], Dice::CHAIN_CALL],
 118                 ],
 119         ],
 120         ViewDefinition::class => [
 121                 'constructParams' => [
 122                         [Dice::INSTANCE => '$basepath'],
 123                 ],
 124                 'call' => [
 125                         ['load', [false], Dice::CHAIN_CALL],
 126                 ],
 127         ],
 128         Database::class                         => [
 129                 'constructParams' => [
 130                         [Dice::INSTANCE => \Psr\Log\NullLogger::class],
 131                 ],
 132         ],
 133         /**
 134          * Creates the App\BaseURL
 135          *
 136          * Same as:
 137          *   $baseURL = new App\BaseURL($configuration, $_SERVER);
 138          */
 139         App\BaseURL::class             => [
 140                 'constructParams' => [
 141                         $_SERVER,
 142                 ],
 143         ],
 144         App\Page::class => [
 145                 'constructParams' => [
 146                         [Dice::INSTANCE => '$basepath'],
 147                 ],
 148         ],
 149         /**
 150          * Create a Logger, which implements the LoggerInterface
 151          *
 152          * Same as:
 153          *   $loggerFactory = new Factory\LoggerFactory();
 154          *   $logger = $loggerFactory->create($channel, $configuration, $profiler);
 155          *
 156          * Attention1: We can use DICE for detecting dependencies inside "chained" calls too
 157          * Attention2: The variable "$channel" is passed inside the creation of the dependencies per:
 158          *    $app = $dice->create(App::class, [], ['$channel' => 'index']);
 159          *    and is automatically passed as an argument with the same name
 160          */
 161         LoggerInterface::class          => [
 162                 'instanceOf' => \Friendica\Core\Logger\Factory\Logger::class,
 163                 'constructParams' => [
 164                         'index',
 165                 ],
 166                 'call'       => [
 167                         ['create', [], Dice::CHAIN_CALL],
 168                 ],
 169         ],
 170         '$devLogger'                    => [
 171                 'instanceOf' => \Friendica\Core\Logger\Factory\Logger::class,
 172                 'constructParams' => [
 173                         'dev',
 174                 ],
 175                 'call'       => [
 176                         ['createDev', [], Dice::CHAIN_CALL],
 177                 ]
 178         ],
 179         \Friendica\Core\Logger\Capabilities\IHaveCallIntrospections::class => [
 180                 'instanceOf' => \Friendica\Core\Logger\Util\Introspection::class,
 181                 'constructParams' => [
 182                         \Friendica\Core\Logger\Util\Introspection::IGNORE_CLASS_LIST,
 183                 ],
 184         ],
 185         Cache\Capability\ICanCache::class => [
 186                 'instanceOf' => Cache\Factory\Cache::class,
 187                 'call'       => [
 188                         ['createLocal', [], Dice::CHAIN_CALL],
 189                 ],
 190         ],
 191         Cache\Capability\ICanCacheInMemory::class => [
 192                 'instanceOf' => Cache\Factory\Cache::class,
 193                 'call'       => [
 194                         ['createLocal', [], Dice::CHAIN_CALL],
 195                 ],
 196         ],
 197         Lock\Capability\ICanLock::class => [
 198                 'instanceOf' => Lock\Factory\Lock::class,
 199                 'call'       => [
 200                         ['create', [], Dice::CHAIN_CALL],
 201                 ],
 202         ],
 203         App\Arguments::class => [
 204                 'instanceOf' => App\Arguments::class,
 205                 'call' => [
 206                         ['determine', [$_SERVER, $_GET], Dice::CHAIN_CALL],
 207                 ],
 208         ],
 209         \Friendica\Core\System::class => [
 210                 'constructParams' => [
 211                         [Dice::INSTANCE => '$basepath'],
 212                 ],
 213         ],
 214         App\Router::class => [
 215                 'constructParams' => [
 216                         $_SERVER,
 217                         __DIR__ . '/routes.config.php',
 218                         [Dice::INSTANCE => Dice::SELF],
 219                         null
 220                 ],
 221         ],
 222         L10n::class => [
 223                 'constructParams' => [
 224                         $_SERVER, $_GET
 225                 ],
 226         ],
 227         IHandleSessions::class => [
 228                 'instanceOf' => \Friendica\Core\Session\Factory\Session::class,
 229                 'call' => [
 230                         ['createSession', [$_SERVER], Dice::CHAIN_CALL],
 231                         ['start', [], Dice::CHAIN_CALL],
 232                 ],
 233         ],
 234         IHandleUserSessions::class => [
 235                 'instanceOf' => \Friendica\Core\Session\Model\UserSession::class,
 236         ],
 237         Cookie::class => [
 238                 'constructParams' => [
 239                         $_COOKIE
 240                 ],
 241         ],
 242         ICanWriteToStorage::class => [
 243                 'instanceOf' => StorageManager::class,
 244                 'call' => [
 245                         ['getBackend', [], Dice::CHAIN_CALL],
 246                 ],
 247         ],
 248         Network\HTTPClient\Capability\ICanSendHttpRequests::class => [
 249                 'instanceOf' => Network\HTTPClient\Factory\HttpClient::class,
 250                 'call'       => [
 251                         ['createClient', [], Dice::CHAIN_CALL],
 252                 ],
 253         ],
 254         Factory\Api\Mastodon\Error::class => [
 255                 'constructParams' => [
 256                         $_SERVER
 257                 ],
 258         ],
 259         ParsedLogIterator::class => [
 260                 'constructParams' => [
 261                         [Dice::INSTANCE => Util\ReversedFileReader::class],
 262                 ]
 263         ],
 264         \Friendica\Core\Worker\Repository\Process::class => [
 265                 'constructParams' => [
 266                         $_SERVER
 267                 ],
 268         ],
 269         App\Request::class => [
 270                 'constructParams' => [
 271                         $_SERVER
 272                 ],
 273         ],
 274         \Psr\Clock\ClockInterface::class => [
 275                 'instanceOf' => Util\Clock\SystemClock::class
 276         ],
 277         \Friendica\Module\Special\HTTPException::class => [
 278                 'constructParams' => [
 279                         $_SERVER
 280                 ],
 281         ],
 282 ];