CaptchaSettingsForm.php in CAPTCHA 8

Namespace

Drupal\captcha\Form

File

src/Form/CaptchaSettingsForm.php

<?php

namespace Drupal\captcha\Form;

use Drupal\captcha\Service\CaptchaService;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Displays the captcha settings form.
 */
class CaptchaSettingsForm extends ConfigFormBase {

  /**
   * The cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

  /**
   * The CAPTCHA helper service.
   *
   * @var \Drupal\captcha\Service\CaptchaService
   */
  protected $captchaService;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a \Drupal\captcha\Form\CaptchaSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   Module handler.
   * @param \Drupal\captcha\Service\CaptchaService $captcha_service
   *   The captcha service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, CacheBackendInterface $cache_backend, ModuleHandlerInterface $moduleHandler, CaptchaService $captcha_service) {
    parent::__construct($config_factory);
    $this->cacheBackend = $cache_backend;
    $this->moduleHandler = $moduleHandler;
    $this->captchaService = $captcha_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('cache.default'), $container
      ->get('module_handler'), $container
      ->get('captcha.helper'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'captcha.settings',
    ];
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormId() {
    return 'captcha_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('captcha.settings');
    module_load_include('inc', 'captcha');
    module_load_include('inc', 'captcha', 'captcha.admin');

    // Configuration of which forms to protect, with what challenge.
    $form['form_protection'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form protection'),
      '#description' => $this
        ->t("Select the challenge type you want for each of the listed forms (identified by their so called <em>form_id</em>'s). You can easily add arbitrary forms with the textfield at the bottom of the table or with the help of the option <em>Add CAPTCHA administration links to forms</em> below."),
      '#open' => TRUE,
    ];
    $form['form_protection']['default_challenge'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default challenge type'),
      '#description' => $this
        ->t('Select the default challenge type for CAPTCHAs. This can be overridden for each form if desired.'),
      '#options' => $this->captchaService
        ->getAvailableChallengeTypes(FALSE),
      '#default_value' => $config
        ->get('default_challenge'),
    ];

    // Option for enabling CAPTCHA for all forms.
    $form['form_protection']['enabled_default'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Default challenge on non-listed forms.'),
      '#description' => $this
        ->t('Enable CAPTCHA for every form not listed here'),
      '#default_value' => $config
        ->get('enabled_default'),
    ];

    // Field for the CAPTCHA administration mode.
    $form['form_protection']['administration_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add CAPTCHA administration links to forms'),
      '#default_value' => $config
        ->get('administration_mode'),
      '#description' => $this
        ->t('This option makes it easy to manage CAPTCHA settings on forms. When enabled, users with the <em>administer CAPTCHA settings</em> permission will see a fieldset with CAPTCHA administration links on all forms, except on administrative pages.'),
    ];

    // Field for the CAPTCHAs on admin pages.
    $form['form_protection']['allow_on_admin_pages'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow CAPTCHAs and CAPTCHA administration links on administrative pages'),
      '#default_value' => $config
        ->get('allow_on_admin_pages'),
      '#description' => $this
        ->t("This option makes it possible to add CAPTCHAs to forms on administrative pages. CAPTCHAs are disabled by default on administrative pages (which shouldn't be accessible to untrusted users normally) to avoid the related overhead. In some situations, e.g. in the case of demo sites, it can be useful to allow CAPTCHAs on administrative pages."),
    ];

    // Button for clearing the CAPTCHA placement cache.
    // Based on Drupal core's "Clear all caches" (performance settings page).
    $form['form_protection']['placement_caching'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('CAPTCHA placement caching'),
      '#description' => $this
        ->t('For efficiency, the positions of the CAPTCHA elements in each of the configured forms are cached. Most of the time, the structure of a form does not change and it would be a waste to recalculate the positions every time. Occasionally however, the form structure can change (e.g. during site building) and clearing the CAPTCHA placement cache can be required to fix the CAPTCHA placement.'),
    ];
    $form['form_protection']['placement_caching']['placement_cache_clear'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Clear the CAPTCHA placement cache'),
      '#submit' => [
        '::clearCaptchaPlacementCacheSubmit',
      ],
    ];

    // Configuration option for adding a CAPTCHA description.
    $form['add_captcha_description'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add a description to the CAPTCHA'),
      '#description' => $this
        ->t('Add a configurable description to explain the purpose of the CAPTCHA to the visitor.'),
      '#default_value' => $config
        ->get('add_captcha_description'),
    ];
    $form['description'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Challenge description'),
      '#description' => $this
        ->t('Configurable description of the CAPTCHA. An empty entry will reset the description to default.'),
      '#default_value' => _captcha_get_description(),
      '#maxlength' => 256,
      '#attributes' => [
        'id' => 'edit-captcha-description-wrapper',
      ],
      '#states' => [
        'visible' => [
          ':input[name="add_captcha_description"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Field for the wrong captcha response error message.
    $form['wrong_captcha_response_message'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Wrong CAPTCHA response error message'),
      '#description' => $this
        ->t('Configurable error message that the user gets when it enters an incorrect CAPTCHA answer.'),
      '#default_value' => _captcha_get_error_message(),
      '#maxlength' => 256,
      '#required' => TRUE,
    ];

    // Option for case sensitive/insensitive validation of the responses.
    $form['default_validation'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Default CAPTCHA validation'),
      '#description' => $this
        ->t('Define how the response should be processed by default. Note that the modules that provide the actual challenges can override or ignore this.'),
      '#options' => [
        CAPTCHA_DEFAULT_VALIDATION_CASE_SENSITIVE => $this
          ->t('Case sensitive validation: the response has to exactly match the solution.'),
        CAPTCHA_DEFAULT_VALIDATION_CASE_INSENSITIVE => $this
          ->t('Case insensitive validation: lowercase/uppercase errors are ignored.'),
      ],
      '#default_value' => $config
        ->get('default_validation'),
    ];

    // Field for CAPTCHA persistence.
    // TODO for D7: Rethink/simplify the explanation and UI strings.
    $form['persistence'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Persistence'),
      '#default_value' => $config
        ->get('persistence'),
      '#options' => [
        CAPTCHA_PERSISTENCE_SHOW_ALWAYS => $this
          ->t('Always add a challenge.'),
        CAPTCHA_PERSISTENCE_SKIP_ONCE_SUCCESSFUL_PER_FORM_INSTANCE => $this
          ->t('Omit challenges in a multi-step/preview workflow once the user successfully responds to a challenge.'),
        CAPTCHA_PERSISTENCE_SKIP_ONCE_SUCCESSFUL_PER_FORM_TYPE => $this
          ->t('Omit challenges on a form type once the user successfully responds to a challenge on a form of that type.'),
        CAPTCHA_PERSISTENCE_SKIP_ONCE_SUCCESSFUL => $this
          ->t('Omit challenges on all forms once the user successfully responds to any challenge on the site.'),
      ],
      '#description' => $this
        ->t('Define if challenges should be omitted during the rest of a session once the user successfully responds to a challenge.'),
    ];

    // Enable wrong response counter.
    $form['enable_stats'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable statistics'),
      '#description' => $this
        ->t('Keep CAPTCHA related counters in the <a href=":statusreport">status report</a>. Note that this comes with a performance penalty as updating the counters results in clearing the variable cache.', [
        ':statusreport' => Url::fromRoute('system.status')
          ->toString(),
      ]),
      '#default_value' => $config
        ->get('enable_stats'),
    ];

    // Option for logging wrong responses.
    $form['log_wrong_responses'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Log wrong responses'),
      '#description' => $this
        ->t('Report information about wrong responses to the log.'),
      '#default_value' => $config
        ->get('log_wrong_responses'),
    ];

    // Replace the description with a link if dblog.module is enabled.
    if ($this->moduleHandler
      ->moduleExists('dblog')) {
      $form['log_wrong_responses']['#description'] = $this
        ->t('Report information about wrong responses to the <a href=":dblog">log</a>.', [
        ':dblog' => Url::fromRoute('dblog.overview')
          ->toString(),
      ]);
    }

    // Submit button.
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('captcha.settings');
    $config
      ->set('administration_mode', $form_state
      ->getValue('administration_mode'));
    $config
      ->set('allow_on_admin_pages', $form_state
      ->getValue('allow_on_admin_pages'));
    $config
      ->set('default_challenge', $form_state
      ->getValue('default_challenge'));
    $config
      ->set('enabled_default', $form_state
      ->getValue('enabled_default'));

    // CAPTCHA description stuff.
    $config
      ->set('add_captcha_description', $form_state
      ->getValue('add_captcha_description'));

    // Save (or reset) the CAPTCHA descriptions.
    $config
      ->set('description', $form_state
      ->getValue('description'));
    $config
      ->set('wrong_captcha_response_message', $form_state
      ->getValue('wrong_captcha_response_message'));
    $config
      ->set('default_validation', $form_state
      ->getValue('default_validation'));
    $config
      ->set('persistence', $form_state
      ->getValue('persistence'));
    $config
      ->set('enable_stats', $form_state
      ->getValue('enable_stats'));
    $config
      ->set('log_wrong_responses', $form_state
      ->getValue('log_wrong_responses'));
    $config
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('The CAPTCHA settings have been saved.'));
    parent::submitForm($form, $form_state);
  }

  /**
   * Submit callback; clear CAPTCHA placement cache.
   *
   * @param array $form
   *   Form structured array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state structured array.
   */
  public function clearCaptchaPlacementCacheSubmit(array $form, FormStateInterface $form_state) {
    $this->cacheBackend
      ->delete('captcha_placement_map_cache');
    $this
      ->messenger()
      ->addMessage($this
      ->t('Cleared the CAPTCHA placement cache.'));
  }

}

Classes

Name	Description
CaptchaSettingsForm	Displays the captcha settings form.