You are here

Home » API reference » Honeypot 8 » HoneypotSettingsController.php

class HoneypotSettingsController in Honeypot 8

Same name and namespace in other branches
  1. 2.0.x src/Controller/HoneypotSettingsController.php \Drupal\honeypot\Controller\HoneypotSettingsController

Returns responses for Honeypot module routes.

Hierarchy

Expanded class hierarchy of HoneypotSettingsController

1 string reference to 'HoneypotSettingsController'
honeypot.routing.yml in ./honeypot.routing.yml
honeypot.routing.yml

File

src/Controller/HoneypotSettingsController.php, line 21

Namespace

Drupal\honeypot\Controller
View source 
class HoneypotSettingsController extends ConfigFormBase {

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

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * A cache backend interface.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a settings controller.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info service.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend interface.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, CacheBackendInterface $cache_backend, MessengerInterface $messenger) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->cache = $cache_backend;
    $this->messenger = $messenger;
  }

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

  /**
   * Get a value from the retrieved form settings array.
   */
  public function getFormSettingsValue($form_settings, $form_id) {

    // If there are settings in the array and the form ID already has a setting,
    // return the saved setting for the form ID.
    if (!empty($form_settings) && isset($form_settings[$form_id])) {
      return $form_settings[$form_id];
    }
    else {
      return 0;
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'honeypot_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Honeypot Configuration.
    $form['configuration'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Honeypot Configuration'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    ];
    $form['configuration']['protect_all_forms'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Protect all forms with Honeypot'),
      '#description' => $this
        ->t('Enable Honeypot protection for ALL forms on this site (it is best to only enable Honeypot for the forms you need below).'),
      '#default_value' => $this
        ->config('honeypot.settings')
        ->get('protect_all_forms'),
    ];
    $form['configuration']['protect_all_forms']['#description'] .= '<br />' . $this
      ->t('<strong>Page caching will be disabled on any page where a form is present if the Honeypot time limit is not set to 0.</strong>');
    $form['configuration']['log'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Log blocked form submissions'),
      '#description' => $this
        ->t('Log submissions that are blocked due to Honeypot protection.'),
      '#default_value' => $this
        ->config('honeypot.settings')
        ->get('log'),
    ];
    $form['configuration']['element_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Honeypot element name'),
      '#description' => $this
        ->t("The name of the Honeypot form field. It's usually most effective to use a generic name like email, homepage, or link, but this should be changed if it interferes with fields that are already in your forms. Must not contain spaces or special characters."),
      '#default_value' => $this
        ->config('honeypot.settings')
        ->get('element_name'),
      '#required' => TRUE,
      '#size' => 30,
    ];
    $form['configuration']['time_limit'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Honeypot time limit'),
      '#description' => $this
        ->t('Minimum time required before form should be considered entered by a human instead of a bot. Set to 0 to disable.'),
      '#default_value' => $this
        ->config('honeypot.settings')
        ->get('time_limit'),
      '#required' => TRUE,
      '#size' => 5,
      '#field_suffix' => $this
        ->t('seconds'),
    ];
    $form['configuration']['time_limit']['#description'] .= '<br />' . $this
      ->t('<strong>Page caching will be disabled if there is a form protected by time limit on the page.</strong>');

    // Honeypot Enabled forms.
    $form_settings = $this
      ->config('honeypot.settings')
      ->get('form_settings');
    $form['form_settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Honeypot Enabled Forms'),
      '#description' => $this
        ->t("Check the boxes next to individual forms on which you'd like Honeypot protection enabled."),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#tree' => TRUE,
      '#states' => [
        // Hide this fieldset when all forms are protected.
        'invisible' => [
          'input[name="protect_all_forms"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Generic forms.
    $form['form_settings']['general_forms'] = [
      '#markup' => '<h5>' . $this
        ->t('General Forms') . '</h5>',
    ];

    // User register form.
    $form['form_settings']['user_register_form'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('User Registration form'),
      '#default_value' => $this
        ->getFormSettingsValue($form_settings, 'user_register_form'),
    ];

    // User password form.
    $form['form_settings']['user_pass'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('User Password Reset form'),
      '#default_value' => $this
        ->getFormSettingsValue($form_settings, 'user_pass'),
    ];

    // If contact.module enabled, add contact forms.
    if ($this->moduleHandler
      ->moduleExists('contact')) {
      $form['form_settings']['contact_forms'] = [
        '#markup' => '<h5>' . $this
          ->t('Contact Forms') . '</h5>',
      ];
      $bundles = $this->entityTypeBundleInfo
        ->getBundleInfo('contact_message');
      $formController = $this->entityTypeManager
        ->getFormObject('contact_message', 'default');
      foreach ($bundles as $bundle_key => $bundle) {
        $stub = $this->entityTypeManager
          ->getStorage('contact_message')
          ->create([
          'contact_form' => $bundle_key,
        ]);
        $formController
          ->setEntity($stub);
        $form_id = $formController
          ->getFormId();
        $form['form_settings'][$form_id] = [
          '#type' => 'checkbox',
          '#title' => Html::escape($bundle['label']),
          '#default_value' => $this
            ->getFormSettingsValue($form_settings, $form_id),
        ];
      }
    }

    // Node types for node forms.
    if ($this->moduleHandler
      ->moduleExists('node')) {
      $types = NodeType::loadMultiple();
      if (!empty($types)) {

        // Node forms.
        $form['form_settings']['node_forms'] = [
          '#markup' => '<h5>' . $this
            ->t('Node Forms') . '</h5>',
        ];
        foreach ($types as $type) {
          $id = 'node_' . $type
            ->get('type') . '_form';
          $form['form_settings'][$id] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('@name node form', [
              '@name' => $type
                ->label(),
            ]),
            '#default_value' => $this
              ->getFormSettingsValue($form_settings, $id),
          ];
        }
      }
    }

    // Comment types for comment forms.
    if ($this->moduleHandler
      ->moduleExists('comment')) {
      $types = CommentType::loadMultiple();
      if (!empty($types)) {
        $form['form_settings']['comment_forms'] = [
          '#markup' => '<h5>' . $this
            ->t('Comment Forms') . '</h5>',
        ];
        foreach ($types as $type) {
          $id = 'comment_' . $type
            ->id() . '_form';
          $form['form_settings'][$id] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('@name comment form', [
              '@name' => $type
                ->label(),
            ]),
            '#default_value' => $this
              ->getFormSettingsValue($form_settings, $id),
          ];
        }
      }
    }

    // Store the keys we want to save in configuration when form is submitted.
    $keys_to_save = array_keys($form['configuration']);
    foreach ($keys_to_save as $key => $key_to_save) {
      if (strpos($key_to_save, '#') !== FALSE) {
        unset($keys_to_save[$key]);
      }
    }
    $form_state
      ->setStorage([
      'keys' => $keys_to_save,
    ]);

    // For now, manually add submit button. Hopefully, by the time D8 is
    // released, there will be something like system_settings_form() in D7.
    $form['actions']['#type'] = 'container';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Make sure the time limit is a positive integer or 0.
    $time_limit = $form_state
      ->getValue('time_limit');
    if (is_numeric($time_limit) && $time_limit > 0 || $time_limit === '0') {
      if (ctype_digit($time_limit)) {

        // Good to go.
      }
      else {
        $form_state
          ->setErrorByName('time_limit', $this
          ->t("The time limit must be a positive integer or 0."));
      }
    }
    else {
      $form_state
        ->setErrorByName('time_limit', $this
        ->t("The time limit must be a positive integer or 0."));
    }

    // Make sure Honeypot element name only contains A-Z, 0-9.
    if (!preg_match("/^[-_a-zA-Z0-9]+\$/", $form_state
      ->getValue('element_name'))) {
      $form_state
        ->setErrorByName('element_name', $this
        ->t("The element name cannot contain spaces or other special characters."));
    }

    // Make sure Honeypot element name starts with a letter.
    if (!preg_match("/^[a-zA-Z].+\$/", $form_state
      ->getValue('element_name'))) {
      $form_state
        ->setErrorByName('element_name', $this
        ->t("The element name must start with a letter."));
    }

    // Make sure Honeypot element name isn't one of the reserved names.
    $reserved_element_names = [
      'name',
      'pass',
      'website',
    ];
    if (in_array($form_state
      ->getValue('element_name'), $reserved_element_names)) {
      $form_state
        ->setErrorByName('element_name', $this
        ->t("The element name cannot match one of the common Drupal form field names (e.g. @names).", [
        '@names' => implode(', ', $reserved_element_names),
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('honeypot.settings');
    $storage = $form_state
      ->getStorage();

    // Save all the Honeypot configuration items from $form_state.
    foreach ($form_state
      ->getValues() as $key => $value) {
      if (in_array($key, $storage['keys'])) {
        $config
          ->set($key, $value);
      }
    }

    // Save the honeypot forms from $form_state into a 'form_settings' array.
    $config
      ->set('form_settings', $form_state
      ->getValue('form_settings'));
    $config
      ->save();

    // Clear the honeypot protected forms cache.
    $this->cache
      ->delete('honeypot_protected_forms');

    // Tell the user the settings have been saved.
    $this->messenger
      ->addMessage($this
      ->t('The configuration options have been saved.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
HoneypotSettingsController::$cache protected property A cache backend interface.
HoneypotSettingsController::$entityTypeBundleInfo protected property The entity type bundle info service.
HoneypotSettingsController::$entityTypeManager protected property The entity type manager.
HoneypotSettingsController::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
HoneypotSettingsController::$moduleHandler protected property The module handler service.
HoneypotSettingsController::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
HoneypotSettingsController::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
HoneypotSettingsController::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HoneypotSettingsController::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
HoneypotSettingsController::getFormSettingsValue public function Get a value from the retrieved form settings array.
HoneypotSettingsController::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
HoneypotSettingsController::validateForm public function Form validation handler. Overrides FormBase::validateForm
HoneypotSettingsController::__construct public function Constructs a settings controller. Overrides ConfigFormBase::__construct
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.