Civi/Core/Container.php

   1 <?php
   2 namespace Civi\Core;
   3
   4 use Civi\Core\Event\SystemInstallEvent;
   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    *   - CIVICRM_TEMPLATE_COMPILEDIR
  50    *
  51    * @return \Symfony\Component\DependencyInjection\ContainerInterface
  52    */
  53   public function loadContainer() {
  54     // Note: The container's raison d'etre is to manage construction of other
  55     // services. Consequently, we assume a minimal service available -- the classloader
  56     // has been setup, and civicrm.settings.php is loaded, but nothing else works.
  57
  58     $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE : 'auto';
  59
  60     // In pre-installation environments, don't bother with caching.
  61     if (!defined('CIVICRM_TEMPLATE_COMPILEDIR') || !defined('CIVICRM_DSN') || $cacheMode === 'never' || \CRM_Utils_System::isInUpgradeMode()) {
  62       $containerBuilder = $this->createContainer();
  63       $containerBuilder->compile();
  64       return $containerBuilder;
  65     }
  66
  67     $envId = \CRM_Core_Config_Runtime::getId();
  68     $file = CIVICRM_TEMPLATE_COMPILEDIR . "/CachedCiviContainer.{$envId}.php";
  69     $containerConfigCache = new ConfigCache($file, $cacheMode === 'auto');
  70     if (!$containerConfigCache->isFresh()) {
  71       $containerBuilder = $this->createContainer();
  72       $containerBuilder->compile();
  73       $dumper = new PhpDumper($containerBuilder);
  74       $containerConfigCache->write(
  75         $dumper->dump(['class' => 'CachedCiviContainer']),
  76         $containerBuilder->getResources()
  77       );
  78     }
  79
  80     require_once $file;
  81     $c = new \CachedCiviContainer();
  82     return $c;
  83   }
  84
  85   /**
  86    * Construct a new container.
  87    *
  88    * @var \Symfony\Component\DependencyInjection\ContainerBuilder
  89    * @return \Symfony\Component\DependencyInjection\ContainerBuilder
  90    */
  91   public function createContainer() {
  92     $civicrm_base_path = dirname(dirname(__DIR__));
  93     $container = new ContainerBuilder();
  94     $container->addCompilerPass(new RegisterListenersPass('dispatcher'));
  95     $container->addObjectResource($this);
  96     $container->setParameter('civicrm_base_path', $civicrm_base_path);
  97     //$container->set(self::SELF, $this);
  98
  99     $container->addResource(new \Symfony\Component\Config\Resource\FileResource(__FILE__));
 100
 101     $container->setDefinition(self::SELF, new Definition(
 102       'Civi\Core\Container',
 103       []
 104     ));
 105
 106     // TODO Move configuration to an external file; define caching structure
 107     //    if (empty($configDirectories)) {
 108     //      throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)');
 109     //    }
 110     //    $locator = new FileLocator($configDirectories);
 111     //    $loaderResolver = new LoaderResolver(array(
 112     //      new YamlFileLoader($container, $locator)
 113     //    ));
 114     //    $delegatingLoader = new DelegatingLoader($loaderResolver);
 115     //    foreach (array('services.yml') as $file) {
 116     //      $yamlUserFiles = $locator->locate($file, NULL, FALSE);
 117     //      foreach ($yamlUserFiles as $file) {
 118     //        $delegatingLoader->load($file);
 119     //      }
 120     //    }
 121
 122     $container->setDefinition('angular', new Definition(
 123       'Civi\Angular\Manager',
 124       []
 125     ))
 126       ->setFactory([new Reference(self::SELF), 'createAngularManager']);
 127
 128     $container->setDefinition('dispatcher', new Definition(
 129       'Civi\Core\CiviEventDispatcher',
 130       [new Reference('service_container')]
 131     ))
 132       ->setFactory([new Reference(self::SELF), 'createEventDispatcher']);
 133
 134     $container->setDefinition('magic_function_provider', new Definition(
 135       'Civi\API\Provider\MagicFunctionProvider',
 136       []
 137     ));
 138
 139     $container->setDefinition('civi_api_kernel', new Definition(
 140       'Civi\API\Kernel',
 141       [new Reference('dispatcher'), new Reference('magic_function_provider')]
 142     ))
 143       ->setFactory([new Reference(self::SELF), 'createApiKernel']);
 144
 145     $container->setDefinition('cxn_reg_client', new Definition(
 146       'Civi\Cxn\Rpc\RegistrationClient',
 147       []
 148     ))
 149       ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient');
 150
 151     $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', []));
 152
 153     $basicCaches = [
 154       'js_strings' => 'js_strings',
 155       'community_messages' => 'community_messages',
 156       'checks' => 'checks',
 157       'session' => 'CiviCRM Session',
 158       'long' => 'long',
 159       'groups' => 'contact groups',
 160       'navigation' => 'navigation',
 161     ];
 162     foreach ($basicCaches as $cacheSvc => $cacheGrp) {
 163       $definitionParams = [
 164         'name' => $cacheGrp,
 165         'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 166       ];
 167       // For Caches that we don't really care about the ttl for and/or maybe accessed
 168       // fairly often we use the fastArrayDecorator which improves reads and writes, these
 169       // caches should also not have concurrency risk.
 170       $fastArrayCaches = ['groups'];
 171       if (in_array($cacheSvc, $fastArrayCaches)) {
 172         $definitionParams['withArray'] = 'fast';
 173       }
 174       $container->setDefinition("cache.{$cacheSvc}", new Definition(
 175         'CRM_Utils_Cache_Interface',
 176         [$definitionParams]
 177       ))->setFactory('CRM_Utils_Cache::create');
 178     }
 179
 180     // PrevNextCache cannot use memory or array cache at the moment because the
 181     // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed.
 182     $container->setDefinition("cache.prevNextCache", new Definition(
 183       'CRM_Utils_Cache_Interface',
 184       [
 185         [
 186           'name' => 'CiviCRM Search PrevNextCache',
 187           'type' => ['SqlGroup'],
 188         ],
 189       ]
 190     ))->setFactory('CRM_Utils_Cache::create');
 191
 192     $container->setDefinition('sql_triggers', new Definition(
 193       'Civi\Core\SqlTriggers',
 194       []
 195     ));
 196
 197     $container->setDefinition('asset_builder', new Definition(
 198       'Civi\Core\AssetBuilder',
 199       []
 200     ));
 201
 202     $container->setDefinition('themes', new Definition(
 203       'Civi\Core\Themes',
 204       []
 205     ));
 206
 207     $container->setDefinition('pear_mail', new Definition('Mail'))
 208       ->setFactory('CRM_Utils_Mail::createMailer');
 209
 210     if (empty(\Civi::$statics[__CLASS__]['boot'])) {
 211       throw new \RuntimeException("Cannot initialize container. Boot services are undefined.");
 212     }
 213     foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) {
 214       $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE);
 215     }
 216
 217     // Expose legacy singletons as services in the container.
 218     $singletons = [
 219       'httpClient' => 'CRM_Utils_HttpClient',
 220       'cache.default' => 'CRM_Utils_Cache',
 221       'i18n' => 'CRM_Core_I18n',
 222       // Maybe? 'config' => 'CRM_Core_Config',
 223       // Maybe? 'smarty' => 'CRM_Core_Smarty',
 224     ];
 225     foreach ($singletons as $name => $class) {
 226       $container->setDefinition($name, new Definition(
 227         $class
 228       ))
 229         ->setFactory([$class, 'singleton']);
 230     }
 231     $container->setAlias('cache.short', 'cache.default');
 232
 233     $container->setDefinition('resources', new Definition(
 234       'CRM_Core_Resources',
 235       [new Reference('service_container')]
 236     ))->setFactory([new Reference(self::SELF), 'createResources']);
 237
 238     $container->setDefinition('prevnext', new Definition(
 239       'CRM_Core_PrevNextCache_Interface',
 240       [new Reference('service_container')]
 241     ))->setFactory([new Reference(self::SELF), 'createPrevNextCache']);
 242
 243     $container->setDefinition('prevnext.driver.sql', new Definition(
 244       'CRM_Core_PrevNextCache_Sql',
 245       []
 246     ));
 247
 248     $container->setDefinition('prevnext.driver.redis', new Definition(
 249       'CRM_Core_PrevNextCache_Redis',
 250       [new Reference('cache_config')]
 251     ));
 252
 253     $container->setDefinition('cache_config', new Definition('ArrayObject'))
 254       ->setFactory([new Reference(self::SELF), 'createCacheConfig']);
 255
 256     $container->setDefinition('civi.mailing.triggers', new Definition(
 257       'Civi\Core\SqlTrigger\TimestampTriggers',
 258       ['civicrm_mailing', 'Mailing']
 259     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
 260
 261     $container->setDefinition('civi.activity.triggers', new Definition(
 262       'Civi\Core\SqlTrigger\TimestampTriggers',
 263       ['civicrm_activity', 'Activity']
 264     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
 265
 266     $container->setDefinition('civi.case.triggers', new Definition(
 267       'Civi\Core\SqlTrigger\TimestampTriggers',
 268       ['civicrm_case', 'Case']
 269     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
 270
 271     $container->setDefinition('civi.case.staticTriggers', new Definition(
 272       'Civi\Core\SqlTrigger\StaticTriggers',
 273       [
 274         [
 275           [
 276             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 277             'table' => 'civicrm_case_activity',
 278             'when' => 'AFTER',
 279             'event' => ['INSERT'],
 280             'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
 281           ],
 282           [
 283             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 284             'table' => 'civicrm_activity',
 285             'when' => 'BEFORE',
 286             'event' => ['UPDATE', 'DELETE'],
 287             '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",
 288           ],
 289         ],
 290       ]
 291     ))
 292       ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
 293
 294     $container->setDefinition('civi_token_compat', new Definition(
 295       'Civi\Token\TokenCompatSubscriber',
 296       []
 297     ))->addTag('kernel.event_subscriber');
 298     $container->setDefinition("crm_mailing_action_tokens", new Definition(
 299       "CRM_Mailing_ActionTokens",
 300       []
 301     ))->addTag('kernel.event_subscriber');
 302
 303     foreach (['Activity', 'Contribute', 'Event', 'Mailing', 'Member'] as $comp) {
 304       $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
 305         "CRM_{$comp}_Tokens",
 306         []
 307       ))->addTag('kernel.event_subscriber');
 308     }
 309
 310     if (\CRM_Utils_Constant::value('CIVICRM_FLEXMAILER_HACK_SERVICES')) {
 311       \Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_SERVICES, [$container]);
 312     }
 313
 314     \CRM_Utils_Hook::container($container);
 315
 316     return $container;
 317   }
 318
 319   /**
 320    * @return \Civi\Angular\Manager
 321    */
 322   public function createAngularManager() {
 323     return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton());
 324   }
 325
 326   /**
 327    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 328    * @return \Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
 329    */
 330   public function createEventDispatcher($container) {
 331     $dispatcher = new CiviEventDispatcher($container);
 332     $dispatcher->addListener(SystemInstallEvent::EVENT_NAME, ['\Civi\Core\InstallationCanary', 'check']);
 333     $dispatcher->addListener(SystemInstallEvent::EVENT_NAME, ['\Civi\Core\DatabaseInitializer', 'initialize']);
 334     $dispatcher->addListener(SystemInstallEvent::EVENT_NAME, ['\Civi\Core\LocalizationInitializer', 'initialize']);
 335     $dispatcher->addListener('hook_civicrm_pre', ['\Civi\Core\Event\PreEvent', 'dispatchSubevent'], 100);
 336     $dispatcher->addListener('hook_civicrm_post', ['\Civi\Core\Event\PostEvent', 'dispatchSubevent'], 100);
 337     $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
 338     $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
 339     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
 340     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
 341     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
 342     // TODO We need a better code-convention for metadata about non-hook events.
 343     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
 344     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
 345     $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
 346     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
 347     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
 348     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
 349     $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
 350     $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
 351     $dispatcher->addListener('civi.dao.postInsert', ['\CRM_Core_BAO_RecurringEntity', 'triggerInsert']);
 352     $dispatcher->addListener('civi.dao.postUpdate', ['\CRM_Core_BAO_RecurringEntity', 'triggerUpdate']);
 353     $dispatcher->addListener('civi.dao.postDelete', ['\CRM_Core_BAO_RecurringEntity', 'triggerDelete']);
 354     $dispatcher->addListener('hook_civicrm_unhandled_exception', [
 355       'CRM_Core_LegacyErrorHandler',
 356       'handleException',
 357     ], -200);
 358     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
 359     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
 360     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
 361     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
 362     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
 363     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
 364
 365     if (\CRM_Utils_Constant::value('CIVICRM_FLEXMAILER_HACK_LISTENERS')) {
 366       \Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_LISTENERS, [$dispatcher]);
 367     }
 368
 369     return $dispatcher;
 370   }
 371
 372   /**
 373    * @return \Civi\Core\Lock\LockManager
 374    */
 375   public static function createLockManager() {
 376     // Ideally, downstream implementers could override any definitions in
 377     // the container. For now, we'll make-do with some define()s.
 378     $lm = new LockManager();
 379     $lm
 380       ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 381       ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 382       ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createCivimailLock'])
 383       ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createScopedLock']);
 384
 385     // Registrations may use complex resolver expressions, but (as a micro-optimization)
 386     // the default factory is specified as an array.
 387
 388     return $lm;
 389   }
 390
 391   /**
 392    * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 393    * @param $magicFunctionProvider
 394    *
 395    * @return \Civi\API\Kernel
 396    */
 397   public function createApiKernel($dispatcher, $magicFunctionProvider) {
 398     $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
 399     $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
 400     $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
 401     $dispatcher->addSubscriber($magicFunctionProvider);
 402     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 403     $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
 404     $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter([
 405       \CRM_Utils_API_HTMLInputCoder::singleton(),
 406       \CRM_Utils_API_NullOutputCoder::singleton(),
 407       \CRM_Utils_API_ReloadOption::singleton(),
 408       \CRM_Utils_API_MatchOption::singleton(),
 409     ]));
 410     $dispatcher->addSubscriber(new \Civi\API\Subscriber\XDebugSubscriber());
 411     $kernel = new \Civi\API\Kernel($dispatcher);
 412
 413     $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
 414     $dispatcher->addSubscriber($reflectionProvider);
 415
 416     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
 417       $kernel,
 418       'Attachment',
 419       ['create', 'get', 'delete'],
 420       // Given a file ID, determine the entity+table it's attached to.
 421       'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
 422          FROM civicrm_file cf
 423          LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
 424          WHERE cf.id = %1',
 425       // Get a list of custom fields (field_name,table_name,extends)
 426       'SELECT concat("custom_",fld.id) as field_name,
 427         grp.table_name as table_name,
 428         grp.extends as extends
 429        FROM civicrm_custom_field fld
 430        INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
 431        WHERE fld.data_type = "File"
 432       ',
 433       ['civicrm_activity', 'civicrm_mailing', 'civicrm_contact', 'civicrm_grant']
 434     ));
 435
 436     $kernel->setApiProviders([
 437       $reflectionProvider,
 438       $magicFunctionProvider,
 439     ]);
 440
 441     return $kernel;
 442   }
 443
 444   /**
 445    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 446    * @return \CRM_Core_Resources
 447    */
 448   public static function createResources($container) {
 449     $sys = \CRM_Extension_System::singleton();
 450     return new \CRM_Core_Resources(
 451       $sys->getMapper(),
 452       $container->get('cache.js_strings'),
 453       \CRM_Core_Config::isUpgradeMode() ? NULL : 'resCacheCode'
 454     );
 455   }
 456
 457   /**
 458    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 459    * @return \CRM_Core_PrevNextCache_Interface
 460    */
 461   public static function createPrevNextCache($container) {
 462     $setting = \Civi::settings()->get('prevNextBackend');
 463     if ($setting === 'default') {
 464       // For initial release (5.8.x), continue defaulting to SQL.
 465       $isTransitional = version_compare(\CRM_Utils_System::version(), '5.9.alpha1', '<');
 466       $cacheDriver = \CRM_Utils_Cache::getCacheDriver();
 467       $service = 'prevnext.driver.' . strtolower($cacheDriver);
 468       return $container->has($service) && !$isTransitional
 469         ? $container->get($service)
 470         : $container->get('prevnext.driver.sql');
 471     }
 472     else {
 473       return $container->get('prevnext.driver.' . $setting);
 474     }
 475   }
 476
 477   public static function createCacheConfig() {
 478     $driver = \CRM_Utils_Cache::getCacheDriver();
 479     $settings = \CRM_Utils_Cache::getCacheSettings($driver);
 480     $settings['driver'] = $driver;
 481     return new \ArrayObject($settings);
 482   }
 483
 484   /**
 485    * Get a list of boot services.
 486    *
 487    * These are services which must be setup *before* the container can operate.
 488    *
 489    * @param bool $loadFromDB
 490    * @throws \CRM_Core_Exception
 491    */
 492   public static function boot($loadFromDB) {
 493     // Array(string $serviceId => object $serviceInstance).
 494     $bootServices = [];
 495     \Civi::$statics[__CLASS__]['boot'] = &$bootServices;
 496
 497     $bootServices['runtime'] = $runtime = new \CRM_Core_Config_Runtime();
 498     $runtime->initialize($loadFromDB);
 499
 500     $bootServices['paths'] = new \Civi\Core\Paths();
 501
 502     $class = $runtime->userFrameworkClass;
 503     $bootServices['userSystem'] = $userSystem = new $class();
 504     $userSystem->initialize();
 505
 506     $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework;
 507     $bootServices['userPermissionClass'] = new $userPermissionClass();
 508
 509     $bootServices['cache.settings'] = \CRM_Utils_Cache::create([
 510       'name' => 'settings',
 511       'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 512     ]);
 513
 514     $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']);
 515
 516     $bootServices['lockManager'] = self::createLockManager();
 517
 518     if ($loadFromDB && $runtime->dsn) {
 519       \CRM_Core_DAO::init($runtime->dsn);
 520       \CRM_Utils_Hook::singleton(TRUE);
 521       \CRM_Extension_System::singleton(TRUE);
 522       \CRM_Extension_System::singleton(TRUE)->getClassLoader()->register();
 523
 524       $runtime->includeCustomPath();
 525
 526       $c = new self();
 527       $container = $c->loadContainer();
 528       foreach ($bootServices as $name => $obj) {
 529         $container->set($name, $obj);
 530       }
 531       \Civi::$statics[__CLASS__]['container'] = $container;
 532     }
 533   }
 534
 535   public static function getBootService($name) {
 536     return \Civi::$statics[__CLASS__]['boot'][$name];
 537   }
 538
 539   /**
 540    * Determine whether the container services are available.
 541    *
 542    * @return bool
 543    */
 544   public static function isContainerBooted() {
 545     return isset(\Civi::$statics[__CLASS__]['container']);
 546   }
 547
 548 }