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     $verSuffixCaches = ['metadata'];
 172     $verSuffix = '_' . preg_replace(';[^0-9a-z_];', '_', \CRM_Utils_System::version());
 173     foreach ($basicCaches as $cacheSvc => $cacheGrp) {
 174       $definitionParams = [
 175         'name' => $cacheGrp . (in_array($cacheGrp, $verSuffixCaches) ? $verSuffix : ''),
 176         'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 177       ];
 178       // For Caches that we don't really care about the ttl for and/or maybe accessed
 179       // fairly often we use the fastArrayDecorator which improves reads and writes, these
 180       // caches should also not have concurrency risk.
 181       $fastArrayCaches = ['groups', 'navigation', 'customData', 'fields', 'contactTypes', 'metadata'];
 182       if (in_array($cacheSvc, $fastArrayCaches)) {
 183         $definitionParams['withArray'] = 'fast';
 184       }
 185       $container->setDefinition("cache.{$cacheSvc}", new Definition(
 186         'CRM_Utils_Cache_Interface',
 187         [$definitionParams]
 188       ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 189     }
 190
 191     // PrevNextCache cannot use memory or array cache at the moment because the
 192     // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed.
 193     $container->setDefinition("cache.prevNextCache", new Definition(
 194       'CRM_Utils_Cache_Interface',
 195       [
 196         [
 197           'name' => 'CiviCRM Search PrevNextCache',
 198           'type' => ['SqlGroup'],
 199         ],
 200       ]
 201     ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 202
 203     // Memcache is limited to 1 MB by default, and since this is not read often
 204     // it does not make much sense in Redis either.
 205     $container->setDefinition('cache.extension_browser', new Definition(
 206       'CRM_Utils_Cache_Interface',
 207       [
 208         [
 209           'name' => 'extension_browser',
 210           'type' => ['SqlGroup', 'ArrayCache'],
 211         ],
 212       ]
 213     ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 214
 215     $container->setDefinition('sql_triggers', new Definition(
 216       'Civi\Core\SqlTriggers',
 217       []
 218     ))->setPublic(TRUE);
 219
 220     $container->setDefinition('asset_builder', new Definition(
 221       'Civi\Core\AssetBuilder',
 222       []
 223     ))->setPublic(TRUE);
 224
 225     $container->setDefinition('themes', new Definition(
 226       'Civi\Core\Themes',
 227       []
 228     ))->setPublic(TRUE);
 229
 230     $container->setDefinition('format', new Definition(
 231       '\Civi\Core\Format',
 232       []
 233     ))->setPublic(TRUE);
 234
 235     $container->setDefinition('bundle.bootstrap3', new Definition('CRM_Core_Resources_Bundle', ['bootstrap3']))
 236       ->setFactory('CRM_Core_Resources_Common::createBootstrap3Bundle')->setPublic(TRUE);
 237
 238     $container->setDefinition('bundle.coreStyles', new Definition('CRM_Core_Resources_Bundle', ['coreStyles']))
 239       ->setFactory('CRM_Core_Resources_Common::createStyleBundle')->setPublic(TRUE);
 240
 241     $container->setDefinition('bundle.coreResources', new Definition('CRM_Core_Resources_Bundle', ['coreResources']))
 242       ->setFactory('CRM_Core_Resources_Common::createFullBundle')->setPublic(TRUE);
 243
 244     $container->setDefinition('pear_mail', new Definition('Mail'))
 245       ->setFactory('CRM_Utils_Mail::createMailer')->setPublic(TRUE);
 246
 247     $container->setDefinition('crypto.registry', new Definition('Civi\Crypto\CryptoRegistry'))
 248       ->setFactory('Civi\Crypto\CryptoRegistry::createDefaultRegistry')->setPublic(TRUE);
 249
 250     $container->setDefinition('crypto.token', new Definition('Civi\Crypto\CryptoToken', []))
 251       ->setPublic(TRUE);
 252
 253     $container->setDefinition('crypto.jwt', new Definition('Civi\Crypto\CryptoJwt', []))
 254       ->setPublic(TRUE);
 255
 256     if (empty(\Civi::$statics[__CLASS__]['boot'])) {
 257       throw new \RuntimeException('Cannot initialize container. Boot services are undefined.');
 258     }
 259     foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) {
 260       $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE)->setPublic(TRUE);
 261     }
 262
 263     // Expose legacy singletons as services in the container.
 264     $singletons = [
 265       'httpClient' => 'CRM_Utils_HttpClient',
 266       'cache.default' => 'CRM_Utils_Cache',
 267       'i18n' => 'CRM_Core_I18n',
 268       // Maybe? 'config' => 'CRM_Core_Config',
 269       // Maybe? 'smarty' => 'CRM_Core_Smarty',
 270     ];
 271     foreach ($singletons as $name => $class) {
 272       $container->setDefinition($name, new Definition(
 273         $class
 274       ))
 275         ->setFactory([$class, 'singleton'])->setPublic(TRUE);
 276     }
 277     $container->setAlias('cache.short', 'cache.default')->setPublic(TRUE);
 278
 279     $container->setDefinition('civi.pipe', new Definition(
 280       'Civi\Pipe\PipeSession',
 281       []
 282     ))->setPublic(TRUE)->setShared(FALSE);
 283
 284     $container->setDefinition('resources', new Definition(
 285       'CRM_Core_Resources',
 286       [new Reference('service_container')]
 287     ))->setFactory([new Reference(self::SELF), 'createResources'])->setPublic(TRUE);
 288
 289     $container->setDefinition('resources.js_strings', new Definition(
 290       'CRM_Core_Resources_Strings',
 291       [new Reference('cache.js_strings')]
 292     ))->setPublic(TRUE);
 293
 294     $container->setDefinition('prevnext', new Definition(
 295       'CRM_Core_PrevNextCache_Interface',
 296       [new Reference('service_container')]
 297     ))->setFactory([new Reference(self::SELF), 'createPrevNextCache'])->setPublic(TRUE);
 298
 299     $container->setDefinition('prevnext.driver.sql', new Definition(
 300       'CRM_Core_PrevNextCache_Sql',
 301       []
 302     ))->setPublic(TRUE);
 303
 304     $container->setDefinition('prevnext.driver.redis', new Definition(
 305       'CRM_Core_PrevNextCache_Redis',
 306       [new Reference('cache_config')]
 307     ))->setPublic(TRUE);
 308
 309     $container->setDefinition('cache_config', new Definition('ArrayObject'))
 310       ->setFactory([new Reference(self::SELF), 'createCacheConfig'])->setPublic(TRUE);
 311
 312     $container->setDefinition('civi.activity.triggers', new Definition(
 313       'Civi\Core\SqlTrigger\TimestampTriggers',
 314       ['civicrm_activity', 'Activity']
 315     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 316
 317     $container->setDefinition('civi.case.triggers', new Definition(
 318       'Civi\Core\SqlTrigger\TimestampTriggers',
 319       ['civicrm_case', 'Case']
 320     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 321
 322     $container->setDefinition('civi.case.staticTriggers', new Definition(
 323       'Civi\Core\SqlTrigger\StaticTriggers',
 324       [
 325         [
 326           [
 327             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 328             'table' => 'civicrm_case_activity',
 329             'when' => 'AFTER',
 330             'event' => ['INSERT'],
 331             'sql' => "UPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;",
 332           ],
 333           [
 334             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 335             'table' => 'civicrm_activity',
 336             'when' => 'BEFORE',
 337             'event' => ['UPDATE', 'DELETE'],
 338             'sql' => "UPDATE 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);",
 339           ],
 340         ],
 341       ]
 342     ))
 343       ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 344
 345     $container->setDefinition('civi_token_compat', new Definition(
 346       'Civi\Token\TokenCompatSubscriber',
 347       []
 348     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 349     $container->setDefinition("crm_mailing_action_tokens", new Definition(
 350       'CRM_Mailing_ActionTokens',
 351       []
 352     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 353
 354     foreach (['Activity', 'Contact', 'Contribute', 'Event', 'Mailing', 'Member', 'Case'] as $comp) {
 355       $container->setDefinition('crm_' . strtolower($comp) . '_tokens', new Definition(
 356         "CRM_{$comp}_Tokens",
 357         []
 358       ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 359     }
 360     $container->setDefinition('civi_token_impliedcontext', new Definition(
 361       'Civi\Token\ImpliedContextSubscriber',
 362       []
 363     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 364     $container->setDefinition('crm_participant_tokens', new Definition(
 365       'CRM_Event_ParticipantTokens',
 366       []
 367     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 368     $container->setDefinition('crm_contribution_recur_tokens', new Definition(
 369       'CRM_Contribute_RecurTokens',
 370       []
 371     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 372     $container->setDefinition('crm_domain_tokens', new Definition(
 373       'CRM_Core_DomainTokens',
 374       []
 375     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 376
 377     $dispatcherDefn = $container->getDefinition('dispatcher');
 378     foreach (\CRM_Core_DAO_AllCoreTables::getBaoClasses() as $baoEntity => $baoClass) {
 379       $listenerMap = EventScanner::findListeners($baoClass, $baoEntity);
 380       if ($listenerMap) {
 381         $file = (new \ReflectionClass($baoClass))->getFileName();
 382         $container->addResource(new \Symfony\Component\Config\Resource\FileResource($file));
 383         $dispatcherDefn->addMethodCall('addListenerMap', [$baoClass, $listenerMap]);
 384       }
 385     }
 386
 387     \CRM_Api4_Services::hook_container($container);
 388
 389     \CRM_Utils_Hook::container($container);
 390
 391     return $container;
 392   }
 393
 394   /**
 395    * @return \Civi\Angular\Manager
 396    */
 397   public function createAngularManager() {
 398     return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton());
 399   }
 400
 401   /**
 402    * @return \Symfony\Component\EventDispatcher\EventDispatcher
 403    */
 404   public function createEventDispatcher() {
 405     // Continue building on the original dispatcher created during bootstrap.
 406     /** @var CiviEventDispatcher $dispatcher */
 407     $dispatcher = static::getBootService('dispatcher.boot');
 408
 409     // Sometimes, you have a generic event ('hook_pre') and wish to fire more targeted aliases ('hook_pre::MyEntity') to allow shorter subscriber lists.
 410     $aliasEvent = function($eventName, $fieldName) {
 411       return function($e) use ($eventName, $fieldName) {
 412         \Civi::dispatcher()->dispatch($eventName . "::" . $e->{$fieldName}, $e);
 413       };
 414     };
 415     $aliasMethodEvent = function($eventName, $methodName) {
 416       return function($e) use ($eventName, $methodName) {
 417         \Civi::dispatcher()->dispatch($eventName . "::" . $e->{$methodName}(), $e);
 418       };
 419     };
 420
 421     $dispatcher->addListener('civi.api4.validate', $aliasMethodEvent('civi.api4.validate', 'getEntityName'), 100);
 422     $dispatcher->addListener('civi.api4.authorizeRecord', $aliasMethodEvent('civi.api4.authorizeRecord', 'getEntityName'), 100);
 423     $dispatcher->addListener('civi.api4.entityTypes', ['\Civi\Api4\Provider\CustomEntityProvider', 'addCustomEntities'], 100);
 424
 425     $dispatcher->addListener('civi.core.install', ['\Civi\Core\InstallationCanary', 'check']);
 426     $dispatcher->addListener('civi.core.install', ['\Civi\Core\DatabaseInitializer', 'initialize']);
 427     $dispatcher->addListener('civi.core.install', ['\Civi\Core\LocalizationInitializer', 'initialize']);
 428     $dispatcher->addListener('hook_civicrm_post', ['\CRM_Core_Transaction', 'addPostCommit'], -1000);
 429     $dispatcher->addListener('hook_civicrm_pre', $aliasEvent('hook_civicrm_pre', 'entity'), 100);
 430     $dispatcher->addListener('civi.dao.preDelete', ['\CRM_Core_BAO_EntityTag', 'preDeleteOtherEntity']);
 431     $dispatcher->addListener('hook_civicrm_post', $aliasEvent('hook_civicrm_post', 'entity'), 100);
 432     $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
 433     $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
 434     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
 435     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
 436     $dispatcher->addListener('hook_civicrm_cryptoRotateKey', ['\Civi\Crypto\RotateKeys', 'rotateSmtp']);
 437     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
 438     // TODO We need a better code-convention for metadata about non-hook events.
 439     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
 440     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
 441     $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
 442     $dispatcher->addListenerService('civi.region.render', ['angularjs.loader', 'onRegionRender']);
 443     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
 444     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
 445     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
 446     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderL10nJs']);
 447     $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
 448     $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
 449     $dispatcher->addListener('hook_civicrm_alterExternUrl', ['\CRM_Utils_System', 'migrateExternUrl'], 1000);
 450     // Not a BAO class so it can't implement hookInterface
 451     $dispatcher->addListener('hook_civicrm_post', ['CRM_Utils_Recent', 'on_hook_civicrm_post']);
 452     $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findConstPermissions'], 975);
 453     $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findCiviPermissions'], 950);
 454     $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findCmsPermissions'], 925);
 455
 456     $dispatcher->addListener('hook_civicrm_postSave_civicrm_domain', ['\CRM_Core_BAO_Domain', 'onPostSave']);
 457     $dispatcher->addListener('hook_civicrm_unhandled_exception', [
 458       'CRM_Core_LegacyErrorHandler',
 459       'handleException',
 460     ], -200);
 461     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
 462     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
 463     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
 464     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
 465     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
 466     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
 467
 468     return $dispatcher;
 469   }
 470
 471   /**
 472    * @return \Civi\Core\Lock\LockManager
 473    */
 474   public static function createLockManager() {
 475     // Ideally, downstream implementers could override any definitions in
 476     // the container. For now, we'll make-do with some define()s.
 477     $lm = new LockManager();
 478     $lm
 479       ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 480       ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 481       ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createCivimailLock'])
 482       ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createScopedLock']);
 483
 484     // Registrations may use complex resolver expressions, but (as a micro-optimization)
 485     // the default factory is specified as an array.
 486
 487     return $lm;
 488   }
 489
 490   /**
 491    * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 492    * @param $magicFunctionProvider
 493    *
 494    * @return \Civi\API\Kernel
 495    */
 496   public function createApiKernel($dispatcher, $magicFunctionProvider) {
 497     $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
 498     $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
 499     $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
 500     $dispatcher->addSubscriber($magicFunctionProvider);
 501     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 502     $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
 503     $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter([
 504       \CRM_Utils_API_HTMLInputCoder::singleton(),
 505       \CRM_Utils_API_NullOutputCoder::singleton(),
 506       \CRM_Utils_API_ReloadOption::singleton(),
 507       \CRM_Utils_API_MatchOption::singleton(),
 508     ]));
 509     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DebugSubscriber());
 510     $kernel = new \Civi\API\Kernel($dispatcher);
 511
 512     $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
 513     $dispatcher->addSubscriber($reflectionProvider);
 514
 515     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
 516       $kernel,
 517       'Attachment',
 518       ['create', 'get', 'delete'],
 519       // Given a file ID, determine the entity+table it's attached to.
 520       'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
 521          FROM civicrm_file cf
 522          LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
 523          WHERE cf.id = %1',
 524       // Get a list of custom fields (field_name,table_name,extends)
 525       'SELECT concat("custom_",fld.id) as field_name,
 526         grp.table_name as table_name,
 527         grp.extends as extends
 528        FROM civicrm_custom_field fld
 529        INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
 530        WHERE fld.data_type = "File"
 531       '
 532     ));
 533
 534     $kernel->setApiProviders([
 535       $reflectionProvider,
 536       $magicFunctionProvider,
 537     ]);
 538
 539     return $kernel;
 540   }
 541
 542   /**
 543    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 544    * @return \CRM_Core_Resources
 545    */
 546   public static function createResources($container) {
 547     $sys = \CRM_Extension_System::singleton();
 548     return new \CRM_Core_Resources(
 549       $sys->getMapper(),
 550       new \CRM_Core_Resources_Strings($container->get('cache.js_strings')),
 551       \CRM_Core_Config::isUpgradeMode() ? NULL : 'resCacheCode'
 552     );
 553   }
 554
 555   /**
 556    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 557    * @return \CRM_Core_PrevNextCache_Interface
 558    */
 559   public static function createPrevNextCache($container) {
 560     $setting = \Civi::settings()->get('prevNextBackend');
 561     if (!$setting || $setting === 'default') {
 562       $cacheDriver = \CRM_Utils_Cache::getCacheDriver();
 563       $service = 'prevnext.driver.' . strtolower($cacheDriver);
 564       return $container->has($service)
 565         ? $container->get($service)
 566         : $container->get('prevnext.driver.sql');
 567     }
 568     return $container->get('prevnext.driver.' . $setting);
 569   }
 570
 571   /**
 572    * @return \ArrayObject
 573    */
 574   public static function createCacheConfig() {
 575     $driver = \CRM_Utils_Cache::getCacheDriver();
 576     $settings = \CRM_Utils_Cache::getCacheSettings($driver);
 577     $settings['driver'] = $driver;
 578     return new \ArrayObject($settings);
 579   }
 580
 581   /**
 582    * Get a list of boot services.
 583    *
 584    * These are services which must be setup *before* the container can operate.
 585    *
 586    * @param bool $loadFromDB
 587    * @throws \CRM_Core_Exception
 588    */
 589   public static function boot($loadFromDB) {
 590     // Array(string $serviceId => object $serviceInstance).
 591     $bootServices = [];
 592     \Civi::$statics[__CLASS__]['boot'] = &$bootServices;
 593
 594     $bootServices['runtime'] = $runtime = new \CRM_Core_Config_Runtime();
 595     $runtime->initialize($loadFromDB);
 596
 597     $bootServices['paths'] = new \Civi\Core\Paths();
 598
 599     $bootServices['dispatcher.boot'] = new CiviEventDispatcher();
 600     $bootServices['dispatcher.boot']->addListener('civi.queue.runTask.start', ['CRM_Upgrade_DispatchPolicy', 'onRunTask']);
 601
 602     // Quality control: There should be no pre-boot hooks because they make it harder to understand/support/refactor.
 603     // If a pre-boot hook sneaks in, we'll raise an error.
 604     $bootDispatchPolicy = [
 605       '/^hook_/' => 'not-ready',
 606       '/^civi\./' => 'run',
 607     ];
 608     $bootServices['dispatcher.boot']->setDispatchPolicy($bootDispatchPolicy);
 609
 610     $class = $runtime->userFrameworkClass;
 611     $bootServices['userSystem'] = $userSystem = new $class();
 612     $userSystem->initialize();
 613
 614     $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework;
 615     $bootServices['userPermissionClass'] = new $userPermissionClass();
 616
 617     $bootServices['cache.settings'] = \CRM_Utils_Cache::create([
 618       'name' => 'settings',
 619       'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 620     ]);
 621
 622     $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']);
 623
 624     $bootServices['lockManager'] = self::createLockManager();
 625
 626     if ($loadFromDB && $runtime->dsn) {
 627       \CRM_Core_DAO::init($runtime->dsn);
 628       \CRM_Utils_Hook::singleton(TRUE);
 629       \CRM_Extension_System::singleton(TRUE);
 630       \CRM_Extension_System::singleton()->getClassLoader()->register();
 631       \CRM_Extension_System::singleton()->getMixinLoader()->run();
 632       \CRM_Utils_Hook::singleton()->commonBuildModuleList('civicrm_boot');
 633       $bootServices['dispatcher.boot']->setDispatchPolicy(\CRM_Core_Config::isUpgradeMode() ? \CRM_Upgrade_DispatchPolicy::pick() : NULL);
 634
 635       $runtime->includeCustomPath();
 636
 637       $c = new self();
 638       $container = $c->loadContainer();
 639       foreach ($bootServices as $name => $obj) {
 640         $container->set($name, $obj);
 641       }
 642       \Civi::$statics[__CLASS__]['container'] = $container;
 643       // Ensure all container-based serivces have a chance to add their listeners.
 644       // Without this, it's a matter of happenstance (dependent upon particular page-request/configuration/etc).
 645       $container->get('dispatcher');
 646
 647     }
 648     else {
 649       $bootServices['dispatcher.boot']->setDispatchPolicy(\CRM_Core_Config::isUpgradeMode() ? \CRM_Upgrade_DispatchPolicy::pick() : NULL);
 650     }
 651   }
 652
 653   /**
 654    * @param string $name
 655    *
 656    * @return mixed
 657    */
 658   public static function getBootService($name) {
 659     return \Civi::$statics[__CLASS__]['boot'][$name];
 660   }
 661
 662   /**
 663    * Determine whether the container services are available.
 664    *
 665    * @return bool
 666    */
 667   public static function isContainerBooted() {
 668     return isset(\Civi::$statics[__CLASS__]['container']);
 669   }
 670
 671 }