Civi/Core/Container.php

   1 <?php
   2 namespace Civi\Core;
   3
   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;
  22
  23 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  24
  25 /**
  26  * Class Container
  27  * @package Civi\Core
  28  */
  29 class Container {
  30
  31   const SELF = 'civi_container_factory';
  32
  33   /**
  34    * @param bool $reset
  35    *   Whether to forcibly rebuild the entire container.
  36    * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
  37    */
  38   public static function singleton($reset = FALSE) {
  39     if ($reset || !isset(\Civi::$statics[__CLASS__]['container'])) {
  40       self::boot(TRUE);
  41     }
  42     return \Civi::$statics[__CLASS__]['container'];
  43   }
  44
  45   /**
  46    * Find a cached container definition or construct a new one.
  47    *
  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").
  54    *
  55    * Constants:
  56    *   - CIVICRM_CONTAINER_CACHE -- 'always' [default], 'never', 'auto'
  57    *   - CIVICRM_DSN
  58    *   - CIVICRM_DOMAIN_ID
  59    *   - CIVICRM_TEMPLATE_COMPILEDIR
  60    *
  61    * @return ContainerInterface
  62    */
  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.
  67
  68     $cacheMode = defined('CIVICRM_CONTAINER_CACHE') ? CIVICRM_CONTAINER_CACHE : 'auto';
  69
  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;
  75     }
  76
  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()
  87       );
  88     }
  89
  90     require_once $file;
  91     $c = new \CachedCiviContainer();
  92     return $c;
  93   }
  94
  95   /**
  96    * Construct a new container.
  97    *
  98    * @var ContainerBuilder
  99    * @return \Symfony\Component\DependencyInjection\ContainerBuilder
 100    */
 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);
 108
 109     $container->addResource(new \Symfony\Component\Config\Resource\FileResource(__FILE__));
 110
 111     $container->setDefinition(self::SELF, new Definition(
 112       'Civi\Core\Container',
 113       array()
 114     ));
 115
 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)');
 119     //    }
 120     //    $locator = new FileLocator($configDirectories);
 121     //    $loaderResolver = new LoaderResolver(array(
 122     //      new YamlFileLoader($container, $locator)
 123     //    ));
 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);
 129     //      }
 130     //    }
 131
 132     $container->setDefinition('angular', new Definition(
 133       'Civi\Angular\Manager',
 134       array()
 135     ))
 136       ->setFactory(array(new Reference(self::SELF), 'createAngularManager'));
 137
 138     $container->setDefinition('dispatcher', new Definition(
 139       'Civi\Core\CiviEventDispatcher',
 140       array(new Reference('service_container'))
 141     ))
 142       ->setFactory(array(new Reference(self::SELF), 'createEventDispatcher'));
 143
 144     $container->setDefinition('magic_function_provider', new Definition(
 145       'Civi\API\Provider\MagicFunctionProvider',
 146       array()
 147     ));
 148
 149     $container->setDefinition('civi_api_kernel', new Definition(
 150       'Civi\API\Kernel',
 151       array(new Reference('dispatcher'), new Reference('magic_function_provider'))
 152     ))
 153       ->setFactory(array(new Reference(self::SELF), 'createApiKernel'));
 154
 155     $container->setDefinition('cxn_reg_client', new Definition(
 156       'Civi\Cxn\Rpc\RegistrationClient',
 157       array()
 158     ))
 159       ->setFactory('CRM_Cxn_BAO_Cxn::createRegistrationClient');
 160
 161     $container->setDefinition('psr_log', new Definition('CRM_Core_Error_Log', array()));
 162
 163     $basicCaches = array(
 164       'js_strings' => 'js_strings',
 165       'community_messages' => 'community_messages',
 166       'checks' => 'checks',
 167       'session' => 'CiviCRM Session',
 168       'long' => 'long',
 169     );
 170     foreach ($basicCaches as $cacheSvc => $cacheGrp) {
 171       $container->setDefinition("cache.{$cacheSvc}", new Definition(
 172         'CRM_Utils_Cache_Interface',
 173         array(
 174           array(
 175             'name' => $cacheGrp,
 176             'type' => array('*memory*', 'SqlGroup', 'ArrayCache'),
 177           ),
 178         )
 179       ))->setFactory('CRM_Utils_Cache::create');
 180     }
 181
 182     $container->setDefinition('sql_triggers', new Definition(
 183       'Civi\Core\SqlTriggers',
 184       array()
 185     ));
 186
 187     $container->setDefinition('asset_builder', new Definition(
 188       'Civi\Core\AssetBuilder',
 189       array()
 190     ));
 191
 192     $container->setDefinition('pear_mail', new Definition('Mail'))
 193       ->setFactory('CRM_Utils_Mail::createMailer');
 194
 195     if (empty(\Civi::$statics[__CLASS__]['boot'])) {
 196       throw new \RuntimeException("Cannot initialize container. Boot services are undefined.");
 197     }
 198     foreach (\Civi::$statics[__CLASS__]['boot'] as $bootService => $def) {
 199       $container->setDefinition($bootService, new Definition())->setSynthetic(TRUE);
 200     }
 201
 202     // Expose legacy singletons as services in the container.
 203     $singletons = array(
 204       'resources' => 'CRM_Core_Resources',
 205       'httpClient' => 'CRM_Utils_HttpClient',
 206       'cache.default' => 'CRM_Utils_Cache',
 207       'i18n' => 'CRM_Core_I18n',
 208       // Maybe? 'config' => 'CRM_Core_Config',
 209       // Maybe? 'smarty' => 'CRM_Core_Smarty',
 210     );
 211     foreach ($singletons as $name => $class) {
 212       $container->setDefinition($name, new Definition(
 213         $class
 214       ))
 215         ->setFactory(array($class, 'singleton'));
 216     }
 217     $container->setAlias('cache.short', 'cache.default');
 218
 219     $container->setDefinition('prevnext', new Definition(
 220       'CRM_Core_PrevNextCache_Interface',
 221       [new Reference('service_container')]
 222     ))->setFactory(array(new Reference(self::SELF), 'createPrevNextCache'));
 223
 224     $container->setDefinition('prevnext.driver.sql', new Definition(
 225       'CRM_Core_PrevNextCache_Sql',
 226       []
 227     ));
 228
 229     $container->setDefinition('civi.mailing.triggers', new Definition(
 230       'Civi\Core\SqlTrigger\TimestampTriggers',
 231       array('civicrm_mailing', 'Mailing')
 232     ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
 233
 234     $container->setDefinition('civi.activity.triggers', new Definition(
 235       'Civi\Core\SqlTrigger\TimestampTriggers',
 236       array('civicrm_activity', 'Activity')
 237     ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
 238
 239     $container->setDefinition('civi.case.triggers', new Definition(
 240       'Civi\Core\SqlTrigger\TimestampTriggers',
 241       array('civicrm_case', 'Case')
 242     ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
 243
 244     $container->setDefinition('civi.case.staticTriggers', new Definition(
 245       'Civi\Core\SqlTrigger\StaticTriggers',
 246       array(
 247         array(
 248           array(
 249             'upgrade_check' => array('table' => 'civicrm_case', 'column' => 'modified_date'),
 250             'table' => 'civicrm_case_activity',
 251             'when' => 'AFTER',
 252             'event' => array('INSERT'),
 253             'sql' => "\nUPDATE civicrm_case SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.case_id;\n",
 254           ),
 255           array(
 256             'upgrade_check' => array('table' => 'civicrm_case', 'column' => 'modified_date'),
 257             'table' => 'civicrm_activity',
 258             'when' => 'BEFORE',
 259             'event' => array('UPDATE', 'DELETE'),
 260             '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",
 261           ),
 262         ),
 263       )
 264     ))
 265       ->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
 266
 267     $container->setDefinition('civi_token_compat', new Definition(
 268       'Civi\Token\TokenCompatSubscriber',
 269       array()
 270     ))->addTag('kernel.event_subscriber');
 271     $container->setDefinition("crm_mailing_action_tokens", new Definition(
 272       "CRM_Mailing_ActionTokens",
 273       array()
 274     ))->addTag('kernel.event_subscriber');
 275
 276     foreach (array('Activity', 'Contribute', 'Event', 'Mailing', 'Member') as $comp) {
 277       $container->setDefinition("crm_" . strtolower($comp) . "_tokens", new Definition(
 278         "CRM_{$comp}_Tokens",
 279         array()
 280       ))->addTag('kernel.event_subscriber');
 281     }
 282
 283     if (\CRM_Utils_Constant::value('CIVICRM_FLEXMAILER_HACK_SERVICES')) {
 284       \Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_SERVICES, array($container));
 285     }
 286
 287     \CRM_Utils_Hook::container($container);
 288
 289     return $container;
 290   }
 291
 292   /**
 293    * @return \Civi\Angular\Manager
 294    */
 295   public function createAngularManager() {
 296     return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton());
 297   }
 298
 299   /**
 300    * @param ContainerInterface $container
 301    * @return \Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
 302    */
 303   public function createEventDispatcher($container) {
 304     $dispatcher = new CiviEventDispatcher($container);
 305     $dispatcher->addListener(SystemInstallEvent::EVENT_NAME, array('\Civi\Core\InstallationCanary', 'check'));
 306     $dispatcher->addListener(SystemInstallEvent::EVENT_NAME, array('\Civi\Core\DatabaseInitializer', 'initialize'));
 307     $dispatcher->addListener(SystemInstallEvent::EVENT_NAME, array('\Civi\Core\LocalizationInitializer', 'initialize'));
 308     $dispatcher->addListener('hook_civicrm_pre', array('\Civi\Core\Event\PreEvent', 'dispatchSubevent'), 100);
 309     $dispatcher->addListener('hook_civicrm_post', array('\Civi\Core\Event\PostEvent', 'dispatchSubevent'), 100);
 310     $dispatcher->addListener('hook_civicrm_post::Activity', array('\Civi\CCase\Events', 'fireCaseChange'));
 311     $dispatcher->addListener('hook_civicrm_post::Case', array('\Civi\CCase\Events', 'fireCaseChange'));
 312     $dispatcher->addListener('hook_civicrm_caseChange', array('\Civi\CCase\Events', 'delegateToXmlListeners'));
 313     $dispatcher->addListener('hook_civicrm_caseChange', array('\Civi\CCase\SequenceListener', 'onCaseChange_static'));
 314     $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\Core\CiviEventInspector', 'findBuiltInEvents'));
 315     // TODO We need a better code-convention for metadata about non-hook events.
 316     $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\API\Events', 'hookEventDefs'));
 317     $dispatcher->addListener('hook_civicrm_eventDefs', array('\Civi\Core\Event\SystemInstallEvent', 'hookEventDefs'));
 318     $dispatcher->addListener('hook_civicrm_buildAsset', array('\Civi\Angular\Page\Modules', 'buildAngularModules'));
 319     $dispatcher->addListener('hook_civicrm_buildAsset', array('\CRM_Utils_VisualBundle', 'buildAssetJs'));
 320     $dispatcher->addListener('hook_civicrm_buildAsset', array('\CRM_Utils_VisualBundle', 'buildAssetCss'));
 321     $dispatcher->addListener('civi.dao.postInsert', array('\CRM_Core_BAO_RecurringEntity', 'triggerInsert'));
 322     $dispatcher->addListener('civi.dao.postUpdate', array('\CRM_Core_BAO_RecurringEntity', 'triggerUpdate'));
 323     $dispatcher->addListener('civi.dao.postDelete', array('\CRM_Core_BAO_RecurringEntity', 'triggerDelete'));
 324     $dispatcher->addListener('hook_civicrm_unhandled_exception', array(
 325       'CRM_Core_LegacyErrorHandler',
 326       'handleException',
 327     ), -200);
 328     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, array('CRM_Activity_ActionMapping', 'onRegisterActionMappings'));
 329     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, array('CRM_Contact_ActionMapping', 'onRegisterActionMappings'));
 330     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, array('CRM_Contribute_ActionMapping_ByPage', 'onRegisterActionMappings'));
 331     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, array('CRM_Contribute_ActionMapping_ByType', 'onRegisterActionMappings'));
 332     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, array('CRM_Event_ActionMapping', 'onRegisterActionMappings'));
 333     $dispatcher->addListener(\Civi\ActionSchedule\Events::MAPPINGS, array('CRM_Member_ActionMapping', 'onRegisterActionMappings'));
 334
 335     if (\CRM_Utils_Constant::value('CIVICRM_FLEXMAILER_HACK_LISTENERS')) {
 336       \Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_LISTENERS, array($dispatcher));
 337     }
 338
 339     return $dispatcher;
 340   }
 341
 342   /**
 343    * @return LockManager
 344    */
 345   public static function createLockManager() {
 346     // Ideally, downstream implementers could override any definitions in
 347     // the container. For now, we'll make-do with some define()s.
 348     $lm = new LockManager();
 349     $lm
 350       ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : array('CRM_Core_Lock', 'createScopedLock'))
 351       ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : array('CRM_Core_Lock', 'createScopedLock'))
 352       ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : array('CRM_Core_Lock', 'createCivimailLock'))
 353       ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : array('CRM_Core_Lock', 'createScopedLock'));
 354
 355     // Registrations may use complex resolver expressions, but (as a micro-optimization)
 356     // the default factory is specified as an array.
 357
 358     return $lm;
 359   }
 360
 361   /**
 362    * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 363    * @param $magicFunctionProvider
 364    *
 365    * @return \Civi\API\Kernel
 366    */
 367   public function createApiKernel($dispatcher, $magicFunctionProvider) {
 368     $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
 369     $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
 370     $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
 371     $dispatcher->addSubscriber($magicFunctionProvider);
 372     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 373     $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
 374     $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter(array(
 375       \CRM_Utils_API_HTMLInputCoder::singleton(),
 376       \CRM_Utils_API_NullOutputCoder::singleton(),
 377       \CRM_Utils_API_ReloadOption::singleton(),
 378       \CRM_Utils_API_MatchOption::singleton(),
 379     )));
 380     $dispatcher->addSubscriber(new \Civi\API\Subscriber\XDebugSubscriber());
 381     $kernel = new \Civi\API\Kernel($dispatcher);
 382
 383     $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
 384     $dispatcher->addSubscriber($reflectionProvider);
 385
 386     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
 387       $kernel,
 388       'Attachment',
 389       array('create', 'get', 'delete'),
 390       // Given a file ID, determine the entity+table it's attached to.
 391       'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
 392          FROM civicrm_file cf
 393          LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
 394          WHERE cf.id = %1',
 395       // Get a list of custom fields (field_name,table_name,extends)
 396       'SELECT concat("custom_",fld.id) as field_name,
 397         grp.table_name as table_name,
 398         grp.extends as extends
 399        FROM civicrm_custom_field fld
 400        INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
 401        WHERE fld.data_type = "File"
 402       ',
 403       array('civicrm_activity', 'civicrm_mailing', 'civicrm_contact', 'civicrm_grant')
 404     ));
 405
 406     $kernel->setApiProviders(array(
 407       $reflectionProvider,
 408       $magicFunctionProvider,
 409     ));
 410
 411     return $kernel;
 412   }
 413
 414   /**
 415    * @param ContainerInterface $container
 416    * @return \CRM_Core_PrevNextCache_Interface
 417    */
 418   public static function createPrevNextCache($container) {
 419     $cacheDriver = \CRM_Utils_Cache::getCacheDriver();
 420     $service = 'prevnext.driver.' . strtolower($cacheDriver);
 421     return $container->has($service)
 422       ? $container->get($service)
 423       : $container->get('prevnext.driver.sql');
 424   }
 425
 426   /**
 427    * Get a list of boot services.
 428    *
 429    * These are services which must be setup *before* the container can operate.
 430    *
 431    * @param bool $loadFromDB
 432    * @throws \CRM_Core_Exception
 433    */
 434   public static function boot($loadFromDB) {
 435     // Array(string $serviceId => object $serviceInstance).
 436     $bootServices = array();
 437     \Civi::$statics[__CLASS__]['boot'] = &$bootServices;
 438
 439     $bootServices['runtime'] = $runtime = new \CRM_Core_Config_Runtime();
 440     $runtime->initialize($loadFromDB);
 441
 442     $bootServices['paths'] = new \Civi\Core\Paths();
 443
 444     $class = $runtime->userFrameworkClass;
 445     $bootServices['userSystem'] = $userSystem = new $class();
 446     $userSystem->initialize();
 447
 448     $userPermissionClass = 'CRM_Core_Permission_' . $runtime->userFramework;
 449     $bootServices['userPermissionClass'] = new $userPermissionClass();
 450
 451     $bootServices['cache.settings'] = \CRM_Utils_Cache::create(array(
 452       'name' => 'settings',
 453       'type' => array('*memory*', 'SqlGroup', 'ArrayCache'),
 454     ));
 455
 456     $bootServices['settings_manager'] = new \Civi\Core\SettingsManager($bootServices['cache.settings']);
 457
 458     $bootServices['lockManager'] = self::createLockManager();
 459
 460     if ($loadFromDB && $runtime->dsn) {
 461       \CRM_Core_DAO::init($runtime->dsn);
 462       \CRM_Utils_Hook::singleton(TRUE);
 463       \CRM_Extension_System::singleton(TRUE);
 464       \CRM_Extension_System::singleton(TRUE)->getClassLoader()->register();
 465
 466       $runtime->includeCustomPath();
 467
 468       $c = new self();
 469       $container = $c->loadContainer();
 470       foreach ($bootServices as $name => $obj) {
 471         $container->set($name, $obj);
 472       }
 473       \Civi::$statics[__CLASS__]['container'] = $container;
 474     }
 475   }
 476
 477   public static function getBootService($name) {
 478     return \Civi::$statics[__CLASS__]['boot'][$name];
 479   }
 480
 481   /**
 482    * Determine whether the container services are available.
 483    *
 484    * @return bool
 485    */
 486   public static function isContainerBooted() {
 487     return isset(\Civi::$statics[__CLASS__]['container']);
 488   }
 489
 490 }