Add configuration option for whether to match blocked users (defaulting to FALSE)

config/install/civiremote.settings.yml

@@ -1,2 +1,3 @@
 cmrf_connector: civiremote
 acquire_civiremote_id: false
+match_blocked_users: false

config/schema/civiremote.schema.yml

@@ -1,3 +1,28 @@
+civiremote.settings:
+  type: config_object
+  mapping:
+    cmrf_connector:
+      type: string
+      label: 'CiviMRF Connector'
+    acquire_civiremote_id:
+      type: boolean
+      label: 'Acquire CiviRemote ID'
+    match_blocked_users:
+      type: boolean
+      label: 'Match blocked users'
+    match_contact_mapping:
+      type: sequence
+      label: 'Parameter mapping'
+      sequence:
+        type: mapping
+        label: 'Mapping of a Drupal user field to a CiviCRM contact field'
+        mapping:
+          user_field:
+            type: string
+            label: 'Drupal user field'
+          contact_field:
+            type: string
+            label: 'CiviCRM contact field'
 action.configuration.civiremote_match_contact_action:
   type: action_configuration_default
   label: 'CiviRemote: Match contact(s)'

src/Form/CiviRemoteConfigForm.php

@@ -91,6 +91,16 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#default_value' => $config->get('acquire_civiremote_id'),
     ];
 
+    $form['match_blocked_users'] = [
+      '#type' => 'checkbox',
+      '#title' => $this->t('Match blocked users'),
+      '#description' => $this->t('Whether to match blocked users to a CiviCRM contact. If unchecked, only active users will be matched.'),
+      '#default_value' => $config->get('match_blocked_users'),
+      '#states' => [
+        'visible' => [':input[name="acquire_civiremote_id"]' => ['checked' => TRUE]],
+      ],
+    ];
+
     $form['match_contact_mapping'] = [
       '#type' => 'fieldset',
       '#title' => $this->t('Parameter mapping'),
@@ -198,6 +208,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
     $config = $this->config('civiremote.settings');
     $config->set('cmrf_connector', $form_state->getValue('cmrf_connector'));
     $config->set('acquire_civiremote_id', $form_state->getValue('acquire_civiremote_id'));
+    $config->set('match_blocked_users', $form_state->getValue('match_blocked_users'));
     $config->set('match_contact_mapping', $form_state->getValue('match_contact_mapping_table'));
     $config->save();
     parent::submitForm($form, $form_state);

src/User.php

@@ -59,6 +59,11 @@ public static function matchContact(UserInterface $user, $prefix = '') {
     /* @var \Drupal\civiremote\CiviMRF $cmrf */
     $cmrf = Drupal::service('civiremote.cmrf');
     $config = Drupal::config('civiremote.settings');
+
+    // Only match locked users when configured.
+    if ($user->isBlocked() && !($config->get('match_blocked_users') ?? FALSE)) {
+      return;
+    }
     $params = [];
 
     // Use base URL as default key prefix.