Merge pull request #17981 from eileenmcnaughton/merge_form
[civicrm-core.git] / Civi / Core / Container.php
CommitLineData
fa184193
TO
1<?php
2namespace Civi\Core;
46bcf597 3
10760fa1 4use Civi\Core\Lock\LockManager;
40787e18 5use Symfony\Component\Config\ConfigCache;
fa184193
TO
6use Symfony\Component\DependencyInjection\ContainerBuilder;
7use Symfony\Component\DependencyInjection\Definition;
40787e18 8use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
fa184193 9use Symfony\Component\DependencyInjection\Reference;
40787e18 10use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
fa184193
TO
11
12// TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
13
6550386a
EM
14/**
15 * Class Container
16 * @package Civi\Core
17 */
fa184193
TO
18class Container {
19
20 const SELF = 'civi_container_factory';
21
fa184193 22 /**
04855556
TO
23 * @param bool $reset
24 * Whether to forcibly rebuild the entire container.
fa184193
TO
25 * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
26 */
378e2654 27 public static function singleton($reset = FALSE) {
7f835399
TO
28 if ($reset || !isset(\Civi::$statics[__CLASS__]['container'])) {
29 self::boot(TRUE);
fa184193 30 }
7f835399 31 return \Civi::$statics[__CLASS__]['container'];
fa184193
TO
32 }
33
34 /**
40787e18
TO
35 * Find a cached container definition or construct a new one.
36 *
37 * There are many weird contexts in which Civi initializes (eg different
38 * variations of multitenancy and different permutations of CMS/CRM bootstrap),
39 * and hook_container may fire a bit differently in each context. To mitigate
40 * risk of leaks between environments, we compute a unique envID
41 * (md5(DB_NAME, HTTP_HOST, SCRIPT_FILENAME, etc)) and use separate caches for
42 * each (eg "templates_c/CachedCiviContainer.$ENVID.php").
43 *
44 * Constants:
45 * - CIVICRM_CONTAINER_CACHE -- 'always' [default], 'never', 'auto'
46 * - CIVICRM_DSN
47 * - CIVICRM_DOMAIN_ID
40787e18 48 *
34f3bbd9 49 * @return \Symfony\Component\DependencyInjection\ContainerInterface
40787e18
TO
50 */
51 public function loadContainer() {
52 // Note: The container's raison d'etre is to manage construction of other
53 // services. Consequently, we assume a minimal service available -- the classloader
54 // has been setup, and civicrm.settings.php is loaded, but nothing else works.
55
5497e016 56 $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE : 'auto';
40787e18
TO
57
58 // In pre-installation environments, don't bother with caching.
6f50d29c 59 if (!defined('CIVICRM_DSN') || $cacheMode === 'never' || \CRM_Utils_System::isInUpgradeMode()) {
12e01332
TO
60 $containerBuilder = $this->createContainer();
61 $containerBuilder->compile();
62 return $containerBuilder;
40787e18
TO
63 }
64
83617886 65 $envId = \CRM_Core_Config_Runtime::getId();
6f50d29c 66 $file = \Civi::paths()->getPath("[civicrm.compile]/CachedCiviContainer.{$envId}.php");
40787e18 67 $containerConfigCache = new ConfigCache($file, $cacheMode === 'auto');
40787e18
TO
68 if (!$containerConfigCache->isFresh()) {
69 $containerBuilder = $this->createContainer();
70 $containerBuilder->compile();
71 $dumper = new PhpDumper($containerBuilder);
72 $containerConfigCache->write(
c64f69d9 73 $dumper->dump(['class' => 'CachedCiviContainer']),
40787e18
TO
74 $containerBuilder->getResources()
75 );
76 }
77
78 require_once $file;
79 $c = new \CachedCiviContainer();
40787e18
TO
80 return $c;
81 }
82
83 /**
84 * Construct a new container.
85 *
34f3bbd9 86 * @var \Symfony\Component\DependencyInjection\ContainerBuilder
77b97be7 87 * @return \Symfony\Component\DependencyInjection\ContainerBuilder
fa184193
TO
88 */
89 public function createContainer() {
90 $civicrm_base_path = dirname(dirname(__DIR__));
91 $container = new ContainerBuilder();
40787e18
TO
92 $container->addCompilerPass(new RegisterListenersPass('dispatcher'));
93 $container->addObjectResource($this);
fa184193 94 $container->setParameter('civicrm_base_path', $civicrm_base_path);
40787e18 95 //$container->set(self::SELF, $this);
762dc04d
TO
96
97 $container->addResource(new \Symfony\Component\Config\Resource\FileResource(__FILE__));
98
40787e18
TO
99 $container->setDefinition(self::SELF, new Definition(
100 'Civi\Core\Container',
c64f69d9 101 []
40787e18 102 ));
fa184193 103
505d8b83
TO
104 // TODO Move configuration to an external file; define caching structure
105 // if (empty($configDirectories)) {
106 // throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)');
107 // }
108 // $locator = new FileLocator($configDirectories);
109 // $loaderResolver = new LoaderResolver(array(
110 // new YamlFileLoader($container, $locator)
111 // ));
112 // $delegatingLoader = new DelegatingLoader($loaderResolver);
113 // foreach (array('services.yml') as $file) {
114 // $yamlUserFiles = $locator->locate($file, NULL, FALSE);
115 // foreach ($yamlUserFiles as $file) {
116 // $delegatingLoader->load($file);
117 // }
118 // }
fa184193 119
16072ce1 120 $container->setDefinition('angular', new Definition(
40787e18 121 'Civi\Angular\Manager',
c64f69d9 122 []
16072ce1 123 ))
3c006cb8 124 ->setFactory([new Reference(self::SELF), 'createAngularManager'])->setPublic(TRUE);
16072ce1 125
fa184193 126 $container->setDefinition('dispatcher', new Definition(
762dc04d 127 'Civi\Core\CiviEventDispatcher',
42ccedc7 128 []
fa184193 129 ))
3c006cb8 130 ->setFactory([new Reference(self::SELF), 'createEventDispatcher'])->setPublic(TRUE);
fa184193 131
c65db512 132 $container->setDefinition('magic_function_provider', new Definition(
40787e18 133 'Civi\API\Provider\MagicFunctionProvider',
c64f69d9 134 []
3c006cb8 135 ))->setPublic(TRUE);
c65db512 136
0f643fb2 137 $container->setDefinition('civi_api_kernel', new Definition(
40787e18 138 'Civi\API\Kernel',
c64f69d9 139 [new Reference('dispatcher'), new Reference('magic_function_provider')]
0f643fb2 140 ))
3c006cb8 141 ->setFactory([new Reference(self::SELF), 'createApiKernel'])->setPublic(TRUE);
0f643fb2 142
7b4bbb34 143 $container->setDefinition('cxn_reg_client', new Definition(
40787e18 144 'Civi\Cxn\Rpc\RegistrationClient',
c64f69d9 145 []
7b4bbb34 146 ))
3c006cb8 147 ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient')->setPublic(TRUE);
7b4bbb34 148
3c006cb8 149 $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', []))->setPublic(TRUE);
6e5ad5ee 150
c64f69d9 151 $basicCaches = [
7a19d718
TO
152 'js_strings' => 'js_strings',
153 'community_messages' => 'community_messages',
b1fc1ab0 154 'checks' => 'checks',
19707a63 155 'session' => 'CiviCRM Session',
90cdaa0e 156 'long' => 'long',
0136044e 157 'groups' => 'contact groups',
96689db3 158 'navigation' => 'navigation',
792fce0b 159 'customData' => 'custom data',
9cdf85c1 160 'fields' => 'contact fields',
81c4c148 161 'contactTypes' => 'contactTypes',
eb151aab 162 'metadata' => 'metadata',
c64f69d9 163 ];
7a19d718 164 foreach ($basicCaches as $cacheSvc => $cacheGrp) {
023bcf83
SL
165 $definitionParams = [
166 'name' => $cacheGrp,
167 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
168 ];
169 // For Caches that we don't really care about the ttl for and/or maybe accessed
170 // fairly often we use the fastArrayDecorator which improves reads and writes, these
171 // caches should also not have concurrency risk.
eb151aab 172 $fastArrayCaches = ['groups', 'navigation', 'customData', 'fields', 'contactTypes', 'metadata'];
023bcf83
SL
173 if (in_array($cacheSvc, $fastArrayCaches)) {
174 $definitionParams['withArray'] = 'fast';
175 }
7a19d718 176 $container->setDefinition("cache.{$cacheSvc}", new Definition(
a4704404 177 'CRM_Utils_Cache_Interface',
023bcf83 178 [$definitionParams]
3c006cb8 179 ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
a4704404 180 }
3a84c0ab 181
da4effce
SL
182 // PrevNextCache cannot use memory or array cache at the moment because the
183 // Code in CRM_Core_BAO_PrevNextCache assumes that this cache is sql backed.
184 $container->setDefinition("cache.prevNextCache", new Definition(
185 'CRM_Utils_Cache_Interface',
186 [
187 [
188 'name' => 'CiviCRM Search PrevNextCache',
189 'type' => ['SqlGroup'],
190 ],
191 ]
3c006cb8 192 ))->setFactory('CRM_Utils_Cache::create')->setPublic(TRUE);
da4effce 193
4ed867e0
TO
194 $container->setDefinition('sql_triggers', new Definition(
195 'Civi\Core\SqlTriggers',
c64f69d9 196 []
3c006cb8 197 ))->setPublic(TRUE);
4ed867e0 198
87e3fe24
TO
199 $container->setDefinition('asset_builder', new Definition(
200 'Civi\Core\AssetBuilder',
c64f69d9 201 []
3c006cb8 202 ))->setPublic(TRUE);
87e3fe24 203
d89d2545
TO
204 $container->setDefinition('themes', new Definition(
205 'Civi\Core\Themes',
206 []
3c006cb8 207 ))->setPublic(TRUE);
d89d2545 208
247eb841 209 $container->setDefinition('pear_mail', new Definition('Mail'))
a892989e 210 ->setFactory('CRM_Utils_Mail::createMailer');
247eb841 211
7f835399 212 if (empty(\Civi::$statics[__CLASS__]['boot'])) {
272dfdc3 213 throw new \RuntimeException('Cannot initialize container. Boot services are undefined.');
7f835399
TO
214 }
215 foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) {
765daeac 216 $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE)->setPublic(TRUE);
83617886
TO
217 }
218
c8074a93 219 // Expose legacy singletons as services in the container.
c64f69d9 220 $singletons = [
c8074a93 221 'httpClient' => 'CRM_Utils_HttpClient',
7b5937fe 222 'cache.default' => 'CRM_Utils_Cache',
a7c57397 223 'i18n' => 'CRM_Core_I18n',
c8074a93
TO
224 // Maybe? 'config' => 'CRM_Core_Config',
225 // Maybe? 'smarty' => 'CRM_Core_Smarty',
c64f69d9 226 ];
c8074a93
TO
227 foreach ($singletons as $name => $class) {
228 $container->setDefinition($name, new Definition(
229 $class
230 ))
3c006cb8 231 ->setFactory([$class, 'singleton'])->setPublic(TRUE);
c8074a93 232 }
90cdaa0e 233 $container->setAlias('cache.short', 'cache.default');
c8074a93 234
223ba025
TO
235 $container->setDefinition('resources', new Definition(
236 'CRM_Core_Resources',
237 [new Reference('service_container')]
3c006cb8 238 ))->setFactory([new Reference(self::SELF), 'createResources'])->setPublic(TRUE);
223ba025 239
780fd0e3 240 $container->setDefinition('prevnext', new Definition(
99098349
TO
241 'CRM_Core_PrevNextCache_Interface',
242 [new Reference('service_container')]
3c006cb8 243 ))->setFactory([new Reference(self::SELF), 'createPrevNextCache'])->setPublic(TRUE);
99098349
TO
244
245 $container->setDefinition('prevnext.driver.sql', new Definition(
780fd0e3
TO
246 'CRM_Core_PrevNextCache_Sql',
247 []
3c006cb8 248 ))->setPublic(TRUE);
780fd0e3 249
751f3d98
TO
250 $container->setDefinition('prevnext.driver.redis', new Definition(
251 'CRM_Core_PrevNextCache_Redis',
252 [new Reference('cache_config')]
3c006cb8 253 ))->setPublic(TRUE);
751f3d98
TO
254
255 $container->setDefinition('cache_config', new Definition('ArrayObject'))
3c006cb8 256 ->setFactory([new Reference(self::SELF), 'createCacheConfig'])->setPublic(TRUE);
751f3d98 257
e7a6eae8
SL
258 $container->setDefinition('civi.mailing.triggers', new Definition(
259 'Civi\Core\SqlTrigger\TimestampTriggers',
c64f69d9 260 ['civicrm_mailing', 'Mailing']
3c006cb8 261 ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
e7a6eae8 262
e0a667ad
TO
263 $container->setDefinition('civi.activity.triggers', new Definition(
264 'Civi\Core\SqlTrigger\TimestampTriggers',
c64f69d9 265 ['civicrm_activity', 'Activity']
3c006cb8 266 ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
e0a667ad
TO
267
268 $container->setDefinition('civi.case.triggers', new Definition(
269 'Civi\Core\SqlTrigger\TimestampTriggers',
c64f69d9 270 ['civicrm_case', 'Case']
3c006cb8 271 ))->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
e0a667ad 272
b21ffed7
TO
273 $container->setDefinition('civi.case.staticTriggers', new Definition(
274 'Civi\Core\SqlTrigger\StaticTriggers',
c64f69d9
CW
275 [
276 [
277 [
278 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
b21ffed7
TO
279 'table' => 'civicrm_case_activity',
280 'when' => 'AFTER',
c64f69d9 281 'event' => ['INSERT'],
b21ffed7 282 'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
c64f69d9
CW
283 ],
284 [
285 'upgrade_check' => ['table' => 'civicrm_case', 'column' => 'modified_date'],
b21ffed7
TO
286 'table' => 'civicrm_activity',
287 'when' => 'BEFORE',
c64f69d9 288 'event' => ['UPDATE', 'DELETE'],
b21ffed7 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",
c64f69d9
CW
290 ],
291 ],
292 ]
b21ffed7 293 ))
3c006cb8 294 ->addTag('kernel.event_listener', ['event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'])->setPublic(TRUE);
b21ffed7 295
43ceab3f
TO
296 $container->setDefinition('civi_token_compat', new Definition(
297 'Civi\Token\TokenCompatSubscriber',
c64f69d9 298 []
3c006cb8 299 ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
56df2d06
TO
300 $container->setDefinition("crm_mailing_action_tokens", new Definition(
301 "CRM_Mailing_ActionTokens",
c64f69d9 302 []
3c006cb8 303 ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
43ceab3f 304
c64f69d9 305 foreach (['Activity', 'Contribute', 'Event', 'Mailing', 'Member'] as $comp) {
46f5566c
TO
306 $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
307 "CRM_{$comp}_Tokens",
c64f69d9 308 []
3c006cb8 309 ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
46f5566c 310 }
50a23755 311
caaeea39 312 \CRM_Api4_Services::hook_container($container);
aa4343bc 313
40787e18
TO
314 \CRM_Utils_Hook::container($container);
315
fa184193
TO
316 return $container;
317 }
318
16072ce1
TO
319 /**
320 * @return \Civi\Angular\Manager
321 */
322 public function createAngularManager() {
323 return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton());
324 }
325
fa184193 326 /**
3c006cb8 327 * @return \Symfony\Component\EventDispatcher\EventDispatcher
fa184193 328 */
42ccedc7
TO
329 public function createEventDispatcher() {
330 // Continue building on the original dispatcher created during bootstrap.
331 $dispatcher = static::getBootService('dispatcher.boot');
ecb0ae5d 332
1d440215
TO
333 $dispatcher->addListener('civi.core.install', ['\Civi\Core\InstallationCanary', 'check']);
334 $dispatcher->addListener('civi.core.install', ['\Civi\Core\DatabaseInitializer', 'initialize']);
335 $dispatcher->addListener('civi.core.install', ['\Civi\Core\LocalizationInitializer', 'initialize']);
74effac4 336 $dispatcher->addListener('hook_civicrm_post', ['\CRM_Core_Transaction', 'addPostCommit'], -1000);
c64f69d9 337 $dispatcher->addListener('hook_civicrm_pre', ['\Civi\Core\Event\PreEvent', 'dispatchSubevent'], 100);
9d4c4ffd 338 $dispatcher->addListener('civi.dao.preDelete', ['\CRM_Core_BAO_EntityTag', 'preDeleteOtherEntity']);
c64f69d9
CW
339 $dispatcher->addListener('hook_civicrm_post', ['\Civi\Core\Event\PostEvent', 'dispatchSubevent'], 100);
340 $dispatcher->addListener('hook_civicrm_post::Activity', ['\Civi\CCase\Events', 'fireCaseChange']);
341 $dispatcher->addListener('hook_civicrm_post::Case', ['\Civi\CCase\Events', 'fireCaseChange']);
342 $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\Events', 'delegateToXmlListeners']);
343 $dispatcher->addListener('hook_civicrm_caseChange', ['\Civi\CCase\SequenceListener', 'onCaseChange_static']);
344 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\CiviEventInspector', 'findBuiltInEvents']);
0d0031a0 345 // TODO We need a better code-convention for metadata about non-hook events.
c64f69d9
CW
346 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\API\Events', 'hookEventDefs']);
347 $dispatcher->addListener('hook_civicrm_eventDefs', ['\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs']);
348 $dispatcher->addListener('hook_civicrm_buildAsset', ['\Civi\Angular\Page\Modules', 'buildAngularModules']);
349 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetJs']);
350 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Utils_VisualBundle', 'buildAssetCss']);
f22fb451 351 $dispatcher->addListener('hook_civicrm_buildAsset', ['\CRM_Core_Resources', 'renderMenubarStylesheet']);
303017a1 352 $dispatcher->addListener('hook_civicrm_coreResourceList', ['\CRM_Utils_System', 'appendCoreResources']);
62c20d1e 353 $dispatcher->addListener('hook_civicrm_getAssetUrl', ['\CRM_Utils_System', 'alterAssetUrl']);
28e28c36 354 $dispatcher->addListener('hook_civicrm_alterExternUrl', ['\CRM_Utils_System', 'migrateExternUrl'], 1000);
bcf70e08 355 $dispatcher->addListener('hook_civicrm_triggerInfo', ['\CRM_Contact_BAO_RelationshipCache', 'onHookTriggerInfo']);
c64f69d9
CW
356 $dispatcher->addListener('civi.dao.postInsert', ['\CRM_Core_BAO_RecurringEntity', 'triggerInsert']);
357 $dispatcher->addListener('civi.dao.postUpdate', ['\CRM_Core_BAO_RecurringEntity', 'triggerUpdate']);
358 $dispatcher->addListener('civi.dao.postDelete', ['\CRM_Core_BAO_RecurringEntity', 'triggerDelete']);
d357f225 359 $dispatcher->addListener('hook_civicrm_postSave_civicrm_domain', ['\CRM_Core_BAO_Domain', 'onPostSave']);
c64f69d9 360 $dispatcher->addListener('hook_civicrm_unhandled_exception', [
9ae2d27b
TO
361 'CRM_Core_LegacyErrorHandler',
362 'handleException',
c64f69d9 363 ], -200);
bc2feeb1
TO
364 $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Activity_ActionMapping', 'onRegisterActionMappings']);
365 $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contact_ActionMapping', 'onRegisterActionMappings']);
366 $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings']);
367 $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings']);
368 $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Event_ActionMapping', 'onRegisterActionMappings']);
369 $dispatcher->addListener('civi.actionSchedule.getMappings', ['CRM_Member_ActionMapping', 'onRegisterActionMappings']);
46f5566c 370
fa184193
TO
371 return $dispatcher;
372 }
0f643fb2 373
10760fa1 374 /**
34f3bbd9 375 * @return \Civi\Core\Lock\LockManager
10760fa1 376 */
83617886 377 public static function createLockManager() {
10760fa1
TO
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();
381 $lm
c64f69d9
CW
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']);
10760fa1
TO
386
387 // Registrations may use complex resolver expressions, but (as a micro-optimization)
388 // the default factory is specified as an array.
389
390 return $lm;
391 }
392
0f643fb2
TO
393 /**
394 * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
2a6da8d7
EM
395 * @param $magicFunctionProvider
396 *
0f643fb2
TO
397 * @return \Civi\API\Kernel
398 */
c65db512 399 public function createApiKernel($dispatcher, $magicFunctionProvider) {
0a946de2 400 $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
b55bc593 401 $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
bace5cd9 402 $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
c65db512 403 $dispatcher->addSubscriber($magicFunctionProvider);
d0c9daa4 404 $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
dcef11bd 405 $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
c64f69d9 406 $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter([
6d3bdc98
TO
407 \CRM_Utils_API_HTMLInputCoder::singleton(),
408 \CRM_Utils_API_NullOutputCoder::singleton(),
409 \CRM_Utils_API_ReloadOption::singleton(),
410 \CRM_Utils_API_MatchOption::singleton(),
c64f69d9 411 ]));
2aafb0fc 412 $dispatcher->addSubscriber(new \Civi\API\Subscriber\DebugSubscriber());
82376c19
TO
413 $kernel = new \Civi\API\Kernel($dispatcher);
414
415 $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
416 $dispatcher->addSubscriber($reflectionProvider);
417
56154d36
TO
418 $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
419 $kernel,
420 'Attachment',
c64f69d9 421 ['create', 'get', 'delete'],
2e37a19f 422 // Given a file ID, determine the entity+table it's attached to.
56154d36
TO
423 'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
424 FROM civicrm_file cf
425 LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
426 WHERE cf.id = %1',
29468114
TO
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"
09871447 434 '
56154d36
TO
435 ));
436
c64f69d9 437 $kernel->setApiProviders([
82376c19
TO
438 $reflectionProvider,
439 $magicFunctionProvider,
c64f69d9 440 ]);
82376c19 441
0f643fb2
TO
442 return $kernel;
443 }
96025800 444
223ba025 445 /**
34f3bbd9 446 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
223ba025
TO
447 * @return \CRM_Core_Resources
448 */
449 public static function createResources($container) {
450 $sys = \CRM_Extension_System::singleton();
451 return new \CRM_Core_Resources(
452 $sys->getMapper(),
453 $container->get('cache.js_strings'),
454 \CRM_Core_Config::isUpgradeMode() ? NULL : 'resCacheCode'
455 );
456 }
457
99098349 458 /**
34f3bbd9 459 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
99098349
TO
460 * @return \CRM_Core_PrevNextCache_Interface
461 */
462 public static function createPrevNextCache($container) {
e28bf654 463 $setting = \Civi::settings()->get('prevNextBackend');
272dfdc3 464 if (!$setting || $setting === 'default') {
e28bf654
TO
465 $cacheDriver = \CRM_Utils_Cache::getCacheDriver();
466 $service = 'prevnext.driver.' . strtolower($cacheDriver);
272dfdc3 467 return $container->has($service)
e28bf654
TO
468 ? $container->get($service)
469 : $container->get('prevnext.driver.sql');
470 }
272dfdc3 471 return $container->get('prevnext.driver.' . $setting);
99098349
TO
472 }
473
272dfdc3 474 /**
475 * @return \ArrayObject
476 */
751f3d98
TO
477 public static function createCacheConfig() {
478 $driver = \CRM_Utils_Cache::getCacheDriver();
479 $settings = \CRM_Utils_Cache::getCacheSettings($driver);
480 $settings['driver'] = $driver;
481 return new \ArrayObject($settings);
482 }
483
83617886
TO
484 /**
485 * Get a list of boot services.
486 *
487 * These are services which must be setup *before* the container can operate.
488 *
7f835399 489 * @param bool $loadFromDB
83617886
TO
490 * @throws \CRM_Core_Exception
491 */
7f835399 492 public static function boot($loadFromDB) {
56eafc21 493 // Array(string $serviceId => object $serviceInstance).
c64f69d9 494 $bootServices = [];
7f835399 495 \Civi::$statics[__CLASS__]['boot'] = &$bootServices;
d4330c62 496
56eafc21 497 $bootServices['runtime'] = $runtime = new \CRM_Core_Config_Runtime();
7f835399 498 $runtime->initialize($loadFromDB);
d4330c62 499
b1db062e
H
500 $bootServices['paths'] = new \Civi\Core\Paths();
501
42ccedc7 502 $bootServices['dispatcher.boot'] = new CiviEventDispatcher();
27e05c5c
TO
503
504 // Quality control: There should be no pre-boot hooks because they make it harder to understand/support/refactor.
505 // If a pre-boot hook sneaks in, we'll raise an error.
506 $bootDispatchPolicy = [
507 '/^hook_/' => 'not-ready',
508 '/^civi\./' => 'run',
509 ];
510 $mainDispatchPolicy = \CRM_Core_Config::isUpgradeMode() ? \CRM_Upgrade_DispatchPolicy::get('upgrade.main') : NULL;
511 $bootServices['dispatcher.boot']->setDispatchPolicy($bootDispatchPolicy);
42ccedc7 512
7f835399 513 $class = $runtime->userFrameworkClass;
56eafc21 514 $bootServices['userSystem'] = $userSystem = new $class();
7f835399
TO
515 $userSystem->initialize();
516
517 $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework;
56eafc21 518 $bootServices['userPermissionClass'] = new $userPermissionClass();
7f835399 519
c64f69d9 520 $bootServices['cache.settings'] = \CRM_Utils_Cache::create([
56eafc21 521 'name' => 'settings',
c64f69d9
CW
522 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
523 ]);
7f835399 524
56eafc21 525 $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']);
7f835399 526
56eafc21 527 $bootServices['lockManager'] = self::createLockManager();
7f835399
TO
528
529 if ($loadFromDB && $runtime->dsn) {
3a036b15 530 \CRM_Core_DAO::init($runtime->dsn);
edbcbd96 531 \CRM_Utils_Hook::singleton(TRUE);
7f835399 532 \CRM_Extension_System::singleton(TRUE);
4025c773 533 \CRM_Extension_System::singleton(TRUE)->getClassLoader()->register();
27e05c5c 534 $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy);
7f835399 535
1b81ed50 536 $runtime->includeCustomPath();
537
7f835399 538 $c = new self();
56eafc21
TO
539 $container = $c->loadContainer();
540 foreach ($bootServices as $name => $obj) {
541 $container->set($name, $obj);
542 }
543 \Civi::$statics[__CLASS__]['container'] = $container;
83617886 544 }
27e05c5c
TO
545 else {
546 $bootServices['dispatcher.boot']->setDispatchPolicy($mainDispatchPolicy);
547 }
83617886
TO
548 }
549
272dfdc3 550 /**
551 * @param string $name
552 *
553 * @return mixed
554 */
83617886 555 public static function getBootService($name) {
56eafc21 556 return \Civi::$statics[__CLASS__]['boot'][$name];
83617886
TO
557 }
558
4d8e83b6
TO
559 /**
560 * Determine whether the container services are available.
561 *
562 * @return bool
563 */
564 public static function isContainerBooted() {
565 return isset(\Civi::$statics[__CLASS__]['container']);
566 }
567
fa184193 568}