$validating_id,
':created' => $purge_time,
));
$purged_users = array();
// Delete the users from the system.
foreach ($accounts as $account) {
user_cancel(array(), $account->uid, 'user_cancel_delete');
$purged_users[] = check_plain($account->name);
}
// Log the purged users.
if (!empty($purged_users)) {
batch_process(drupal_get_destination());
watchdog('logintoboggan', 'Purged the following unvalidated users: !purged_users', array('!purged_users' => theme('item_list', array('items' => $purged_users))));
}
}
}
}
/**
* Implement hook_help().
*/
function logintoboggan_help($path, $arg) {
switch ($path) {
case 'admin/help#logintoboggan':
$output = t("The Login Toboggan module improves the Drupal login system by offering the following features:
- Allow users to login using either their username OR their e-mail address.
- Allow users to login immediately.
- Provide a login form on Access Denied pages for non-logged-in (anonymous) users.
- The module provides two login block options: One uses JavaScript to display the form within the block immediately upon clicking 'log in'. The other brings the user to a separate page, but returns the user to their original page upon login.
- Customize the registration form with two e-mail fields to ensure accuracy.
- Optionally redirect the user to a specific page when using the 'Immediate login' feature.
- Optionally redirect the user to a specific page upon validation of their e-mail address.
- Optionally display a user message indicating a successful login.
- Optionally have unvalidated users purged from the system at a pre-defined interval (please read the CAVEATS section of INSTALL.txt for important information on configuring this feature!).
These features may be turned on or off in the Login Toboggan settings.
Because this module completely reorients the Drupal login process you will probably want to edit the welcome e-mail on the user settings page. For instance if you have enabled the 'Set password' option, you probably should not send the user's password out in the welcome e-mail (also note when the 'Set password' option is enabled, the !login_url becomes a verification url that the user MUST visit in order to enable authenticated status). The following is an example welcome e-mail:
", array('!url' => url('admin/config/system/logintoboggan'), '!user_settings' => url('admin/config/people/accounts')));
$output .= drupal_render(drupal_get_form('logintoboggan_example_help'));
$output .= t("Note that if you have set the 'Visitors can create accounts but administrator approval is required' option for account approval, and are also using the 'Set password' feature of LoginToboggan, the user will immediately receive the permissions of the pre-authorized user role -- you may wish to create a pre-authorized role with the exact same permissions as the anonymous user if you wish the newly created user to only have anonymous permissions.
In order for a site administrator to unblock a user who is awaiting administrator approval, they must either click on the validation link they receive in their notification e-mail, or manually remove the user from the site's pre-authorized role -- afterwards the user will then receive 'authenticated user' permissions. In either case, the user will receive an account activated e-mail if it's enabled on the user settings page -- it's recommended that you edit the default text of the activation e-mail to match LoginToboggan's workflow as described.
If you are using the 'Visitors can create accounts and no administrator approval is required' option, removal of the pre-authorized role will happen automatically when the user validates their account via e-mail.
Also be aware that LoginToboggan only affects registrations initiated by users--any user account created by an administrator will not use any LoginToboggan functionality.");
return $output;
break;
case 'admin/config/system/logintoboggan':
if (module_exists('help')) {
$help_text = t("More help can be found at LoginToboggan help.", array('!help' => url('admin/help/logintoboggan')));
}
else {
$help_text = '';
}
$output = t("
Customize your login and registration system. $help_text
");
return $output;
}
}
/**
* Helper function for example user e-mail textfield.
*/
function logintoboggan_example_help() {
$example = t('
[user:name],
Thank you for registering.
IMPORTANT:
For full site access, you will need to click on this link or copy and paste it in your browser:
[logintoboggan-validation:url]
This will verify your account and log you into the site. In the future you will be able to log in to [site:login-url] using the username and password that you created during registration.
');
$form['foo'] = array(
'#type' => 'textarea',
'#default_value' => $example,
'#rows' => 15,
);
return $form;
}
/**
* Implement hook_form_block_admin_configure_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_block_admin_configure_alter(&$form, &$form_state) {
if (($form['module']['#value'] == 'user') && ($form['delta']['#value'] == 'login')) {
$form['#submit'][] = 'logintoboggan_user_block_admin_configure_submit';
$form['block_settings']['title']['#description'] .= ''. t('Note: Logintoboggan module is installed. If you are using one of the custom login block types below, it is recommended that you set this to <none>.') .'
';
$form['block_settings']['logintoboggan_login_block_type'] = array(
'#type' => 'radios',
'#title' => t('Block type'),
'#default_value' => variable_get('logintoboggan_login_block_type', 0),
'#options' => array(t('Standard'), t('Link'), t('Collapsible form')),
'#description' => t("'Standard' is a standard login block, 'Link' is a login link that returns the user to the original page after logging in, 'Collapsible form' is a javascript collaspible login form."),
);
$form['block_settings']['logintoboggan_login_block_message'] = array(
'#type' => 'textarea',
'#title' => t('Set a custom message to appear at the top of the login block'),
'#default_value' => variable_get('logintoboggan_login_block_message', ''),
);
}
}
/**
* Implement hook_form_logintoboggan_main_settings_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_logintoboggan_main_settings_alter(&$form, &$form_state) {
// Ensure a valid submit array.
$form['#submit'] = is_array($form['#submit']) ? $form['#submit'] : array();
// Make this submit handler run first.
array_unshift($form['#submit'], 'logintoboggan_main_settings_submit');
}
/**
* Implement hook_form_user_profile_form_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_user_profile_form_alter(&$form, &$form_state) {
global $user;
if ($form['#user_category'] == 'account') {
$account = $form['#user'];
$form['#validate'][] = 'logintoboggan_user_edit_validate';
// User is editing their own account settings, or user admin
// is editing their account.
if ($user->uid == $account->uid || user_access('administer users')) {
// Display link to re-send validation e-mail.
// Re-validate link appears if:
// 1. Users can create their own password.
// 2. User is still in the validating role.
// 3. Users can create accounts without admin approval.
// 4. The validating role is not the authorized user role.
$validating_id = logintoboggan_validating_id();
if (!variable_get('user_email_verification', TRUE) && array_key_exists($validating_id, $account->roles) && (variable_get('user_register', 1) == 1) && ($validating_id > DRUPAL_AUTHENTICATED_RID)) {
$form['revalidate'] = array(
'#type' => 'fieldset',
'#title' => t('Account validation'),
'#weight' => -10,
);
$form['revalidate']['revalidate_link'] = array(
'#markup' => l(t('re-send validation e-mail'), 'toboggan/revalidate/'. $account->uid),
);
}
}
$id = logintoboggan_validating_id();
$in_pre_auth_role = in_array($id, array_keys($account->roles));
// Messages are only necessary for user admins, and aren't necessary if
// pre-auth role is authenticated user.
if (user_access('administer users') && isset($form['account']['roles']) && $id != DRUPAL_AUTHENTICATED_RID) {
// User is still in the pre-auth role, so let the admin know.
if ($in_pre_auth_role) {
// This form element is necessary as a placeholder for the user's
// pre-auth setting on form load. It's used to compare against the
// submitted form values to see if the pre-auth role has been unchecked.
$form['logintoboggan_pre_auth_check'] = array(
'#type' => 'hidden',
'#value' => '1',
);
if ((variable_get('user_register', 1) == 2)) {
$form['account']['status']['#description'] = t('If this user was created using the "Immediate Login" feature of LoginToboggan, and they are also awaiting adminstrator approval on their account, you must remove them from the site\'s pre-authorized role in the "Roles" section below, or they will not receive authenticated user permissions!');
}
$form['account']['roles']['#description'] = t("The user is assigned LoginToboggan's pre-authorized role, and is not currently receiving authenticated user permissions.");
}
// User is no longer in the pre-auth role, so remove the option to add
// them back.
else {
unset($form['account']['roles']['#options'][$id]);
}
}
}
}
/**
* Implement hook_form_user_register_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_user_register_form_alter(&$form, &$form_state) {
// Admin created accounts are only validated by the module.
if (user_access('administer users')) {
$form['#validate'][] = 'logintoboggan_user_register_validate';
break;
}
$mail = variable_get('logintoboggan_confirm_email_at_registration', 0);
$pass = !variable_get('user_email_verification', TRUE);
// Ensure a valid submit array.
$form['#submit'] = is_array($form['#submit']) ? $form['#submit'] : array();
// Replace core's registration function with LT's registration function.
// Put the LT submit handler first, so other submit handlers have a valid
// user to work with upon registration.
$key = array_search('user_register_submit', $form['#submit']);
if ($key !== FALSE) {
unset($form['#submit'][$key]);
}
array_unshift($form['#submit'],'logintoboggan_user_register_submit');
if ($mail || $pass) {
$form['#validate'][] = 'logintoboggan_user_register_validate';
//Display a confirm e-mail address box if option is enabled.
if ($mail) {
$form['conf_mail'] = array('#type' => 'textfield',
'#title' => t('Confirm e-mail address'),
'#weight' => -28,
'#maxlength' => 64,
'#description' => t('Please re-type your e-mail address to confirm it is accurate.'),
'#required' => TRUE,
);
// Weight things properly so that the order is name, mail, conf_mail, then pass
if (isset($form['account'])) {
$form['account']['#weight'] = -50; // Make sure account form group is at the top of the display.
$form['account']['name']['#weight'] = -30;
$form['account']['mail']['#weight'] = -29;
$form['account']['conf_mail'] = $form['conf_mail'];
unset($form['conf_mail']);
$form['account']['conf_mail']['#weight'] = -28;
}
else {
$form['name']['#weight'] = -30;
$form['mail']['#weight'] = -29;
}
}
if ($pass) {
$min_pass = variable_get('logintoboggan_minimum_password_length', 0);
$length = $min_pass ? t('between !min and', array('!min' => $min_pass)) : t('no more than');
$pass_description = t('Please choose a password for your account; it must be !length 30 characters.', array('!length' => $length));
if (isset($form['account'])) {
$form['account']['pass']['#description'] = $pass_description;
}
else {
$form['pass']['#description'] = $pass_description;
}
}
}
}
/**
* Implement hook_form_user_admin_account_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_user_admin_account_alter(&$form, &$form_state) {
// Unset the ability to add the pre-auth role in the user admin interface.
$id = logintoboggan_validating_id();
$add = t('Add a role to the selected users');
if ($id != DRUPAL_AUTHENTICATED_RID && isset($form['options']['operation']['#options'][$add]["add_role-$id"])) {
unset($form['options']['operation']['#options'][$add]["add_role-$id"]);
}
}
/**
* Implement hook_form_user_pass_reset_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_user_pass_reset_alter(&$form, &$form_state) {
// Password resets count as validating an email address, so remove the user
// from the pre-auth role if they are still in it. We only want to run this
// code when the user first hits the reset login form.
if (arg(5) != 'login' && ($uid = (int) arg(2))) {
if ($account = user_load($uid)) {
$id = logintoboggan_validating_id();
$in_pre_auth_role = in_array($id, array_keys($account->roles));
if ($in_pre_auth_role) {
_logintoboggan_process_validation($account);
drupal_set_message(t('You have successfully validated your e-mail address.'));
}
}
}
}
/**
* Implement hook_form_user_admin_permissions_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_user_admin_permissions_alter(&$form, &$form_state) {
// If the pre-auth role isn't the auth user, then add it as a setting.
$id = logintoboggan_validating_id();
if ($id != DRUPAL_AUTHENTICATED_RID) {
drupal_add_js(array(
'LoginToboggan' => array(
'preAuthID' => $id,
),
), 'setting');
}
}
/**
* Implement hook_form_alter().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_form_alter(&$form, &$form_state, $form_id) {
switch ($form_id) {
case 'user_login':
case 'user_login_block':
// Grab the message from settings for display at the top of the login block.
if ($login_msg = variable_get('logintoboggan_login_block_message', '')) {
$form['message'] = array(
'#markup' => filter_xss_admin($login_msg),
'#weight' => -50,
);
}
$form['name']['#attributes']['tabindex'] = '1';
$form['pass']['#attributes']['tabindex'] = '2';
$form['submit']['#attributes']['tabindex'] = '3';
if (variable_get('logintoboggan_login_with_email', 0)) {
// Ensure a valid validate array.
$form['#validate'] = is_array($form['#validate']) ? $form['#validate'] : array();
// LT's validation function must run first.
array_unshift($form['#validate'],'logintoboggan_user_login_validate');
// Use theme functions to print the username field's textual labels.
$form['name']['#title'] = theme('lt_username_title', array('form_id' => $form_id));
$form['name']['#description'] = theme('lt_username_description', array('form_id' => $form_id));
// Use theme functions to print the password field's textual labels.
$form['pass']['#title'] = theme('lt_password_title', array('form_id' => $form_id));
$form['pass']['#description'] = theme('lt_password_description', array('form_id' => $form_id));
}
if (($form_id == 'user_login_block')) {
$block_type = variable_get('logintoboggan_login_block_type', 0);
if ($block_type == 1) {
// What would really be nice here is to start with a clean form, but
// we can't really do that, because drupal_prepare_form() has already
// been run, and we can't run it again in the _alter() hook, or we'll
// get into and endless loop. Since we don't know exactly what's in
// the form, strip out all regular form elements and the handlers.
foreach (element_children($form) as $element) {
unset($form[$element]);
}
unset($form['#validate'], $form['#submit']);
$form['logintoboggan_login_link'] = array(
'#markup' => l(theme('lt_login_link'), 'user/login', array('query' => drupal_get_destination())),
);
}
elseif ($block_type == 2) {
$form = _logintoboggan_toggleboggan($form);
}
}
break;
}
}
/**
* Implement hook_js_alter().
*/
function logintoboggan_js_alter(&$javascript) {
// Look for the user permissions js.
if (isset($javascript['modules/user/user.permissions.js'])) {
$id = logintoboggan_validating_id();
// If the pre-auth user isn't the auth user, then swap out core's user
// permissions js with LT's custom implementation. This is necessary to
// prevent the pre-auth role's checkboxes from being automatically disabled
// when the auth user's checkboxes are checked.
if ($id != DRUPAL_AUTHENTICATED_RID) {
$javascript['modules/user/user.permissions.js']['data'] = drupal_get_path('module', 'logintoboggan') . '/logintoboggan.permissions.js';
}
}
}
/**
* Implement hook_page_alter().
*/
function logintoboggan_page_alter(&$page) {
// Remove blocks on access denied pages.
if (isset($page['#logintoboggan_denied'])) {
drupal_set_message(t('Access denied. You may need to login below or register to access this page.'), 'error');
unset($page['sidebar_first'], $page['sidebar_second']);
}
}
/**
* Implement hook_token_info().
*/
function logintoboggan_token_info() {
$types['logintoboggan-validation'] = array(
'name' => t('User validation'),
'description' => t('Tokens related to validating user accounts.'),
'needs-data' => 'user',
);
$user['url'] = array(
'name' => t('Validating URL'),
'description' => t("A special URL the user can use to validate their account."),
);
return array(
'types' => array('logintoboggan' => $types),
'tokens' => array('logintoboggan' => $user),
);
}
/**
* Implement hook_tokens().
*/
function logintoboggan_tokens($type, $tokens, array $data = array(), array $options = array()) {
$url_options = array('absolute' => TRUE);
if (isset($options['language'])) {
$url_options['language'] = $options['language'];
$language_code = $options['language']->language;
}
else {
$language_code = NULL;
}
$sanitize = !empty($options['sanitize']);
$replacements = array();
if ($type == 'logintoboggan-validation' && !empty($data['user'])) {
$account = $data['user'];
foreach ($tokens as $name => $original) {
switch ($name) {
// Validating URL.
case 'url':
$replacements[$original] = variable_get('user_register', 1) == 1 ? logintoboggan_eml_validate_url($account, $url_options) : NULL;
break;
}
}
}
return $replacements;
}
/**
* Custom submit function for user registration form
*
* @ingroup logintoboggan_form
*/
function logintoboggan_user_register_submit($form, &$form_state) {
$reg_pass_set = !variable_get('user_email_verification', TRUE);
// Test here for a valid pre-auth -- if the pre-auth is set to the auth user, we
// handle things a bit differently.
$pre_auth = logintoboggan_validating_id() != DRUPAL_AUTHENTICATED_RID;
// If we are allowing user selected passwords then skip the auto-generate function
// The new user's status should default to the site settings, unless reg_passwd_set == 1
// (immediate login, we are going to assign a pre-auth role), and we want to allow
// admin approval accounts access to the site.
if ($reg_pass_set) {
$pass = $form_state['values']['pass'];
$status = 1;
}
else {
$pass = user_password();
$status = variable_get('user_register', 1) == 1;
}
// The unset below is needed to prevent these form values from being saved as
// user data.
form_state_values_clean($form_state);
// Must unset mail confirmation to prevent it from being saved in the user table's 'data' field.
if (isset($form_state['values']['conf_mail'])) {
unset($form_state['values']['conf_mail']);
}
// Set the roles for the new user -- add the pre-auth role if they can pick their own password,
// and the pre-auth role isn't anon or auth user.
$validating_id = logintoboggan_validating_id();
$roles = isset($form_state['values']['roles']) ? array_filter($form_state['values']['roles']) : array();
if ($reg_pass_set && ($validating_id > DRUPAL_AUTHENTICATED_RID)) {
$roles[$validating_id] = 1;
}
$form_state['values']['pass'] = $pass;
$form_state['values']['init'] = $form_state['values']['mail'];
$form_state['values']['roles'] = $roles;
$form_state['values']['status'] = $status;
$account = $form['#user'];
$account = user_save($account, $form_state['values']);
// Terminate if an error occurred during user_save().
if (!$account) {
drupal_set_message(t("Error saving user account."), 'error');
$form_state['redirect'] = '';
return;
}
$form_state['user'] = $account;
watchdog('user', 'New user: %name (%email).', array('%name' => $form_state['values']['name'], '%email' => $form_state['values']['mail']), WATCHDOG_NOTICE, l(t('edit'), 'user/' . $account->uid . '/edit'));
// Add plain text password into user account to generate mail tokens.
$account->password = $pass;
// Compose the appropriate user message--admin approvals don't require a validation email.
if($reg_pass_set && variable_get('user_register', 1) == 1) {
if ($pre_auth) {
$message = t('A validation e-mail has been sent to your e-mail address. In order to gain full access to the site, you will need to follow the instructions in that message.');
}
else {
$message = t('Further instructions have been sent to your e-mail address.');
}
} else {
$message = t('Your password and further instructions have been sent to your e-mail address.');
}
if (variable_get('user_register', 1) == 1) {
// Create new user account, no administrator approval required.
$mailkey = 'register_no_approval_required';
} elseif (variable_get('user_register', 1) == 2) {
// Create new user account, administrator approval required.
$mailkey = 'register_pending_approval';
$message = t('Thank you for applying for an account. Your account is currently pending approval by the site administrator.
Once it has been approved, you will receive an e-mail containing further instructions.');
}
// Mail the user.
_user_mail_notify($mailkey, $account);
drupal_set_message($message);
// where do we need to redirect after registration?
$redirect = _logintoboggan_process_redirect(variable_get('logintoboggan_redirect_on_register', ''), $account);
// Log the user in if they created the account and immediate login is enabled.
if($reg_pass_set && variable_get('logintoboggan_immediate_login_on_register', TRUE)) {
$form_state['redirect'] = logintoboggan_process_login($account, $form_state['values'], $redirect);
}
else {
// Redirect to the appropriate page.
$form_state['redirect'] = $redirect;
}
}
/**
* Custom validation for user login form
*
* @ingroup logintoboggan_form
*/
function logintoboggan_user_login_validate($form, &$form_state) {
if (isset($form_state['values']['name']) && $form_state['values']['name']) {
if ($name = db_query("SELECT name FROM {users} WHERE LOWER(mail) = LOWER(:name)", array(
':name' => $form_state['values']['name'],
))->fetchField()) {
form_set_value($form['name'], $name, $form_state);
}
}
}
/**
* Custom validation function for user registration form
*
* @ingroup logintoboggan_form
*/
function logintoboggan_user_register_validate($form, &$form_state) {
//Check to see whether our e-mail address matches the confirm address if enabled.
if (variable_get('logintoboggan_confirm_email_at_registration', 0) && isset($form_state['values']['conf_mail'])) {
if ($form_state['values']['mail'] != $form_state['values']['conf_mail']) {
form_set_error('conf_mail', t('Your e-mail address and confirmed e-mail address must match.'));
}
}
//Do some password validation if password selection is enabled.
if (!variable_get('user_email_verification', TRUE)) {
$pass_err = logintoboggan_validate_pass($form_state['values']['pass']);
if ($pass_err) {
form_set_error('pass', $pass_err);
}
}
}
/**
* Custom validation function for user edit form
*
* @ingroup logintoboggan_form
*/
function logintoboggan_user_edit_validate($form, &$form_state) {
$account = $form['#user'];
$edit = $form_state['values'];
// If login with mail is enabled...
if (variable_get('logintoboggan_login_with_email', 0)) {
$uid = isset($account->uid) ? $account->uid : 0;
// Check that no user is using this name for their email address.
if (isset($edit['name']) && db_query("SELECT uid FROM {users} WHERE LOWER(mail) = LOWER(:mail) AND uid <> :uid", array(
':mail' => $edit['name'],
':uid' => $uid,
))->fetchField()) {
form_set_error('name', t('This name has already been taken by another user.'));
}
// Check that no user is using this email address for their name.
if (isset($edit['mail']) && db_query("SELECT uid FROM {users} WHERE LOWER(name) = LOWER(:name) AND uid <> :uid", array(
':name' => $edit['mail'],
':uid' => $uid,
))->fetchField()) {
form_set_error('mail', t('This e-mail has already been taken by another user.'));
}
}
if (strlen($edit['pass'])) {
// if we're changing the password, validate it
$pass_err = logintoboggan_validate_pass($edit['pass']);
if ($pass_err) {
form_set_error('pass', $pass_err);
}
}
}
/**
* Implement hook_init()
*
* @ingroup logintoboggan_core
*/
function logintoboggan_init() {
global $user;
// Make sure any user with pre-auth role doesn't have authenticated user role
_logintoboggan_user_roles_alter($user);
// Add custom css.
drupal_add_css(drupal_get_path('module', 'logintoboggan') .'/logintoboggan.css');
}
/**
* Alter user roles for loaded user account.
*
* If user is not an anonymous user, and the user has the pre-auth role, and the pre-auth role
* isn't also the auth role, then unset the auth role for this user--they haven't validated yet.
*
* This alteration is required because sess_read() and user_load() automatically set the
* authenticated user role for all non-anonymous users (see http://drupal.org/node/92361).
*
* @param &$account
* User account to have roles adjusted.
*/
function _logintoboggan_user_roles_alter($account) {
$id = logintoboggan_validating_id();
$in_pre_auth_role = in_array($id, array_keys($account->roles));
if ($account->uid && $in_pre_auth_role) {
if ($id != DRUPAL_AUTHENTICATED_RID) {
unset($account->roles[DRUPAL_AUTHENTICATED_RID]);
// Reset the permissions cache.
drupal_static_reset('user_access');
}
}
}
/**
* Implement hook_menu()
*
* @ingroup logintoboggan_core
*/
function logintoboggan_menu() {
$items = array();
// Settings page.
$items['admin/config/system/logintoboggan'] = array(
'title' => 'LoginToboggan',
'description' => 'Set up custom login options like instant login, login redirects, pre-authorized validation roles, etc.',
'page callback' => 'drupal_get_form',
'page arguments' => array('logintoboggan_main_settings'),
'access callback' => 'user_access',
'access arguments' => array('administer site configuration'),
);
// Callback for user validate routine.
$items['user/validate'] = array(
'title' => 'Validate e-mail address',
'page callback' => 'logintoboggan_validate_email',
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
// Callback for handling access denied redirection.
$items['toboggan/denied'] = array(
'access callback' => TRUE,
'page callback' => 'logintoboggan_denied',
'title' => 'Access denied',
'type' => MENU_CALLBACK,
);
//callback for re-sending validation e-mail
$items['toboggan/revalidate'] = array(
'title' => 'Re-send validation e-mail',
'page callback' => 'logintoboggan_resend_validation',
'page arguments' => array(2),
'access callback' => 'logintoboggan_revalidate_access',
'access arguments' => array(2),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Access check for user revalidation.
*/
function logintoboggan_revalidate_access($uid) {
global $user;
return $user->uid && ($user->uid == $uid || user_access('administer users'));
}
/**
* Implemenation of hook_theme().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_theme($existing, $type, $theme, $path) {
return array(
'lt_username_title' => array(
'variables' => array('form_id' => NULL),
),
'lt_username_description' => array(
'variables' => array('form_id' => NULL),
),
'lt_password_title' => array(
'variables' => array('form_id' => NULL),
),
'lt_password_description' => array(
'variables' => array('form_id' => NULL),
),
'lt_access_denied' => array(
'variables' => array(),
),
'lt_loggedinblock' => array(
'variables' => array('account' => NULL),
),
'lt_login_link' => array(
'variables' => array(),
),
'lt_login_successful_message' => array(
'variables' => array('account' => NULL),
),
);
}
/**
* @defgroup logintoboggan_block Functions for LoginToboggan blocks.
*/
function logintoboggan_user_block_admin_configure_submit($form, &$form_state) {
variable_set('logintoboggan_login_block_type', $form_state['values']['logintoboggan_login_block_type']);
variable_set('logintoboggan_login_block_message', $form_state['values']['logintoboggan_login_block_message']);
}
/**
* Implement hook_block_view().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_block_view($delta = '') {
global $user;
$block = array();
switch ($delta) {
case 'logintoboggan_logged_in':
if ($user->uid) {
$block['content'] = theme('lt_loggedinblock', array('account' => $user));
}
break;
}
return $block;
}
/**
* Implement hook_block_info().
*
* @ingroup logintoboggan_core
*/
function logintoboggan_block_info() {
$blocks = array();
$blocks['logintoboggan_logged_in'] = array(
'info' => t('LoginToboggan logged in block'),
'cache' => DRUPAL_NO_CACHE,
);
return $blocks;
}
/**
* User login block with JavaScript to expand
*
* this should really be themed
*
* @return array
* the reconstituted user login block
*/
function _logintoboggan_toggleboggan ($form) {
drupal_add_js(drupal_get_path('module', 'logintoboggan') .'/logintoboggan.js');
$pre = '';
$options = array(
'attributes' => array(
'id' => 'toboggan-login-link',
'class' => array('toboggan-login-link'),
),
'query' => drupal_get_destination(),
);
$pre .= '
';
$pre .= l(theme('lt_login_link'), 'user/login', $options);
$pre .= '
';
//the block that will be toggled
$pre .= '
';
$form['pre'] = array('#markup' => $pre, '#weight' => -300);
$form['post'] = array('#markup' => '
NOTE: If you enable this feature, you should edit the Welcome (no approval required) text.", array('!settings' => url('admin/config/people/accounts'))) . $help_text,
);
// Grab the roles that can be used for pre-auth. Remove the anon role, as it's not a valid choice.
$roles = user_roles(TRUE);
$form ['registration']['logintoboggan_pre_auth_role'] = array(
'#type' => 'select',
'#title' => t('Non-authenticated role'),
'#options' => $roles,
'#default_value' => variable_get('logintoboggan_pre_auth_role', DRUPAL_AUTHENTICATED_RID),
'#description' => t('If "Set password" is selected, users will be able to login before their e-mail address has been authenticated. Therefore, you must choose a role for new non-authenticated users -- you may wish to add a new role for this purpose. Users will be removed from this role and assigned to the "authenticated user" role once they follow the link in their welcome e-mail. WARNING: changing this setting after initial site setup can cause undesirable results, including unintended deletion of users -- change with extreme caution!', array('!url' => url('admin/config/people/roles'))),
);
$purge_options = array(
0 => t('Never delete'),
86400 => t('1 Day'),
172800 => t('2 Days'),
259200 => t('3 Days'),
345600 => t('4 Days'),
432000 => t('5 Days'),
518400 => t('6 Days'),
604800 => t('1 Week'),
1209600 => t('2 Weeks'),
2592000 => t('1 Month'),
7776000 => t('3 Months'),
15379200 => t('6 Months'),
30758400 => t('1 Year'),
);
$form['registration']['logintoboggan_purge_unvalidated_user_interval'] = array(
'#type' => 'select',
'#title' => t('Delete unvalidated users after'),
'#options' => $purge_options,
'#default_value' => variable_get('logintoboggan_purge_unvalidated_user_interval', 0),
'#description' => t("If enabled, users that are still in the 'Non-authenticated role' set above will be deleted automatically from the system, if the set time interval since their initial account creation has passed. This can be used to automatically purge spambot registrations. Note: this requires cron, and also requires that the 'Set password' option above is enabled. WARNING: changing this setting after initial site setup can cause undesirable results, including unintended deletion of users -- change with extreme caution! (please read the CAVEATS section of INSTALL.txt for important information on configuring this feature)")
);
$form['registration']['logintoboggan_immediate_login_on_register'] = array(
'#type' => 'checkbox',
'#title' => t('Immediate login'),
'#default_value' => variable_get('logintoboggan_immediate_login_on_register', TRUE),
'#description' => t("If set, the user will be logged in immediately after registering. Note this only applies if the 'Set password' option above is enabled."),
);
$form['registration']['redirect'] = array(
'#type' => 'fieldset',
'#title' => t('Redirections'),
'#collapsible' => true,
'#collapsed' => false,
);
$form['registration']['redirect']['logintoboggan_redirect_on_register'] = array(
'#type' => 'textfield',
'#title' => t('Redirect path on Registration'),
'#default_value' => variable_get('logintoboggan_redirect_on_register', ''),
'#description' => t('Normally, after a user registers a new account, they will be taken to the front page, or to their user page if you specify Immediate login above. Leave this setting blank if you wish to keep the default behavior. If you wish the user to go to a page of your choosing, then enter the path for it here. For instance, you may redirect them to a static page such as node/35, or to the <front> page. You may also use %uid as a variable, and the user\'s user ID will be substituted in the path.'),
);
$form['registration']['redirect']['logintoboggan_redirect_on_confirm'] = array(
'#type' => 'textfield',
'#title' => t('Redirect path on Confirmation'),
'#default_value' => variable_get('logintoboggan_redirect_on_confirm', ''),
'#description' => t('Normally, after a user confirms their new account, they will be taken to their user page. Leave this setting blank if you wish to keep the default behavior. If you wish the user to go to a page of your choosing, then enter the path for it here. For instance, you may redirect them to a static page such as node/35, or to the <front> page. You may also use %uid as a variable, and the user\'s user ID will be substituted in the path. In the case where users are not creating their own passwords, it is suggested to use user/%uid/edit here, so the user may set their password immediately after validating their account.'),
);
$form['registration']['redirect']['logintoboggan_override_destination_parameter'] = array(
'#type' => 'checkbox',
'#title' => t('Override destination parameter'),
'#default_value' => variable_get('logintoboggan_override_destination_parameter', 1),
'#description' => t("Normally, when a Drupal redirect is performed, priority is given to the 'destination' parameter from the originating URL. With this setting enabled, LoginToboggan will attempt to override this behavior with any values set above."),
);
$form['other'] = array('#type' => 'fieldset',
'#title' => t('Other'),
'#tree' => FALSE,
);
$site403 = variable_get('site_403', '');
if ($site403 == '') {
$disabled = $default = '0';
}
elseif ($site403 == 'toboggan/denied') {
$disabled = '0';
$default = 'toboggan/denied';
}
else {
$disabled = $default = $site403;
}
$options = array($disabled => $_disabled, 'toboggan/denied' => $_enabled);
$form['other']['logintoboggan_site_403'] = array(
'#type' => 'radios',
'#title' => t('Present login form on access denied (403)'),
'#options' => $options,
'#default_value' => $default,
'#description' => t('Anonymous users will be presented with a login form along with an access denied message.')
);
$form['other']['logintoboggan_login_successful_message'] = array(
'#type' => 'radios',
'#title' => t('Display login successful message'),
'#options' => array($_disabled, $_enabled),
'#default_value' => variable_get('logintoboggan_login_successful_message', 0),
'#description' => t('If enabled, users will receive a \'Login successful\' message upon login.')
);
$min_pass_options = array(t('None'));
for ($i = 2; $i < 30; $i++) {
$min_pass_options[$i] = $i;
}
$form['other']['logintoboggan_minimum_password_length'] = array(
'#type' => 'select',
'#title' => t('Minimum password length'),
'#options' => $min_pass_options,
'#default_value' => variable_get('logintoboggan_minimum_password_length', 0),
'#description' => t('LoginToboggan automatically performs basic password validation for illegal characters. If you would additionally like to have a mimimum password length requirement, select the length here, or set to \'None\' for no password length validation.')
);
return system_settings_form($form);
}
function logintoboggan_denied() {
global $user;
if ($user->uid == 0) {
// Output the user login form.
drupal_set_title(t('Access Denied / User Login'));
$output = drupal_get_form('user_login');
drupal_set_page_content($output);
// Return page attributes, hide blocks.
$page = element_info('page');
$page['#logintoboggan_denied'] = TRUE;
}
else {
drupal_set_title(t('Access Denied'));
$page = theme('lt_access_denied');
}
return $page;
}
/**
* Modified version of user_validate_name
* - validates user submitted passwords have a certain length and only contain letters, numbers or punctuation (graph character class in regex)
*/
function logintoboggan_validate_pass($pass) {
if (!strlen($pass)) return t('You must enter a password.');
if (ereg("[^\x80-\xF7[:graph:] ]", $pass)) return t('The password contains an illegal character.');
if (preg_match('/[\x{80}-\x{A0}'. // Non-printable ISO-8859-1 + NBSP
'\x{AD}'. // Soft-hyphen
'\x{2000}-\x{200F}'. // Various space characters
'\x{2028}-\x{202F}'. // Bidirectional text overrides
'\x{205F}-\x{206F}'. // Various text hinting characters
'\x{FEFF}'. // Byte order mark
'\x{FF01}-\x{FF60}'. // Full-width latin
'\x{FFF9}-\x{FFFD}]/u', // Replacement characters
$pass)) {
return t('The password contains an illegal character.');
}
if (strlen($pass) > 30) return t('The password is too long: it must be less than 30 characters.');
$min_pass_length = variable_get('logintoboggan_minimum_password_length', 0);
if ($min_pass_length && strlen($pass) < $min_pass_length) return t("The password is too short: it must be at least %min_length characters.", array('%min_length' => $min_pass_length));
}
/**
* Modified version of $DRUPAL_AUTHENTICATED_RID
* - gets the role id for the "validating" user role.
*/
function logintoboggan_validating_id() {
return variable_get('logintoboggan_pre_auth_role', DRUPAL_AUTHENTICATED_RID);
}
/**
* Menu callback; process validate the e-mail address as a one time URL,
* and redirects to the user page on success.
*/
function logintoboggan_validate_email($uid, $timestamp, $hashed_pass, $action = 'login') {
$current = REQUEST_TIME;
$uid = (int) $uid;
// Some redundant checks for extra security
if ($timestamp < $current && $uid && $account = user_load($uid) ) {
// No time out for first time login.
// This conditional checks that:
// - the user is still in the pre-auth role or didn't set
// their own password.
// - the hashed password is correct.
if (((variable_get('user_email_verification', TRUE) && empty($account->login)) || array_key_exists(logintoboggan_validating_id(), $account->roles)) && $hashed_pass == logintoboggan_eml_rehash($account->pass, $timestamp, $account->mail)) {
watchdog('user', 'E-mail validation URL used for %name with timestamp @timestamp.', array('%name' => $account->name, '@timestamp' => $timestamp));
// Test here for a valid pre-auth -- if the pre-auth is set to the auth user, we
// handle things a bit differently.
$validating_id = logintoboggan_validating_id();
$pre_auth = !variable_get('user_email_verification', TRUE) && $validating_id != DRUPAL_AUTHENTICATED_RID;
_logintoboggan_process_validation($account);
// Where do we redirect after confirming the account?
$redirect = _logintoboggan_process_redirect(variable_get('logintoboggan_redirect_on_confirm', ''), $account);
switch ($action) {
// Proceed with normal user login, as long as it's open registration and their
// account hasn't been blocked.
case 'login':
// Only show the validated message if there's a valid pre-auth role.
if ($pre_auth) {
drupal_set_message(t('You have successfully validated your e-mail address.'));
}
if (!$account->status) {
drupal_set_message(t('Your account is currently blocked -- login cancelled.'), 'error');
drupal_goto('');
}
else {
$edit = array();
$redirect = logintoboggan_process_login($account, $edit, $redirect);
call_user_func_array('drupal_goto', $redirect);
}
break;
// Admin validation.
case 'admin':
// TODO: is this still necessary?
// user has new permissions, so we clear their menu cache
cache_clear_all($account->uid .':', 'cache_menu', TRUE);
if ($pre_auth) {
// Mail the user, letting them know their account now has auth user perms.
_user_mail_notify('status_activated', $account);
}
drupal_set_message(t('You have successfully validated %user.', array('%user' => $account->name)));
drupal_goto("user/$account->uid/edit");
break;
// Catch all.
default:
// TODO: is this still necessary?
// user has new permissions, so we clear their menu cache
cache_clear_all($account->uid .':', 'cache_menu', TRUE);
drupal_set_message(t('You have successfully validated %user.', array('%user' => $account->name)));
drupal_goto('');
break;
}
}
else {
drupal_set_message(t("Sorry, you can only use your validation link once for security reasons. Please !login with your username and password instead now.", array('!login' => l(t('login'),'user/login'))),'error');
}
}
// Deny access, no more clues.
// Everything will be in the watchdog's URL for the administrator to check.
drupal_access_denied();
}
function _logintoboggan_process_validation($account) {
// Test here for a valid pre-auth -- if the pre-auth is set to the auth user, we
// handle things a bit differently.
$validating_id = logintoboggan_validating_id();
$pre_auth = !variable_get('user_email_verification', TRUE) && $validating_id != DRUPAL_AUTHENTICATED_RID;
// Remove the pre-auth role from the user, unless they haven't been approved yet.
if ($account->status) {
if ($pre_auth) {
db_delete('users_roles')
->condition('uid', $account->uid)
->condition('rid', $validating_id)
->execute();
// Since we're passing $account around to the update hook, remove
// the pre-auth role from the roles array, and add in the auth user
// role.
$account->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
unset($account->roles[$validating_id]);
}
}
// Allow other modules to react to email validation by invoking the user update hook.
// This should only be triggered if LT's custom validation is active.
if (!variable_get('user_email_verification', TRUE)) {
$edit = array();
$account->logintoboggan_email_validated = TRUE;
user_module_invoke('update', $edit, $account);
}
}
/**
* Actually log the user on
*
* @param object $account
* The user object.
* @param array $edit
* An array of form values if a form has been submitted.
* @param array $redirect
* An array of key/value pairs describing a redirect location, in the form
* that drupal_goto() will understand. Defaults to:
* 'path' => 'user/'. $user->uid
* 'query' => NULL
* 'fragment' => NULL
*/
function logintoboggan_process_login($account, &$edit, $redirect = array()){
global $user;
$user = user_load($account->uid);
user_login_finalize($edit);
// In the special case where a user is validating but they did not create their
// own password, show a user message letting them know to change their password.
if (variable_get('user_email_verification', TRUE)) {
watchdog('user', 'User %name used one-time login link at time %timestamp.', array('%name' => $user->name, '%timestamp' => REQUEST_TIME));
drupal_set_message(t('You have just used your one-time login link. It is no longer possible to use this link to login. Please change your password.'));
}
if (isset($redirect[0]) && $redirect[0] != '') {
return $redirect;
}
return array(
'user/'. $user->uid,
array(
'query' => array(),
'fragment' => '',
),
);
}
function logintoboggan_eml_validate_url($account, $url_options){
$timestamp = REQUEST_TIME;
return url("user/validate/$account->uid/$timestamp/". logintoboggan_eml_rehash($account->pass, $timestamp, $account->mail), $url_options);
}
function logintoboggan_eml_rehash($password, $timestamp, $mail){
return md5($timestamp . $password . $mail);
}
/**
* Implement hook_user_login().
*/
function logintoboggan_user_login(&$edit, $account) {
if (variable_get('logintoboggan_login_successful_message', 0)) {
drupal_set_message(theme('lt_login_successful_message', array('account' => $account)));
}
}
/**
* Implement hook_user_load().
*/
function logintoboggan_user_load($users) {
foreach ($users as $account) {
// If the user has the pre-auth role, unset the authenticated role
_logintoboggan_user_roles_alter($account);
}
}
/**
* Implement hook_user_update().
*/
function logintoboggan_user_update(&$edit, $account, $category) {
// Only perform this check if an admin is editing the account.
if (user_access('administer users')&& isset($edit['roles'])) {
// Check to see if roles present, and the pre-auth role was present when
// the form was initially displayed.
if (isset($edit['logintoboggan_pre_auth_check'])) {
// If the pre-auth is set to the auth user, then no further checking is
// necessary.
$validating_id = logintoboggan_validating_id();
$pre_auth = !variable_get('user_email_verification', TRUE) && $validating_id != DRUPAL_AUTHENTICATED_RID;
if ($pre_auth) {
// Check to see if an admin has manually removed the pre-auth role from
// the user. If so, send the account activation email.
if (!isset($edit['roles'][$validating_id]) || !$edit['roles'][$validating_id]) {
// Mail the user, letting them know their account now has auth user perms.
_user_mail_notify('status_activated', $account);
}
}
unset($edit['logintoboggan_pre_auth_check']);
}
}
}
/**
* Re-sends validation e-mail to user specified by $uid.
*/
function logintoboggan_resend_validation($uid) {
$account = user_load($uid);
$account->password = t('If required, you may reset your password from: !url', array('!url' => url('user/password', array('absolute' => TRUE))));
_user_mail_notify('register_no_approval_required', $account);
// Notify admin or user that e-mail was sent and return to user edit form.
if (user_access('administer users')) {
drupal_set_message(t("A validation e-mail has been sent to the user's e-mail address."));
}
else {
drupal_set_message(t('A validation e-mail has been sent to your e-mail address. You will need to follow the instructions in that message in order to gain full access to the site.'));
}
drupal_goto('user/'. $account->uid .'/edit');
}
function _logintoboggan_protocol() {
return ((isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http');
}
/**
* Transforms a URL fragment into a redirect array understood by drupal_goto().
*
* @param $redirect
* The redirect string.
* @param $account
* The user account object associated with the redirect.
*/
function _logintoboggan_process_redirect($redirect, $account) {
$variables = array('%uid' => $account->uid);
$redirect = parse_url(urldecode(strtr($redirect, $variables)));
// If there's a path set, override the destination parameter if necessary.
if ($redirect['path'] && variable_get('logintoboggan_override_destination_parameter', 1)) {
unset($_GET['destination']);
}
// Explicitly create query and fragment elements if not present already.
$query = isset($redirect['query']) ? $redirect['query'] : array();
$fragment = isset($redirect['fragment']) ? $redirect['fragment'] : '';
return array(
$redirect['path'],
array(
'query' => $query,
'fragment' => $fragment,
),
);
}
/**
* Takes custom settings on the main settings page, transforms them into the
* appropriate core setting, and cleans up the custom values.
*/
function logintoboggan_main_settings_submit($form, &$form_state) {
// User email verification setting.
$user_email_verification = $form_state['values']['logintoboggan_user_email_verification'] ? FALSE : TRUE;
variable_set('user_email_verification', $user_email_verification);
unset($form_state['values']['logintoboggan_user_email_verification']);
// Site 403 setting.
$site_403 = $form_state['values']['logintoboggan_site_403'] == '0' ? '' : $form_state['values']['logintoboggan_site_403'];
variable_set('site_403', $site_403);
unset($form_state['values']['logintoboggan_site_403']);
}
/**
* Implement hook_mail_alter().
*/
function logintoboggan_mail_alter(&$message) {
if ($message['id'] == 'user_register_pending_approval_admin') {
$reg_pass_set = !variable_get('user_email_verification', TRUE);
if ($reg_pass_set) {
$account = $message['params']['account'];
$url_options = array('absolute' => TRUE);
$language = $message['language'];
$langcode = isset($language) ? $language->language : NULL;
$message['body'][] = t("\n\nThe user has automatically received the permissions of the LoginToboggan validating role. To give the user full site permissions, click the link below:\n\n!validation_url/admin\n\nAlternatively, you may visit their user account listed above and remove them from the validating role.", array('!validation_url' => logintoboggan_eml_validate_url($account, $url_options)), array('langcode' => $langcode));
}
}
}
/**
*
* THEME FUNCTIONS!
*
* You may override and change any of these custom HTML output functions
* by copy/pasting them into your template.php file, at which point you can
* customize anything, provided you are using the default phptemplate engine.
*
* For more info on overriding theme functions, see http://drupal.org/node/55126
*/
/**
* Theme the username title of the user login form
* and the user login block.
*/
function theme_lt_username_title($variables) {
switch ($variables['form_id']) {
case 'user_login':
// Label text for the username field on the /user/login page.
return t('Username or e-mail address');
break;
case 'user_login_block':
// Label text for the username field when shown in a block.
return t('Username or e-mail');
break;
}
}
/**
* Theme the username description of the user login form
* and the user login block.
*/
function theme_lt_username_description($variables) {
switch ($variables['form_id']) {
case 'user_login':
// The username field's description when shown on the /user/login page.
return t('You may login with either your assigned username or your e-mail address.');
break;
case 'user_login_block':
return '';
break;
}
}
/**
* Theme the password title of the user login form
* and the user login block.
*/
function theme_lt_password_title($variables) {
// Label text for the password field.
return t('Password');
}
/**
* Theme the password description of the user login form
* and the user login block.
*/
function theme_lt_password_description($variables) {
switch ($variables['form_id']) {
case 'user_login':
// The password field's description on the /user/login page.
return t('The password field is case sensitive.');
break;
case 'user_login_block':
// If showing the login form in a block, don't print any descriptive text.
return '';
break;
}
}
/**
* Theme the Access Denied message.
*/
function theme_lt_access_denied($variables) {
return t('You are not authorized to access this page.');
}
/**
* Theme the loggedinblock that shows for logged-in users.
*/
function theme_lt_loggedinblock($variables){
return theme('username', array('account' => $variables['account'])) .' | ' . l(t('Log out'), 'user/logout');
}
/**
* Custom theme function for the login/register link.
*/
function theme_lt_login_link($variables) {
// Only display register text if registration is allowed.
if (variable_get('user_register', 1)) {
return t('Login/Register');
}
else {
return t('Login');
}
}
/**
* Theme the login successful message.
*
* @param $account
* A user object representing the user being logged in.
*/
function theme_lt_login_successful_message($variables) {
return t('Login successful for %name.', array('%name' => $variables['account']->name));
}