View source
<?php
namespace Drupal\emaillog\Form;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\Core\Url;
use Symfony\Component\HttpFoundation\Request;
class EmaillogConfigForm extends ConfigFormBase {
public function getFormId() {
return 'email_log_config_form';
}
public function getEditableConfigNames() {
return [
'emaillog.settings',
];
}
public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
$severity_levels = RfcLogLevel::getLevels();
$form['emaillog'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Email addresses for each severity level'),
'#description' => $this
->t('Enter an email address for each severity level. For example, you may want to get emergency and critical levels to your pager or mobile phone, while notice level messages can go to a regular email. If you leave the email address blank for a severity level, no email messages will be sent for that severity level.'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
];
foreach ($severity_levels as $severity => $level) {
$key = 'emaillog_' . $severity;
$form['emaillog'][$key] = [
'#type' => 'textfield',
'#title' => $this
->t('Email address for severity %description', [
'%description' => Unicode::ucfirst($level
->render()),
]),
'#default_value' => $this
->config('emaillog.settings')
->get($key),
'#description' => $this
->t('The email address to send log entries of severity %description to.', [
'%description' => Unicode::ucfirst($level
->render()),
]),
];
}
$form['debug_info'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Additional debug info'),
'#description' => $this
->t('Additional debug information that should be attached to email alerts. Note that this information could be altered by other modules using <em>hook_emaillog_debug_info_alter(&$debug_info)</em>'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#tree' => TRUE,
];
$debug_info_settings = $this
->config('emaillog.settings')
->get('emaillog_debug_info');
$status = [];
foreach (_emaillog_get_debug_info_callbacks() as $debug_info_key => $debug_info_callback) {
$options[$debug_info_key] = '';
$form['debug_info']['variable'][$debug_info_key] = [
'#type' => 'item',
'#markup' => $debug_info_callback,
];
foreach (array_keys($severity_levels) as $level_id) {
if (!empty($debug_info_settings[$level_id][$debug_info_key])) {
$status[$level_id][] = $debug_info_key;
}
}
}
foreach ($severity_levels as $level_id => $description) {
$form['debug_info'][$level_id] = [
'#title' => $description,
'#type' => 'checkboxes',
'#options' => $options,
'#default_value' => isset($status[$level_id]) ? $status[$level_id] : [],
];
}
$form['debug_info']['emaillog_backtrace_replace_args'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Replace debug_backtrace() argument values with types'),
'#description' => $this
->t('By default <em>debug_backtrace()</em> will return full variable information in the stack traces that it produces. Variable information can take quite a bit of resources, both while collecting and adding to the alert email, therefore here by default all variable values are replaced with their types only. Warning - unchecking this option could cause your site to crash when it tries to send an alert email with too big stack trace!'),
'#default_value' => $this
->config('emaillog.settings')
->get('emaillog_backtrace_replace_args'),
'#weight' => 1,
];
$form['limits'] = [
'#type' => 'fieldset',
'#title' => t('Email sending limits'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
];
$form['limits']['emaillog_max_similar_emails'] = [
'#type' => 'textfield',
'#title' => $this
->t('Maximum number of allowed consecutive similar email alerts'),
'#description' => $this
->t('Upper limit of email alerts sent consecutively with the same or very similar message. Leave empty for no limit.'),
'#default_value' => $this
->config('emaillog.settings')
->get('emaillog_max_similar_emails'),
];
$form['limits']['emaillog_max_consecutive_timespan'] = [
'#type' => 'textfield',
'#title' => $this
->t('Email alerts should be considered "consecutive" if sent within'),
'#field_suffix' => $this
->t('minutes from each other'),
'#description' => $this
->t('Longest possible period between two email alerts being sent to still be considered consecutive. Leave empty for no limit.'),
'#default_value' => $this
->config('emaillog.settings')
->get('emaillog_max_consecutive_timespan'),
];
$form['limits']['emaillog_max_similarity_level'] = [
'#type' => 'textfield',
'#title' => $this
->t('Maximum allowed similarity level between consecutive email alerts'),
'#description' => '<p>' . $this
->t('Highest similarity level above which new email alerts will not be sent anymore if "Maximum number of allowed consecutive similar email alerts" has been reached and email alerts are considered "consecutive" (time period between each previous and next one is smaller than defined above). Possible values range from 0 to 1, where 1 stands for two identical emails.') . '</p>' . '<p>' . $this
->t('For example setting "Maximum number of allowed consecutive similar email alerts" to 5, "Email alerts should be considered consecutive if sent within" to 5 minutes and "Similarity level" to 0.9 would mean that only 5 email alerts would be sent within 5 minutes if Watchdog entries are similar in at least 90%.') . '</p>' . '<p>' . $this
->t("(Note that similarity level is calculated using PHP's <a href='@similar_text_url'>similar_text()</a> function, with all its complexity and implications.)", [
'@similar_text_url' => Url::fromUri('http://php.net/similar_text')
->getUri(),
]) . '</p>',
'#default_value' => $this
->config('emaillog.settings')
->get('emaillog_max_similarity_level'),
];
$form['legacy'] = [
'#type' => 'fieldset',
'#title' => t('Legacy settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
];
$form['legacy']['emaillog_legacy_subject'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use legacy email subject'),
'#description' => $this
->t('Older versions of this module were using email subject "%subject", while currently it is being set to beginning of Watchdog message. This option allows to switch back to previous version of email subject.', [
'%subject' => $this
->t('[@site_name] @severity_desc: Alert from your web site'),
]),
'#default_value' => $this
->config('emaillog.settings')
->get('emaillog_legacy_subject'),
];
$form['submit'] = [
'#type' => 'submit',
'#value' => 'Save Configuration',
];
$form['#theme'] = 'emaillog_admin_settings';
return $form;
}
public function validateForm(array &$form, FormStateInterface $form_state) {
$userInputValues = $form_state
->getUserInput();
if ($userInputValues['emaillog_max_similar_emails'] && !$userInputValues['emaillog_max_similarity_level']) {
$form_state
->setErrorByName('emaillog_max_similarity_level', $this
->t('You need to provide value for %field1 field when specifying %field2.', [
'%field1' => 'Maximum allowed similarity level between consecutive email alerts',
'%field2' => 'Maximum number of allowed consecutive similar emails',
]));
}
if ($userInputValues['emaillog_max_similarity_level'] && !$userInputValues['emaillog_max_similar_emails']) {
$form_state
->setErrorByName('emaillog_max_similar_emails', $this
->t('You need to provide value for %field1 field when specifying %field2.', [
'%field1' => 'Maximum number of allowed consecutive similar emails',
'%field2' => 'Maximum allowed similarity level between consecutive email alerts',
]));
}
if ($userInputValues['emaillog_max_consecutive_timespan'] && !$userInputValues['emaillog_max_similar_emails']) {
$form_state
->setErrorByName('emaillog_max_similar_emails', $this
->t('You need to provide value for %field1 field when specifying %field2.', [
'%field1' => 'Maximum number of allowed consecutive similar emails',
'%field2' => 'Email alerts should be considered "consecutive" if sent within',
]));
}
if ($userInputValues['emaillog_max_consecutive_timespan'] && !$userInputValues['emaillog_max_similarity_level']) {
$form_state
->setErrorByName('emaillog_max_similarity_level', $this
->t('You need to provide value for %field1 field when specifying %field2.', [
'%field1' => 'Maximum allowed similarity level between consecutive email alerts',
'%field2' => 'Email alerts should be considered "consecutive" if sent within',
]));
}
if ($userInputValues['emaillog_max_similarity_level']) {
if (!is_numeric($userInputValues['emaillog_max_similarity_level'])) {
$form_state
->setErrorByName('emaillog_max_similarity_level', $this
->t('Value of %field cannot contain any non-numeric characters.', [
'%field' => 'Maximum allowed similarity level between consecutive email alerts',
]));
}
if ($userInputValues['emaillog_max_similarity_level'] < 0 || $userInputValues['emaillog_max_similarity_level'] > 1) {
$form_state
->setErrorByName('emaillog_max_similarity_level', $this
->t('Value of %field needs to be in [0-1] range.', [
'%field' => 'Maximum allowed similarity level between consecutive email alerts',
]));
}
}
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$userInputValues = $form_state
->getUserInput();
$config = $this
->config('emaillog.settings');
$severity_levels = RfcLogLevel::getLevels();
$debug_info = [];
foreach (array_keys($severity_levels) as $level_id) {
foreach (array_keys(_emaillog_get_debug_info_callbacks()) as $variable_id) {
if (!empty($userInputValues['debug_info'][$level_id][$variable_id])) {
$debug_info[$level_id][$variable_id] = 1;
}
}
}
foreach (array_keys($severity_levels) as $level_id) {
$config
->set('emaillog_' . $level_id, $userInputValues['emaillog_' . $level_id]);
}
$config
->set('emaillog_backtrace_replace_args', $userInputValues['debug_info']['emaillog_backtrace_replace_args']);
$config
->set('emaillog_debug_info', $debug_info);
$config
->set('emaillog_max_similar_emails', $userInputValues['emaillog_max_similar_emails']);
$config
->set('emaillog_max_consecutive_timespan', $userInputValues['emaillog_max_consecutive_timespan']);
$config
->set('emaillog_max_similarity_level', $userInputValues['emaillog_max_similarity_level']);
$config
->set('emaillog_legacy_subject', $userInputValues['emaillog_legacy_subject']);
$config
->save();
}
}
