function protected_node_admin_settings in Protected Node 6
Same name and namespace in other branches
- 5 protected_node.module \protected_node_admin_settings()
- 7 protected_node.settings.inc \protected_node_admin_settings()
- 1.0.x protected_node.settings.inc \protected_node_admin_settings()
Define the settings form
Return value
$form The settings form
1 string reference to 'protected_node_admin_settings'
- protected_node_menu_array in ./
protected_node.settings.inc - Actual implementation of the protected_node_menu() function.
File
- ./
protected_node.settings.inc, line 238 - Configuration file for the protected_node module.
Code
function protected_node_admin_settings() {
// statistics
$form['protected_node_stats'] = array(
'#type' => 'fieldset',
'#title' => t('Protected node statistics'),
'#collapsible' => TRUE,
);
$sql = "SELECT COUNT(n.nid) FROM {node} n LEFT JOIN {protected_nodes} pn ON pn.nid = n.nid WHERE pn.protected_node_is_protected = 0 OR pn.protected_node_is_protected IS NULL";
$unprotected_count = db_result(db_query($sql));
$sql = "SELECT COUNT(nid) FROM {protected_nodes} WHERE protected_node_is_protected = 1";
$protected_count = db_result(db_query($sql));
$sql = "SELECT COUNT(nid) FROM {protected_nodes} WHERE protected_node_is_protected = 1 AND protected_node_show_title = 1";
$title_count = db_result(db_query($sql));
$sql = "SELECT COUNT(nid) FROM {protected_nodes} WHERE protected_node_is_protected = 1 AND protected_node_passwd = ''";
$global_count = db_result(db_query($sql));
// any nodes?
if ($protected_count + $unprotected_count > 0) {
$stats = '<table><tr><th style="text-align: center;">Label</th><th style="text-align: center;">Count</th><th style="text-align: center;">Percent</th></tr>' . '<tr><td>Total nodes</td><td align="right">' . ($protected_count + $unprotected_count) . '</td><td align="right">100%</td></tr>' . '<tr><td>Unprotected nodes</td><td align="right">' . $unprotected_count . '</td><td align="right">' . round($unprotected_count * 100 / ($unprotected_count + $protected_count), 2) . '%</td></tr>' . '<tr><td>Protected nodes</td><td align="right">' . $protected_count . '</td><td align="right">' . round($protected_count * 100 / ($unprotected_count + $protected_count), 2) . '%</td></tr>';
// any protected nodes?
if ($protected_count > 0) {
$stats .= '<tr><td>» Showing title</td><td align="right">' . $title_count . '</td><td align="right">' . round($title_count * 100 / $protected_count, 2) . '%</td></tr>' . '<tr><td>» Hiding title</td><td align="right">' . ($protected_count - $title_count) . '</td><td align="right">' . round(($protected_count - $title_count) * 100 / $protected_count, 2) . '%</td></tr>' . '<tr><td>» Global passwords</td><td align="right">' . $global_count . '</td><td align="right">' . round($global_count * 100 / $protected_count, 2) . '%</td></tr>' . '<tr><td>» Node passwords</td><td align="right">' . ($protected_count - $global_count) . '</td><td align="right">' . round(($protected_count - $global_count) * 100 / $protected_count, 2) . '%</td></tr>';
}
$stats .= '</table>';
$form['protected_node_stats']['protected_node_statistics'] = array(
'#value' => $stats,
);
}
// security related options
$form['protected_node_security'] = array(
'#type' => 'fieldset',
'#title' => t('Protected node security'),
'#collapsible' => TRUE,
);
$form['protected_node_security']['protected_node_use_global_password'] = array(
'#type' => 'select',
'#title' => t('Global password handling'),
'#default_value' => variable_get('protected_node_use_global_password', PROTECTED_NODE_PER_NODE_PASSWORD),
'#options' => array(
PROTECTED_NODE_PER_NODE_PASSWORD => 'Per node password',
PROTECTED_NODE_PER_NODE_AND_GLOBAL_PASSWORD => 'Per node password or Global password',
PROTECTED_NODE_GLOBAL_PASSWORD => 'Global password only',
),
'#description' => t('When checked, the global password is used if the user doesn\'t enter a password when creating/editing nodes.') . t('<strong>WARNING:</strong> 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.'),
);
$form['protected_node_security']['protected_node_global_password_field'] = array(
'#type' => 'password_confirm',
'#title' => t('Global password'),
//'#default_value' => variable_get('protected_node_global_password', ''),
'#description' => t('The default password for all nodes. This password is necessary if you select "Global password only" in the prior dropdown box.'),
);
// yeah... we're calling a Core "private" function...
_user_password_dynamic_validation();
$form['protected_node_security']['protected_node_show_password_strength'] = array(
'#type' => 'checkbox',
'#title' => t('Show password strength in nodes'),
'#default_value' => variable_get('protected_node_show_password_strength', TRUE),
'#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.'),
);
$form['protected_node_security']['protected_node_show_node_titles'] = array(
'#type' => 'checkbox',
'#title' => t('Show node titles by default'),
'#default_value' => variable_get('protected_node_show_node_titles', FALSE),
'#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.'),
);
$form['protected_node_security']['protected_node_allow_hint'] = array(
'#type' => 'checkbox',
'#title' => t('Allow author to enter a password hint'),
'#default_value' => variable_get('protected_node_allow_hint', FALSE),
'#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.'),
);
$form['protected_node_auto_email'] = array(
'#type' => 'fieldset',
'#title' => t('Protected node email support'),
'#description' => t('The following allows the users who can protect a node to send an email about the protected node to their friends.'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['protected_node_auto_email']['protected_node_email_box'] = array(
'#type' => 'textfield',
'#title' => t('Email node information'),
'#size' => 12,
'#default_value' => variable_get('protected_node_email_box', ''),
'#description' => t('Enter the width x height of the email box text area (i.e. 60x5). Leave empty to disable this feature.'),
);
$form['protected_node_auto_email']['protected_node_email_from'] = array(
'#type' => 'textfield',
'#title' => t('From email address'),
'#default_value' => variable_get('protected_node_email_from', ''),
'#description' => t('Enter the email address used in the From: header. By default, [site-mail] is used (@mail)', array(
'@mail' => variable_get('site_mail', '<undefined>'),
)),
);
$form['protected_node_auto_email']['protected_node_email_subject'] = array(
'#type' => 'textfield',
'#title' => t('Email subject'),
'#default_value' => variable_get('protected_node_email_subject', protected_node_email_subject()),
'#description' => t('Enter the subject of the email. You may enter tokens in this field. Remember that [user-name] will be the author name.'),
);
$form['protected_node_auto_email']['protected_node_email_body'] = array(
'#type' => 'textarea',
'#title' => t('Email content'),
'#rows' => 15,
'#default_value' => variable_get('protected_node_email_body', protected_node_email_body()),
'#description' => t('Enter the body of the email. You may enter tokens in this field. Remember that [user-name] will be the author name.'),
);
$form['protected_node_auto_email']['protected_node_random_password'] = array(
'#type' => 'checkbox',
'#title' => t('Generate a random password if necessary'),
'#default_value' => variable_get('protected_node_random_password', FALSE),
'#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.)'),
);
$form['protected_node_form'] = array(
'#type' => 'fieldset',
'#title' => t('Protected node form'),
'#collapsible' => TRUE,
);
$form['protected_node_form']['protected_node_cancel'] = array(
'#type' => 'checkbox',
'#title' => t('Always add a cancel link'),
'#default_value' => variable_get('protected_node_cancel', 0),
'#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.'),
);
$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'),
'#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.'),
);
$form['protected_node_form']['protected_node_info'] = array(
'#type' => 'textarea',
'#title' => t('Password page general information'),
'#default_value' => variable_get('protected_node_info', ''),
'#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.'),
);
$form['protected_node_form']['protected_node_description'] = array(
'#type' => 'textarea',
'#title' => t('Password page description (inside the field set)'),
'#default_value' => variable_get('protected_node_description', ''),
'#description' => t('Enter specific description for the protected node page. This description is displayed inside the fieldset. HTML is accepted. You can use node type tokens from the token module when installed.'),
);
$form['protected_node_form']['protected_node_password_label'] = array(
'#type' => 'textfield',
'#title' => t('Password field label on password page'),
'#default_value' => variable_get('protected_node_password_label', ''),
'#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.'),
);
if (module_exists('token')) {
$form['protected_node_form']['protected_node_tokens'] = array(
'#value' => theme('token_tree', array(
'global',
'node',
'user',
)),
'#description' => t('WARNING: the user tokens should only be used if anonymous users cannot access protected nodes; otherwise the result may not be what you\'d expect.'),
);
}
// a few actions to do some "mass work"
$form['protected_node_actions'] = array(
'#type' => 'fieldset',
'#title' => t('Protected node actions'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
// Clear Sessions button
$form['protected_node_actions']['protected_node_clear_sessions'] = array(
'#type' => 'fieldset',
'#title' => t('Clear sessions'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('Click on this button to reset all the Protected Node password sessions of your website. This means all the users who entered a password before then will now have to log back in to see such and such node.'),
);
$form['protected_node_actions']['protected_node_clear_sessions']['protected_node_clear_sessions_button'] = array(
'#type' => 'submit',
'#value' => t('Clear sessions'),
'#submit' => array(
'protected_node_action_clear_sessions',
),
);
// Reset passwords button
$form['protected_node_actions']['protected_node_reset_passwords'] = array(
'#type' => 'fieldset',
'#title' => t('Reset passwords'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('WARNING: this feature sets a password on nodes that were otherwise expected to use the global password.'),
);
$form['protected_node_actions']['protected_node_reset_passwords']['protected_node_reset_passwords_password'] = array(
'#type' => 'password_confirm',
'#title' => t('New Protected Nodes password'),
'#description' => t('Enter the new password that all existing protected nodes will be assigned.'),
);
$form['protected_node_actions']['protected_node_reset_passwords']['protected_node_reset_passwords_button'] = array(
'#type' => 'submit',
'#value' => t('Reset all existing passwords'),
'#submit' => array(
'protected_node_action_reset_passwords',
),
);
// Remove passwords button
$form['protected_node_actions']['protected_node_remove_passwords'] = array(
'#type' => 'fieldset',
'#title' => t('Use global password'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => '<span style="color: red;">' . t('WARNING: this function resets all your nodes password and make sure the global password is now required for all of them.') . '</span>',
);
$form['protected_node_actions']['protected_node_remove_passwords']['protected_node_remove_passwords_button'] = array(
'#type' => 'submit',
'#value' => t('Use global password on ALL nodes'),
'#submit' => array(
'protected_node_action_remove_passwords',
),
);
// Remove protection button
$form['protected_node_actions']['protected_node_remove_protection'] = array(
'#type' => 'fieldset',
'#title' => t('Remove protection'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => '<span style="color: red;">' . t('WARNING: this function unprotects all your currently protected nodes!!! The password is not modified.') . '</span>',
);
$form['protected_node_actions']['protected_node_remove_protection']['protected_node_remove_protection_button'] = array(
'#type' => 'submit',
'#value' => t('Remove password protection from all nodes'),
'#submit' => array(
'protected_node_action_unprotected_all',
),
);
// Protect ALL nodes buttons
$form['protected_node_actions']['protected_node_protect_nodes'] = array(
'#type' => 'fieldset',
'#title' => t('Protect nodes'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('WARNING: this function protects ALL your nodes making them accessible only when the password is known. Nodes that do not yet have a password will make use of the global password. You may use the Reset password feature to change that password afterward.'),
);
$form['protected_node_actions']['protected_node_protect_nodes']['protected_node_protect_all_nodes_button'] = array(
'#type' => 'submit',
'#value' => t('Protect ALL nodes'),
'#submit' => array(
'protected_node_action_protect_all_nodes',
),
);
// Re-protect nodes buttons
$form['protected_node_actions']['protected_node_protect_password'] = array(
'#type' => 'fieldset',
'#title' => t('Restore protection'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('WARNING: this function re-protects the nodes that had a password and got unprotected.'),
);
$form['protected_node_actions']['protected_node_protect_password']['protected_node_protect_nodes_with_password_button'] = array(
'#type' => 'submit',
'#value' => t('Protect nodes that already have a password'),
'#submit' => array(
'protected_node_action_protect_nodes_with_password',
),
);
$form['#validate'][] = '_protected_node_admin_settings_validate';
$form['#submit'][] = '_protected_node_admin_settings_submit';
return system_settings_form($form);
}