CRM-21093: Move CiviCRM initialization from service constructor to method.

civicrm.module

@@ -94,7 +94,7 @@ function civicrm_entity_extra_field_info() {
  * to the user display.
  */
 function civicrm_user_view(array &$build, \Drupal\user\UserInterface $account, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
 
   // We need the $contact_id so that we know what data to pull out of Civicrm.
   // And we need the contact_id of the current user ($current_contact_id) so
@@ -177,7 +177,7 @@ function civicrm_user_view(array &$build, \Drupal\user\UserInterface $account, \
  * based on the $contact_id's contact type.
  */
 function _civicrm_get_profiles($contact_id) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   $profiles = array();
   $ctype = \CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contact_id, 'contact_type');
 
@@ -202,6 +202,7 @@ function _civicrm_get_profiles($contact_id) {
  */
 function civicrm_form_user_register_form_alter(&$form, &$form_state, $form_id) {
   $civicrm = \Drupal::service('civicrm');
+  $civicrm->initialize();
   $html = \CRM_Core_BAO_UFGroup::getEditHTML(NULL, '', 1, TRUE, FALSE, NULL, FALSE, $civicrm->getCtype());
 
   $form['civicrm_profile_register'] = array(
@@ -214,7 +215,7 @@ function civicrm_form_user_register_form_alter(&$form, &$form_state, $form_id) {
  * Validation function for additional profile form fields attached to user registration form.
  */
 function _civicrm_user_register_form_validate(&$form, &$form_state) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   $errors = CRM_Core_BAO_UFGroup::isValid(NULL, '', TRUE);
 
   if (is_array($errors)) {

civicrm.user.inc

@@ -33,7 +33,7 @@ function civicrm_user_insert(AccountInterface $account) {
  * Implements hook_user_update().
  */
 function civicrm_user_update(AccountInterface $account) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
 
   // Update primary email address of contact if it has changed.
   $contact_id = \CRM_Core_BAO_UFMatch::getContactId($account->id());
@@ -52,6 +52,6 @@ function civicrm_user_update(AccountInterface $account) {
  * Implements hook_user_delete().
  */
 function civicrm_user_delete(AccountInterface $account) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   \CRM_Core_BAO_UFMatch::deleteUser($account->id());
 }

drush/civicrm.drush.inc

@@ -545,7 +545,7 @@ function civicrm_drush_help($section) {
  * Implementation of command 'civicrm-ext-list'
  */
 function drush_civicrm_ext_list() {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   try{
     $result = civicrm_api3('extension', 'get', array(
       'options' => array(
@@ -575,7 +575,7 @@ function drush_civicrm_ext_list() {
  * Implementation of command 'civicrm-ext-install'
  */
 function drush_civicrm_ext_install($extension_name) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   try{
     $result = civicrm_api('extension', 'install', array('key' => $extension_name, 'version' => 3));
     if($result['values'] && $result['values'] == 1) {
@@ -597,7 +597,7 @@ function drush_civicrm_ext_install($extension_name) {
  * Implementation of command 'civicrm-ext-disable'
  */
 function drush_civicrm_ext_disable($extension_name) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   try{
     $result = civicrm_api('extension', 'disable', array('key' => $extension_name, 'version' => 3));
     if($result['values'] && $result['values'] == 1) {
@@ -619,7 +619,7 @@ function drush_civicrm_ext_disable($extension_name) {
  * Implementation of command 'civicrm-ext-uninstall'
  */
 function drush_civicrm_ext_uninstall($extension_name) {
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
   try{
     $result = civicrm_api('extension', 'uninstall', array('key' => $extension_name, 'version' => 3));
     if($result['values'] && $result['values'] == 1) {
@@ -1507,7 +1507,7 @@ function drush_civicrm_api() {
       break;
   }
 
-  \Drupal::service('civicrm');
+  \Drupal::service('civicrm')->initialize();
 
   global $user;
   CRM_Core_BAO_UFMatch::synchronize($user, FALSE, 'Drupal', 'Individual'

modules/civicrm_views/civicrm_views.views.inc

@@ -4,7 +4,7 @@ function civicrm_views_views_data() {
   $data = array();
 
   try {
-    \Drupal::service('civicrm');
+    \Drupal::service('civicrm')->initialize();
   }
   catch (Exception $e) {
     \Drupal::logger('civicrm_views')->error("Unable to initialize CiviCRM. Aborting hook_views_data().");
@@ -84,7 +84,7 @@ function civicrm_views_views_data() {
 
 function civicrm_views_views_data_alter(&$data) {
   try {
-    \Drupal::service('civicrm');
+    \Drupal::service('civicrm')->initialize();
   }
   catch (Exception $e) {
     \Drupal::logger('civicrm_views')->error("Unable to initialize CiviCRM. Aborting hook_views_data_alter().");

modules/civicrm_views/src/Plugin/views/field/CivicrmPseudoconstant.php

@@ -20,6 +20,8 @@ class CivicrmPseudoconstant extends FieldPluginBase {
   public function __construct(array $configuration, $plugin_id, $plugin_definition, Civicrm $civicrm) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
 
+    $civicrm->initialize();
+
     $this->pseudovalues = call_user_func_array($this->definition['pseudo callback'], $this->definition['pseudo arguments']);
   }
 

modules/civicrm_views/src/Plugin/views/filter/CivicrmInOperator.php

@@ -13,6 +13,7 @@
 class CivicrmInOperator extends InOperator {
   public function __construct(array $configuration, $plugin_id, $plugin_definition, Civicrm $civicrm) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $civicrm->initialize();
   }
 
   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

modules/civicrm_views/src/Plugin/views/relationship/CivicrmRelationship.php

@@ -19,6 +19,8 @@ class CivicrmRelationship extends RelationshipPluginBase {
   public function __construct(array $configuration, $plugin_id, $plugin_definition, Civicrm $civicrm) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
 
+    $civicrm->initialize();
+
     // relationshipType() returns information about relations as array with fields
     // 'name_a_b', 'name_b_a', 'contact_type_a' and 'contact_type_b'.
     $this->relationships[0] = t('Any');

modules/civicrm_views/src/Plugin/views/relationship/CivicrmUFMatch.php

@@ -19,6 +19,8 @@ class CivicrmUFMatch extends RelationshipPluginBase {
   public function __construct(array $configuration, $plugin_id, $plugin_definition, Civicrm $civicrm) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
 
+    $civicrm->initialize();
+
     $this->civicrm_current_domain = \CRM_Core_Config::domainID();
 
     $this->civicrm_domains['current'] = t('Current domain');

src/Civicrm.php

@@ -6,11 +6,18 @@
 use Drupal\Core\Session\AccountInterface;
 
 class Civicrm {
+
+  protected $initialized = FALSE;
+
   /**
    * Initialize CiviCRM. Call this function from other modules too if
    * they use the CiviCRM API.
    */
-  public function __construct() {
+  public function initialize() {
+    if ($this->initialized) {
+      return;
+    }
+
     // Get ready for problems
     $docLinkInstall = "http://wiki.civicrm.org/confluence/display/CRMDOC/Drupal+Installation+Guide";
     $docLinkTrouble = "http://wiki.civicrm.org/confluence/display/CRMDOC/Installation+and+Configuration+Trouble-shooting";
@@ -43,9 +50,18 @@ public function __construct() {
 
     // Initialize the system by creating a config object
     \CRM_Core_Config::singleton();
+
+    // Mark CiviCRM as initialized.
+    $this->initialized = TRUE;
+  }
+
+  public function isInitialized() {
+    return $this->initialized;
   }
 
   public function invoke($args) {
+    $this->initialize();
+
     // Civicrm will echo/print directly to stdout. We need to capture it
     // so that we can return the output as a renderable array.
     ob_start();
@@ -61,6 +77,7 @@ public function invoke($args) {
    * @param string $contact_type
    */
   public function synchronizeUser(AccountInterface $account, $contact_type = 'Individual') {
+    $this->initialize();
     \CRM_Core_BAO_UFMatch::synchronize($account, FALSE, 'Drupal', $this->getCtype($contact_type));
   }
 

src/CivicrmPermissions.php

@@ -16,7 +16,7 @@ static function create(ContainerInterface $container) {
   public function permissions() {
     // Initialize civicrm.
     // @Todo: Inject this via container injection instead.
-    \Drupal::service('civicrm');
+    \Drupal::service('civicrm')->initialize();
 
     $permissions = [];
     foreach (\CRM_Core_Permission::basicPermissions() as $permission => $title) {

src/Form/UserProfile.php

@@ -19,8 +19,7 @@ class UserProfile extends FormBase  {
   protected $uf_group;
 
   public function __construct(Civicrm $civicrm) {
-    // We don't do anything with the Civicrm service, only ensure that it
-    // has been initialized.
+    $civicrm->initialize();
   }
 
   static function create(ContainerInterface $container) {

src/PathProcessor/CivicrmPathProcessor.php

@@ -14,6 +14,7 @@ public function processInbound($path, Request $request) {
     if (strpos($path, '/civicrm/') === 0) {
       // initialize civicrm
       $civicrm = new Civicrm();
+      $civicrm->initialize();
       // fetch civicrm menu items
       $items = \CRM_Core_Menu::items();
       $longest = '';

src/Plugin/Block/CivicrmBlock.php

@@ -20,12 +20,10 @@
  */
 class CivicrmBlock extends BlockBase implements ContainerFactoryPluginInterface {
   public function __construct(Civicrm $civicrm, array $configuration, $plugin_id, array $plugin_definition) {
-    // We don't do anything with the Civicrm service, only ensure that it
-    // has been initialized.
-
     // Mark all CiviCRM blocks as uncachable.
     $configuration['cache']['max_age'] = 0;
     parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $civicrm->initialize();
   }
 
   static public function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

src/Plugin/Derivative/CivicrmBlock.php

@@ -9,8 +9,7 @@
 
 class CivicrmBlock extends DeriverBase implements ContainerDeriverInterface {
   public function __construct(Civicrm $civicrm) {
-    // We don't do anything with the Civicrm service, only ensure that it
-    // has been initialized.
+    $civicrm->initialize();
   }
 
   static public function create(ContainerInterface $container, $base_plugin_id) {

src/Plugin/Derivative/LocalTasks.php

@@ -9,8 +9,7 @@
 
 class LocalTasks extends DeriverBase implements ContainerDeriverInterface {
   public function __construct(Civicrm $civicrm) {
-    // We don't do anything with the Civicrm service, only ensure that it
-    // has been initialized.
+    $civicrm->initialize();
   }
 
   static public function create(ContainerInterface $container, $base_plugin_id) {

src/Routing/Routes.php

@@ -11,7 +11,7 @@ public function routes() {
     $collection = new RouteCollection();
 
     // Initialize CiviCRM.
-    \Drupal::service('civicrm');
+    \Drupal::service('civicrm')->initialize();
 
     $items = \CRM_Core_Menu::items();