Civi/Core/Container.php

   1 <?php
   2 namespace Civi\Core;
   3
   4 use Civi\Core\Lock\LockManager;
   5 use Doctrine\Common\Annotations\AnnotationReader;
   6 use Doctrine\Common\Annotations\AnnotationRegistry;
   7 use Doctrine\Common\Annotations\FileCacheReader;
   8 use Doctrine\Common\Cache\FilesystemCache;
   9 use Doctrine\ORM\EntityManager;
  10 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
  11 use Doctrine\ORM\Tools\Setup;
  12 use Symfony\Component\DependencyInjection\ContainerBuilder;
  13 use Symfony\Component\DependencyInjection\ContainerInterface;
  14 use Symfony\Component\DependencyInjection\Definition;
  15 use Symfony\Component\DependencyInjection\Reference;
  16
  17 // TODO use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  18
  19 /**
  20  * Class Container
  21  * @package Civi\Core
  22  */
  23 class Container {
  24
  25   const SELF = 'civi_container_factory';
  26
  27   /**
  28    * @var ContainerBuilder
  29    */
  30   private static $singleton;
  31
  32   /**
  33    * @param bool $reset
  34    *   Whether to forcibly rebuild the entire container.
  35    * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface
  36    */
  37   public static function singleton($reset = FALSE) {
  38     if ($reset || self::$singleton === NULL) {
  39       $c = new self();
  40       self::$singleton = $c->createContainer();
  41     }
  42     return self::$singleton;
  43   }
  44
  45   /**
  46    * @var ContainerBuilder
  47    * @return \Symfony\Component\DependencyInjection\ContainerBuilder
  48    */
  49   public function createContainer() {
  50     $civicrm_base_path = dirname(dirname(__DIR__));
  51     $container = new ContainerBuilder();
  52     $container->setParameter('civicrm_base_path', $civicrm_base_path);
  53     $container->set(self::SELF, $this);
  54
  55     // TODO Move configuration to an external file; define caching structure
  56     //    if (empty($configDirectories)) {
  57     //      throw new \Exception(__CLASS__ . ': Missing required properties (civicrmRoot, configDirectories)');
  58     //    }
  59     //    $locator = new FileLocator($configDirectories);
  60     //    $loaderResolver = new LoaderResolver(array(
  61     //      new YamlFileLoader($container, $locator)
  62     //    ));
  63     //    $delegatingLoader = new DelegatingLoader($loaderResolver);
  64     //    foreach (array('services.yml') as $file) {
  65     //      $yamlUserFiles = $locator->locate($file, NULL, FALSE);
  66     //      foreach ($yamlUserFiles as $file) {
  67     //        $delegatingLoader->load($file);
  68     //      }
  69     //    }
  70
  71     $container->setDefinition('lockManager', new Definition(
  72       '\Civi\Core\Lock\LockManager',
  73       array()
  74     ))
  75       ->setFactoryService(self::SELF)->setFactoryMethod('createLockManager');
  76
  77     $container->setDefinition('angular', new Definition(
  78       '\Civi\Angular\Manager',
  79       array()
  80     ))
  81       ->setFactoryService(self::SELF)->setFactoryMethod('createAngularManager');
  82
  83     $container->setDefinition('dispatcher', new Definition(
  84       '\Symfony\Component\EventDispatcher\EventDispatcher',
  85       array()
  86     ))
  87       ->setFactoryService(self::SELF)->setFactoryMethod('createEventDispatcher');
  88
  89     $container->setDefinition('magic_function_provider', new Definition(
  90       '\Civi\API\Provider\MagicFunctionProvider',
  91       array()
  92     ));
  93
  94     $container->setDefinition('civi_api_kernel', new Definition(
  95       '\Civi\API\Kernel',
  96       array(new Reference('dispatcher'), new Reference('magic_function_provider'))
  97     ))
  98       ->setFactoryService(self::SELF)->setFactoryMethod('createApiKernel');
  99
 100     $container->setDefinition('cxn_reg_client', new Definition(
 101       '\Civi\Cxn\Rpc\RegistrationClient',
 102       array()
 103     ))
 104       ->setFactoryClass('CRM_Cxn_BAO_Cxn')->setFactoryMethod('createRegistrationClient');
 105
 106     $container->setDefinition('cache.settings', new Definition(
 107       'CRM_Utils_Cache_SqlGroup',
 108       array(
 109         array('group' => 'Settings', 'prefetch' => 0),
 110       )
 111     ));
 112
 113     $container->setDefinition('settings_manager', new Definition(
 114       'Civi\Core\SettingsManager',
 115       array(new Reference('cache.settings'))
 116     ));
 117
 118     $container->setDefinition('pear_mail', new Definition('Mail'))
 119       ->setFactoryClass('CRM_Utils_Mail')->setFactoryMethod('createMailer');
 120
 121     // Expose legacy singletons as services in the container.
 122     $singletons = array(
 123       'resources' => 'CRM_Core_Resources',
 124       'httpClient' => 'CRM_Utils_HttpClient',
 125       'cache.default' => 'CRM_Utils_Cache',
 126       // Maybe? 'config' => 'CRM_Core_Config',
 127       // Maybe? 'smarty' => 'CRM_Core_Smarty',
 128     );
 129     foreach ($singletons as $name => $class) {
 130       $container->setDefinition($name, new Definition(
 131         $class
 132       ))
 133         ->setFactoryClass($class)->setFactoryMethod('singleton');
 134     }
 135
 136     return $container;
 137   }
 138
 139   /**
 140    * @return \Civi\Angular\Manager
 141    */
 142   public function createAngularManager() {
 143     return new \Civi\Angular\Manager(\CRM_Core_Resources::singleton());
 144   }
 145
 146   /**
 147    * @return \Symfony\Component\EventDispatcher\EventDispatcher
 148    */
 149   public function createEventDispatcher() {
 150     $dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
 151     $dispatcher->addListener('hook_civicrm_post::Activity', array('\Civi\CCase\Events', 'fireCaseChange'));
 152     $dispatcher->addListener('hook_civicrm_post::Case', array('\Civi\CCase\Events', 'fireCaseChange'));
 153     $dispatcher->addListener('hook_civicrm_caseChange', array('\Civi\CCase\Events', 'delegateToXmlListeners'));
 154     $dispatcher->addListener('hook_civicrm_caseChange', array('\Civi\CCase\SequenceListener', 'onCaseChange_static'));
 155     $dispatcher->addListener('DAO::post-insert', array('\CRM_Core_BAO_RecurringEntity', 'triggerInsert'));
 156     $dispatcher->addListener('DAO::post-update', array('\CRM_Core_BAO_RecurringEntity', 'triggerUpdate'));
 157     $dispatcher->addListener('DAO::post-delete', array('\CRM_Core_BAO_RecurringEntity', 'triggerDelete'));
 158     $dispatcher->addListener('hook_civicrm_unhandled_exception', array(
 159       'CRM_Core_LegacyErrorHandler',
 160       'handleException',
 161     ));
 162     return $dispatcher;
 163   }
 164
 165   /**
 166    * @return LockManager
 167    */
 168   public function createLockManager() {
 169     // Ideally, downstream implementers could override any definitions in
 170     // the container. For now, we'll make-do with some define()s.
 171     $lm = new LockManager();
 172     $lm
 173       ->register('/^cache\./', defined('CIVICRM_CACHE_LOCK') ? CIVICRM_CACHE_LOCK : array('CRM_Core_Lock', 'createScopedLock'))
 174       ->register('/^data\./', defined('CIVICRM_DATA_LOCK') ? CIVICRM_DATA_LOCK : array('CRM_Core_Lock', 'createScopedLock'))
 175       ->register('/^worker\.mailing\.send\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : array('CRM_Core_Lock', 'createCivimailLock'))
 176       ->register('/^worker\./', defined('CIVICRM_WORK_LOCK') ? CIVICRM_WORK_LOCK : array('CRM_Core_Lock', 'createScopedLock'));
 177
 178     // Registrations may use complex resolver expressions, but (as a micro-optimization)
 179     // the default factory is specified as an array.
 180
 181     return $lm;
 182   }
 183
 184   /**
 185    * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 186    * @param $magicFunctionProvider
 187    *
 188    * @return \Civi\API\Kernel
 189    */
 190   public function createApiKernel($dispatcher, $magicFunctionProvider) {
 191     $dispatcher->addSubscriber(new \Civi\API\Subscriber\ChainSubscriber());
 192     $dispatcher->addSubscriber(new \Civi\API\Subscriber\TransactionSubscriber());
 193     $dispatcher->addSubscriber(new \Civi\API\Subscriber\I18nSubscriber());
 194     $dispatcher->addSubscriber($magicFunctionProvider);
 195     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 196     $dispatcher->addSubscriber(new \Civi\API\Subscriber\APIv3SchemaAdapter());
 197     $dispatcher->addSubscriber(new \Civi\API\Subscriber\WrapperAdapter(array(
 198       \CRM_Utils_API_HTMLInputCoder::singleton(),
 199       \CRM_Utils_API_NullOutputCoder::singleton(),
 200       \CRM_Utils_API_ReloadOption::singleton(),
 201       \CRM_Utils_API_MatchOption::singleton(),
 202     )));
 203     $dispatcher->addSubscriber(new \Civi\API\Subscriber\XDebugSubscriber());
 204     $kernel = new \Civi\API\Kernel($dispatcher);
 205
 206     $reflectionProvider = new \Civi\API\Provider\ReflectionProvider($kernel);
 207     $dispatcher->addSubscriber($reflectionProvider);
 208
 209     $dispatcher->addSubscriber(new \Civi\API\Subscriber\DynamicFKAuthorization(
 210       $kernel,
 211       'Attachment',
 212       array('create', 'get', 'delete'),
 213       // Given a file ID, determine the entity+table it's attached to.
 214       'SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
 215          FROM civicrm_file cf
 216          LEFT JOIN civicrm_entity_file cef ON cf.id = cef.file_id
 217          WHERE cf.id = %1',
 218       // Get a list of custom fields (field_name,table_name,extends)
 219       'SELECT concat("custom_",fld.id) as field_name,
 220         grp.table_name as table_name,
 221         grp.extends as extends
 222        FROM civicrm_custom_field fld
 223        INNER JOIN civicrm_custom_group grp ON fld.custom_group_id = grp.id
 224        WHERE fld.data_type = "File"
 225       ',
 226       array('civicrm_activity', 'civicrm_mailing', 'civicrm_contact', 'civicrm_grant')
 227     ));
 228
 229     $kernel->setApiProviders(array(
 230       $reflectionProvider,
 231       $magicFunctionProvider,
 232     ));
 233
 234     return $kernel;
 235   }
 236
 237 }