From 9ff378a093f5a65916e81b578eead431b83e7aa2 Mon Sep 17 00:00:00 2001 From: Florent Torregrosa Date: Wed, 12 Aug 2015 00:03:44 +0200 Subject: [PATCH] Issue #2549747: Add variable support. --- protected_node.module | 57 +++++++++++ protected_node.settings.inc | 46 +-------- protected_node.variable.inc | 230 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 292 insertions(+), 41 deletions(-) create mode 100644 protected_node.variable.inc diff --git a/protected_node.module b/protected_node.module index d7f7a4e..5929958 100644 --- a/protected_node.module +++ b/protected_node.module @@ -1343,3 +1343,60 @@ function _protected_node_get_default_checked_view_modes() { return $default_view_modes; } + +/** + * Helper function. + * + * Used to get the options for the protected_node_failed_password_ip_limit + * variable. + */ +function _protected_node_get_failed_password_ip_limit_options() { + return drupal_map_assoc(array( + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 75, + 100, + 125, + 150, + 200, + 250, + 500, + )); +} + + +/** + * Helper function. + * + * Used to get the options for the protected_node_failed_password_ip_window + * variable. + */ +function _protected_node_get_failed_password_ip_window_options() { + return array(0 => t('None (flood control disabled)')) + drupal_map_assoc(array( + 60, + 180, + 300, + 600, + 900, + 1800, + 2700, + 3600, + 10800, + 21600, + 32400, + 43200, + 86400, + ), 'format_interval'); +} diff --git a/protected_node.settings.inc b/protected_node.settings.inc index 13148c3..620f89c 100644 --- a/protected_node.settings.inc +++ b/protected_node.settings.inc @@ -567,7 +567,7 @@ function protected_node_admin_settings() { $form['protected_node_form']['protected_node_title'] = array( '#type' => 'textfield', '#title' => t('Password page title'), - '#default_value' => variable_get('protected_node_title', 'Protected page -- Enter password'), + '#default_value' => variable_get('protected_node_title', t('Protected page -- Enter password')), '#description' => t('Enter the title of the protected node page. No HTML allowed. You can use node type tokens from the token module when installed.'), ); @@ -609,56 +609,20 @@ function protected_node_admin_settings() { '#collapsible' => TRUE, ); - $protected_node_failed_password_ip_limit_options = drupal_map_assoc(array( - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 9, - 10, - 20, - 30, - 40, - 50, - 75, - 100, - 125, - 150, - 200, - 250, - 500, - )); $form['protected_node_flood_control']['protected_node_failed_password_ip_limit'] = array( '#type' => 'select', '#title' => t('Failed password (IP) limit'), - '#options' => $protected_node_failed_password_ip_limit_options, + '#options' => _protected_node_get_failed_password_ip_limit_options(), '#default_value' => variable_get('protected_node_failed_password_ip_limit', 50), + '#description' => t('Defines the number of attempts a user has during a limited time window.'), ); - $protected_node_failed_password_ip_window_options = array(0 => t('None (flood control disabled)')) + drupal_map_assoc(array( - 60, - 180, - 300, - 600, - 900, - 1800, - 2700, - 3600, - 10800, - 21600, - 32400, - 43200, - 86400, - ), 'format_interval'); $form['protected_node_flood_control']['protected_node_failed_password_ip_window'] = array( '#type' => 'select', '#title' => t('Failed password (IP) window'), - '#options' => $protected_node_failed_password_ip_window_options, + '#options' => _protected_node_get_failed_password_ip_window_options(), '#default_value' => variable_get('protected_node_failed_password_ip_window', 3600), + '#description' => t('Defines the time window during while the user has a limited number of possible attempts.'), ); // View modes. diff --git a/protected_node.variable.inc b/protected_node.variable.inc new file mode 100644 index 0000000..171addd --- /dev/null +++ b/protected_node.variable.inc @@ -0,0 +1,230 @@ + t('Protected node'), + 'description' => t('Controls whether selected nodes are protected with a password.'), + 'access' => 'administer site configuration', + 'path' => array('admin/config/content/protected_node'), + ); + + return $groups; +} + +/** + * Implements hook_variable_info(). + */ +function protected_node_variable_info($options) { + module_load_include('settings.inc', 'protected_node'); + + // Global settings. + $variables['protected_node_use_global_password'] = array( + 'type' => 'select', + 'title' => t('Global password handling', array(), $options), + 'description' => t("When checked, the global password is used if the user doesn't enter a password when creating/editing nodes.", array(), $options) . t("WARNING: removing the global password when many pages were not otherwise assigned a password will make those nodes unaccessible except for UID=1 and the author of the node.", array(), $options), + 'option' => array( + PROTECTED_NODE_PER_NODE_PASSWORD => t('Per node password', array(), $options), + PROTECTED_NODE_PER_NODE_AND_GLOBAL_PASSWORD => t('Per node password or Global password', array(), $options), + PROTECTED_NODE_GLOBAL_PASSWORD => t('Global password only', array(), $options), + ), + 'default' => PROTECTED_NODE_PER_NODE_PASSWORD, + 'group' => 'protected_node', + ); + $variables['protected_node_show_password_strength'] = array( + 'type' => 'boolean', + 'title' => t('Show password strength in nodes', array(), $options), + 'description' => t('When checked, show the password strength on nodes being edited. Since some people will on purpose want to use this feature with very weak password, this may not always be welcome.', array(), $options), + 'default' => TRUE, + 'group' => 'protected_node', + ); + $variables['protected_node_show_node_titles'] = array( + 'type' => 'boolean', + 'title' => t('Show node titles by default', array(), $options), + 'description' => t('Whether a the node title should be shown (selected) or hidden (unchecked) by default. This flag is used as the default of the Show title checkbox on a create node. Note that this setting is overridden by custom password page description text.', array(), $options), + 'default' => FALSE, + 'group' => 'protected_node', + ); + $variables['protected_node_allow_hint'] = array( + 'type' => 'boolean', + 'title' => t('Allow author to enter a password hint', array(), $options), + 'description' => t('By default, the password is kept as secret as possible. This option allows the author to enter a hint about the password of a node. The hint is later shown using the [node:password-hint] token.', array(), $options), + 'default' => FALSE, + 'group' => 'protected_node', + ); + + // Email features. + $variables['protected_node_email_activation'] = array( + 'type' => 'boolean', + 'title' => t('Enable protected node email support', array(), $options), + 'description' => t('Check this box to enable the protected node email support (NOTE: Random password support available within this feature).', array(), $options), + 'default' => FALSE, + 'group' => 'protected_node', + ); + $variables['protected_node_email_box_width'] = array( + 'type' => 'number', + 'title' => t('Email box width', array(), $options), + 'description' => t('Enter the width (number of columns) of the email box text area. Must be a positive integer. Default value : 10.', array(), $options), + 'default' => 10, + 'group' => 'protected_node', + ); + $variables['protected_node_email_box_height'] = array( + 'type' => 'number', + 'title' => t('Email box height', array(), $options), + 'description' => t('Enter the height (number of rows) of the email box text area. Must be a positive integer. Default value : 2.', array(), $options), + 'default' => 2, + 'group' => 'protected_node', + ); + $variables['protected_node_email_from'] = array( + 'type' => 'mail_address', + 'title' => t('From email address', array(), $options), + 'description' => t('Enter the email address used in the From: header. By default, [site-mail] is used (@mail)', array('@mail' => variable_get('site_mail', '')), $options), + 'default' => '', + 'group' => 'protected_node', + ); + $variables['protected_node_email_subject'] = array( + 'type' => 'string', + 'title' => t('Email subject', array(), $options), + 'description' => t('Enter the subject of the email. You may enter tokens in this field. Remember that [user-name] will be the author name.', array(), $options), + 'default callback' => protected_node_email_subject(), + 'group' => 'protected_node', + ); + $variables['protected_node_email_body'] = array( + 'type' => 'text', + 'title' => t('Email content', array(), $options), + 'description' => t('Enter the body of the email. You may enter tokens in this field. Remember that [user-name] will be the author name.', array(), $options), + 'default callback' => protected_node_email_body(), + 'group' => 'protected_node', + ); + $variables['protected_node_random_password'] = array( + 'type' => 'boolean', + 'title' => t('Generate a random password if necessary', array(), $options), + 'description' => t('When this flag is set, saving a protected node without re-entering the password will randomize a password and send it to your users. You may enter your email address to know about the password yourself. (It otherwise gets encrypted in the database.)', array(), $options), + 'default' => FALSE, + 'group' => 'protected_node', + ); + + // Protected node form. + $variables['protected_node_cancel'] = array( + 'type' => 'boolean', + 'title' => t('Always add a cancel link', array(), $options), + 'description' => t('Whether a cancel link should be added to the password form. If checked and we do not have a back link, then the cancel is set to <front> instead.', array(), $options), + 'default' => FALSE, + 'group' => 'protected_node', + ); + $variables['protected_node_title'] = array( + 'type' => 'string', + 'title' => t('Password page title', array(), $options), + 'description' => t('Enter the title of the protected node page. No HTML allowed. You can use node type tokens from the token module when installed.', array(), $options), + 'default' => t('Protected page -- Enter password', array(), $options), + 'group' => 'protected_node', + ); + $variables['protected_node_info'] = array( + 'type' => 'text', + 'title' => t('Password page general information', array(), $options), + 'description' => t('Enter general information for the protected node page. HTML is accepted. You can use node type tokens from the token module when installed.', array(), $options), + 'default' => '', + 'group' => 'protected_node', + ); + $variables['protected_node_description'] = array( + 'type' => 'text', + 'title' => t('Password page description (inside the field set with the password form)', array(), $options), + 'description' => t('Enter custom description for the protected node page. This description is displayed inside the fieldset with the password form. HTML is accepted. You can use node type tokens from the token module when installed.', array(), $options), + 'default' => '', + 'group' => 'protected_node', + ); + $variables['protected_node_password_label'] = array( + 'type' => 'string', + 'title' => t('Password field label on password page', array(), $options), + 'description' => t('Enter the text for the password label appearing on the password page. The default (when empty) is the node type name followed by the word "password". You can use tokens from the token module when installed.', array(), $options), + 'default' => '', + 'group' => 'protected_node', + ); + + // Flood control. + $variables['protected_node_failed_password_ip_limit'] = array( + 'type' => 'select_number', + 'title' => t('Failed password (IP) limit', array(), $options), + 'description' => t('Defines the number of attempts a user has during a limited time window.', array(), $options), + 'option callback' => _protected_node_get_failed_password_ip_limit_options(), + 'default' => 50, + 'group' => 'protected_node', + ); + $variables['protected_node_failed_password_ip_window'] = array( + 'type' => 'select_number', + 'title' => t('Failed password (IP) window', array(), $options), + 'description' => t('Defines the time window during while the user has a limited number of possible attempts.', array(), $options), + 'option callback' => _protected_node_get_failed_password_ip_window_options(), + 'default' => 3600, + 'group' => 'protected_node', + ); + + // View modes. + $node_info = entity_get_info('node'); + $view_modes = array(); + foreach ($node_info['view modes'] as $id => $item) { + $view_modes[$id] = $item['label']; + } + asort($view_modes); + + $variables['protected_node_checked_view_modes'] = array( + 'type' => 'select', + 'title' => t('Enabled view modes', array(), $options), + 'description' => t('Only check passwords for nodes that are rendered with the selected view modes.', array(), $options), + 'option' => $view_modes, + 'default callback' => _protected_node_get_default_checked_view_modes(), + 'group' => 'protected_node', + ); + + // Node type variables. + $variables['protected_node_protection_[node_type]'] = array( + 'type' => 'multiple', + 'title' => t('Protected mode for nodes of this type', array(), $options), + 'description' => t('Select the protection mode for nodes of this type:', array(), $options), + 'repeat' => array( + 'type' => 'enable', + 'options' => array( + PROTECTED_NODE_PROTECTION_NEVER => t('Never protected', array(), $options), + PROTECTED_NODE_PROTECTION_PROTECTABLE => t('Protectable (default is unprotected)', array(), $options), + PROTECTED_NODE_PROTECTION_PROTECTED => t('Protectable (default is protected)', array(), $options), + PROTECTED_NODE_PROTECTION_ALWAYS => t('Always protected', array(), $options), + ), + 'default' => PROTECTED_NODE_PROTECTION_PROTECTABLE, + ), + 'group' => 'protected_node', + ); + $variables['protected_node_fieldset_[node_type]'] = array( + 'type' => 'multiple', + 'title' => t('How to show the protected node fieldset', array(), $options), + 'description' => t('Select whether the "Protected node" field set should be opened or closed when editing a node.', array(), $options), + 'repeat' => array( + 'type' => 'enable', + 'options' => array( + PROTECTED_NODE_FIELDSET_OPEN => t('Always open', array(), $options), + PROTECTED_NODE_FIELDSET_SMART => t('Smart mode (Open when protected)', array(), $options), + PROTECTED_NODE_FIELDSET_CLOSE => t('Always closed', array(), $options), + ), + 'default' => PROTECTED_NODE_FIELDSET_SMART, + ), + 'group' => 'protected_node', + ); + $variables['protected_node_description_[node_type]'] = array( + 'type' => 'multiple', + 'title' => t('Password page description (inside the field set with the password form)', array(), $options), + 'description' => t('Enter custom description for the protected node page of this content type to override the global setting. This description is displayed inside the fieldset with the password form. HTML is accepted. You can use node type tokens from the token module when installed.', array(), $options), + 'repeat' => array( + 'type' => 'text', + 'default' => '', + ), + 'group' => 'protected_node', + ); + + return $variables; +} -- 2.1.4