Commit | Line | Data |
---|---|---|
fa184193 TO |
1 | <?php |
2 | namespace Civi\Core; | |
46bcf597 | 3 | |
c8d84653 | 4 | use Civi\Core\Event\EventScanner; |
10760fa1 | 5 | use Civi\Core\Lock\LockManager; |
40787e18 | 6 | use Symfony\Component\Config\ConfigCache; |
fa184193 TO |
7 | use Symfony\Component\DependencyInjection\ContainerBuilder; |
8 | use Symfony\Component\DependencyInjection\Definition; | |
40787e18 | 9 | use Symfony\Component\DependencyInjection\Dumper\PhpDumper; |
fa184193 | 10 | use Symfony\Component\DependencyInjection\Reference; |
40787e18 | 11 | use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass; |
fa184193 TO |
12 | |
13 | // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader; | |
14 | ||
6550386a EM |
15 | /** |
16 | * Class Container | |
17 | * @package Civi\Core | |
18 | */ | |
fa184193 TO |
19 | class Container { |
20 | ||
21 | const SELF = 'civi_container_factory'; | |
22 | ||
fa184193 | 23 | /** |
04855556 TO |
24 | * @param bool $reset |
25 | * Whether to forcibly rebuild the entire container. | |
fa184193 TO |
26 | * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface |
27 | */ | |
378e2654 | 28 | public static function singleton($reset = FALSE) { |
7f835399 TO |
29 | if ($reset || !isset(\Civi::$statics[__CLASS__]['container'])) { |
30 | self::boot(TRUE); | |
fa184193 | 31 | } |
7f835399 | 32 | return \Civi::$statics[__CLASS__]['container']; |
fa184193 TO |
33 | } |
34 | ||
35 | /** | |
40787e18 TO |
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 | |
40787e18 | 49 | * |
34f3bbd9 | 50 | * @return \Symfony\Component\DependencyInjection\ContainerInterface |
40787e18 TO |
51 | */ |
52 | public function loadContainer() { | |
53 | // Note: The container's raison d'etre is to manage construction of other | |
54 | // services. Consequently, we assume a minimal service available -- the classloader | |
55 | // has been setup, and civicrm.settings.php is loaded, but nothing else works. | |
56 | ||
5497e016 | 57 | $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE : 'auto'; |
40787e18 TO |
58 | |
59 | // In pre-installation environments, don't bother with caching. | |
43a2114e | 60 | if (!defined('CIVICRM_DSN') || defined('CIVICRM_TEST') || CIVICRM_UF === 'UnitTests' || $cacheMode === 'never' || \CRM_Utils_System::isInUpgradeMode()) { |
12e01332 TO |
61 | $containerBuilder = $this->createContainer(); |
62 | $containerBuilder->compile(); | |
63 | return $containerBuilder; | |
40787e18 TO |
64 | } |
65 | ||
83617886 | 66 | $envId = \CRM_Core_Config_Runtime::getId(); |
6f50d29c | 67 | $file = \Civi::paths()->getPath("[civicrm.compile]/CachedCiviContainer.{$envId}.php"); |
40787e18 | 68 | $containerConfigCache = new ConfigCache($file, $cacheMode === 'auto'); |
40787e18 TO |
69 | if (!$containerConfigCache->isFresh()) { |
70 | $containerBuilder = $this->createContainer(); | |
71 | $containerBuilder->compile(); | |
72 | $dumper = new PhpDumper($containerBuilder); | |
73 | $containerConfigCache->write( | |
c64f69d9 | 74 | $dumper->dump(['class' => 'CachedCiviContainer']), |
40787e18 TO |
75 | $containerBuilder->getResources() |
76 | ); | |
77 | } | |
78 | ||
79 | require_once $file; | |
80 | $c = new \CachedCiviContainer(); | |
40787e18 TO |
81 | return $c; |
82 | } | |
83 | ||
84 | /** | |
85 | * Construct a new container. | |
86 | * | |
34f3bbd9 | 87 | * @var \Symfony\Component\DependencyInjection\ContainerBuilder |
77b97be7 | 88 | * @return \Symfony\Component\DependencyInjection\ContainerBuilder |
fa184193 TO |
89 | */ |
90 | public function createContainer() { | |
91 | $civicrm_base_path = dirname(dirname(__DIR__)); | |
92 | $container = new ContainerBuilder(); | |
40787e18 TO |
93 | $container->addCompilerPass(new RegisterListenersPass('dispatcher')); |
94 | $container->addObjectResource($this); | |
fa184193 | 95 | $container->setParameter('civicrm_base_path', $civicrm_base_path); |
40787e18 | 96 | //$container->set(self::SELF, $this); |
762dc04d TO |
97 | |
98 | $container->addResource(new \Symfony\Component\Config\Resource\FileResource(__FILE__)); | |
99 | ||
40787e18 TO |
100 | $container->setDefinition(self::SELF, new Definition( |
101 | 'Civi\Core\Container', | |
c64f69d9 | 102 | [] |
40787e18 | 103 | )); |
fa184193 | 104 | |
505d8b83 TO |
105 | // TODO Move configuration to an external file; define caching structure |
106 | // if (empty($configDirectories)) { | |
107 | // throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)'); | |
108 | // } | |
109 | // $locator = new FileLocator($configDirectories); | |
110 | // $loaderResolver = new LoaderResolver(array( | |
111 | // new YamlFileLoader($container, $locator) | |
112 | // )); | |
113 | // $delegatingLoader = new DelegatingLoader($loaderResolver); | |
114 | // foreach (array('services.yml') as $file) { | |
115 | // $yamlUserFiles = $locator->locate($file, NULL, FALSE); | |
116 | // foreach ($yamlUserFiles as $file) { | |
117 | // $delegatingLoader->load($file); | |
118 | // } | |
119 | // } | |
fa184193 | 120 | |
16072ce1 | 121 | $container->setDefinition('angular', new Definition( |
40787e18 | 122 | 'Civi\Angular\Manager', |
c64f69d9 | 123 | [] |
16072ce1 | 124 | )) |
3c006cb8 | 125 | ->setFactory([new Reference(self::SELF), 'createAngularManager'])->setPublic(TRUE); |
16072ce1 | 126 | |
9bd30577 CW |
127 | $container->setDefinition('angularjs.loader', new Definition('Civi\Angular\AngularLoader', [])) |
128 | ->setPublic(TRUE); | |
129 | ||
fa184193 | 130 | $container->setDefinition('dispatcher', new Definition( |
762dc04d | 131 | 'Civi\Core\CiviEventDispatcher', |
42ccedc7 | 132 | [] |
fa184193 | 133 | )) |
3c006cb8 | 134 | ->setFactory([new Reference(self::SELF), 'createEventDispatcher'])->setPublic(TRUE); |
fa184193 | 135 | |
c65db512 | 136 | $container->setDefinition('magic_function_provider', new Definition( |
40787e18 | 137 | 'Civi\API\Provider\MagicFunctionProvider', |
c64f69d9 | 138 | [] |
3c006cb8 | 139 | ))->setPublic(TRUE); |
c65db512 | 140 | |
0f643fb2 | 141 | $container->setDefinition('civi_api_kernel', new Definition( |
40787e18 | 142 | 'Civi\API\Kernel', |
c64f69d9 | 143 | [new Reference('dispatcher'), new Reference('magic_function_provider')] |
0f643fb2 | 144 | )) |
3c006cb8 | 145 | ->setFactory([new Reference(self::SELF), 'createApiKernel'])->setPublic(TRUE); |
0f643fb2 | 146 | |
7b4bbb34 | 147 | $container->setDefinition('cxn_reg_client', new Definition( |
40787e18 | 148 | 'Civi\Cxn\Rpc\RegistrationClient', |
c64f69d9 | 149 | [] |
7b4bbb34 | 150 | )) |
3c006cb8 | 151 | ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient')->setPublic(TRUE); |
7b4bbb34 | 152 | |
3c006cb8 | 153 | $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', []))->setPublic(TRUE); |
c213eb51 TO |
154 | $container->setDefinition('psr_log_manager', new Definition('Civi\Core\LogManager', []))->setPublic(TRUE); |
155 | // With the default log-manager, you may overload a channel by defining a service, e.g. | |
156 | // $container->setDefinition('log.ipn', new Definition('CRM_Core_Error_Log', []))->setPublic(TRUE); | |
6e5ad5ee | 157 | |
c64f69d9 | 158 | $basicCaches = [ |
7a19d718 TO |
159 | 'js_strings' => 'js_strings', |
160 | 'community_messages' => 'community_messages', | |
b1fc1ab0 | 161 | 'checks' => 'checks', |
19707a63 | 162 | 'session' => 'CiviCRM Session', |
90cdaa0e | 163 | 'long' => 'long', |
0136044e | 164 | 'groups' => 'contact groups', |
96689db3 | 165 | 'navigation' => 'navigation', |
792fce0b | 166 | 'customData' => 'custom data', |
9cdf85c1 | 167 | 'fields' => 'contact fields', |
81c4c148 | 168 | 'contactTypes' => 'contactTypes', |
eb151aab | 169 | 'metadata' => 'metadata', |
c64f69d9 | 170 | ]; |
7a19d718 | 171 | foreach ($basicCaches as $cacheSvc => $cacheGrp) { |
023bcf83 SL |
172 | $definitionParams = [ |
173 | 'name' => $cacheGrp, | |
174 | 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'], | |
175 | ]; | |
176 | // For Caches that we don't really care about the ttl for and/or maybe accessed | |
177 | // fairly often we use the fastArrayDecorator which improves reads and writes, these | |
178 | // caches should also not have concurrency risk. | |
eb151aab | 179 | $fastArrayCaches = ['groups', 'navigation', 'customData', 'fields', 'contactTypes', 'metadata']; |
023bcf83 SL |
180 | if (in_array($cacheSvc, $fastArrayCaches)) { |
181 | $definitionParams['withArray'] = 'fast'; | |
182 | } | |
7a19d718 | 183 | $container->setDefinition("cache.{$cacheSvc}", new Definition( |
a4704404 | 184 | 'CRM_Utils_Cache_Interface', |
023bcf83 | 185 | [$definitionParams] |
3c006cb8 | 186 | ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE); |
a4704404 | 187 | } |
3a84c0ab | 188 | |
da4effce SL |
189 | // PrevNextCache cannot use memory or array cache at the moment because the |
190 | // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed. | |
191 | $container->setDefinition("cache.prevNextCache", new Definition( | |
192 | 'CRM_Utils_Cache_Interface', | |
193 | [ | |
194 | [ | |
195 | 'name' => 'CiviCRM Search PrevNextCache', | |
196 | 'type' => ['SqlGroup'], | |
197 | ], | |
198 | ] | |
3c006cb8 | 199 | ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE); |
da4effce | 200 | |
4ed867e0 TO |
201 | $container->setDefinition('sql_triggers', new Definition( |
202 | 'Civi\Core\SqlTriggers', | |
c64f69d9 | 203 | [] |
3c006cb8 | 204 | ))->setPublic(TRUE); |
4ed867e0 | 205 | |
87e3fe24 TO |
206 | $container->setDefinition('asset_builder', new Definition( |
207 | 'Civi\Core\AssetBuilder', | |
c64f69d9 | 208 | [] |
3c006cb8 | 209 | ))->setPublic(TRUE); |
87e3fe24 | 210 | |
d89d2545 TO |
211 | $container->setDefinition('themes', new Definition( |
212 | 'Civi\Core\Themes', | |
213 | [] | |
3c006cb8 | 214 | ))->setPublic(TRUE); |
386fe6c2 EM |
215 | |
216 | $container->setDefinition('format', new Definition( | |
217 | '\Civi\Core\Format', | |
218 | [] | |
219 | ))->setPublic(TRUE); | |
d89d2545 | 220 | |
6e7adedc | 221 | $container->setDefinition('bundle.bootstrap3', new Definition('CRM_Core_Resources_Bundle', ['bootstrap3'])) |
3c86501c | 222 | ->setFactory('CRM_Core_Resources_Common::createBootstrap3Bundle')->setPublic(TRUE); |
6e7adedc | 223 | |
b2d8361e | 224 | $container->setDefinition('bundle.coreStyles', new Definition('CRM_Core_Resources_Bundle', ['coreStyles'])) |
3c86501c | 225 | ->setFactory('CRM_Core_Resources_Common::createStyleBundle')->setPublic(TRUE); |
b2d8361e TO |
226 | |
227 | $container->setDefinition('bundle.coreResources', new Definition('CRM_Core_Resources_Bundle', ['coreResources'])) | |
3c86501c | 228 | ->setFactory('CRM_Core_Resources_Common::createFullBundle')->setPublic(TRUE); |
b2d8361e | 229 | |
247eb841 | 230 | $container->setDefinition('pear_mail', new Definition('Mail')) |
3c86501c | 231 | ->setFactory('CRM_Utils_Mail::createMailer')->setPublic(TRUE); |
247eb841 | 232 | |
281eacd8 | 233 | $container->setDefinition('crypto.registry', new Definition('Civi\Crypto\CryptoService')) |
23fa0118 | 234 | ->setFactory('Civi\Crypto\CryptoRegistry::createDefaultRegistry')->setPublic(TRUE); |
281eacd8 | 235 | |
7c5110c3 TO |
236 | $container->setDefinition('crypto.token', new Definition('Civi\Crypto\CryptoToken', [])) |
237 | ->setPublic(TRUE); | |
8d3452c4 | 238 | |
9c976d32 TO |
239 | $container->setDefinition('crypto.jwt', new Definition('Civi\Crypto\CryptoJwt', [])) |
240 | ->setPublic(TRUE); | |
241 | ||
7f835399 | 242 | if (empty(\Civi::$statics[__CLASS__]['boot'])) { |
272dfdc3 | 243 | throw new \RuntimeException('Cannot initialize container. Boot services are undefined.'); |
7f835399 TO |
244 | } |
245 | foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) { | |
765daeac | 246 | $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE)->setPublic(TRUE); |
83617886 TO |
247 | } |
248 | ||
c8074a93 | 249 | // Expose legacy singletons as services in the container. |
c64f69d9 | 250 | $singletons = [ |
c8074a93 | 251 | 'httpClient' => 'CRM_Utils_HttpClient', |
7b5937fe | 252 | 'cache.default' => 'CRM_Utils_Cache', |
a7c57397 | 253 | 'i18n' => 'CRM_Core_I18n', |
c8074a93 TO |
254 | // Maybe? 'config' => 'CRM_Core_Config', |
255 | // Maybe? 'smarty' => 'CRM_Core_Smarty', | |
c64f69d9 | 256 | ]; |
c8074a93 TO |
257 | foreach ($singletons as $name => $class) { |
258 | $container->setDefinition($name, new Definition( | |
259 | $class | |
260 | )) | |
3c006cb8 | 261 | ->setFactory([$class, 'singleton'])->setPublic(TRUE); |
c8074a93 | 262 | } |
e5c6b3cd | 263 | $container->setAlias('cache.short', 'cache.default')->setPublic(TRUE); |
c8074a93 | 264 | |
88d93265 | 265 | $container->setDefinition('civi.pipe', new Definition( |
25804d7a | 266 | 'Civi\Pipe\PipeSession', |
1e88220a | 267 | [] |
88d93265 | 268 | ))->setPublic(TRUE)->setShared(FALSE); |
1e88220a | 269 | |
223ba025 TO |
270 | $container->setDefinition('resources', new Definition( |
271 | 'CRM_Core_Resources', | |
272 | [new Reference('service_container')] | |
3c006cb8 | 273 | ))->setFactory([new Reference(self::SELF), 'createResources'])->setPublic(TRUE); |
223ba025 | 274 | |
bbcf0f46 TO |
275 | $container->setDefinition('resources.js_strings', new Definition( |
276 | 'CRM_Core_Resources_Strings', | |
277 | [new Reference('cache.js_strings')] | |
278 | ))->setPublic(TRUE); | |
279 | ||
780fd0e3 | 280 | $container->setDefinition('prevnext', new Definition( |
99098349 TO |
281 | 'CRM_Core_PrevNextCache_Interface', |
282 | [new Reference('service_container')] | |
3c006cb8 | 283 | ))->setFactory([new Reference(self::SELF), 'createPrevNextCache'])->setPublic(TRUE); |
99098349 TO |
284 | |
285 | $container->setDefinition('prevnext.driver.sql', new Definition( | |
780fd0e3 TO |
286 | 'CRM_Core_PrevNextCache_Sql', |
287 | [] | |
3c006cb8 | 288 | ))->setPublic(TRUE); |
780fd0e3 | 289 | |
751f3d98 TO |
290 | $container->setDefinition('prevnext.driver.redis', new Definition( |
291 | 'CRM_Core_PrevNextCache_Redis', | |
292 | [new Reference('cache_config')] | |
3c006cb8 | 293 | ))->setPublic(TRUE); |
751f3d98 TO |
294 | |
295 | $container->setDefinition('cache_config', new Definition('ArrayObject')) | |
3c006cb8 | 296 | ->setFactory([new Reference(self::SELF), 'createCacheConfig'])->setPublic(TRUE); |
751f3d98 | 297 | |
e0a667ad TO |
298 | $container->setDefinition('civi.activity.triggers', new Definition( |
299 | 'Civi\Core\SqlTrigger\TimestampTriggers', | |
c64f69d9 | 300 | ['civicrm_activity', 'Activity'] |
3c006cb8 | 301 | ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE); |
e0a667ad TO |
302 | |
303 | $container->setDefinition('civi.case.triggers', new Definition( | |
304 | 'Civi\Core\SqlTrigger\TimestampTriggers', | |
c64f69d9 | 305 | ['civicrm_case', 'Case'] |
3c006cb8 | 306 | ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE); |
e0a667ad | 307 | |
b21ffed7 TO |
308 | $container->setDefinition('civi.case.staticTriggers', new Definition( |
309 | 'Civi\Core\SqlTrigger\StaticTriggers', | |
c64f69d9 CW |
310 | [ |
311 | [ | |
312 | [ | |
313 | 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'], | |
b21ffed7 TO |
314 | 'table' => 'civicrm_case_activity', |
315 | 'when' => 'AFTER', | |
c64f69d9 | 316 | 'event' => ['INSERT'], |
b21ffed7 | 317 | 'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n", |
c64f69d9 CW |
318 | ], |
319 | [ | |
320 | 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'], | |
b21ffed7 TO |
321 | 'table' => 'civicrm_activity', |
322 | 'when' => 'BEFORE', | |
c64f69d9 | 323 | 'event' => ['UPDATE', 'DELETE'], |
b21ffed7 | 324 | '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", |
c64f69d9 CW |
325 | ], |
326 | ], | |
327 | ] | |
b21ffed7 | 328 | )) |
3c006cb8 | 329 | ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE); |
b21ffed7 | 330 | |
43ceab3f TO |
331 | $container->setDefinition('civi_token_compat', new Definition( |
332 | 'Civi\Token\TokenCompatSubscriber', | |
c64f69d9 | 333 | [] |
3c006cb8 | 334 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); |
56df2d06 | 335 | $container->setDefinition("crm_mailing_action_tokens", new Definition( |
0f4031da | 336 | 'CRM_Mailing_ActionTokens', |
c64f69d9 | 337 | [] |
3c006cb8 | 338 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); |
43ceab3f | 339 | |
a7f29bf4 | 340 | foreach (['Activity', 'Contact', 'Contribute', 'Event', 'Mailing', 'Member', 'Case'] as $comp) { |
0f4031da | 341 | $container->setDefinition('crm_' . strtolower($comp) . '_tokens', new Definition( |
46f5566c | 342 | "CRM_{$comp}_Tokens", |
c64f69d9 | 343 | [] |
3c006cb8 | 344 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); |
46f5566c | 345 | } |
fa75f064 TO |
346 | $container->setDefinition('civi_token_impliedcontext', new Definition( |
347 | 'Civi\Token\ImpliedContextSubscriber', | |
348 | [] | |
349 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); | |
b7472bd6 EM |
350 | $container->setDefinition('crm_participant_tokens', new Definition( |
351 | 'CRM_Event_ParticipantTokens', | |
352 | [] | |
353 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); | |
0f4031da EM |
354 | $container->setDefinition('crm_contribution_recur_tokens', new Definition( |
355 | 'CRM_Contribute_RecurTokens', | |
356 | [] | |
357 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); | |
3c78698e EM |
358 | $container->setDefinition('crm_domain_tokens', new Definition( |
359 | 'CRM_Core_DomainTokens', | |
360 | [] | |
361 | ))->addTag('kernel.event_subscriber')->setPublic(TRUE); | |
50a23755 | 362 | |
c8d84653 TO |
363 | $dispatcherDefn = $container->getDefinition('dispatcher'); |
364 | foreach (\CRM_Core_DAO_AllCoreTables::getBaoClasses() as $baoEntity => $baoClass) { | |
365 | $listenerMap = EventScanner::findListeners($baoClass, $baoEntity); | |
366 | if ($listenerMap) { | |
367 | $file = (new \ReflectionClass($baoClass))->getFileName(); | |
368 | $container->addResource(new \Symfony\Component\Config\Resource\FileResource($file)); | |
369 | $dispatcherDefn->addMethodCall('addListenerMap', [$baoClass, $listenerMap]); | |
370 | } | |
371 | } | |
372 | ||
caaeea39 | 373 | \CRM_Api4_Services::hook_container($container); |
aa4343bc | 374 | |
40787e18 TO |
375 | \CRM_Utils_Hook::container($container); |
376 | ||
fa184193 TO |
377 | return $container; |
378 | } | |
379 | ||
16072ce1 TO |
380 | /** |
381 | * @return \Civi\Angular\Manager | |
382 | */ | |
383 | public function createAngularManager() { | |
384 | return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton()); | |
385 | } | |
386 | ||
fa184193 | 387 | /** |
3c006cb8 | 388 | * @return \Symfony\Component\EventDispatcher\EventDispatcher |
fa184193 | 389 | */ |
42ccedc7 TO |
390 | public function createEventDispatcher() { |
391 | // Continue building on the original dispatcher created during bootstrap. | |
9bd30577 | 392 | /** @var CiviEventDispatcher $dispatcher */ |
42ccedc7 | 393 | $dispatcher = static::getBootService('dispatcher.boot'); |
ecb0ae5d | 394 | |
cc69f300 TO |
395 | // Sometimes, you have a generic event ('hook_pre') and wish to fire more targeted aliases ('hook_pre::MyEntity') to allow shorter subscriber lists. |
396 | $aliasEvent = function($eventName, $fieldName) { | |
397 | return function($e) use ($eventName, $fieldName) { | |
398 | \Civi::dispatcher()->dispatch($eventName . "::" . $e->{$fieldName}, $e); | |
399 | }; | |
400 | }; | |
4bf92107 TO |
401 | $aliasMethodEvent = function($eventName, $methodName) { |
402 | return function($e) use ($eventName, $methodName) { | |
403 | \Civi::dispatcher()->dispatch($eventName . "::" . $e->{$methodName}(), $e); | |
404 | }; | |
405 | }; | |
406 | ||
407 | $dispatcher->addListener('civi.api4.validate', $aliasMethodEvent('civi.api4.validate', 'getEntityName'), 100); | |
af4cccf7 | 408 | $dispatcher->addListener('civi.api4.authorizeRecord', $aliasMethodEvent('civi.api4.authorizeRecord', 'getEntityName'), 100); |
304fc59f | 409 | $dispatcher->addListener('civi.api4.entityTypes', ['\Civi\Api4\Provider\CustomEntityProvider', 'addCustomEntities'], 100); |
cc69f300 | 410 | |
1d440215 TO |
411 | $dispatcher->addListener('civi.core.install', ['\Civi\Core\InstallationCanary', 'check']); |
412 | $dispatcher->addListener('civi.core.install', ['\Civi\Core\DatabaseInitializer', 'initialize']); | |
413 | $dispatcher->addListener('civi.core.install', ['\Civi\Core\LocalizationInitializer', 'initialize']); | |
74effac4 | 414 | $dispatcher->addListener('hook_civicrm_post', ['\CRM_Core_Transaction', 'addPostCommit'], -1000); |
cc69f300 | 415 | $dispatcher->addListener('hook_civicrm_pre', $aliasEvent('hook_civicrm_pre', 'entity'), 100); |
9d4c4ffd | 416 | $dispatcher->addListener('civi.dao.preDelete', ['\CRM_Core_BAO_EntityTag', 'preDeleteOtherEntity']); |
cc69f300 | 417 | $dispatcher->addListener('hook_civicrm_post', $aliasEvent('hook_civicrm_post', 'entity'), 100); |
c64f69d9 CW |
418 | $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']); |
419 | $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']); | |
420 | $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']); | |
421 | $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']); | |
f1aeb0ba | 422 | $dispatcher->addListener('hook_civicrm_cryptoRotateKey', ['\Civi\Crypto\RotateKeys', 'rotateSmtp']); |
c64f69d9 | 423 | $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']); |
0d0031a0 | 424 | // TODO We need a better code-convention for metadata about non-hook events. |
c64f69d9 CW |
425 | $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']); |
426 | $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']); | |
427 | $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']); | |
9bd30577 | 428 | $dispatcher->addListenerService('civi.region.render', ['angularjs.loader', 'onRegionRender']); |
c64f69d9 CW |
429 | $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']); |
430 | $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']); | |
f22fb451 | 431 | $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']); |
2daeb956 | 432 | $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderL10nJs']); |
303017a1 | 433 | $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']); |
62c20d1e | 434 | $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']); |
28e28c36 | 435 | $dispatcher->addListener('hook_civicrm_alterExternUrl', ['\CRM_Utils_System', 'migrateExternUrl'], 1000); |
54043949 CW |
436 | // Not a BAO class so it can't implement hookInterface |
437 | $dispatcher->addListener('hook_civicrm_post', ['CRM_Utils_Recent', 'on_hook_civicrm_post']); | |
29541977 TO |
438 | $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findConstPermissions'], 975); |
439 | $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findCiviPermissions'], 950); | |
440 | $dispatcher->addListener('hook_civicrm_permissionList', ['CRM_Core_Permission_List', 'findCmsPermissions'], 925); | |
441 | ||
d357f225 | 442 | $dispatcher->addListener('hook_civicrm_postSave_civicrm_domain', ['\CRM_Core_BAO_Domain', 'onPostSave']); |
c64f69d9 | 443 | $dispatcher->addListener('hook_civicrm_unhandled_exception', [ |
9ae2d27b TO |
444 | 'CRM_Core_LegacyErrorHandler', |
445 | 'handleException', | |
c64f69d9 | 446 | ], -200); |
bc2feeb1 TO |
447 | $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']); |
448 | $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']); | |
449 | $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']); | |
450 | $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']); | |
451 | $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Event_ActionMapping', 'onRegisterActionMappings']); | |
452 | $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Member_ActionMapping', 'onRegisterActionMappings']); | |
46f5566c | 453 | |
fa184193 TO |
454 | return $dispatcher; |
455 | } | |
0f643fb2 | 456 | |
10760fa1 | 457 | /** |
34f3bbd9 | 458 | * @return \Civi\Core\Lock\LockManager |
10760fa1 | 459 | */ |
83617886 | 460 | public static function createLockManager() { |
10760fa1 TO |
461 | // Ideally, downstream implementers could override any definitions in |
462 | // the container. For now, we'll make-do with some define()s. | |
463 | $lm = new LockManager(); | |
464 | $lm | |
c64f69d9 CW |
465 | ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : ['CRM_Core_Lock', 'createScopedLock']) |
466 | ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : ['CRM_Core_Lock', 'createScopedLock']) | |
467 | ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createCivimailLock']) | |
468 | ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : ['CRM_Core_Lock', 'createScopedLock']); | |
10760fa1 TO |
469 | |
470 | // Registrations may use complex resolver expressions, but (as a micro-optimization) | |
471 | // the default factory is specified as an array. | |
472 | ||
473 | return $lm; | |
474 | } | |
475 | ||
0f643fb2 TO |
476 | /** |
477 | * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher | |
2a6da8d7 EM |
478 | * @param $magicFunctionProvider |
479 | * | |
0f643fb2 TO |
480 | * @return \Civi\API\Kernel |
481 | */ | |
c65db512 | 482 | public function createApiKernel($dispatcher, $magicFunctionProvider) { |
0a946de2 | 483 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber()); |
b55bc593 | 484 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber()); |
bace5cd9 | 485 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber()); |
c65db512 | 486 | $dispatcher->addSubscriber($magicFunctionProvider); |
d0c9daa4 | 487 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck()); |
dcef11bd | 488 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter()); |
c64f69d9 | 489 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter([ |
6d3bdc98 TO |
490 | \CRM_Utils_API_HTMLInputCoder::singleton(), |
491 | \CRM_Utils_API_NullOutputCoder::singleton(), | |
492 | \CRM_Utils_API_ReloadOption::singleton(), | |
493 | \CRM_Utils_API_MatchOption::singleton(), | |
c64f69d9 | 494 | ])); |
2aafb0fc | 495 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\DebugSubscriber()); |
82376c19 TO |
496 | $kernel = new \Civi\API\Kernel($dispatcher); |
497 | ||
498 | $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel); | |
499 | $dispatcher->addSubscriber($reflectionProvider); | |
500 | ||
56154d36 TO |
501 | $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization( |
502 | $kernel, | |
503 | 'Attachment', | |
c64f69d9 | 504 | ['create', 'get', 'delete'], |
2e37a19f | 505 | // Given a file ID, determine the entity+table it's attached to. |
56154d36 TO |
506 | 'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id |
507 | FROM civicrm_file cf | |
508 | LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id | |
509 | WHERE cf.id = %1', | |
29468114 TO |
510 | // Get a list of custom fields (field_name,table_name,extends) |
511 | 'SELECT concat("custom_",fld.id) as field_name, | |
512 | grp.table_name as table_name, | |
513 | grp.extends as extends | |
514 | FROM civicrm_custom_field fld | |
515 | INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id | |
516 | WHERE fld.data_type = "File" | |
09871447 | 517 | ' |
56154d36 TO |
518 | )); |
519 | ||
c64f69d9 | 520 | $kernel->setApiProviders([ |
82376c19 TO |
521 | $reflectionProvider, |
522 | $magicFunctionProvider, | |
c64f69d9 | 523 | ]); |
82376c19 | 524 | |
0f643fb2 TO |
525 | return $kernel; |
526 | } | |
96025800 | 527 | |
223ba025 | 528 | /** |
34f3bbd9 | 529 | * @param \Symfony\Component\DependencyInjection\ContainerInterface $container |
223ba025 TO |
530 | * @return \CRM_Core_Resources |
531 | */ | |
532 | public static function createResources($container) { | |
533 | $sys = \CRM_Extension_System::singleton(); | |
534 | return new \CRM_Core_Resources( | |
535 | $sys->getMapper(), | |
bbcf0f46 | 536 | new \CRM_Core_Resources_Strings($container->get('cache.js_strings')), |
223ba025 TO |
537 | \CRM_Core_Config::isUpgradeMode() ? NULL : 'resCacheCode' |
538 | ); | |
539 | } | |
540 | ||
99098349 | 541 | /** |
34f3bbd9 | 542 | * @param \Symfony\Component\DependencyInjection\ContainerInterface $container |
99098349 TO |
543 | * @return \CRM_Core_PrevNextCache_Interface |
544 | */ | |
545 | public static function createPrevNextCache($container) { | |
e28bf654 | 546 | $setting = \Civi::settings()->get('prevNextBackend'); |
272dfdc3 | 547 | if (!$setting || $setting === 'default') { |
e28bf654 TO |
548 | $cacheDriver = \CRM_Utils_Cache::getCacheDriver(); |
549 | $service = 'prevnext.driver.' . strtolower($cacheDriver); | |
272dfdc3 | 550 | return $container->has($service) |
e28bf654 TO |
551 | ? $container->get($service) |
552 | : $container->get('prevnext.driver.sql'); | |
553 | } | |
272dfdc3 | 554 | return $container->get('prevnext.driver.' . $setting); |
99098349 TO |
555 | } |
556 | ||
272dfdc3 | 557 | /** |
558 | * @return \ArrayObject | |
559 | */ | |
751f3d98 TO |
560 | public static function createCacheConfig() { |
561 | $driver = \CRM_Utils_Cache::getCacheDriver(); | |
562 | $settings = \CRM_Utils_Cache::getCacheSettings($driver); | |
563 | $settings['driver'] = $driver; | |
564 | return new \ArrayObject($settings); | |
565 | } | |
566 | ||
83617886 TO |
567 | /** |
568 | * Get a list of boot services. | |
569 | * | |
570 | * These are services which must be setup *before* the container can operate. | |
571 | * | |
7f835399 | 572 | * @param bool $loadFromDB |
83617886 TO |
573 | * @throws \CRM_Core_Exception |
574 | */ | |
7f835399 | 575 | public static function boot($loadFromDB) { |
56eafc21 | 576 | // Array(string $serviceId => object $serviceInstance). |
c64f69d9 | 577 | $bootServices = []; |
7f835399 | 578 | \Civi::$statics[__CLASS__]['boot'] = &$bootServices; |
d4330c62 | 579 | |
56eafc21 | 580 | $bootServices['runtime'] = $runtime = new \CRM_Core_Config_Runtime(); |
7f835399 | 581 | $runtime->initialize($loadFromDB); |
d4330c62 | 582 | |
b1db062e H |
583 | $bootServices['paths'] = new \Civi\Core\Paths(); |
584 | ||
42ccedc7 | 585 | $bootServices['dispatcher.boot'] = new CiviEventDispatcher(); |
27e05c5c TO |
586 | |
587 | // Quality control: There should be no pre-boot hooks because they make it harder to understand/support/refactor. | |
588 | // If a pre-boot hook sneaks in, we'll raise an error. | |
589 | $bootDispatchPolicy = [ | |
590 | '/^hook_/' => 'not-ready', | |
591 | '/^civi\./' => 'run', | |
592 | ]; | |
593 | $mainDispatchPolicy = \CRM_Core_Config::isUpgradeMode() ? \CRM_Upgrade_DispatchPolicy::get('upgrade.main') : NULL; | |
594 | $bootServices['dispatcher.boot']->setDispatchPolicy($bootDispatchPolicy); | |
42ccedc7 | 595 | |
7f835399 | 596 | $class = $runtime->userFrameworkClass; |
56eafc21 | 597 | $bootServices['userSystem'] = $userSystem = new $class(); |
7f835399 TO |
598 | $userSystem->initialize(); |
599 | ||
600 | $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework; | |
56eafc21 | 601 | $bootServices['userPermissionClass'] = new $userPermissionClass(); |
7f835399 | 602 | |
c64f69d9 | 603 | $bootServices['cache.settings'] = \CRM_Utils_Cache::create([ |
56eafc21 | 604 | 'name' => 'settings', |
c64f69d9 CW |
605 | 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'], |
606 | ]); | |
7f835399 | 607 | |
56eafc21 | 608 | $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']); |
7f835399 | 609 | |
56eafc21 | 610 | $bootServices['lockManager'] = self::createLockManager(); |
7f835399 TO |
611 | |
612 | if ($loadFromDB && $runtime->dsn) { | |
3a036b15 | 613 | \CRM_Core_DAO::init($runtime->dsn); |
edbcbd96 | 614 | \CRM_Utils_Hook::singleton(TRUE); |
7f835399 | 615 | \CRM_Extension_System::singleton(TRUE); |
15e47dfc | 616 | \CRM_Extension_System::singleton()->getClassLoader()->register(); |
8aff4734 | 617 | \CRM_Extension_System::singleton()->getMixinLoader()->run(); |
27e05c5c | 618 | $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy); |
7f835399 | 619 | |
1b81ed50 | 620 | $runtime->includeCustomPath(); |
621 | ||
7f835399 | 622 | $c = new self(); |
56eafc21 TO |
623 | $container = $c->loadContainer(); |
624 | foreach ($bootServices as $name => $obj) { | |
625 | $container->set($name, $obj); | |
626 | } | |
627 | \Civi::$statics[__CLASS__]['container'] = $container; | |
acccf150 TO |
628 | // Ensure all container-based serivces have a chance to add their listeners. |
629 | // Without this, it's a matter of happenstance (dependent upon particular page-request/configuration/etc). | |
e103005b | 630 | $container->get('dispatcher'); |
631 | ||
83617886 | 632 | } |
27e05c5c TO |
633 | else { |
634 | $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy); | |
635 | } | |
83617886 TO |
636 | } |
637 | ||
272dfdc3 | 638 | /** |
639 | * @param string $name | |
640 | * | |
641 | * @return mixed | |
642 | */ | |
83617886 | 643 | public static function getBootService($name) { |
56eafc21 | 644 | return \Civi::$statics[__CLASS__]['boot'][$name]; |
83617886 TO |
645 | } |
646 | ||
4d8e83b6 TO |
647 | /** |
648 | * Determine whether the container services are available. | |
649 | * | |
650 | * @return bool | |
651 | */ | |
652 | public static function isContainerBooted() { | |
653 | return isset(\Civi::$statics[__CLASS__]['container']); | |
654 | } | |
655 | ||
fa184193 | 656 | } |