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
;
13 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
21 const SELF
= 'civi_container_factory';
25 * Whether to forcibly rebuild the entire container.
26 * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
28 public static function singleton($reset = FALSE) {
29 if ($reset ||
!isset(\Civi
::$statics[__CLASS__
]['container'])) {
32 return \Civi
::$statics[__CLASS__
]['container'];
36 * Find a cached container definition or construct a new one.
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").
46 * - CIVICRM_CONTAINER_CACHE -- 'always' [default], 'never', 'auto'
49 * - CIVICRM_TEMPLATE_COMPILEDIR
51 * @return \Symfony\Component\DependencyInjection\ContainerInterface
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.
58 $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE
: 'auto';
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;
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()
81 $c = new \
CachedCiviContainer();
86 * Construct a new container.
88 * @var \Symfony\Component\DependencyInjection\ContainerBuilder
89 * @return \Symfony\Component\DependencyInjection\ContainerBuilder
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);
99 $container->addResource(new \Symfony\Component\Config\
Resource\
FileResource(__FILE__
));
101 $container->setDefinition(self
::SELF
, new Definition(
102 'Civi\Core\Container',
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)');
110 // $locator = new FileLocator($configDirectories);
111 // $loaderResolver = new LoaderResolver(array(
112 // new YamlFileLoader($container, $locator)
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);
122 $container->setDefinition('angular', new Definition(
123 'Civi\Angular\Manager',
126 ->setFactory([new Reference(self
::SELF
), 'createAngularManager']);
128 $container->setDefinition('dispatcher', new Definition(
129 'Civi\Core\CiviEventDispatcher',
130 [new Reference('service_container')]
132 ->setFactory([new Reference(self
::SELF
), 'createEventDispatcher']);
134 $container->setDefinition('magic_function_provider', new Definition(
135 'Civi\API\Provider\MagicFunctionProvider',
139 $container->setDefinition('civi_api_kernel', new Definition(
141 [new Reference('dispatcher'), new Reference('magic_function_provider')]
143 ->setFactory([new Reference(self
::SELF
), 'createApiKernel']);
145 $container->setDefinition('cxn_reg_client', new Definition(
146 'Civi\Cxn\Rpc\RegistrationClient',
149 ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient');
151 $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', []));
154 'js_strings' => 'js_strings',
155 'community_messages' => 'community_messages',
156 'checks' => 'checks',
157 'session' => 'CiviCRM Session',
159 'groups' => 'contact groups',
160 'navigation' => 'navigation',
161 'customData' => 'custom data',
162 'fields' => 'contact fields',
164 foreach ($basicCaches as $cacheSvc => $cacheGrp) {
165 $definitionParams = [
167 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
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'];
173 if (in_array($cacheSvc, $fastArrayCaches)) {
174 $definitionParams['withArray'] = 'fast';
176 $container->setDefinition("cache.{$cacheSvc}", new Definition(
177 'CRM_Utils_Cache_Interface',
179 ))->setFactory('CRM_Utils_Cache::create');
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',
188 'name' => 'CiviCRM Search PrevNextCache',
189 'type' => ['SqlGroup'],
192 ))->setFactory('CRM_Utils_Cache::create');
194 $container->setDefinition('sql_triggers', new Definition(
195 'Civi\Core\SqlTriggers',
199 $container->setDefinition('asset_builder', new Definition(
200 'Civi\Core\AssetBuilder',
204 $container->setDefinition('themes', new Definition(
209 $container->setDefinition('pear_mail', new Definition('Mail'))
210 ->setFactory('CRM_Utils_Mail::createMailer');
212 if (empty(\Civi
::$statics[__CLASS__
]['boot'])) {
213 throw new \
RuntimeException("Cannot initialize container. Boot services are undefined.");
215 foreach (\Civi
::$statics[__CLASS__
]['boot'] as $bootService => $def) {
216 $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE);
219 // Expose legacy singletons as services in the container.
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',
227 foreach ($singletons as $name => $class) {
228 $container->setDefinition($name, new Definition(
231 ->setFactory([$class, 'singleton']);
233 $container->setAlias('cache.short', 'cache.default');
235 $container->setDefinition('resources', new Definition(
236 'CRM_Core_Resources',
237 [new Reference('service_container')]
238 ))->setFactory([new Reference(self
::SELF
), 'createResources']);
240 $container->setDefinition('prevnext', new Definition(
241 'CRM_Core_PrevNextCache_Interface',
242 [new Reference('service_container')]
243 ))->setFactory([new Reference(self
::SELF
), 'createPrevNextCache']);
245 $container->setDefinition('prevnext.driver.sql', new Definition(
246 'CRM_Core_PrevNextCache_Sql',
250 $container->setDefinition('prevnext.driver.redis', new Definition(
251 'CRM_Core_PrevNextCache_Redis',
252 [new Reference('cache_config')]
255 $container->setDefinition('cache_config', new Definition('ArrayObject'))
256 ->setFactory([new Reference(self
::SELF
), 'createCacheConfig']);
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']);
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']);
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']);
273 $container->setDefinition('civi.case.staticTriggers', new Definition(
274 'Civi\Core\SqlTrigger\StaticTriggers',
278 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
279 'table' => 'civicrm_case_activity',
281 'event' => ['INSERT'],
282 'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
285 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
286 'table' => 'civicrm_activity',
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",
294 ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
296 $container->setDefinition('civi_token_compat', new Definition(
297 'Civi\Token\TokenCompatSubscriber',
299 ))->addTag('kernel.event_subscriber');
300 $container->setDefinition("crm_mailing_action_tokens", new Definition(
301 "CRM_Mailing_ActionTokens",
303 ))->addTag('kernel.event_subscriber');
305 foreach (['Activity', 'Contribute', 'Event', 'Mailing', 'Member'] as $comp) {
306 $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
307 "CRM_{$comp}_Tokens",
309 ))->addTag('kernel.event_subscriber');
312 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_SERVICES')) {
313 \Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_SERVICES
, [$container]);
316 \CRM_Utils_Hook
::container($container);
322 * @return \Civi\Angular\Manager
324 public function createAngularManager() {
325 return new \Civi\Angular\
Manager(\CRM_Core_Resources
::singleton());
329 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
330 * @return \Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
332 public function createEventDispatcher($container) {
333 $dispatcher = new CiviEventDispatcher($container);
334 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, ['\Civi\Core\InstallationCanary', 'check']);
335 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, ['\Civi\Core\DatabaseInitializer', 'initialize']);
336 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, ['\Civi\Core\LocalizationInitializer', 'initialize']);
337 $dispatcher->addListener('hook_civicrm_pre', ['\Civi\Core\Event\PreEvent', 'dispatchSubevent'], 100);
338 $dispatcher->addListener('hook_civicrm_post', ['\Civi\Core\Event\PostEvent', 'dispatchSubevent'], 100);
339 $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
340 $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
341 $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
342 $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
343 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
344 // TODO We need a better code-convention for metadata about non-hook events.
345 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
346 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
347 $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
348 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
349 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
350 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
351 $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
352 $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
353 $dispatcher->addListener('civi.dao.postInsert', ['\CRM_Core_BAO_RecurringEntity', 'triggerInsert']);
354 $dispatcher->addListener('civi.dao.postUpdate', ['\CRM_Core_BAO_RecurringEntity', 'triggerUpdate']);
355 $dispatcher->addListener('civi.dao.postDelete', ['\CRM_Core_BAO_RecurringEntity', 'triggerDelete']);
356 $dispatcher->addListener('hook_civicrm_unhandled_exception', [
357 'CRM_Core_LegacyErrorHandler',
360 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
361 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
362 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
363 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
364 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
365 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
367 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_LISTENERS')) {
368 \Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_LISTENERS
, [$dispatcher]);
375 * @return \Civi\Core\Lock\LockManager
377 public static function createLockManager() {
378 // Ideally, downstream implementers could override any definitions in
379 // the container. For now, we'll make-do with some define()s.
380 $lm = new LockManager();
382 ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK
: ['CRM_Core_Lock', 'createScopedLock'])
383 ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK
: ['CRM_Core_Lock', 'createScopedLock'])
384 ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK
: ['CRM_Core_Lock', 'createCivimailLock'])
385 ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK
: ['CRM_Core_Lock', 'createScopedLock']);
387 // Registrations may use complex resolver expressions, but (as a micro-optimization)
388 // the default factory is specified as an array.
394 * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
395 * @param $magicFunctionProvider
397 * @return \Civi\API\Kernel
399 public function createApiKernel($dispatcher, $magicFunctionProvider) {
400 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
ChainSubscriber());
401 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
TransactionSubscriber());
402 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
I18nSubscriber());
403 $dispatcher->addSubscriber($magicFunctionProvider);
404 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
PermissionCheck());
405 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
APIv3SchemaAdapter());
406 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
WrapperAdapter([
407 \CRM_Utils_API_HTMLInputCoder
::singleton(),
408 \CRM_Utils_API_NullOutputCoder
::singleton(),
409 \CRM_Utils_API_ReloadOption
::singleton(),
410 \CRM_Utils_API_MatchOption
::singleton(),
412 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
XDebugSubscriber());
413 $kernel = new \Civi\API\
Kernel($dispatcher);
415 $reflectionProvider = new \Civi\API\Provider\
ReflectionProvider($kernel);
416 $dispatcher->addSubscriber($reflectionProvider);
418 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
DynamicFKAuthorization(
421 ['create', 'get', 'delete'],
422 // Given a file ID, determine the entity+table it's attached to.
423 'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
425 LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
427 // Get a list of custom fields (field_name,table_name,extends)
428 'SELECT concat("custom_",fld.id) as field_name,
429 grp.table_name as table_name,
430 grp.extends as extends
431 FROM civicrm_custom_field fld
432 INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
433 WHERE fld.data_type = "File"
435 ['civicrm_activity', 'civicrm_mailing', 'civicrm_contact', 'civicrm_grant']
438 $kernel->setApiProviders([
440 $magicFunctionProvider,
447 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
448 * @return \CRM_Core_Resources
450 public static function createResources($container) {
451 $sys = \CRM_Extension_System
::singleton();
452 return new \
CRM_Core_Resources(
454 $container->get('cache.js_strings'),
455 \CRM_Core_Config
::isUpgradeMode() ?
NULL : 'resCacheCode'
460 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
461 * @return \CRM_Core_PrevNextCache_Interface
463 public static function createPrevNextCache($container) {
464 $setting = \Civi
::settings()->get('prevNextBackend');
465 if ($setting === 'default') {
466 // For initial release (5.8.x), continue defaulting to SQL.
467 $isTransitional = version_compare(\CRM_Utils_System
::version(), '5.9.alpha1', '<');
468 $cacheDriver = \CRM_Utils_Cache
::getCacheDriver();
469 $service = 'prevnext.driver.' . strtolower($cacheDriver);
470 return $container->has($service) && !$isTransitional
471 ?
$container->get($service)
472 : $container->get('prevnext.driver.sql');
475 return $container->get('prevnext.driver.' . $setting);
479 public static function createCacheConfig() {
480 $driver = \CRM_Utils_Cache
::getCacheDriver();
481 $settings = \CRM_Utils_Cache
::getCacheSettings($driver);
482 $settings['driver'] = $driver;
483 return new \
ArrayObject($settings);
487 * Get a list of boot services.
489 * These are services which must be setup *before* the container can operate.
491 * @param bool $loadFromDB
492 * @throws \CRM_Core_Exception
494 public static function boot($loadFromDB) {
495 // Array(string $serviceId => object $serviceInstance).
497 \Civi
::$statics[__CLASS__
]['boot'] = &$bootServices;
499 $bootServices['runtime'] = $runtime = new \
CRM_Core_Config_Runtime();
500 $runtime->initialize($loadFromDB);
502 $bootServices['paths'] = new \Civi\Core\
Paths();
504 $class = $runtime->userFrameworkClass
;
505 $bootServices['userSystem'] = $userSystem = new $class();
506 $userSystem->initialize();
508 $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework
;
509 $bootServices['userPermissionClass'] = new $userPermissionClass();
511 $bootServices['cache.settings'] = \CRM_Utils_Cache
::create([
512 'name' => 'settings',
513 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
516 $bootServices['settings_manager'] = new \Civi\Core\
SettingsManager($bootServices['cache.settings']);
518 $bootServices['lockManager'] = self
::createLockManager();
520 if ($loadFromDB && $runtime->dsn
) {
521 \CRM_Core_DAO
::init($runtime->dsn
);
522 \CRM_Utils_Hook
::singleton(TRUE);
523 \CRM_Extension_System
::singleton(TRUE);
524 \CRM_Extension_System
::singleton(TRUE)->getClassLoader()->register();
526 $runtime->includeCustomPath();
529 $container = $c->loadContainer();
530 foreach ($bootServices as $name => $obj) {
531 $container->set($name, $obj);
533 \Civi
::$statics[__CLASS__
]['container'] = $container;
537 public static function getBootService($name) {
538 return \Civi
::$statics[__CLASS__
]['boot'][$name];
542 * Determine whether the container services are available.
546 public static function isContainerBooted() {
547 return isset(\Civi
::$statics[__CLASS__
]['container']);