Civi/Core/Container.php

   1 <?php
   2 namespace Civi\Core;
   3
   4 use Civi\Core\Event\EventScanner;
   5 use Civi\Core\Lock\LockManager;
   6 use Symfony\Component\Config\ConfigCache;
   7 use Symfony\Component\DependencyInjection\ContainerBuilder;
   8 use Symfony\Component\DependencyInjection\Definition;
   9 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
  10 use Symfony\Component\DependencyInjection\Reference;
  11 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
  12
  13 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  14
  15 /**
  16  * Class Container
  17  * @package Civi\Core
  18  */
  19 class Container {
  20
  21   const SELF = 'civi_container_factory';
  22
  23   /**
  24    * @param bool $reset
  25    *   Whether to forcibly rebuild the entire container.
  26    * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
  27    */
  28   public static function singleton($reset = FALSE) {
  29     if ($reset || !isset(\Civi::$statics[__CLASS__]['container'])) {
  30       self::boot(TRUE);
  31     }
  32     return \Civi::$statics[__CLASS__]['container'];
  33   }
  34
  35   /**
  36    * Find a cached container definition or construct a new one.
  37    *
  38    * There are many weird contexts in which Civi initializes (eg different
  39    * variations of multitenancy and different permutations of CMS/CRM bootstrap),
  40    * and hook_container may fire a bit differently in each context. To mitigate
  41    * risk of leaks between environments, we compute a unique envID
  42    * (md5(DB_NAME, HTTP_HOST, SCRIPT_FILENAME, etc)) and use separate caches for
  43    * each (eg "templates_c/CachedCiviContainer.$ENVID.php").
  44    *
  45    * Constants:
  46    *   - CIVICRM_CONTAINER_CACHE -- 'always' [default], 'never', 'auto'
  47    *   - CIVICRM_DSN
  48    *   - CIVICRM_DOMAIN_ID
  49    *
  50    * @return \Symfony\Component\DependencyInjection\ContainerInterface
  51    */
  52   public function loadContainer() {
  53     // Note: The container's raison d'etre is to manage construction of other
  54     // services. Consequently, we assume a minimal service available -- the classloader
  55     // has been setup, and civicrm.settings.php is loaded, but nothing else works.
  56
  57     $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE : 'auto';
  58
  59     // In pre-installation environments, don't bother with caching.
  60     if (!defined('CIVICRM_DSN') || defined('CIVICRM_TEST') || CIVICRM_UF === 'UnitTests' || $cacheMode === 'never' || \CRM_Utils_System::isInUpgradeMode()) {
  61       $containerBuilder = $this->createContainer();
  62       $containerBuilder->compile();
  63       return $containerBuilder;
  64     }
  65
  66     $envId = \CRM_Core_Config_Runtime::getId();
  67     $file = \Civi::paths()->getPath("[civicrm.compile]/CachedCiviContainer.{$envId}.php");
  68     $containerConfigCache = new ConfigCache($file, $cacheMode === 'auto');
  69     if (!$containerConfigCache->isFresh()) {
  70       $containerBuilder = $this->createContainer();
  71       $containerBuilder->compile();
  72       $dumper = new PhpDumper($containerBuilder);
  73       $containerConfigCache->write(
  74         $dumper->dump(['class' => 'CachedCiviContainer']),
  75         $containerBuilder->getResources()
  76       );
  77     }
  78
  79     require_once $file;
  80     $c = new \CachedCiviContainer();
  81     return $c;
  82   }
  83
  84   /**
  85    * Construct a new container.
  86    *
  87    * @var \Symfony\Component\DependencyInjection\ContainerBuilder
  88    * @return \Symfony\Component\DependencyInjection\ContainerBuilder
  89    */
  90   public function createContainer() {
  91     $civicrm_base_path = dirname(dirname(__DIR__));
  92     $container = new ContainerBuilder();
  93     $container->addCompilerPass(new RegisterListenersPass('dispatcher'));
  94     $container->addObjectResource($this);
  95     $container->setParameter('civicrm_base_path', $civicrm_base_path);
  96     //$container->set(self::SELF, $this);
  97
  98     $container->addResource(new \Symfony\Component\Config\Resource\FileResource(__FILE__));
  99
 100     $container->setDefinition(self::SELF, new Definition(
 101       'Civi\Core\Container',
 102       []
 103     ));
 104
 105     // TODO Move configuration to an external file; define caching structure
 106     //    if (empty($configDirectories)) {
 107     //      throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)');
 108     //    }
 109     //    $locator = new FileLocator($configDirectories);
 110     //    $loaderResolver = new LoaderResolver(array(
 111     //      new YamlFileLoader($container, $locator)
 112     //    ));
 113     //    $delegatingLoader = new DelegatingLoader($loaderResolver);
 114     //    foreach (array('services.yml') as $file) {
 115     //      $yamlUserFiles = $locator->locate($file, NULL, FALSE);
 116     //      foreach ($yamlUserFiles as $file) {
 117     //        $delegatingLoader->load($file);
 118     //      }
 119     //    }
 120
 121     $container->setDefinition('angular', new Definition(
 122       'Civi\Angular\Manager',
 123       []
 124     ))
 125       ->setFactory([new Reference(self::SELF), 'createAngularManager'])->setPublic(TRUE);
 126
 127     $container->setDefinition('angularjs.loader', new Definition('Civi\Angular\AngularLoader', []))
 128       ->setPublic(TRUE);
 129
 130     $container->setDefinition('dispatcher', new Definition(
 131       'Civi\Core\CiviEventDispatcher',
 132       []
 133     ))
 134       ->setFactory([new Reference(self::SELF), 'createEventDispatcher'])->setPublic(TRUE);
 135
 136     $container->setDefinition('magic_function_provider', new Definition(
 137       'Civi\API\Provider\MagicFunctionProvider',
 138       []
 139     ))->setPublic(TRUE);
 140
 141     $container->setDefinition('civi_api_kernel', new Definition(
 142       'Civi\API\Kernel',
 143       [new Reference('dispatcher'), new Reference('magic_function_provider')]
 144     ))
 145       ->setFactory([new Reference(self::SELF), 'createApiKernel'])->setPublic(TRUE);
 146
 147     $container->setDefinition('cxn_reg_client', new Definition(
 148       'Civi\Cxn\Rpc\RegistrationClient',
 149       []
 150     ))
 151       ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient')->setPublic(TRUE);
 152
 153     $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', []))->setPublic(TRUE);
 154     $container->setDefinition('psr_log_manager', new Definition('Civi\Core\LogManager', []))->setPublic(TRUE);
 155     // With the default log-manager, you may overload a channel by defining a service, e.g.
 156     // $container->setDefinition('log.ipn', new Definition('CRM_Core_Error_Log', []))->setPublic(TRUE);
 157
 158     $basicCaches = [
 159       'js_strings' => 'js_strings',
 160       'community_messages' => 'community_messages',
 161       'checks' => 'checks',
 162       'session' => 'CiviCRM Session',
 163       'long' => 'long',
 164       'groups' => 'contact groups',
 165       'navigation' => 'navigation',
 166       'customData' => 'custom data',
 167       'fields' => 'contact fields',
 168       'contactTypes' => 'contactTypes',
 169       'metadata' => 'metadata',
 170     ];
 171     foreach ($basicCaches as $cacheSvc => $cacheGrp) {
 172       $definitionParams = [
 173         'name' => $cacheGrp,
 174         'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 175       ];
 176       // For Caches that we don't really care about the ttl for and/or maybe accessed
 177       // fairly often we use the fastArrayDecorator which improves reads and writes, these
 178       // caches should also not have concurrency risk.
 179       $fastArrayCaches = ['groups', 'navigation', 'customData', 'fields', 'contactTypes', 'metadata'];
 180       if (in_array($cacheSvc, $fastArrayCaches)) {
 181         $definitionParams['withArray'] = 'fast';
 182       }
 183       $container->setDefinition("cache.{$cacheSvc}", new Definition(
 184         'CRM_Utils_Cache_Interface',
 185         [$definitionParams]
 186       ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 187     }
 188
 189     // PrevNextCache cannot use memory or array cache at the moment because the
 190     // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed.
 191     $container->setDefinition("cache.prevNextCache", new Definition(
 192       'CRM_Utils_Cache_Interface',
 193       [
 194         [
 195           'name' => 'CiviCRM Search PrevNextCache',
 196           'type' => ['SqlGroup'],
 197         ],
 198       ]
 199     ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 200
 201     $container->setDefinition('sql_triggers', new Definition(
 202       'Civi\Core\SqlTriggers',
 203       []
 204     ))->setPublic(TRUE);
 205
 206     $container->setDefinition('asset_builder', new Definition(
 207       'Civi\Core\AssetBuilder',
 208       []
 209     ))->setPublic(TRUE);
 210
 211     $container->setDefinition('themes', new Definition(
 212       'Civi\Core\Themes',
 213       []
 214     ))->setPublic(TRUE);
 215
 216     $container->setDefinition('bundle.bootstrap3', new Definition('CRM_Core_Resources_Bundle', ['bootstrap3']))
 217       ->setFactory('CRM_Core_Resources_Common::createBootstrap3Bundle')->setPublic(TRUE);
 218
 219     $container->setDefinition('bundle.coreStyles', new Definition('CRM_Core_Resources_Bundle', ['coreStyles']))
 220       ->setFactory('CRM_Core_Resources_Common::createStyleBundle')->setPublic(TRUE);
 221
 222     $container->setDefinition('bundle.coreResources', new Definition('CRM_Core_Resources_Bundle', ['coreResources']))
 223       ->setFactory('CRM_Core_Resources_Common::createFullBundle')->setPublic(TRUE);
 224
 225     $container->setDefinition('pear_mail', new Definition('Mail'))
 226       ->setFactory('CRM_Utils_Mail::createMailer')->setPublic(TRUE);
 227
 228     $container->setDefinition('crypto.registry', new Definition('Civi\Crypto\CryptoService'))
 229       ->setFactory('Civi\Crypto\CryptoRegistry::createDefaultRegistry')->setPublic(TRUE);
 230
 231     $container->setDefinition('crypto.token', new Definition('Civi\Crypto\CryptoToken', []))
 232       ->setPublic(TRUE);
 233
 234     $container->setDefinition('crypto.jwt', new Definition('Civi\Crypto\CryptoJwt', []))
 235       ->setPublic(TRUE);
 236
 237     if (empty(\Civi::$statics[__CLASS__]['boot'])) {
 238       throw new \RuntimeException('Cannot initialize container. Boot services are undefined.');
 239     }
 240     foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) {
 241       $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE)->setPublic(TRUE);
 242     }
 243
 244     // Expose legacy singletons as services in the container.
 245     $singletons = [
 246       'httpClient' => 'CRM_Utils_HttpClient',
 247       'cache.default' => 'CRM_Utils_Cache',
 248       'i18n' => 'CRM_Core_I18n',
 249       // Maybe? 'config' => 'CRM_Core_Config',
 250       // Maybe? 'smarty' => 'CRM_Core_Smarty',
 251     ];
 252     foreach ($singletons as $name => $class) {
 253       $container->setDefinition($name, new Definition(
 254         $class
 255       ))
 256         ->setFactory([$class, 'singleton'])->setPublic(TRUE);
 257     }
 258     $container->setAlias('cache.short', 'cache.default')->setPublic(TRUE);
 259
 260     $container->setDefinition('resources', new Definition(
 261       'CRM_Core_Resources',
 262       [new Reference('service_container')]
 263     ))->setFactory([new Reference(self::SELF), 'createResources'])->setPublic(TRUE);
 264
 265     $container->setDefinition('resources.js_strings', new Definition(
 266       'CRM_Core_Resources_Strings',
 267       [new Reference('cache.js_strings')]
 268     ))->setPublic(TRUE);
 269
 270     $container->setDefinition('prevnext', new Definition(
 271       'CRM_Core_PrevNextCache_Interface',
 272       [new Reference('service_container')]
 273     ))->setFactory([new Reference(self::SELF), 'createPrevNextCache'])->setPublic(TRUE);
 274
 275     $container->setDefinition('prevnext.driver.sql', new Definition(
 276       'CRM_Core_PrevNextCache_Sql',
 277       []
 278     ))->setPublic(TRUE);
 279
 280     $container->setDefinition('prevnext.driver.redis', new Definition(
 281       'CRM_Core_PrevNextCache_Redis',
 282       [new Reference('cache_config')]
 283     ))->setPublic(TRUE);
 284
 285     $container->setDefinition('cache_config', new Definition('ArrayObject'))
 286       ->setFactory([new Reference(self::SELF), 'createCacheConfig'])->setPublic(TRUE);
 287
 288     $container->setDefinition('civi.activity.triggers', new Definition(
 289       'Civi\Core\SqlTrigger\TimestampTriggers',
 290       ['civicrm_activity', 'Activity']
 291     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 292
 293     $container->setDefinition('civi.case.triggers', new Definition(
 294       'Civi\Core\SqlTrigger\TimestampTriggers',
 295       ['civicrm_case', 'Case']
 296     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 297
 298     $container->setDefinition('civi.case.staticTriggers', new Definition(
 299       'Civi\Core\SqlTrigger\StaticTriggers',
 300       [
 301         [
 302           [
 303             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 304             'table' => 'civicrm_case_activity',
 305             'when' => 'AFTER',
 306             'event' => ['INSERT'],
 307             'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
 308           ],
 309           [
 310             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 311             'table' => 'civicrm_activity',
 312             'when' => 'BEFORE',
 313             'event' => ['UPDATE', 'DELETE'],
 314             'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id IN (SELECT ca.case_id FROM civicrm_case_activity ca WHERE ca.activity_id = OLD.id);\n",
 315           ],
 316         ],
 317       ]
 318     ))
 319       ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 320
 321     $container->setDefinition('civi_token_compat', new Definition(
 322       'Civi\Token\TokenCompatSubscriber',
 323       []
 324     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 325     $container->setDefinition("crm_mailing_action_tokens", new Definition(
 326       "CRM_Mailing_ActionTokens",
 327       []
 328     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 329
 330     foreach (['Activity', 'Contribute', 'Event', 'Mailing', 'Member'] as $comp) {
 331       $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
 332         "CRM_{$comp}_Tokens",
 333         []
 334       ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 335     }
 336
 337     $dispatcherDefn = $container->getDefinition('dispatcher');
 338     foreach (\CRM_Core_DAO_AllCoreTables::getBaoClasses() as $baoEntity => $baoClass) {
 339       $listenerMap = EventScanner::findListeners($baoClass, $baoEntity);
 340       if ($listenerMap) {
 341         $file = (new \ReflectionClass($baoClass))->getFileName();
 342         $container->addResource(new \Symfony\Component\Config\Resource\FileResource($file));
 343         $dispatcherDefn->addMethodCall('addListenerMap', [$baoClass, $listenerMap]);
 344       }
 345     }
 346
 347     \CRM_Api4_Services::hook_container($container);
 348
 349     \CRM_Utils_Hook::container($container);
 350
 351     return $container;
 352   }
 353
 354   /**
 355    * @return \Civi\Angular\Manager
 356    */
 357   public function createAngularManager() {
 358     return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton());
 359   }
 360
 361   /**
 362    * @return \Symfony\Component\EventDispatcher\EventDispatcher
 363    */
 364   public function createEventDispatcher() {
 365     // Continue building on the original dispatcher created during bootstrap.
 366     /** @var CiviEventDispatcher $dispatcher */
 367     $dispatcher = static::getBootService('dispatcher.boot');
 368
 369     // Sometimes, you have a generic event ('hook_pre') and wish to fire more targeted aliases ('hook_pre::MyEntity') to allow shorter subscriber lists.
 370     $aliasEvent = function($eventName, $fieldName) {
 371       return function($e) use ($eventName, $fieldName) {
 372         \Civi::dispatcher()->dispatch($eventName . "::" . $e->{$fieldName}, $e);
 373       };
 374     };
 375     $aliasMethodEvent = function($eventName, $methodName) {
 376       return function($e) use ($eventName, $methodName) {
 377         \Civi::dispatcher()->dispatch($eventName . "::" . $e->{$methodName}(), $e);
 378       };
 379     };
 380
 381     $dispatcher->addListener('civi.api4.validate', $aliasMethodEvent('civi.api4.validate', 'getEntityName'), 100);
 382     $dispatcher->addListener('civi.api4.authorizeRecord', $aliasMethodEvent('civi.api4.authorizeRecord', 'getEntityName'), 100);
 383
 384     $dispatcher->addListener('civi.core.install', ['\Civi\Core\InstallationCanary', 'check']);
 385     $dispatcher->addListener('civi.core.install', ['\Civi\Core\DatabaseInitializer', 'initialize']);
 386     $dispatcher->addListener('civi.core.install', ['\Civi\Core\LocalizationInitializer', 'initialize']);
 387     $dispatcher->addListener('hook_civicrm_post', ['\CRM_Core_Transaction', 'addPostCommit'], -1000);
 388     $dispatcher->addListener('hook_civicrm_pre', $aliasEvent('hook_civicrm_pre', 'entity'), 100);
 389     $dispatcher->addListener('civi.dao.preDelete', ['\CRM_Core_BAO_EntityTag', 'preDeleteOtherEntity']);
 390     $dispatcher->addListener('hook_civicrm_post', $aliasEvent('hook_civicrm_post', 'entity'), 100);
 391     $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
 392     $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
 393     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
 394     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
 395     $dispatcher->addListener('hook_civicrm_cryptoRotateKey', ['\Civi\Crypto\RotateKeys', 'rotateSmtp']);
 396     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
 397     // TODO We need a better code-convention for metadata about non-hook events.
 398     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
 399     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
 400     $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
 401     $dispatcher->addListenerService('civi.region.render', ['angularjs.loader', 'onRegionRender']);
 402     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
 403     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
 404     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
 405     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderL10nJs']);
 406     $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
 407     $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
 408     $dispatcher->addListener('hook_civicrm_alterExternUrl', ['\CRM_Utils_System', 'migrateExternUrl'], 1000);
 409     $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findConstPermissions'], 975);
 410     $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findCiviPermissions'], 950);
 411     $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findCmsPermissions'], 925);
 412
 413     $dispatcher->addListener('hook_civicrm_postSave_civicrm_domain', ['\CRM_Core_BAO_Domain', 'onPostSave']);
 414     $dispatcher->addListener('hook_civicrm_unhandled_exception', [
 415       'CRM_Core_LegacyErrorHandler',
 416       'handleException',
 417     ], -200);
 418     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
 419     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
 420     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
 421     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
 422     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
 423     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
 424
 425     return $dispatcher;
 426   }
 427
 428   /**
 429    * @return \Civi\Core\Lock\LockManager
 430    */
 431   public static function createLockManager() {
 432     // Ideally, downstream implementers could override any definitions in
 433     // the container. For now, we'll make-do with some define()s.
 434     $lm = new LockManager();
 435     $lm
 436       ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 437       ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 438       ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createCivimailLock'])
 439       ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createScopedLock']);
 440
 441     // Registrations may use complex resolver expressions, but (as a micro-optimization)
 442     // the default factory is specified as an array.
 443
 444     return $lm;
 445   }
 446
 447   /**
 448    * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 449    * @param $magicFunctionProvider
 450    *
 451    * @return \Civi\API\Kernel
 452    */
 453   public function createApiKernel($dispatcher, $magicFunctionProvider) {
 454     $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
 455     $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
 456     $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
 457     $dispatcher->addSubscriber($magicFunctionProvider);
 458     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 459     $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
 460     $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter([
 461       \CRM_Utils_API_HTMLInputCoder::singleton(),
 462       \CRM_Utils_API_NullOutputCoder::singleton(),
 463       \CRM_Utils_API_ReloadOption::singleton(),
 464       \CRM_Utils_API_MatchOption::singleton(),
 465     ]));
 466     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DebugSubscriber());
 467     $kernel = new \Civi\API\Kernel($dispatcher);
 468
 469     $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
 470     $dispatcher->addSubscriber($reflectionProvider);
 471
 472     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
 473       $kernel,
 474       'Attachment',
 475       ['create', 'get', 'delete'],
 476       // Given a file ID, determine the entity+table it's attached to.
 477       'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
 478          FROM civicrm_file cf
 479          LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
 480          WHERE cf.id = %1',
 481       // Get a list of custom fields (field_name,table_name,extends)
 482       'SELECT concat("custom_",fld.id) as field_name,
 483         grp.table_name as table_name,
 484         grp.extends as extends
 485        FROM civicrm_custom_field fld
 486        INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
 487        WHERE fld.data_type = "File"
 488       '
 489     ));
 490
 491     $kernel->setApiProviders([
 492       $reflectionProvider,
 493       $magicFunctionProvider,
 494     ]);
 495
 496     return $kernel;
 497   }
 498
 499   /**
 500    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 501    * @return \CRM_Core_Resources
 502    */
 503   public static function createResources($container) {
 504     $sys = \CRM_Extension_System::singleton();
 505     return new \CRM_Core_Resources(
 506       $sys->getMapper(),
 507       new \CRM_Core_Resources_Strings($container->get('cache.js_strings')),
 508       \CRM_Core_Config::isUpgradeMode() ? NULL : 'resCacheCode'
 509     );
 510   }
 511
 512   /**
 513    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 514    * @return \CRM_Core_PrevNextCache_Interface
 515    */
 516   public static function createPrevNextCache($container) {
 517     $setting = \Civi::settings()->get('prevNextBackend');
 518     if (!$setting || $setting === 'default') {
 519       $cacheDriver = \CRM_Utils_Cache::getCacheDriver();
 520       $service = 'prevnext.driver.' . strtolower($cacheDriver);
 521       return $container->has($service)
 522         ? $container->get($service)
 523         : $container->get('prevnext.driver.sql');
 524     }
 525     return $container->get('prevnext.driver.' . $setting);
 526   }
 527
 528   /**
 529    * @return \ArrayObject
 530    */
 531   public static function createCacheConfig() {
 532     $driver = \CRM_Utils_Cache::getCacheDriver();
 533     $settings = \CRM_Utils_Cache::getCacheSettings($driver);
 534     $settings['driver'] = $driver;
 535     return new \ArrayObject($settings);
 536   }
 537
 538   /**
 539    * Get a list of boot services.
 540    *
 541    * These are services which must be setup *before* the container can operate.
 542    *
 543    * @param bool $loadFromDB
 544    * @throws \CRM_Core_Exception
 545    */
 546   public static function boot($loadFromDB) {
 547     // Array(string $serviceId => object $serviceInstance).
 548     $bootServices = [];
 549     \Civi::$statics[__CLASS__]['boot'] = &$bootServices;
 550
 551     $bootServices['runtime'] = $runtime = new \CRM_Core_Config_Runtime();
 552     $runtime->initialize($loadFromDB);
 553
 554     $bootServices['paths'] = new \Civi\Core\Paths();
 555
 556     $bootServices['dispatcher.boot'] = new CiviEventDispatcher();
 557
 558     // Quality control: There should be no pre-boot hooks because they make it harder to understand/support/refactor.
 559     // If a pre-boot hook sneaks in, we'll raise an error.
 560     $bootDispatchPolicy = [
 561       '/^hook_/' => 'not-ready',
 562       '/^civi\./' => 'run',
 563     ];
 564     $mainDispatchPolicy = \CRM_Core_Config::isUpgradeMode() ? \CRM_Upgrade_DispatchPolicy::get('upgrade.main') : NULL;
 565     $bootServices['dispatcher.boot']->setDispatchPolicy($bootDispatchPolicy);
 566
 567     $class = $runtime->userFrameworkClass;
 568     $bootServices['userSystem'] = $userSystem = new $class();
 569     $userSystem->initialize();
 570
 571     $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework;
 572     $bootServices['userPermissionClass'] = new $userPermissionClass();
 573
 574     $bootServices['cache.settings'] = \CRM_Utils_Cache::create([
 575       'name' => 'settings',
 576       'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 577     ]);
 578
 579     $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']);
 580
 581     $bootServices['lockManager'] = self::createLockManager();
 582
 583     if ($loadFromDB && $runtime->dsn) {
 584       \CRM_Core_DAO::init($runtime->dsn);
 585       \CRM_Utils_Hook::singleton(TRUE);
 586       \CRM_Extension_System::singleton(TRUE);
 587       \CRM_Extension_System::singleton(TRUE)->getClassLoader()->register();
 588       $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy);
 589
 590       $runtime->includeCustomPath();
 591
 592       $c = new self();
 593       $container = $c->loadContainer();
 594       foreach ($bootServices as $name => $obj) {
 595         $container->set($name, $obj);
 596       }
 597       \Civi::$statics[__CLASS__]['container'] = $container;
 598       // Ensure all container-based serivces have a chance to add their listeners.
 599       // Without this, it's a matter of happenstance (dependent upon particular page-request/configuration/etc).
 600       $container->get('dispatcher');
 601
 602     }
 603     else {
 604       $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy);
 605     }
 606   }
 607
 608   /**
 609    * @param string $name
 610    *
 611    * @return mixed
 612    */
 613   public static function getBootService($name) {
 614     return \Civi::$statics[__CLASS__]['boot'][$name];
 615   }
 616
 617   /**
 618    * Determine whether the container services are available.
 619    *
 620    * @return bool
 621    */
 622   public static function isContainerBooted() {
 623     return isset(\Civi::$statics[__CLASS__]['container']);
 624   }
 625
 626 }