honeypot.admin.inc in Honeypot 7
Same filename and directory in other branches
Honeypot administration forms.
File
honeypot.admin.incView source
<?php
/**
* @file
* Honeypot administration forms.
*/
/**
* Honeypot administration page.
*/
function honeypot_admin_form($form, &$form_state) {
// Honeypot Configuration.
$form['configuration'] = array(
'#type' => 'fieldset',
'#title' => t('Honeypot Configuration'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['configuration']['honeypot_protect_all_forms'] = array(
'#type' => 'checkbox',
'#title' => t('Protect all forms with Honeypot'),
'#description' => 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' => variable_get('honeypot_protect_all_forms', 0),
);
if (!variable_get('honeypot_use_js_for_cached_pages', FALSE)) {
$form['configuration']['honeypot_protect_all_forms']['#description'] .= '<br />' . 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']['honeypot_log'] = array(
'#type' => 'checkbox',
'#title' => t('Log blocked form submissions'),
'#description' => t('Log submissions that are blocked due to Honeypot protection.'),
'#default_value' => variable_get('honeypot_log', 0),
);
$form['configuration']['honeypot_element_name'] = array(
'#type' => 'textfield',
'#title' => t('Honeypot element name'),
'#description' => 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' => variable_get('honeypot_element_name', 'url'),
'#required' => TRUE,
'#size' => 30,
);
$form['configuration']['honeypot_time_limit'] = array(
'#type' => 'textfield',
'#title' => t('Honeypot time limit'),
'#description' => t('Minimum time required before form should be considered entered by a human instead of a bot. Set to 0 to disable.'),
'#default_value' => variable_get('honeypot_time_limit', 5),
'#required' => TRUE,
'#size' => 5,
'#field_suffix' => t('seconds'),
);
if (!variable_get('honeypot_use_js_for_cached_pages', FALSE)) {
$form['configuration']['honeypot_time_limit']['#description'] .= '<br />' . t('<strong>Page caching will be disabled if there is a form protected by time limit on the page.</strong>');
}
$form['configuration']['honeypot_use_js_for_cached_pages'] = array(
'#type' => 'checkbox',
'#title' => t('Use Javascript protection for cacheable pages. (experimental)'),
'#description' => t('Uses Javascript to preserve Page caching.'),
'#default_value' => variable_get('honeypot_use_js_for_cached_pages', FALSE),
'#states' => array(
// Hide this when time limit is disabled.
'invisible' => array(
'input[name="honeypot_time_limit"]' => array(
'value' => 0,
),
),
),
);
$form['configuration']['honeypot_use_js_for_cached_pages']['#description'] .= '<br />' . t('<strong>Warning: Users who have javascript disabled will need to confirm their form submission on the next page (if the Honeypot-enabled form is on a cacheable page).</strong>');
// Honeypot Enabled forms.
$form['enabled_forms'] = array(
'#type' => 'fieldset',
'#title' => t('Honeypot Enabled Forms'),
'#description' => t("Check the boxes next to individual forms on which you'd like Honeypot protection enabled."),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#states' => array(
// Hide this fieldset when all forms are protected.
'invisible' => array(
'input[name="honeypot_protect_all_forms"]' => array(
'checked' => TRUE,
),
),
),
);
// Generic forms.
$form['enabled_forms']['general_forms'] = array(
'#markup' => '<h5>' . t('General Forms') . '</h5>',
);
// User register form.
$form['enabled_forms']['honeypot_form_user_register_form'] = array(
'#type' => 'checkbox',
'#title' => t('User Registration form'),
'#default_value' => variable_get('honeypot_form_user_register_form', 0),
);
// User password form.
$form['enabled_forms']['honeypot_form_user_pass'] = array(
'#type' => 'checkbox',
'#title' => t('User Password Reset form'),
'#default_value' => variable_get('honeypot_form_user_pass', 0),
);
// If webform.module enabled, add webforms.
if (module_exists('webform')) {
$form['enabled_forms']['honeypot_form_webforms'] = array(
'#type' => 'checkbox',
'#title' => t('Webforms (all)'),
'#default_value' => variable_get('honeypot_form_webforms', 0),
);
}
// If contact.module enabled, add contact forms.
if (module_exists('contact')) {
$form['enabled_forms']['contact_forms'] = array(
'#markup' => '<h5>' . t('Contact Forms') . '</h5>',
);
// Sitewide contact form.
$form['enabled_forms']['honeypot_form_contact_site_form'] = array(
'#type' => 'checkbox',
'#title' => t('Sitewide Contact form'),
'#default_value' => variable_get('honeypot_form_contact_site_form', 0),
);
// Sitewide personal form.
$form['enabled_forms']['honeypot_form_contact_personal_form'] = array(
'#type' => 'checkbox',
'#title' => t('Personal Contact forms'),
'#default_value' => variable_get('honeypot_form_contact_personal_form', 0),
);
}
// If profile.module enabled, add profile forms.
if (module_exists('profile')) {
$form['enabled_forms']['profile_forms'] = array(
'#value' => '<h5>' . t('Profile Forms') . '</h5>',
);
$form['enabled_forms']['honeypot_form_user_profile_form'] = array(
'#type' => 'checkbox',
'#title' => t('Profile forms (all)'),
'#default_value' => variable_get('honeypot_form_user_profile_form', 0),
);
}
// Get node types for node forms and node comment forms.
$types = node_type_get_types();
if (!empty($types)) {
// Node forms.
$form['enabled_forms']['node_forms'] = array(
'#markup' => '<h5>' . t('Node Forms') . '</h5>',
);
foreach ($types as $type) {
$id = 'honeypot_form_' . $type->type . '_node_form';
$form['enabled_forms'][$id] = array(
'#type' => 'checkbox',
'#title' => t('@name node form', array(
'@name' => $type->name,
)),
'#default_value' => variable_get($id, 0),
);
}
// Comment forms.
if (module_exists('comment')) {
$form['enabled_forms']['comment_forms'] = array(
'#markup' => '<h5>' . t('Comment Forms') . '</h5>',
);
foreach ($types as $type) {
$id = 'honeypot_form_comment_node_' . $type->type . '_form';
$form['enabled_forms'][$id] = array(
'#type' => 'checkbox',
'#title' => t('@name comment form', array(
'@name' => $type->name,
)),
'#default_value' => variable_get($id, 0),
);
}
}
}
// Add our own submit handler to clear honeypot's form cache on save.
$form['#submit'][] = 'honeypot_admin_form_submit';
return system_settings_form($form);
}
/**
* Validate the admin form.
*/
function honeypot_admin_form_validate($form, &$form_state) {
// Make sure the time limit is a positive integer or 0.
$time_limit = $form_state['values']['honeypot_time_limit'];
if (is_numeric($time_limit) && $time_limit > 0 || $time_limit === '0') {
if (ctype_digit($time_limit)) {
// Good to go.
}
else {
form_set_error('honeypot_time_limit', t("The time limit must be a positive integer or 0."));
}
}
else {
form_set_error('honeypot_time_limit', 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['values']['honeypot_element_name'])) {
form_set_error('honeypot_element_name', 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['values']['honeypot_element_name'])) {
form_set_error('honeypot_element_name', t("The element name must start with a letter."));
}
// Make sure Honeypot element name isn't one of the reserved names.
$reserved_element_names = array(
'name',
'pass',
'website',
);
if (in_array($form_state['values']['honeypot_element_name'], $reserved_element_names)) {
form_set_error('honeypot_element_name', t("The element name cannot match one of the common Drupal form field names (e.g. @names).", array(
'@names' => implode(', ', $reserved_element_names),
)));
}
}
/**
* Honeypot admin form submit callback.
*/
function honeypot_admin_form_submit($form, &$form_state) {
// Create CSS file for honeypot.
honeypot_create_css($form_state['values']['honeypot_element_name']);
// Clear the Honeypot form cache on submit.
cache_clear_all('honeypot_protected_forms', 'cache');
}
Functions
Name | Description |
---|---|
honeypot_admin_form | Honeypot administration page. |
honeypot_admin_form_submit | Honeypot admin form submit callback. |
honeypot_admin_form_validate | Validate the admin form. |