4 use Civi\API\Provider\ActionObjectProvider
;
5 use Civi\Core\Event\SystemInstallEvent
;
6 use Civi\Core\Lock\LockManager
;
7 use Doctrine\Common\Annotations\AnnotationReader
;
8 use Doctrine\Common\Annotations\AnnotationRegistry
;
9 use Doctrine\Common\Annotations\FileCacheReader
;
10 use Doctrine\Common\Cache\FilesystemCache
;
11 use Doctrine\ORM\EntityManager
;
12 use Doctrine\ORM\Mapping\Driver\AnnotationDriver
;
13 use Doctrine\ORM\Tools\Setup
;
14 use Symfony\Component\Config\ConfigCache
;
15 use Symfony\Component\DependencyInjection\ContainerBuilder
;
16 use Symfony\Component\DependencyInjection\ContainerInterface
;
17 use Symfony\Component\DependencyInjection\Definition
;
18 use Symfony\Component\DependencyInjection\Dumper\PhpDumper
;
19 use Symfony\Component\DependencyInjection\Reference
;
20 use Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
;
21 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass
;
23 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
31 const SELF
= 'civi_container_factory';
35 * Whether to forcibly rebuild the entire container.
36 * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
38 public static function singleton($reset = FALSE) {
39 if ($reset ||
!isset(\Civi
::$statics[__CLASS__
]['container'])) {
42 return \Civi
::$statics[__CLASS__
]['container'];
46 * Find a cached container definition or construct a new one.
48 * There are many weird contexts in which Civi initializes (eg different
49 * variations of multitenancy and different permutations of CMS/CRM bootstrap),
50 * and hook_container may fire a bit differently in each context. To mitigate
51 * risk of leaks between environments, we compute a unique envID
52 * (md5(DB_NAME, HTTP_HOST, SCRIPT_FILENAME, etc)) and use separate caches for
53 * each (eg "templates_c/CachedCiviContainer.$ENVID.php").
56 * - CIVICRM_CONTAINER_CACHE -- 'always' [default], 'never', 'auto'
59 * - CIVICRM_TEMPLATE_COMPILEDIR
61 * @return ContainerInterface
63 public function loadContainer() {
64 // Note: The container's raison d'etre is to manage construction of other
65 // services. Consequently, we assume a minimal service available -- the classloader
66 // has been setup, and civicrm.settings.php is loaded, but nothing else works.
68 $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE
: 'auto';
70 // In pre-installation environments, don't bother with caching.
71 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR') ||
!defined('CIVICRM_DSN') ||
$cacheMode === 'never' || \CRM_Utils_System
::isInUpgradeMode()) {
72 $containerBuilder = $this->createContainer();
73 $containerBuilder->compile();
74 return $containerBuilder;
77 $envId = \CRM_Core_Config_Runtime
::getId();
78 $file = CIVICRM_TEMPLATE_COMPILEDIR
. "/CachedCiviContainer.{$envId}.php";
79 $containerConfigCache = new ConfigCache($file, $cacheMode === 'auto');
80 if (!$containerConfigCache->isFresh()) {
81 $containerBuilder = $this->createContainer();
82 $containerBuilder->compile();
83 $dumper = new PhpDumper($containerBuilder);
84 $containerConfigCache->write(
85 $dumper->dump(array('class' => 'CachedCiviContainer')),
86 $containerBuilder->getResources()
91 $c = new \
CachedCiviContainer();
96 * Construct a new container.
98 * @var ContainerBuilder
99 * @return \Symfony\Component\DependencyInjection\ContainerBuilder
101 public function createContainer() {
102 $civicrm_base_path = dirname(dirname(__DIR__
));
103 $container = new ContainerBuilder();
104 $container->addCompilerPass(new RegisterListenersPass('dispatcher'));
105 $container->addObjectResource($this);
106 $container->setParameter('civicrm_base_path', $civicrm_base_path);
107 //$container->set(self::SELF, $this);
109 $container->addResource(new \Symfony\Component\Config\
Resource\
FileResource(__FILE__
));
111 $container->setDefinition(self
::SELF
, new Definition(
112 'Civi\Core\Container',
116 // TODO Move configuration to an external file; define caching structure
117 // if (empty($configDirectories)) {
118 // throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)');
120 // $locator = new FileLocator($configDirectories);
121 // $loaderResolver = new LoaderResolver(array(
122 // new YamlFileLoader($container, $locator)
124 // $delegatingLoader = new DelegatingLoader($loaderResolver);
125 // foreach (array('services.yml') as $file) {
126 // $yamlUserFiles = $locator->locate($file, NULL, FALSE);
127 // foreach ($yamlUserFiles as $file) {
128 // $delegatingLoader->load($file);
132 $container->setDefinition('angular', new Definition(
133 'Civi\Angular\Manager',
136 ->setFactory(array(new Reference(self
::SELF
), 'createAngularManager'));
138 $container->setDefinition('dispatcher', new Definition(
139 'Civi\Core\CiviEventDispatcher',
140 array(new Reference('service_container'))
142 ->setFactory(array(new Reference(self
::SELF
), 'createEventDispatcher'));
144 $container->setDefinition('magic_function_provider', new Definition(
145 'Civi\API\Provider\MagicFunctionProvider',
149 $container->setDefinition('civi_api_kernel', new Definition(
151 array(new Reference('dispatcher'), new Reference('magic_function_provider'))
153 ->setFactory(array(new Reference(self
::SELF
), 'createApiKernel'));
155 $container->setDefinition('cxn_reg_client', new Definition(
156 'Civi\Cxn\Rpc\RegistrationClient',
159 ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient');
161 $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', array()));
163 $basicCaches = array(
164 'js_strings' => 'js_strings',
165 'community_messages' => 'community_messages',
166 'checks' => 'checks',
167 'session' => 'CiviCRM Session',
170 foreach ($basicCaches as $cacheSvc => $cacheGrp) {
171 $container->setDefinition("cache.{$cacheSvc}", new Definition(
172 'CRM_Utils_Cache_Interface',
176 'type' => array('*memory*', 'SqlGroup', 'ArrayCache'),
179 ))->setFactory('CRM_Utils_Cache::create');
182 $container->setDefinition('sql_triggers', new Definition(
183 'Civi\Core\SqlTriggers',
187 $container->setDefinition('asset_builder', new Definition(
188 'Civi\Core\AssetBuilder',
192 $container->setDefinition('pear_mail', new Definition('Mail'))
193 ->setFactory('CRM_Utils_Mail::createMailer');
195 if (empty(\Civi
::$statics[__CLASS__
]['boot'])) {
196 throw new \
RuntimeException("Cannot initialize container. Boot services are undefined.");
198 foreach (\Civi
::$statics[__CLASS__
]['boot'] as $bootService => $def) {
199 $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE);
202 // Expose legacy singletons as services in the container.
204 'httpClient' => 'CRM_Utils_HttpClient',
205 'cache.default' => 'CRM_Utils_Cache',
206 'i18n' => 'CRM_Core_I18n',
207 // Maybe? 'config' => 'CRM_Core_Config',
208 // Maybe? 'smarty' => 'CRM_Core_Smarty',
210 foreach ($singletons as $name => $class) {
211 $container->setDefinition($name, new Definition(
214 ->setFactory(array($class, 'singleton'));
216 $container->setAlias('cache.short', 'cache.default');
218 $container->setDefinition('resources', new Definition(
219 'CRM_Core_Resources',
220 [new Reference('service_container')]
221 ))->setFactory(array(new Reference(self
::SELF
), 'createResources'));
223 $container->setDefinition('prevnext', new Definition(
224 'CRM_Core_PrevNextCache_Interface',
225 [new Reference('service_container')]
226 ))->setFactory(array(new Reference(self
::SELF
), 'createPrevNextCache'));
228 $container->setDefinition('prevnext.driver.sql', new Definition(
229 'CRM_Core_PrevNextCache_Sql',
233 $container->setDefinition('prevnext.driver.redis', new Definition(
234 'CRM_Core_PrevNextCache_Redis',
235 [new Reference('cache_config')]
238 $container->setDefinition('cache_config', new Definition('ArrayObject'))
239 ->setFactory(array(new Reference(self
::SELF
), 'createCacheConfig'));
241 $container->setDefinition('civi.mailing.triggers', new Definition(
242 'Civi\Core\SqlTrigger\TimestampTriggers',
243 array('civicrm_mailing', 'Mailing')
244 ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
246 $container->setDefinition('civi.activity.triggers', new Definition(
247 'Civi\Core\SqlTrigger\TimestampTriggers',
248 array('civicrm_activity', 'Activity')
249 ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
251 $container->setDefinition('civi.case.triggers', new Definition(
252 'Civi\Core\SqlTrigger\TimestampTriggers',
253 array('civicrm_case', 'Case')
254 ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
256 $container->setDefinition('civi.case.staticTriggers', new Definition(
257 'Civi\Core\SqlTrigger\StaticTriggers',
261 'upgrade_check' => array('table' => 'civicrm_case', 'column' => 'modified_date'),
262 'table' => 'civicrm_case_activity',
264 'event' => array('INSERT'),
265 'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
268 'upgrade_check' => array('table' => 'civicrm_case', 'column' => 'modified_date'),
269 'table' => 'civicrm_activity',
271 'event' => array('UPDATE', 'DELETE'),
272 '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",
277 ->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
279 $container->setDefinition('civi_token_compat', new Definition(
280 'Civi\Token\TokenCompatSubscriber',
282 ))->addTag('kernel.event_subscriber');
283 $container->setDefinition("crm_mailing_action_tokens", new Definition(
284 "CRM_Mailing_ActionTokens",
286 ))->addTag('kernel.event_subscriber');
288 foreach (array('Activity', 'Contribute', 'Event', 'Mailing', 'Member') as $comp) {
289 $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
290 "CRM_{$comp}_Tokens",
292 ))->addTag('kernel.event_subscriber');
295 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_SERVICES')) {
296 \Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_SERVICES
, array($container));
299 \CRM_Utils_Hook
::container($container);
305 * @return \Civi\Angular\Manager
307 public function createAngularManager() {
308 return new \Civi\Angular\
Manager(\CRM_Core_Resources
::singleton());
312 * @param ContainerInterface $container
313 * @return \Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
315 public function createEventDispatcher($container) {
316 $dispatcher = new CiviEventDispatcher($container);
317 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, array('\Civi\Core\InstallationCanary', 'check'));
318 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, array('\Civi\Core\DatabaseInitializer', 'initialize'));
319 $dispatcher->addListener(SystemInstallEvent
::EVENT_NAME
, array('\Civi\Core\LocalizationInitializer', 'initialize'));
320 $dispatcher->addListener('hook_civicrm_pre', array('\Civi\Core\Event\PreEvent', 'dispatchSubevent'), 100);
321 $dispatcher->addListener('hook_civicrm_post', array('\Civi\Core\Event\PostEvent', 'dispatchSubevent'), 100);
322 $dispatcher->addListener('hook_civicrm_post::Activity', array('\Civi\CCase\Events', 'fireCaseChange'));
323 $dispatcher->addListener('hook_civicrm_post::Case', array('\Civi\CCase\Events', 'fireCaseChange'));
324 $dispatcher->addListener('hook_civicrm_caseChange', array('\Civi\CCase\Events', 'delegateToXmlListeners'));
325 $dispatcher->addListener('hook_civicrm_caseChange', array('\Civi\CCase\SequenceListener', 'onCaseChange_static'));
326 $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\Core\CiviEventInspector', 'findBuiltInEvents'));
327 // TODO We need a better code-convention for metadata about non-hook events.
328 $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\API\Events', 'hookEventDefs'));
329 $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs'));
330 $dispatcher->addListener('hook_civicrm_buildAsset', array('\Civi\Angular\Page\Modules', 'buildAngularModules'));
331 $dispatcher->addListener('hook_civicrm_buildAsset', array('\CRM_Utils_VisualBundle', 'buildAssetJs'));
332 $dispatcher->addListener('hook_civicrm_buildAsset', array('\CRM_Utils_VisualBundle', 'buildAssetCss'));
333 $dispatcher->addListener('civi.dao.postInsert', array('\CRM_Core_BAO_RecurringEntity', 'triggerInsert'));
334 $dispatcher->addListener('civi.dao.postUpdate', array('\CRM_Core_BAO_RecurringEntity', 'triggerUpdate'));
335 $dispatcher->addListener('civi.dao.postDelete', array('\CRM_Core_BAO_RecurringEntity', 'triggerDelete'));
336 $dispatcher->addListener('hook_civicrm_unhandled_exception', array(
337 'CRM_Core_LegacyErrorHandler',
340 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, array('CRM_Activity_ActionMapping', 'onRegisterActionMappings'));
341 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, array('CRM_Contact_ActionMapping', 'onRegisterActionMappings'));
342 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, array('CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings'));
343 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, array('CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings'));
344 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, array('CRM_Event_ActionMapping', 'onRegisterActionMappings'));
345 $dispatcher->addListener(\Civi\ActionSchedule\Events
::MAPPINGS
, array('CRM_Member_ActionMapping', 'onRegisterActionMappings'));
347 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_LISTENERS')) {
348 \Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_LISTENERS
, array($dispatcher));
355 * @return LockManager
357 public static function createLockManager() {
358 // Ideally, downstream implementers could override any definitions in
359 // the container. For now, we'll make-do with some define()s.
360 $lm = new LockManager();
362 ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK
: array('CRM_Core_Lock', 'createScopedLock'))
363 ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK
: array('CRM_Core_Lock', 'createScopedLock'))
364 ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK
: array('CRM_Core_Lock', 'createCivimailLock'))
365 ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK
: array('CRM_Core_Lock', 'createScopedLock'));
367 // Registrations may use complex resolver expressions, but (as a micro-optimization)
368 // the default factory is specified as an array.
374 * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
375 * @param $magicFunctionProvider
377 * @return \Civi\API\Kernel
379 public function createApiKernel($dispatcher, $magicFunctionProvider) {
380 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
ChainSubscriber());
381 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
TransactionSubscriber());
382 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
I18nSubscriber());
383 $dispatcher->addSubscriber($magicFunctionProvider);
384 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
PermissionCheck());
385 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
APIv3SchemaAdapter());
386 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
WrapperAdapter(array(
387 \CRM_Utils_API_HTMLInputCoder
::singleton(),
388 \CRM_Utils_API_NullOutputCoder
::singleton(),
389 \CRM_Utils_API_ReloadOption
::singleton(),
390 \CRM_Utils_API_MatchOption
::singleton(),
392 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
XDebugSubscriber());
393 $kernel = new \Civi\API\
Kernel($dispatcher);
395 $reflectionProvider = new \Civi\API\Provider\
ReflectionProvider($kernel);
396 $dispatcher->addSubscriber($reflectionProvider);
398 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
DynamicFKAuthorization(
401 array('create', 'get', 'delete'),
402 // Given a file ID, determine the entity+table it's attached to.
403 'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
405 LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
407 // Get a list of custom fields (field_name,table_name,extends)
408 'SELECT concat("custom_",fld.id) as field_name,
409 grp.table_name as table_name,
410 grp.extends as extends
411 FROM civicrm_custom_field fld
412 INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
413 WHERE fld.data_type = "File"
415 array('civicrm_activity', 'civicrm_mailing', 'civicrm_contact', 'civicrm_grant')
418 $kernel->setApiProviders(array(
420 $magicFunctionProvider,
427 * @param ContainerInterface $container
428 * @return \CRM_Core_Resources
430 public static function createResources($container) {
431 $sys = \CRM_Extension_System
::singleton();
432 return new \
CRM_Core_Resources(
434 $container->get('cache.js_strings'),
435 \CRM_Core_Config
::isUpgradeMode() ?
NULL : 'resCacheCode'
440 * @param ContainerInterface $container
441 * @return \CRM_Core_PrevNextCache_Interface
443 public static function createPrevNextCache($container) {
444 $setting = \Civi
::settings()->get('prevNextBackend');
445 if ($setting === 'default') {
446 // For initial release (5.8.x), continue defaulting to SQL.
447 $isTransitional = version_compare(\CRM_Utils_System
::version(), '5.9.alpha1', '<');
448 $cacheDriver = \CRM_Utils_Cache
::getCacheDriver();
449 $service = 'prevnext.driver.' . strtolower($cacheDriver);
450 return $container->has($service) && !$isTransitional
451 ?
$container->get($service)
452 : $container->get('prevnext.driver.sql');
455 return $container->get('prevnext.driver.' . $setting);
459 public static function createCacheConfig() {
460 $driver = \CRM_Utils_Cache
::getCacheDriver();
461 $settings = \CRM_Utils_Cache
::getCacheSettings($driver);
462 $settings['driver'] = $driver;
463 return new \
ArrayObject($settings);
467 * Get a list of boot services.
469 * These are services which must be setup *before* the container can operate.
471 * @param bool $loadFromDB
472 * @throws \CRM_Core_Exception
474 public static function boot($loadFromDB) {
475 // Array(string $serviceId => object $serviceInstance).
476 $bootServices = array();
477 \Civi
::$statics[__CLASS__
]['boot'] = &$bootServices;
479 $bootServices['runtime'] = $runtime = new \
CRM_Core_Config_Runtime();
480 $runtime->initialize($loadFromDB);
482 $bootServices['paths'] = new \Civi\Core\
Paths();
484 $class = $runtime->userFrameworkClass
;
485 $bootServices['userSystem'] = $userSystem = new $class();
486 $userSystem->initialize();
488 $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework
;
489 $bootServices['userPermissionClass'] = new $userPermissionClass();
491 $bootServices['cache.settings'] = \CRM_Utils_Cache
::create(array(
492 'name' => 'settings',
493 'type' => array('*memory*', 'SqlGroup', 'ArrayCache'),
496 $bootServices['settings_manager'] = new \Civi\Core\
SettingsManager($bootServices['cache.settings']);
498 $bootServices['lockManager'] = self
::createLockManager();
500 if ($loadFromDB && $runtime->dsn
) {
501 \CRM_Core_DAO
::init($runtime->dsn
);
502 \CRM_Utils_Hook
::singleton(TRUE);
503 \CRM_Extension_System
::singleton(TRUE);
504 \CRM_Extension_System
::singleton(TRUE)->getClassLoader()->register();
506 $runtime->includeCustomPath();
509 $container = $c->loadContainer();
510 foreach ($bootServices as $name => $obj) {
511 $container->set($name, $obj);
513 \Civi
::$statics[__CLASS__
]['container'] = $container;
517 public static function getBootService($name) {
518 return \Civi
::$statics[__CLASS__
]['boot'][$name];
522 * Determine whether the container services are available.
526 public static function isContainerBooted() {
527 return isset(\Civi
::$statics[__CLASS__
]['container']);