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',
161 foreach ($basicCaches as $cacheSvc => $cacheGrp) {
162 $container->setDefinition("cache.{$cacheSvc}", new Definition(
163 'CRM_Utils_Cache_Interface',
167 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
170 ))->setFactory('CRM_Utils_Cache::create');
173 // PrevNextCache cannot use memory or array cache at the moment because the
174 // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed.
175 $container->setDefinition("cache.prevNextCache", new Definition(
176 'CRM_Utils_Cache_Interface',
179 'name' => 'CiviCRM Search PrevNextCache',
180 'type' => ['SqlGroup'],
183 ))->setFactory('CRM_Utils_Cache::create');
185 $container->setDefinition('sql_triggers', new Definition(
186 'Civi\Core\SqlTriggers',
190 $container->setDefinition('asset_builder', new Definition(
191 'Civi\Core\AssetBuilder',
195 $container->setDefinition('themes', new Definition(
200 $container->setDefinition('pear_mail', new Definition('Mail'))
201 ->setFactory('CRM_Utils_Mail::createMailer');
203 if (empty(\Civi
::$statics[__CLASS__
]['boot'])) {
204 throw new \
RuntimeException("Cannot initialize container. Boot services are undefined.");
206 foreach (\Civi
::$statics[__CLASS__
]['boot'] as $bootService => $def) {
207 $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE);
210 // Expose legacy singletons as services in the container.
212 'httpClient' => 'CRM_Utils_HttpClient',
213 'cache.default' => 'CRM_Utils_Cache',
214 'i18n' => 'CRM_Core_I18n',
215 // Maybe? 'config' => 'CRM_Core_Config',
216 // Maybe? 'smarty' => 'CRM_Core_Smarty',
218 foreach ($singletons as $name => $class) {
219 $container->setDefinition($name, new Definition(
222 ->setFactory([$class, 'singleton']);
224 $container->setAlias('cache.short', 'cache.default');
226 $container->setDefinition('resources', new Definition(
227 'CRM_Core_Resources',
228 [new Reference('service_container')]
229 ))->setFactory([new Reference(self
::SELF
), 'createResources']);
231 $container->setDefinition('prevnext', new Definition(
232 'CRM_Core_PrevNextCache_Interface',
233 [new Reference('service_container')]
234 ))->setFactory([new Reference(self
::SELF
), 'createPrevNextCache']);
236 $container->setDefinition('prevnext.driver.sql', new Definition(
237 'CRM_Core_PrevNextCache_Sql',
241 $container->setDefinition('prevnext.driver.redis', new Definition(
242 'CRM_Core_PrevNextCache_Redis',
243 [new Reference('cache_config')]
246 $container->setDefinition('cache_config', new Definition('ArrayObject'))
247 ->setFactory([new Reference(self
::SELF
), 'createCacheConfig']);
249 $container->setDefinition('civi.mailing.triggers', new Definition(
250 'Civi\Core\SqlTrigger\TimestampTriggers',
251 ['civicrm_mailing', 'Mailing']
252 ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
254 $container->setDefinition('civi.activity.triggers', new Definition(
255 'Civi\Core\SqlTrigger\TimestampTriggers',
256 ['civicrm_activity', 'Activity']
257 ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
259 $container->setDefinition('civi.case.triggers', new Definition(
260 'Civi\Core\SqlTrigger\TimestampTriggers',
261 ['civicrm_case', 'Case']
262 ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
264 $container->setDefinition('civi.case.staticTriggers', new Definition(
265 'Civi\Core\SqlTrigger\StaticTriggers',
269 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
270 'table' => 'civicrm_case_activity',
272 'event' => ['INSERT'],
273 'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
276 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
277 'table' => 'civicrm_activity',
279 'event' => ['UPDATE', 'DELETE'],
280 '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",
285 ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo']);
287 $container->setDefinition('civi_token_compat', new Definition(
288 'Civi\Token\TokenCompatSubscriber',
290 ))->addTag('kernel.event_subscriber');
291 $container->setDefinition("crm_mailing_action_tokens", new Definition(
292 "CRM_Mailing_ActionTokens",
294 ))->addTag('kernel.event_subscriber');
296 foreach (['Activity', 'Contribute', 'Event', 'Mailing', 'Member'] as $comp) {
297 $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
298 "CRM_{$comp}_Tokens",
300 ))->addTag('kernel.event_subscriber');
303 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_SERVICES')) {
304 \Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_SERVICES
, [$container]);
307 \CRM_Utils_Hook
::container($container);
313 * @return \Civi\Angular\Manager
315 public function createAngularManager() {
316 return new \Civi\Angular\
Manager(\CRM_Core_Resources
::singleton());
320 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
321 * @return \Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
323 public function createEventDispatcher($container) {
324 $dispatcher = new CiviEventDispatcher($container);
325 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, ['\Civi\Core\InstallationCanary', 'check']);
326 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, ['\Civi\Core\DatabaseInitializer', 'initialize']);
327 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, ['\Civi\Core\LocalizationInitializer', 'initialize']);
328 $dispatcher->addListener('hook_civicrm_pre', ['\Civi\Core\Event\PreEvent', 'dispatchSubevent'], 100);
329 $dispatcher->addListener('hook_civicrm_post', ['\Civi\Core\Event\PostEvent', 'dispatchSubevent'], 100);
330 $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
331 $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
332 $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
333 $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
334 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
335 // TODO We need a better code-convention for metadata about non-hook events.
336 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
337 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
338 $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
339 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
340 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
341 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
342 $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
343 $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
344 $dispatcher->addListener('civi.dao.postInsert', ['\CRM_Core_BAO_RecurringEntity', 'triggerInsert']);
345 $dispatcher->addListener('civi.dao.postUpdate', ['\CRM_Core_BAO_RecurringEntity', 'triggerUpdate']);
346 $dispatcher->addListener('civi.dao.postDelete', ['\CRM_Core_BAO_RecurringEntity', 'triggerDelete']);
347 $dispatcher->addListener('hook_civicrm_unhandled_exception', [
348 'CRM_Core_LegacyErrorHandler',
351 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
352 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
353 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
354 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
355 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
356 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
358 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_LISTENERS')) {
359 \Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_LISTENERS
, [$dispatcher]);
366 * @return \Civi\Core\Lock\LockManager
368 public static function createLockManager() {
369 // Ideally, downstream implementers could override any definitions in
370 // the container. For now, we'll make-do with some define()s.
371 $lm = new LockManager();
373 ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK
: ['CRM_Core_Lock', 'createScopedLock'])
374 ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK
: ['CRM_Core_Lock', 'createScopedLock'])
375 ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK
: ['CRM_Core_Lock', 'createCivimailLock'])
376 ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK
: ['CRM_Core_Lock', 'createScopedLock']);
378 // Registrations may use complex resolver expressions, but (as a micro-optimization)
379 // the default factory is specified as an array.
385 * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
386 * @param $magicFunctionProvider
388 * @return \Civi\API\Kernel
390 public function createApiKernel($dispatcher, $magicFunctionProvider) {
391 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
ChainSubscriber());
392 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
TransactionSubscriber());
393 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
I18nSubscriber());
394 $dispatcher->addSubscriber($magicFunctionProvider);
395 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
PermissionCheck());
396 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
APIv3SchemaAdapter());
397 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
WrapperAdapter([
398 \CRM_Utils_API_HTMLInputCoder
::singleton(),
399 \CRM_Utils_API_NullOutputCoder
::singleton(),
400 \CRM_Utils_API_ReloadOption
::singleton(),
401 \CRM_Utils_API_MatchOption
::singleton(),
403 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
XDebugSubscriber());
404 $kernel = new \Civi\API\
Kernel($dispatcher);
406 $reflectionProvider = new \Civi\API\Provider\
ReflectionProvider($kernel);
407 $dispatcher->addSubscriber($reflectionProvider);
409 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
DynamicFKAuthorization(
412 ['create', 'get', 'delete'],
413 // Given a file ID, determine the entity+table it's attached to.
414 'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
416 LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
418 // Get a list of custom fields (field_name,table_name,extends)
419 'SELECT concat("custom_",fld.id) as field_name,
420 grp.table_name as table_name,
421 grp.extends as extends
422 FROM civicrm_custom_field fld
423 INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
424 WHERE fld.data_type = "File"
426 ['civicrm_activity', 'civicrm_mailing', 'civicrm_contact', 'civicrm_grant']
429 $kernel->setApiProviders([
431 $magicFunctionProvider,
438 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
439 * @return \CRM_Core_Resources
441 public static function createResources($container) {
442 $sys = \CRM_Extension_System
::singleton();
443 return new \
CRM_Core_Resources(
445 $container->get('cache.js_strings'),
446 \CRM_Core_Config
::isUpgradeMode() ?
NULL : 'resCacheCode'
451 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
452 * @return \CRM_Core_PrevNextCache_Interface
454 public static function createPrevNextCache($container) {
455 $setting = \Civi
::settings()->get('prevNextBackend');
456 if ($setting === 'default') {
457 // For initial release (5.8.x), continue defaulting to SQL.
458 $isTransitional = version_compare(\CRM_Utils_System
::version(), '5.9.alpha1', '<');
459 $cacheDriver = \CRM_Utils_Cache
::getCacheDriver();
460 $service = 'prevnext.driver.' . strtolower($cacheDriver);
461 return $container->has($service) && !$isTransitional
462 ?
$container->get($service)
463 : $container->get('prevnext.driver.sql');
466 return $container->get('prevnext.driver.' . $setting);
470 public static function createCacheConfig() {
471 $driver = \CRM_Utils_Cache
::getCacheDriver();
472 $settings = \CRM_Utils_Cache
::getCacheSettings($driver);
473 $settings['driver'] = $driver;
474 return new \
ArrayObject($settings);
478 * Get a list of boot services.
480 * These are services which must be setup *before* the container can operate.
482 * @param bool $loadFromDB
483 * @throws \CRM_Core_Exception
485 public static function boot($loadFromDB) {
486 // Array(string $serviceId => object $serviceInstance).
488 \Civi
::$statics[__CLASS__
]['boot'] = &$bootServices;
490 $bootServices['runtime'] = $runtime = new \
CRM_Core_Config_Runtime();
491 $runtime->initialize($loadFromDB);
493 $bootServices['paths'] = new \Civi\Core\
Paths();
495 $class = $runtime->userFrameworkClass
;
496 $bootServices['userSystem'] = $userSystem = new $class();
497 $userSystem->initialize();
499 $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework
;
500 $bootServices['userPermissionClass'] = new $userPermissionClass();
502 $bootServices['cache.settings'] = \CRM_Utils_Cache
::create([
503 'name' => 'settings',
504 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
507 $bootServices['settings_manager'] = new \Civi\Core\
SettingsManager($bootServices['cache.settings']);
509 $bootServices['lockManager'] = self
::createLockManager();
511 if ($loadFromDB && $runtime->dsn
) {
512 \CRM_Core_DAO
::init($runtime->dsn
);
513 \CRM_Utils_Hook
::singleton(TRUE);
514 \CRM_Extension_System
::singleton(TRUE);
515 \CRM_Extension_System
::singleton(TRUE)->getClassLoader()->register();
517 $runtime->includeCustomPath();
520 $container = $c->loadContainer();
521 foreach ($bootServices as $name => $obj) {
522 $container->set($name, $obj);
524 \Civi
::$statics[__CLASS__
]['container'] = $container;
528 public static function getBootService($name) {
529 return \Civi
::$statics[__CLASS__
]['boot'][$name];
533 * Determine whether the container services are available.
537 public static function isContainerBooted() {
538 return isset(\Civi
::$statics[__CLASS__
]['container']);