View source
<?php
namespace Drupal\honeypot\Controller;
use Drupal\Component\Utility\Html;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\node\Entity\NodeType;
use Drupal\comment\Entity\CommentType;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
class HoneypotSettingsController extends ConfigFormBase {
protected $moduleHandler;
protected $entityTypeManager;
protected $entityTypeBundleInfo;
protected $cache;
protected $messenger;
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;
}
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'));
}
public function getFormSettingsValue($form_settings, $form_id) {
if (!empty($form_settings) && isset($form_settings[$form_id])) {
return $form_settings[$form_id];
}
else {
return 0;
}
}
protected function getEditableConfigNames() {
return [
'honeypot.settings',
];
}
public function getFormId() {
return 'honeypot_settings_form';
}
public function buildForm(array $form, FormStateInterface $form_state) {
$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>');
$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' => [
'invisible' => [
'input[name="protect_all_forms"]' => [
'checked' => TRUE,
],
],
],
];
$form['form_settings']['general_forms'] = [
'#markup' => '<h5>' . $this
->t('General Forms') . '</h5>',
];
$form['form_settings']['user_register_form'] = [
'#type' => 'checkbox',
'#title' => $this
->t('User Registration form'),
'#default_value' => $this
->getFormSettingsValue($form_settings, 'user_register_form'),
];
$form['form_settings']['user_pass'] = [
'#type' => 'checkbox',
'#title' => $this
->t('User Password Reset form'),
'#default_value' => $this
->getFormSettingsValue($form_settings, 'user_pass'),
];
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),
];
}
}
if ($this->moduleHandler
->moduleExists('node')) {
$types = NodeType::loadMultiple();
if (!empty($types)) {
$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),
];
}
}
}
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),
];
}
}
}
$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,
]);
$form['actions']['#type'] = 'container';
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Save configuration'),
];
return $form;
}
public function validateForm(array &$form, FormStateInterface $form_state) {
$time_limit = $form_state
->getValue('time_limit');
if (is_numeric($time_limit) && $time_limit > 0 || $time_limit === '0') {
if (ctype_digit($time_limit)) {
}
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."));
}
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."));
}
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."));
}
$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),
]));
}
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$config = $this
->config('honeypot.settings');
$storage = $form_state
->getStorage();
foreach ($form_state
->getValues() as $key => $value) {
if (in_array($key, $storage['keys'])) {
$config
->set($key, $value);
}
}
$config
->set('form_settings', $form_state
->getValue('form_settings'));
$config
->save();
$this->cache
->delete('honeypot_protected_forms');
$this->messenger
->addMessage($this
->t('The configuration options have been saved.'));
}
}