webform.antibot.inc in Webform 8.5

Integrates third party settings on the Antibot module's behalf.

File

third_party_settings/webform.antibot.inc

<?php

/**
 * @file
 * Integrates third party settings on the Antibot module's behalf.
 */
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;

/**
 * Flag to indicate that antibot can be set.
 */
define('WEBFORM_ANTIBOT_NEUTRAL', -1);

/**
 * Flag to indicate that antibot is disabled for all webforms.
 */
define('WEBFORM_ANTIBOT_DISABLED_WEBFORM', 2);

/**
 * Flag to indicate that antibot is enabled for all webforms.
 */
define('WEBFORM_ANTIBOT_ENABLED_WEBFORM', 3);

/**
 * Alter webform third party settings webforms to include Antibot configuration.
 *
 * @param array $form
 *   An associative array containing the structure of the form.
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The current state of the form.
 * @param bool $antibot
 *   TRUE if antibot protection is enabled.
 * @param int $antibot_state
 *   Flag that determines if antibot protection is enabled, disabled, or can be
 *   set.
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to displayed within the checkbox titles.
 */
function _webform_antibot_form(array &$form, FormStateInterface $form_state, $antibot, $antibot_state, $label) {
  $t_args = [
    '%label' => $label,
    ':href_antibot' => Url::fromRoute('antibot.settings')
      ->toString(),
    ':href_webform' => Url::fromRoute('webform.config')
      ->toString(),
  ];

  // Antibot.
  $form['third_party_settings']['antibot'] = [
    '#type' => 'details',
    '#title' => t('Antibot'),
    '#open' => TRUE,
    '#description' => t('Prevent SPAM webform submissions from being submitted without JavaScript enabled using the <a href=":href_antibot">antibot</a> method.', $t_args),
  ];
  $form['third_party_settings']['antibot']['antibot'] = [
    '#type' => 'checkbox',
    '#title' => t('Protect %label with Antibot', $t_args),
    '#default_value' => $antibot,
    '#return_value' => TRUE,
  ];
  $antibot_state = (int) $antibot_state;
  if ($antibot_state !== WEBFORM_ANTIBOT_NEUTRAL) {
    $form['third_party_settings']['antibot']['antibot']['#attributes']['disabled'] = 'disabled';
    $form_state
      ->set('antibot_disabled', TRUE);
    if ($antibot_state === WEBFORM_ANTIBOT_ENABLED_WEBFORM) {
      $form['third_party_settings']['antibot']['antibot']['#default_value'] = 1;
      $form['third_party_settings']['antibot']['antibot']['#description'] = t('<a href=":href_webform">Antibot protection</a> is enabled for all webforms.', $t_args);
    }
  }
  $form['#validate'][] = '_webform_antibot_form_validate';
}

/**
 * Validate callback; Checks if antibot is disabled and remove it from the third party settings values.
 */
function _webform_antibot_form_validate(&$form, FormStateInterface $form_state) {
  $third_party_settings = $form_state
    ->getValue('third_party_settings');
  if ($form_state
    ->get('antibot_disabled') || empty($third_party_settings['antibot']['antibot'])) {
    unset($third_party_settings['antibot']['antibot']);
  }
  $form_state
    ->setValue('third_party_settings', $third_party_settings);
}

/**
 * Implements hook_webform_admin_third_party_settings_form_alter().
 */
function antibot_webform_admin_third_party_settings_form_alter(&$form, FormStateInterface $form_state) {

  /** @var \Drupal\webform\WebformThirdPartySettingsManagerInterface $third_party_settings_manager */
  $third_party_settings_manager = \Drupal::service('webform.third_party_settings_manager');
  $antibot = $third_party_settings_manager
    ->getThirdPartySetting('antibot', 'antibot');
  $antibot_state = WEBFORM_ANTIBOT_NEUTRAL;
  _webform_antibot_form($form, $form_state, $antibot, $antibot_state, t('all webforms'));
}

/**
 * Implements hook_webform_third_party_settings_form_alter().
 */
function antibot_webform_third_party_settings_form_alter(&$form, FormStateInterface $form_state) {

  /** @var \Drupal\webform\WebformThirdPartySettingsManagerInterface $third_party_settings_manager */
  $third_party_settings_manager = \Drupal::service('webform.third_party_settings_manager');

  /** @var \Drupal\webform\WebformInterface $webform */
  $webform = $form_state
    ->getFormObject()
    ->getEntity();
  $antibot = $webform
    ->getThirdPartySetting('antibot', 'antibot');
  if ($third_party_settings_manager
    ->getThirdPartySetting('antibot', 'antibot')) {
    $antibot_state = WEBFORM_ANTIBOT_ENABLED_WEBFORM;
  }
  else {
    $antibot_state = WEBFORM_ANTIBOT_NEUTRAL;
  }
  _webform_antibot_form($form, $form_state, $antibot, $antibot_state, t('@label webform', [
    '@label' => $webform
      ->label(),
  ]));
}

/**
 * Implements hook_webform_submission_form_alter().
 */
function antibot_webform_submission_form_alter(&$form, FormStateInterface $form_state, $form_id) {

  // Only add an Antibot when a webform is initially load.
  // After a webform is submitted, via a multi-step webform and/or saving a draft,
  // we can skip adding an Antibot.
  if ($form_state
    ->isSubmitted()) {
    return;
  }

  /** @var \Drupal\webform\WebformThirdPartySettingsManagerInterface $third_party_settings_manager */
  $third_party_settings_manager = \Drupal::service('webform.third_party_settings_manager');

  /** @var \Drupal\webform\WebformSubmissionInterface $webform_submission */
  $webform_submission = $form_state
    ->getFormObject()
    ->getEntity();
  $webform = $webform_submission
    ->getWebform();
  $antibot = $third_party_settings_manager
    ->getThirdPartySetting('antibot', 'antibot') ?: $webform
    ->getThirdPartySetting('antibot', 'antibot');
  if ($antibot) {
    if (function_exists('antibot_protect_form')) {

      // Applies to antibot-8.x-1.2+
      // Set #form_id which is needed by antibot_protect_form().
      $form['#form_id'] = $form_id;
      antibot_protect_form($form);
    }
    else {

      // Applies to antibot-8.x-1.1 and below.
      // @todo Remove backward compatibility for antibot-8.x-1.1.
      $form['#pre_render'][] = 'antibot_form_pre_render';
    }
  }
}

Functions

Name	Description
antibot_webform_admin_third_party_settings_form_alter	Implements hook_webform_admin_third_party_settings_form_alter().
antibot_webform_submission_form_alter	Implements hook_webform_submission_form_alter().
antibot_webform_third_party_settings_form_alter	Implements hook_webform_third_party_settings_form_alter().
_webform_antibot_form	Alter webform third party settings webforms to include Antibot configuration.
_webform_antibot_form_validate	Validate callback; Checks if antibot is disabled and remove it from the third party settings values.

Constants

Name	Description
WEBFORM_ANTIBOT_DISABLED_WEBFORM	Flag to indicate that antibot is disabled for all webforms.
WEBFORM_ANTIBOT_ENABLED_WEBFORM	Flag to indicate that antibot is enabled for all webforms.
WEBFORM_ANTIBOT_NEUTRAL	Flag to indicate that antibot can be set.