Civi/Core/Container.php

   1 <?php
   2 namespace Civi\Core;
   3
   4 use Civi\Core\Lock\LockManager;
   5 use Symfony\Component\Config\ConfigCache;
   6 use Symfony\Component\DependencyInjection\ContainerBuilder;
   7 use Symfony\Component\DependencyInjection\Definition;
   8 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
   9 use Symfony\Component\DependencyInjection\Reference;
  10 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
  11
  12 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  13
  14 /**
  15  * Class Container
  16  * @package Civi\Core
  17  */
  18 class Container {
  19
  20   const SELF = 'civi_container_factory';
  21
  22   /**
  23    * @param bool $reset
  24    *   Whether to forcibly rebuild the entire container.
  25    * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
  26    */
  27   public static function singleton($reset = FALSE) {
  28     if ($reset || !isset(\Civi::$statics[__CLASS__]['container'])) {
  29       self::boot(TRUE);
  30     }
  31     return \Civi::$statics[__CLASS__]['container'];
  32   }
  33
  34   /**
  35    * Find a cached container definition or construct a new one.
  36    *
  37    * There are many weird contexts in which Civi initializes (eg different
  38    * variations of multitenancy and different permutations of CMS/CRM bootstrap),
  39    * and hook_container may fire a bit differently in each context. To mitigate
  40    * risk of leaks between environments, we compute a unique envID
  41    * (md5(DB_NAME, HTTP_HOST, SCRIPT_FILENAME, etc)) and use separate caches for
  42    * each (eg "templates_c/CachedCiviContainer.$ENVID.php").
  43    *
  44    * Constants:
  45    *   - CIVICRM_CONTAINER_CACHE -- 'always' [default], 'never', 'auto'
  46    *   - CIVICRM_DSN
  47    *   - CIVICRM_DOMAIN_ID
  48    *
  49    * @return \Symfony\Component\DependencyInjection\ContainerInterface
  50    */
  51   public function loadContainer() {
  52     // Note: The container's raison d'etre is to manage construction of other
  53     // services. Consequently, we assume a minimal service available -- the classloader
  54     // has been setup, and civicrm.settings.php is loaded, but nothing else works.
  55
  56     $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE : 'auto';
  57
  58     // In pre-installation environments, don't bother with caching.
  59     if (!defined('CIVICRM_DSN') || $cacheMode === 'never' || \CRM_Utils_System::isInUpgradeMode()) {
  60       $containerBuilder = $this->createContainer();
  61       $containerBuilder->compile();
  62       return $containerBuilder;
  63     }
  64
  65     $envId = \CRM_Core_Config_Runtime::getId();
  66     $file = \Civi::paths()->getPath("[civicrm.compile]/CachedCiviContainer.{$envId}.php");
  67     $containerConfigCache = new ConfigCache($file, $cacheMode === 'auto');
  68     if (!$containerConfigCache->isFresh()) {
  69       $containerBuilder = $this->createContainer();
  70       $containerBuilder->compile();
  71       $dumper = new PhpDumper($containerBuilder);
  72       $containerConfigCache->write(
  73         $dumper->dump(['class' => 'CachedCiviContainer']),
  74         $containerBuilder->getResources()
  75       );
  76     }
  77
  78     require_once $file;
  79     $c = new \CachedCiviContainer();
  80     return $c;
  81   }
  82
  83   /**
  84    * Construct a new container.
  85    *
  86    * @var \Symfony\Component\DependencyInjection\ContainerBuilder
  87    * @return \Symfony\Component\DependencyInjection\ContainerBuilder
  88    */
  89   public function createContainer() {
  90     $civicrm_base_path = dirname(dirname(__DIR__));
  91     $container = new ContainerBuilder();
  92     $container->addCompilerPass(new RegisterListenersPass('dispatcher'));
  93     $container->addObjectResource($this);
  94     $container->setParameter('civicrm_base_path', $civicrm_base_path);
  95     //$container->set(self::SELF, $this);
  96
  97     $container->addResource(new \Symfony\Component\Config\Resource\FileResource(__FILE__));
  98
  99     $container->setDefinition(self::SELF, new Definition(
 100       'Civi\Core\Container',
 101       []
 102     ));
 103
 104     // TODO Move configuration to an external file; define caching structure
 105     //    if (empty($configDirectories)) {
 106     //      throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)');
 107     //    }
 108     //    $locator = new FileLocator($configDirectories);
 109     //    $loaderResolver = new LoaderResolver(array(
 110     //      new YamlFileLoader($container, $locator)
 111     //    ));
 112     //    $delegatingLoader = new DelegatingLoader($loaderResolver);
 113     //    foreach (array('services.yml') as $file) {
 114     //      $yamlUserFiles = $locator->locate($file, NULL, FALSE);
 115     //      foreach ($yamlUserFiles as $file) {
 116     //        $delegatingLoader->load($file);
 117     //      }
 118     //    }
 119
 120     $container->setDefinition('angular', new Definition(
 121       'Civi\Angular\Manager',
 122       []
 123     ))
 124       ->setFactory([new Reference(self::SELF), 'createAngularManager'])->setPublic(TRUE);
 125
 126     $container->setDefinition('dispatcher', new Definition(
 127       'Civi\Core\CiviEventDispatcher',
 128       []
 129     ))
 130       ->setFactory([new Reference(self::SELF), 'createEventDispatcher'])->setPublic(TRUE);
 131
 132     $container->setDefinition('magic_function_provider', new Definition(
 133       'Civi\API\Provider\MagicFunctionProvider',
 134       []
 135     ))->setPublic(TRUE);
 136
 137     $container->setDefinition('civi_api_kernel', new Definition(
 138       'Civi\API\Kernel',
 139       [new Reference('dispatcher'), new Reference('magic_function_provider')]
 140     ))
 141       ->setFactory([new Reference(self::SELF), 'createApiKernel'])->setPublic(TRUE);
 142
 143     $container->setDefinition('cxn_reg_client', new Definition(
 144       'Civi\Cxn\Rpc\RegistrationClient',
 145       []
 146     ))
 147       ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient')->setPublic(TRUE);
 148
 149     $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', []))->setPublic(TRUE);
 150
 151     $basicCaches = [
 152       'js_strings' => 'js_strings',
 153       'community_messages' => 'community_messages',
 154       'checks' => 'checks',
 155       'session' => 'CiviCRM Session',
 156       'long' => 'long',
 157       'groups' => 'contact groups',
 158       'navigation' => 'navigation',
 159       'customData' => 'custom data',
 160       'fields' => 'contact fields',
 161       'contactTypes' => 'contactTypes',
 162       'metadata' => 'metadata',
 163     ];
 164     foreach ($basicCaches as $cacheSvc => $cacheGrp) {
 165       $definitionParams = [
 166         'name' => $cacheGrp,
 167         'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 168       ];
 169       // For Caches that we don't really care about the ttl for and/or maybe accessed
 170       // fairly often we use the fastArrayDecorator which improves reads and writes, these
 171       // caches should also not have concurrency risk.
 172       $fastArrayCaches = ['groups', 'navigation', 'customData', 'fields', 'contactTypes', 'metadata'];
 173       if (in_array($cacheSvc, $fastArrayCaches)) {
 174         $definitionParams['withArray'] = 'fast';
 175       }
 176       $container->setDefinition("cache.{$cacheSvc}", new Definition(
 177         'CRM_Utils_Cache_Interface',
 178         [$definitionParams]
 179       ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 180     }
 181
 182     // PrevNextCache cannot use memory or array cache at the moment because the
 183     // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed.
 184     $container->setDefinition("cache.prevNextCache", new Definition(
 185       'CRM_Utils_Cache_Interface',
 186       [
 187         [
 188           'name' => 'CiviCRM Search PrevNextCache',
 189           'type' => ['SqlGroup'],
 190         ],
 191       ]
 192     ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
 193
 194     $container->setDefinition('sql_triggers', new Definition(
 195       'Civi\Core\SqlTriggers',
 196       []
 197     ))->setPublic(TRUE);
 198
 199     $container->setDefinition('asset_builder', new Definition(
 200       'Civi\Core\AssetBuilder',
 201       []
 202     ))->setPublic(TRUE);
 203
 204     $container->setDefinition('themes', new Definition(
 205       'Civi\Core\Themes',
 206       []
 207     ))->setPublic(TRUE);
 208
 209     $container->setDefinition('pear_mail', new Definition('Mail'))
 210       ->setFactory('CRM_Utils_Mail::createMailer');
 211
 212     if (empty(\Civi::$statics[__CLASS__]['boot'])) {
 213       throw new \RuntimeException("Cannot initialize container. Boot services are undefined.");
 214     }
 215     foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) {
 216       $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE)->setPublic(TRUE);
 217     }
 218
 219     // Expose legacy singletons as services in the container.
 220     $singletons = [
 221       'httpClient' => 'CRM_Utils_HttpClient',
 222       'cache.default' => 'CRM_Utils_Cache',
 223       'i18n' => 'CRM_Core_I18n',
 224       // Maybe? 'config' => 'CRM_Core_Config',
 225       // Maybe? 'smarty' => 'CRM_Core_Smarty',
 226     ];
 227     foreach ($singletons as $name => $class) {
 228       $container->setDefinition($name, new Definition(
 229         $class
 230       ))
 231         ->setFactory([$class, 'singleton'])->setPublic(TRUE);
 232     }
 233     $container->setAlias('cache.short', 'cache.default');
 234
 235     $container->setDefinition('resources', new Definition(
 236       'CRM_Core_Resources',
 237       [new Reference('service_container')]
 238     ))->setFactory([new Reference(self::SELF), 'createResources'])->setPublic(TRUE);
 239
 240     $container->setDefinition('prevnext', new Definition(
 241       'CRM_Core_PrevNextCache_Interface',
 242       [new Reference('service_container')]
 243     ))->setFactory([new Reference(self::SELF), 'createPrevNextCache'])->setPublic(TRUE);
 244
 245     $container->setDefinition('prevnext.driver.sql', new Definition(
 246       'CRM_Core_PrevNextCache_Sql',
 247       []
 248     ))->setPublic(TRUE);
 249
 250     $container->setDefinition('prevnext.driver.redis', new Definition(
 251       'CRM_Core_PrevNextCache_Redis',
 252       [new Reference('cache_config')]
 253     ))->setPublic(TRUE);
 254
 255     $container->setDefinition('cache_config', new Definition('ArrayObject'))
 256       ->setFactory([new Reference(self::SELF), 'createCacheConfig'])->setPublic(TRUE);
 257
 258     $container->setDefinition('civi.mailing.triggers', new Definition(
 259       'Civi\Core\SqlTrigger\TimestampTriggers',
 260       ['civicrm_mailing', 'Mailing']
 261     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 262
 263     $container->setDefinition('civi.activity.triggers', new Definition(
 264       'Civi\Core\SqlTrigger\TimestampTriggers',
 265       ['civicrm_activity', 'Activity']
 266     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 267
 268     $container->setDefinition('civi.case.triggers', new Definition(
 269       'Civi\Core\SqlTrigger\TimestampTriggers',
 270       ['civicrm_case', 'Case']
 271     ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 272
 273     $container->setDefinition('civi.case.staticTriggers', new Definition(
 274       'Civi\Core\SqlTrigger\StaticTriggers',
 275       [
 276         [
 277           [
 278             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 279             'table' => 'civicrm_case_activity',
 280             'when' => 'AFTER',
 281             'event' => ['INSERT'],
 282             'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
 283           ],
 284           [
 285             'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
 286             'table' => 'civicrm_activity',
 287             'when' => 'BEFORE',
 288             'event' => ['UPDATE', 'DELETE'],
 289             '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",
 290           ],
 291         ],
 292       ]
 293     ))
 294       ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
 295
 296     $container->setDefinition('civi_token_compat', new Definition(
 297       'Civi\Token\TokenCompatSubscriber',
 298       []
 299     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 300     $container->setDefinition("crm_mailing_action_tokens", new Definition(
 301       "CRM_Mailing_ActionTokens",
 302       []
 303     ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 304
 305     foreach (['Activity', 'Contribute', 'Event', 'Mailing', 'Member'] as $comp) {
 306       $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
 307         "CRM_{$comp}_Tokens",
 308         []
 309       ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
 310     }
 311
 312     \CRM_Api4_Services::hook_container($container);
 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    * @return \Symfony\Component\EventDispatcher\EventDispatcher
 328    */
 329   public function createEventDispatcher() {
 330     // Continue building on the original dispatcher created during bootstrap.
 331     $dispatcher = static::getBootService('dispatcher.boot');
 332
 333     $dispatcher->addListener('civi.core.install', ['\Civi\Core\InstallationCanary', 'check']);
 334     $dispatcher->addListener('civi.core.install', ['\Civi\Core\DatabaseInitializer', 'initialize']);
 335     $dispatcher->addListener('civi.core.install', ['\Civi\Core\LocalizationInitializer', 'initialize']);
 336     $dispatcher->addListener('hook_civicrm_post', ['\CRM_Core_Transaction', 'addPostCommit'], -1000);
 337     $dispatcher->addListener('hook_civicrm_pre', ['\Civi\Core\Event\PreEvent', 'dispatchSubevent'], 100);
 338     $dispatcher->addListener('civi.dao.preDelete', ['\CRM_Core_BAO_EntityTag', 'preDeleteOtherEntity']);
 339     $dispatcher->addListener('hook_civicrm_post', ['\Civi\Core\Event\PostEvent', 'dispatchSubevent'], 100);
 340     $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
 341     $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
 342     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
 343     $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
 344     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
 345     // TODO We need a better code-convention for metadata about non-hook events.
 346     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
 347     $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
 348     $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
 349     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
 350     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
 351     $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
 352     $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
 353     $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
 354     $dispatcher->addListener('hook_civicrm_alterExternUrl', ['\CRM_Utils_System', 'migrateExternUrl'], 1000);
 355     $dispatcher->addListener('hook_civicrm_triggerInfo', ['\CRM_Contact_BAO_RelationshipCache', 'onHookTriggerInfo']);
 356     $dispatcher->addListener('civi.dao.postInsert', ['\CRM_Core_BAO_RecurringEntity', 'triggerInsert']);
 357     $dispatcher->addListener('civi.dao.postUpdate', ['\CRM_Core_BAO_RecurringEntity', 'triggerUpdate']);
 358     $dispatcher->addListener('civi.dao.postDelete', ['\CRM_Core_BAO_RecurringEntity', 'triggerDelete']);
 359     $dispatcher->addListener('hook_civicrm_unhandled_exception', [
 360       'CRM_Core_LegacyErrorHandler',
 361       'handleException',
 362     ], -200);
 363     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
 364     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
 365     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
 366     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
 367     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
 368     $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
 369
 370     return $dispatcher;
 371   }
 372
 373   /**
 374    * @return \Civi\Core\Lock\LockManager
 375    */
 376   public static function createLockManager() {
 377     // Ideally, downstream implementers could override any definitions in
 378     // the container. For now, we'll make-do with some define()s.
 379     $lm = new LockManager();
 380     $lm
 381       ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 382       ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : ['CRM_Core_Lock', 'createScopedLock'])
 383       ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createCivimailLock'])
 384       ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createScopedLock']);
 385
 386     // Registrations may use complex resolver expressions, but (as a micro-optimization)
 387     // the default factory is specified as an array.
 388
 389     return $lm;
 390   }
 391
 392   /**
 393    * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 394    * @param $magicFunctionProvider
 395    *
 396    * @return \Civi\API\Kernel
 397    */
 398   public function createApiKernel($dispatcher, $magicFunctionProvider) {
 399     $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
 400     $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
 401     $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
 402     $dispatcher->addSubscriber($magicFunctionProvider);
 403     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 404     $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
 405     $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter([
 406       \CRM_Utils_API_HTMLInputCoder::singleton(),
 407       \CRM_Utils_API_NullOutputCoder::singleton(),
 408       \CRM_Utils_API_ReloadOption::singleton(),
 409       \CRM_Utils_API_MatchOption::singleton(),
 410     ]));
 411     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DebugSubscriber());
 412     $kernel = new \Civi\API\Kernel($dispatcher);
 413
 414     $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
 415     $dispatcher->addSubscriber($reflectionProvider);
 416
 417     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
 418       $kernel,
 419       'Attachment',
 420       ['create', 'get', 'delete'],
 421       // Given a file ID, determine the entity+table it's attached to.
 422       'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
 423          FROM civicrm_file cf
 424          LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
 425          WHERE cf.id = %1',
 426       // Get a list of custom fields (field_name,table_name,extends)
 427       'SELECT concat("custom_",fld.id) as field_name,
 428         grp.table_name as table_name,
 429         grp.extends as extends
 430        FROM civicrm_custom_field fld
 431        INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
 432        WHERE fld.data_type = "File"
 433       '
 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     $bootServices['dispatcher.boot'] = new CiviEventDispatcher();
 503
 504     // Quality control: There should be no pre-boot hooks because they make it harder to understand/support/refactor.
 505     // If a pre-boot hook sneaks in, we'll raise an error.
 506     $bootDispatchPolicy = [
 507       '/^hook_/' => 'not-ready',
 508       '/^civi\./' => 'run',
 509     ];
 510     $mainDispatchPolicy = \CRM_Core_Config::isUpgradeMode() ? \CRM_Upgrade_DispatchPolicy::get('upgrade.main') : NULL;
 511     $bootServices['dispatcher.boot']->setDispatchPolicy($bootDispatchPolicy);
 512
 513     $class = $runtime->userFrameworkClass;
 514     $bootServices['userSystem'] = $userSystem = new $class();
 515     $userSystem->initialize();
 516
 517     $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework;
 518     $bootServices['userPermissionClass'] = new $userPermissionClass();
 519
 520     $bootServices['cache.settings'] = \CRM_Utils_Cache::create([
 521       'name' => 'settings',
 522       'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
 523     ]);
 524
 525     $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']);
 526
 527     $bootServices['lockManager'] = self::createLockManager();
 528
 529     if ($loadFromDB && $runtime->dsn) {
 530       \CRM_Core_DAO::init($runtime->dsn);
 531       \CRM_Utils_Hook::singleton(TRUE);
 532       \CRM_Extension_System::singleton(TRUE);
 533       \CRM_Extension_System::singleton(TRUE)->getClassLoader()->register();
 534       $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy);
 535
 536       $runtime->includeCustomPath();
 537
 538       $c = new self();
 539       $container = $c->loadContainer();
 540       foreach ($bootServices as $name => $obj) {
 541         $container->set($name, $obj);
 542       }
 543       \Civi::$statics[__CLASS__]['container'] = $container;
 544     }
 545     else {
 546       $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy);
 547     }
 548   }
 549
 550   public static function getBootService($name) {
 551     return \Civi::$statics[__CLASS__]['boot'][$name];
 552   }
 553
 554   /**
 555    * Determine whether the container services are available.
 556    *
 557    * @return bool
 558    */
 559   public static function isContainerBooted() {
 560     return isset(\Civi::$statics[__CLASS__]['container']);
 561   }
 562
 563 }