array( 'arguments' => array('account' => NULL), 'template' => 'user-picture', ), 'user_profile' => array( 'arguments' => array('elements' => NULL), 'template' => 'user-profile', 'file' => 'user.pages.inc', ), 'user_profile_category' => array( 'arguments' => array('element' => NULL), 'template' => 'user-profile-category', 'file' => 'user.pages.inc', ), 'user_profile_item' => array( 'arguments' => array('element' => NULL), 'template' => 'user-profile-item', 'file' => 'user.pages.inc', ), 'user_list' => array( 'arguments' => array('users' => NULL, 'title' => NULL), ), 'user_admin_permissions' => array( 'arguments' => array('form' => NULL), 'file' => 'user.admin.inc', ), 'user_admin_new_role' => array( 'arguments' => array('form' => NULL), 'file' => 'user.admin.inc', ), 'user_admin_account' => array( 'arguments' => array('form' => NULL), 'file' => 'user.admin.inc', ), 'user_filter_form' => array( 'arguments' => array('form' => NULL), 'file' => 'user.admin.inc', ), 'user_filters' => array( 'arguments' => array('form' => NULL), 'file' => 'user.admin.inc', ), 'user_signature' => array( 'arguments' => array('signature' => NULL), ), ); } /** * Implement hook_fieldable_info(). */ function user_fieldable_info() { $return = array( 'user' => array( 'label' => t('User'), 'object keys' => array( 'id' => 'uid', ), 'bundles' => array( 'user' => array( 'label' => t('User'), 'admin' => array( 'path' => 'admin/settings/user', 'access arguments' => array('administer users'), ), ), ), ), ); return $return; } /** * Implement hook_field_build_modes(). */ function user_field_build_modes($obj_type) { $modes = array(); if ($obj_type == 'user') { $modes = array( 'full' => t('User account'), ); } return $modes; } function user_external_load($authname) { $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField(); if ($uid) { return user_load($uid); } else { return FALSE; } } /** * Load multiple users based on certain conditions. * * This function should be used whenever you need to load more than one user * from the database. Users are loaded into memory and will not require * database access if loaded again during the same page request. * * @param $uids * An array of user IDs. * @param $conditions * An array of conditions to match against the {users} table. These * should be supplied in the form array('field_name' => 'field_value'). * @param $reset * A boolean indicating that the internal cache should be reset. Use this if * loading a user object which has been altered during the page request. * @return * An array of user objects, indexed by uid. * * @see user_load() * @see user_load_by_mail() * @see user_load_by_name() */ function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) { static $user_cache = array(); if ($reset) { $user_cache = array(); } $users = array(); // Create a new variable which is either a prepared version of the $uids // array for later comparison with the user cache, or FALSE if no $uids were // passed. The $uids array is reduced as items are loaded from cache, and we // need to know if it's empty for this reason to avoid querying the database // when all requested users are loaded from cache. $passed_uids = !empty($uids) ? array_flip($uids) : FALSE; // Load any available users from the internal cache. if ($user_cache) { if ($uids && !$conditions) { $users += array_intersect_key($user_cache, $passed_uids); // If any users were loaded, remove them from the $uids still to load. $uids = array_keys(array_diff_key($passed_uids, $users)); } } // Load any remaining users from the database, this is necessary if we have // $uids still to load, or if $conditions was passed without $uids. if ($uids || ($conditions && !$passed_uids)) { $query = db_select('users', 'u')->fields('u'); // If the $uids array is populated, add those to the query. if ($uids) { $query->condition('u.uid', $uids, 'IN'); } // If the conditions array is populated, add those to the query. if ($conditions) { // TODO D7: Using LIKE() to get a case insensitive comparison because Crell // and chx promise that dbtng will map it to ILIKE in postgres. if (isset($conditions['name'])) { $query->condition('u.name', $conditions['name'], 'LIKE'); unset($conditions['name']); } if (isset($conditions['mail'])) { $query->condition('u.mail', $conditions['mail'], 'LIKE'); unset($conditions['mail']); } foreach ($conditions as $field => $value) { $query->condition('u.' . $field, $value); } } $result = $query->execute(); $queried_users = array(); // Build an array of user picture IDs so that these can be fetched later. $picture_fids = array(); foreach ($result as $record) { $picture_fids[] = $record->picture; $queried_users[$record->uid] = drupal_unpack($record); $queried_users[$record->uid]->roles = array(); if ($record->uid) { $queried_users[$record->uid]->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user'; } else { $queried_users[$record->uid]->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user'; } } if (!empty($queried_users)) { // Add any additional roles from the database. $result = db_query('SELECT r.rid, r.name, ur.uid FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid IN (:uids)', array(':uids' => array_keys($queried_users))); foreach ($result as $record) { $queried_users[$record->uid]->roles[$record->rid] = $record->name; } // Add the full file objects for user pictures if enabled. if (!empty($picture_fids) && variable_get('user_pictures', 1) == 1) { $pictures = file_load_multiple($picture_fids); foreach ($queried_users as $account) { if (!empty($account->picture) && isset($pictures[$account->picture])) { $account->picture = $pictures[$account->picture]; } else { $account->picture = NULL; } } } field_attach_load('user', $queried_users); // Invoke hook_user_load() on the users loaded from the database // and add them to the static cache. foreach (module_implements('user_load') as $module) { $function = $module . '_user_load'; $function($queried_users); } $users = $users + $queried_users; $user_cache = $user_cache + $queried_users; } } // Ensure that the returned array is ordered the same as the original $uids // array if this was passed in and remove any invalid uids. if ($passed_uids) { // Remove any invalid uids from the array. $passed_uids = array_intersect_key($passed_uids, $users); foreach ($users as $user) { $passed_uids[$user->uid] = $user; } $users = $passed_uids; } return $users; } /** * Fetch a user object. * * @param $uid * Integer specifying the user id. * @param $reset * A boolean indicating that the internal cache should be reset. * @return * A fully-loaded $user object upon successful user load or FALSE if user * cannot be loaded. * * @see user_load_multiple() */ function user_load($uid, $reset = FALSE) { $users = user_load_multiple(array($uid), array(), $reset); return reset($users); } /** * Fetch a user object by email address. * * @param $mail * String with the account's e-mail address. * @return * A fully-loaded $user object upon successful user load or FALSE if user * cannot be loaded. * * @see user_load_multiple() */ function user_load_by_mail($mail) { $users = user_load_multiple(array(), array('mail' => $mail)); return reset($users); } /** * Fetch a user object by account name. * * @param $name * String with the account's user name. * @return * A fully-loaded $user object upon successful user load or FALSE if user * cannot be loaded. * * @see user_load_multiple() */ function user_load_by_name($name) { $users = user_load_multiple(array(), array('name' => $name)); return reset($users); } /** * Save changes to a user account or add a new user. * * @param $account * (optional) The user object to modify or add. If you want to modify * an existing user account, you will need to ensure that (a) $account * is an object, and (b) you have set $account->uid to the numeric * user ID of the user account you wish to modify. If you * want to create a new user account, you can set $account->is_new to * TRUE or omit the $account->uid field. * @param $edit * An array of fields and values to save. For example array('name' * => 'My name'). Keys that do not belong to columns in the user-related * tables are added to the a serialized array in the 'data' column * and will be loaded in the $user->data array by user_load(). * Setting a field to NULL deletes it from the data column, if you are * modifying an existing user account. * @param $category * (optional) The category for storing profile information in. * * @return * A fully-loaded $user object upon successful save or FALSE if the save failed. */ function user_save($account, $edit = array(), $category = 'account') { $table = drupal_get_schema('users'); $user_fields = $table['fields']; if (!empty($edit['pass'])) { // Allow alternate password hashing schemes. require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc'); $edit['pass'] = user_hash_password(trim($edit['pass'])); // Abort if the hashing failed and returned FALSE. if (!$edit['pass']) { return FALSE; } } else { // Avoid overwriting an existing password with a blank password. unset($edit['pass']); } // Get the fields form so we can recognize the fields in the $edit // form that should not go into the serialized data array. $field_form = array(); $field_form_state = array(); $edit = (object) $edit; field_attach_form('user', $edit, $field_form, $field_form_state); // Presave fields. field_attach_presave('user', $edit); $edit = (array) $edit; if (!isset($account->is_new)) { $account->is_new = empty($account->uid); } if (is_object($account) && !$account->is_new) { user_module_invoke('update', $edit, $account, $category); $data = unserialize(db_query('SELECT data FROM {users} WHERE uid = :uid', array(':uid' => $account->uid))->fetchField()); // Consider users edited by an administrator as logged in, if they haven't // already, so anonymous users can view the profile (if allowed). if (empty($edit['access']) && empty($account->access) && user_access('administer users')) { $edit['access'] = REQUEST_TIME; } foreach ($edit as $key => $value) { // Form fields that don't pertain to the users, user_roles, or // Field API are automatically serialized into the users.data // column. if (!in_array($key, array('roles', 'is_new')) && empty($user_fields[$key]) && empty($field_form[$key])) { if ($value === NULL) { unset($data[$key]); } else { $data[$key] = $value; } } } // Process picture uploads. if (!empty($edit['picture']->fid)) { $picture = $edit['picture']; // If the picture is a temporary file move it to its final location and // make it permanent. if (($picture->status & FILE_STATUS_PERMANENT) == 0) { $info = image_get_info($picture->filepath); $destination = file_create_path(variable_get('user_picture_path', 'pictures') . '/picture-' . $account->uid . '.' . $info['extension']); if ($picture = file_move($picture, $destination, FILE_EXISTS_REPLACE)) { $picture->status |= FILE_STATUS_PERMANENT; $edit['picture'] = file_save($picture); } } } $edit['picture'] = empty($edit['picture']->fid) ? 0 : $edit['picture']->fid; $edit['data'] = $data; // Do not allow 'uid' to be changed. $edit['uid'] = $account->uid; // Save changes to the user table. $success = drupal_write_record('users', $edit, 'uid'); if (!$success) { // The query failed - better to abort the save than risk further // data loss. // TODO: Fields change: I think this is a bug. If no columns in // the user table are changed, drupal_write_record returns // FALSE because rowCount() (rows changed) is 0. However, // non-users data may have been changed, e.g. fields. // return FALSE; } // If the picture changed or was unset, remove the old one. This step needs // to occur after updating the {users} record so that user_file_references() // doesn't report it in use and block the deletion. if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) { file_delete($account->picture); } // Reload user roles if provided. if (isset($edit['roles']) && is_array($edit['roles'])) { db_delete('users_roles') ->condition('uid', $account->uid) ->execute(); $query = db_insert('users_roles')->fields(array('uid', 'rid')); foreach (array_keys($edit['roles']) as $rid) { if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) { $query->values(array( 'uid' => $account->uid, 'rid' => $rid, )); } } $query->execute(); } // Delete a blocked user's sessions to kick them if they are online. if (isset($edit['status']) && $edit['status'] == 0) { drupal_session_destroy_uid($account->uid); } // If the password changed, delete all open sessions and recreate // the current one. if (!empty($edit['pass'])) { drupal_session_destroy_uid($account->uid); if ($account->uid == $GLOBALS['user']->uid) { drupal_session_regenerate(); } } // Save Field data. $object = (object) $edit; field_attach_update('user', $object); // Refresh user object. $user = user_load($account->uid, TRUE); // Send emails after we have the new user object. if (isset($edit['status']) && $edit['status'] != $account->status) { // The user's status is changing; conditionally send notification email. $op = $edit['status'] == 1 ? 'status_activated' : 'status_blocked'; _user_mail_notify($op, $user); } user_module_invoke('after_update', $edit, $user, $category); } else { // Allow 'created' to be set by the caller. if (!isset($edit['created'])) { $edit['created'] = REQUEST_TIME; } // Consider users created by an administrator as already logged in, so // anonymous users can view the profile (if allowed). if (empty($edit['access']) && user_access('administer users')) { $edit['access'] = REQUEST_TIME; } $edit['mail'] = trim($edit['mail']); $success = drupal_write_record('users', $edit); if (!$success) { // On a failed INSERT some other existing user's uid may be returned. // We must abort to avoid overwriting their account. return FALSE; } // Build the initial user object. $user = user_load($edit['uid'], TRUE); $object = (object) $edit; field_attach_insert('user', $object); user_module_invoke('insert', $edit, $user, $category); // Note, we wait with saving the data column to prevent module-handled // fields from being saved there. $data = array(); foreach ($edit as $key => $value) { // Form fields that don't pertain to the users, user_roles, or // Field API are automatically serialized into the user.data // column. if ((!in_array($key, array('roles', 'is_new'))) && (empty($user_fields[$key]) && empty($field_form[$key])) && ($value !== NULL)) { $data[$key] = $value; } } if (!empty($data)) { $data_array = array('uid' => $user->uid, 'data' => $data); drupal_write_record('users', $data_array, 'uid'); } // Save user roles (delete just to be safe). if (isset($edit['roles']) && is_array($edit['roles'])) { db_delete('users_roles') ->condition('uid', $edit['uid']) ->execute(); $query = db_insert('users_roles')->fields(array('uid', 'rid')); foreach (array_keys($edit['roles']) as $rid) { if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) { $query->values(array( 'uid' => $edit['uid'], 'rid' => $rid, )); } } $query->execute(); } // Build the finished user object. $user = user_load($edit['uid'], TRUE); } return $user; } /** * Verify the syntax of the given name. */ function user_validate_name($name) { if (!$name) { return t('You must enter a username.'); } if (substr($name, 0, 1) == ' ') { return t('The username cannot begin with a space.'); } if (substr($name, -1) == ' ') { return t('The username cannot end with a space.'); } if (strpos($name, ' ') !== FALSE) { return t('The username cannot contain multiple spaces in a row.'); } if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)) { return t('The username 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}' . // Replacement characters '\x{0}-\x{1F}]/u', // NULL byte and control characters $name)) { return t('The username contains an illegal character.'); } if (drupal_strlen($name) > USERNAME_MAX_LENGTH) { return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH)); } } function user_validate_mail($mail) { $mail = trim($mail); if (!$mail) { return t('You must enter an e-mail address.'); } if (!valid_email_address($mail)) { return t('The e-mail address %mail is not valid.', array('%mail' => $mail)); } } function user_validate_picture(&$form, &$form_state) { // If required, validate the uploaded picture. $validators = array( 'file_validate_is_image' => array(), 'file_validate_image_resolution' => array(variable_get('user_picture_dimensions', '85x85')), 'file_validate_size' => array(variable_get('user_picture_file_size', '30') * 1024), ); // Save the file as a temporary file. $file = file_save_upload('picture_upload', $validators); if ($file === FALSE) { form_set_error('picture_upload', t("Failed to upload the picture image; the %directory directory doesn't exist or is not writable.", array('%directory' => variable_get('user_picture_path', 'pictures')))); } elseif ($file !== NULL) { $form_state['values']['picture_upload'] = $file; } } /** * Generate a random alphanumeric password. */ function user_password($length = 10) { // This variable contains the list of allowable characters for the // password. Note that the number 0 and the letter 'O' have been // removed to avoid confusion between the two. The same is true // of 'I', 1, and 'l'. $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789'; // Zero-based count of characters in the allowable list: $len = strlen($allowable_characters) - 1; // Declare the password as a blank string. $pass = ''; // Loop the number of times specified by $length. for ($i = 0; $i < $length; $i++) { // Each iteration, pick a random character from the // allowable string and append it to the password: $pass .= $allowable_characters[mt_rand(0, $len)]; } return $pass; } /** * Determine the permissions for one or more roles. * * @param $roles * An array whose keys are the role IDs of interest, such as $user->roles. * @param $reset * Optional parameter - if TRUE data in the static variable is rebuilt. * * @return * An array indexed by role ID. Each value is an array whose keys are the * permission strings for the given role ID. */ function user_role_permissions($roles = array(), $reset = FALSE) { static $stored_permissions = array(); if ($reset) { // Clear the data cached in the static variable. $stored_permissions = array(); } $role_permissions = $fetch = array(); if ($roles) { foreach ($roles as $rid => $name) { if (isset($stored_permissions[$rid])) { $role_permissions[$rid] = $stored_permissions[$rid]; } else { // Add this rid to the list of those needing to be fetched. $fetch[] = $rid; // Prepare in case no permissions are returned. $stored_permissions[$rid] = array(); } } if ($fetch) { // Get from the database permissions that were not in the static variable. // Only role IDs with at least one permission assigned will return rows. $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch)); foreach ($result as $row) { $stored_permissions[$row->rid][$row->permission] = TRUE; } foreach ($fetch as $rid) { // For every rid, we know we at least assigned an empty array. $role_permissions[$rid] = $stored_permissions[$rid]; } } } return $role_permissions; } /** * Determine whether the user has a given privilege. * * @param $string * The permission, such as "administer nodes", being checked for. * @param $account * (optional) The account to check, if not given use currently logged in user. * @param $reset * (optional) Resets the user's permissions cache, which will result in a * recalculation of the user's permissions. This is necessary to support * dynamically added user roles. * * @return * Boolean TRUE if the current user has the requested permission. * * All permission checks in Drupal should go through this function. This * way, we guarantee consistent behavior, and ensure that the superuser * can perform all actions. */ function user_access($string, $account = NULL, $reset = FALSE) { global $user; static $perm = array(); if ($reset) { $perm = array(); } if (!isset($account)) { $account = $user; } // User #1 has all privileges: if ($account->uid == 1) { return TRUE; } // To reduce the number of SQL queries, we cache the user's permissions // in a static variable. if (!isset($perm[$account->uid])) { $role_permissions = user_role_permissions($account->roles, $reset); $perms = array(); foreach ($role_permissions as $one_role) { $perms += $one_role; } $perm[$account->uid] = $perms; } return isset($perm[$account->uid][$string]); } /** * Checks for usernames blocked by user administration. * * @return boolean TRUE for blocked users, FALSE for active. */ function user_is_blocked($name) { $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject(); return $deny; } /** * Implement hook_permission(). */ function user_permission() { return array( 'administer permissions' => array( 'title' => t('Administer permissions'), 'description' => t('Manage the permissions assigned to user roles. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))), ), 'administer users' => array( 'title' => t('Administer users'), 'description' => t('Manage or block users, and manage their role assignments.'), ), 'access user profiles' => array( 'title' => t('Access user profiles'), 'description' => t('View profiles of users on the site, which may contain personal information.'), ), 'change own username' => array( 'title' => t('Change own username'), 'description' => t('Select a different username.'), ), 'cancel account' => array( 'title' => t('Cancel account'), 'description' => t('Remove or disable own user account and unpublish, anonymize, or remove own submissions depending on the configured user settings.', array('@user-settings-url' => url('admin/settings/user'))), ), 'select account cancellation method' => array( 'title' => t('Select method for cancelling own account'), 'description' => t('Select the method for cancelling own user account. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))), ), ); } /** * Implement hook_file_download(). * * Ensure that user pictures (avatars) are always downloadable. */ function user_file_download($filepath) { if (strpos($filepath, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) { $info = image_get_info(file_create_path($filepath)); return array('Content-Type' => $info['mime_type']); } } /** * Implement hook_file_references(). */ function user_file_references($file) { // Determine if the file is used by this module. $file_used = (bool) db_query_range('SELECT 1 FROM {users} WHERE picture = :fid', array(':fid' => $file->fid), 0, 1)->fetchField(); if ($file_used) { // Return the name of the module and how many references it has to the file. return array('user' => $count); } } /** * Implement hook_file_delete(). */ function user_file_delete($file) { // Remove any references to the file. db_update('users') ->fields(array('picture' => 0)) ->condition('picture', $file->fid) ->execute(); } /** * Implement hook_search(). */ function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) { switch ($op) { case 'name': if ($skip_access_check || user_access('access user profiles')) { return t('Users'); } case 'search': if (user_access('access user profiles')) { $find = array(); // Replace wildcards with MySQL/PostgreSQL wildcards. $keys = preg_replace('!\*+!', '%', $keys); $query = db_select('users')->extend('PagerDefault'); $query->fields('users', array('name', 'uid', 'mail')); if (user_access('administer users')) { // Administrators can also search in the otherwise private email field. $query->condition(db_or()-> where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"))-> where('LOWER(mail) LIKE LOWER(:mail)', array(':mail' => "%$keys%"))); } else { $query->where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%")); } $result = $query ->limit(15) ->execute(); foreach ($result as $account) { $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE))); } return $find; } } } /** * Implement hook_elements(). */ function user_elements() { return array( 'user_profile_category' => array( '#theme_wrappers' => array('user_profile_category') ), 'user_profile_item' => array( '#theme' => 'user_profile_item' ), ); } /** * Implement hook_user_view(). */ function user_user_view($account) { $account->content['user_picture'] = array( '#markup' => theme('user_picture', $account), '#weight' => -10, ); if (!isset($account->content['summary'])) { $account->content['summary'] = array(); } $account->content['summary'] += array( '#type' => 'user_profile_category', '#attributes' => array('class' => 'user-member'), '#weight' => 5, '#title' => t('History'), ); $account->content['summary']['member_for'] = array( '#type' => 'user_profile_item', '#title' => t('Member for'), '#markup' => format_interval(REQUEST_TIME - $account->created), ); } /** * Implement hook_user_form. */ function user_user_form(&$edit, $account, $category) { if ($category == 'account') { $form_state = array(); return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit); } } /** * Implement hook_user_validate(). */ function user_user_validate(&$edit, $account, $category) { if ($category == 'account') { $uid = isset($account->uid) ? $account->uid : FALSE; // Validate the username when: new user account; or user is editing own account and can change username; or an admin user. if (!$uid || ($GLOBALS['user']->uid == $uid && user_access('change own username')) || user_access('administer users')) { if ($error = user_validate_name($edit['name'])) { form_set_error('name', $error); } elseif ((bool) db_query_range("SELECT 1 FROM {users} WHERE uid <> :uid AND LOWER(name) = LOWER(:name)", array(':uid' => $uid, ':name' => $edit['name']), 0, 1)->fetchField()) { form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name']))); } } // Validate the e-mail address, and check if it is taken by an existing user. if ($error = user_validate_mail($edit['mail'])) { form_set_error('mail', $error); } elseif ((bool) db_query_range("SELECT 1 FROM {users} WHERE uid <> :uid AND LOWER(mail) = LOWER(:mail)", array(':uid' => $uid, ':mail' => $edit['mail']), 0, 1)->fetchField()) { // Format error message dependent on whether the user is logged in or not. if ($GLOBALS['user']->uid) { form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $edit['mail']))); } else { form_set_error('mail', t('The e-mail address %email is already registered. Have you forgotten your password?', array('%email' => $edit['mail'], '@password' => url('user/password')))); } } // Make sure the signature isn't longer than the size of the database field. // Signatures are disabled by default, so make sure it exists first. if (isset($edit['signature'])) { $user_schema = drupal_get_schema('users'); if (strlen($edit['signature']) > $user_schema['fields']['signature']['length']) { form_set_error('signature', t('The signature is too long: it must be %max characters or less.', array('%max' => $user_schema['fields']['signature']['length']))); } } } } /** * Implement hook_user_submit(). */ function user_user_submit(&$edit, $account, $category) { if ($category == 'account') { if (!empty($edit['picture_upload'])) { $edit['picture'] = $edit['picture_upload']; } // Delete picture if requested, and if no replacement picture was given. elseif (!empty($edit['picture_delete'])) { $edit['picture'] = NULL; } // Remove these values so they don't end up serialized in the data field. $edit['picture_upload'] = NULL; $edit['picture_delete'] = NULL; if (isset($edit['roles'])) { $edit['roles'] = array_filter($edit['roles']); } } } /** * Implement hook_user_categories(). */ function user_user_categories() { return array(array( 'name' => 'account', 'title' => t('Account settings'), 'weight' => 1, )); } function user_login_block() { $form = array( '#action' => url($_GET['q'], array('query' => drupal_get_destination())), '#id' => 'user-login-form', '#validate' => user_login_default_validators(), '#submit' => array('user_login_submit'), ); $form['name'] = array('#type' => 'textfield', '#title' => t('Username'), '#maxlength' => USERNAME_MAX_LENGTH, '#size' => 15, '#required' => TRUE, ); $form['pass'] = array('#type' => 'password', '#title' => t('Password'), '#maxlength' => 60, '#size' => 15, '#required' => TRUE, ); $form['submit'] = array('#type' => 'submit', '#value' => t('Log in'), ); $items = array(); if (variable_get('user_register', 1)) { $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.')))); } $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.')))); $form['links'] = array('#markup' => theme('item_list', $items)); return $form; } /** * Implement hook_block_list(). */ function user_block_list() { global $user; $blocks['login']['info'] = t('User login'); // Not worth caching. $blocks['login']['cache'] = BLOCK_NO_CACHE; $blocks['new']['info'] = t('Who\'s new'); // Too dynamic to cache. $blocks['online']['info'] = t('Who\'s online'); $blocks['online']['cache'] = BLOCK_NO_CACHE; return $blocks; } /** * Implement hook_block_configure(). */ function user_block_configure($delta = '') { global $user; switch ($delta) { case 'new': $form['user_block_whois_new_count'] = array( '#type' => 'select', '#title' => t('Number of users to display'), '#default_value' => variable_get('user_block_whois_new_count', 5), '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)), ); return $form; case 'online': $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval'); $form['user_block_seconds_online'] = array('#type' => 'select', '#title' => t('User activity'), '#default_value' => variable_get('user_block_seconds_online', 900), '#options' => $period, '#description' => t('A user is considered online for this long after they have last viewed a page.')); $form['user_block_max_list_count'] = array('#type' => 'select', '#title' => t('User list length'), '#default_value' => variable_get('user_block_max_list_count', 10), '#options' => drupal_map_assoc(array(0, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100)), '#description' => t('Maximum number of currently online users to display.')); $form['user_block_cache'] = array('#markup' => '

If page caching is disabled, the block shows the number of anonymous and authenticated users, respectively. If page caching is enabled, only the number of authenticated users is displayed.

'); return $form; } } /** * Implement hook_block_save(). */ function user_block_save($delta = '', $edit = array()) { global $user; switch ($delta) { case 'new': variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']); break; case 'online': variable_set('user_block_seconds_online', $edit['user_block_seconds_online']); variable_set('user_block_max_list_count', $edit['user_block_max_list_count']); break; } } /** * Implement hook_block_view(). */ function user_block_view($delta = '') { global $user; $block = array(); switch ($delta) { case 'login': // For usability's sake, avoid showing two login forms on one page. if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) { $block['subject'] = t('User login'); $block['content'] = drupal_get_form('user_login_block'); } return $block; case 'new': if (user_access('access content')) { // Retrieve a list of new users who have subsequently accessed the site successfully. $items = db_query_range('SELECT uid, name FROM {users} WHERE status <> 0 AND access <> 0 ORDER BY created DESC', array(), 0, variable_get('user_block_whois_new_count', 5))->fetchAll(); $output = theme('user_list', $items); $block['subject'] = t('Who\'s new'); $block['content'] = $output; } return $block; case 'online': if (user_access('access content')) { // Count users active within the defined period. $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900); // Perform database queries to gather online user lists. We use s.timestamp // rather than u.access because it is much faster. $authenticated_count = db_query("SELECT COUNT(DISTINCT s.uid) FROM {sessions} s WHERE s.timestamp >= :timestamp AND s.uid > 0", array(':timestamp' => $interval))->fetchField(); // When page caching is enabled, sessions are only created for // anonymous users when needed. if (variable_get('cache', CACHE_DISABLED) == CACHE_DISABLED) { $anonymous_count = drupal_session_count($interval); // Format the output with proper grammar. if ($anonymous_count == 1 && $authenticated_count == 1) { $output = t('There is currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests'))); } else { $output = t('There are currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests'))); } } else { $output = format_plural($authenticated_count, 'There is currently 1 user online.', 'There are currently @count users online.'); } // Display a list of currently online users. $max_users = variable_get('user_block_max_list_count', 10); if ($authenticated_count && $max_users) { $items = db_query_range('SELECT u.uid, u.name, MAX(s.timestamp) AS max_timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.timestamp >= :interval AND s.uid > 0 GROUP BY u.uid, u.name ORDER BY max_timestamp DESC', array(':interval' => $interval), 0, $max_users)->fetchAll(); $output .= theme('user_list', $items, t('Online users')); } $block['subject'] = t('Who\'s online'); $block['content'] = $output; } return $block; } } /** * Process variables for user-picture.tpl.php. * * The $variables array contains the following arguments: * - $account: A user, node or comment object with 'name', 'uid' and 'picture' * fields. * * @see user-picture.tpl.php */ function template_preprocess_user_picture(&$variables) { $variables['user_picture'] = ''; if (variable_get('user_pictures', 0)) { $account = $variables['account']; if (!empty($account->picture)) { // @TODO: Ideally this function would only be passed file objects, but // since there's a lot of legacy code that JOINs the {users} table to // {node} or {comments} and passes the results into this function if we // a numeric value in the picture field we'll assume it's a file id // and load it for them. Once we've got user_load_multiple() and // comment_load_multiple() functions the user module will be able to load // the picture files in mass during the object's load process. if (is_numeric($account->picture)) { $account->picture = file_load($account->picture); } if (!empty($account->picture->filepath)) { $filepath = $account->picture->filepath; } } elseif (variable_get('user_picture_default', '')) { $filepath = variable_get('user_picture_default', ''); } if (isset($filepath)) { $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous')))); if (module_exists('image') && $style = variable_get('user_picture_style', '')) { $variables['user_picture'] = theme('image_style', $style, $filepath, $alt, $alt, array(), FALSE); } else { $variables['user_picture'] = theme('image', $filepath, $alt, $alt, array(), FALSE); } if (!empty($account->uid) && user_access('access user profiles')) { $attributes = array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE); $variables['user_picture'] = l($variables['user_picture'], "user/$account->uid", $attributes); } } } } /** * Make a list of users. * * @param $users * An array with user objects. Should contain at least the name and uid. * @param $title * (optional) Title to pass on to theme_item_list(). * * @ingroup themeable */ function theme_user_list($users, $title = NULL) { if (!empty($users)) { foreach ($users as $user) { $items[] = theme('username', $user); } } return theme('item_list', $items, $title); } function user_is_anonymous() { // Menu administrators can see items for anonymous when administering. return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']); } function user_is_logged_in() { return (bool)$GLOBALS['user']->uid; } function user_register_access() { return user_is_anonymous() && variable_get('user_register', 1); } function user_view_access($account) { return $account && $account->uid && ( // Always let users view their own profile. ($GLOBALS['user']->uid == $account->uid) || // Administrators can view all accounts. user_access('administer users') || // The user is not blocked and logged in at least once. ($account->access && $account->status && user_access('access user profiles')) ); } /** * Access callback for user account editing. */ function user_edit_access($account) { return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0; } /** * Menu access callback; limit access to account cancellation pages. * * Limit access to users with the 'cancel account' permission or administrative * users, and prevent the anonymous user from cancelling the account. */ function user_cancel_access($account) { return ((($GLOBALS['user']->uid == $account->uid) && user_access('cancel account')) || user_access('administer users')) && $account->uid > 0; } function user_load_self($arg) { $arg[1] = user_load($GLOBALS['user']->uid); return $arg; } /** * Implement hook_menu(). */ function user_menu() { $items['user/autocomplete'] = array( 'title' => 'User autocomplete', 'page callback' => 'user_autocomplete', 'access callback' => 'user_access', 'access arguments' => array('access user profiles'), 'type' => MENU_CALLBACK, ); // Registration and login pages. $items['user'] = array( 'title' => 'User account', 'page callback' => 'user_page', 'access callback' => TRUE, 'type' => MENU_CALLBACK, ); $items['user/login'] = array( 'title' => 'Log in', 'access callback' => 'user_is_anonymous', 'type' => MENU_DEFAULT_LOCAL_TASK, ); $items['user/register'] = array( 'title' => 'Create new account', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_register'), 'access callback' => 'user_register_access', 'type' => MENU_LOCAL_TASK, ); $items['user/password'] = array( 'title' => 'Request new password', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_pass'), 'access callback' => 'user_is_anonymous', 'type' => MENU_LOCAL_TASK, ); $items['user/reset/%/%/%'] = array( 'title' => 'Reset password', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_pass_reset', 2, 3, 4), 'access callback' => TRUE, 'type' => MENU_CALLBACK, ); $items['user/logout'] = array( 'title' => 'Log out', 'access callback' => 'user_is_logged_in', 'page callback' => 'user_logout', 'weight' => 10, 'menu_name' => 'user-menu', ); // User administration pages. $items['admin/people'] = array( 'title' => 'People', 'page callback' => 'user_admin', 'page arguments' => array('list'), 'access arguments' => array('administer users'), 'weight' => -4, ); $items['admin/people/list'] = array( 'title' => 'List', 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10, ); $items['admin/people/create'] = array( 'title' => 'Add user', 'page arguments' => array('create'), 'access arguments' => array('administer users'), 'type' => MENU_LOCAL_TASK, ); $items['admin/settings/user'] = array( 'title' => 'Users', 'description' => 'Configure default behavior of users, including registration requirements, e-mails, and user pictures.', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_admin_settings'), 'access arguments' => array('administer users'), ); // Permission administration pages. $items['admin/settings/permissions'] = array( 'title' => 'Permissions', 'description' => 'Determine access to features by selecting permissions for roles.', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_admin_permissions'), 'access arguments' => array('administer permissions'), ); $items['admin/settings/roles'] = array( 'title' => 'Roles', 'description' => 'List, edit, or add user roles.', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_admin_new_role'), 'access arguments' => array('administer permissions'), ); $items['admin/settings/roles/edit'] = array( 'title' => 'Edit role', 'page arguments' => array('user_admin_role'), 'access arguments' => array('administer permissions'), 'type' => MENU_CALLBACK, ); $items['user/%user_uid_optional'] = array( 'title' => 'My account', 'title callback' => 'user_page_title', 'title arguments' => array(1), 'page callback' => 'user_view', 'page arguments' => array(1), 'access callback' => 'user_view_access', 'access arguments' => array(1), 'weight' => -10, 'menu_name' => 'user-menu', ); $items['user/%user/view'] = array( 'title' => 'View', 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10, ); $items['user/%user/cancel'] = array( 'title' => 'Cancel account', 'page callback' => 'drupal_get_form', 'page arguments' => array('user_cancel_confirm_form', 1), 'access callback' => 'user_cancel_access', 'access arguments' => array(1), 'type' => MENU_CALLBACK, ); $items['user/%user/cancel/confirm/%/%'] = array( 'title' => 'Confirm account cancellation', 'page callback' => 'user_cancel_confirm', 'page arguments' => array(1, 4, 5), 'access callback' => 'user_cancel_access', 'access arguments' => array(1), 'type' => MENU_CALLBACK, ); $items['user/%user/edit'] = array( 'title' => 'Edit', 'page callback' => 'user_edit', 'page arguments' => array(1), 'access callback' => 'user_edit_access', 'access arguments' => array(1), 'type' => MENU_LOCAL_TASK, ); $items['user/%user_category/edit/account'] = array( 'title' => 'Account', 'type' => MENU_DEFAULT_LOCAL_TASK, 'load arguments' => array('%map', '%index'), ); if (($categories = _user_categories()) && (count($categories) > 1)) { foreach ($categories as $key => $category) { // 'account' is already handled by the MENU_DEFAULT_LOCAL_TASK. if ($category['name'] != 'account') { $items['user/%user_category/edit/' . $category['name']] = array( 'title callback' => 'check_plain', 'title arguments' => array($category['title']), 'page callback' => 'user_edit', 'page arguments' => array(1, 3), 'access callback' => isset($category['access callback']) ? $category['access callback'] : 'user_edit_access', 'access arguments' => isset($category['access arguments']) ? $category['access arguments'] : array(1), 'type' => MENU_LOCAL_TASK, 'weight' => $category['weight'], 'load arguments' => array('%map', '%index'), 'tab_parent' => 'user/%/edit', ); } } } return $items; } function user_init() { drupal_add_css(drupal_get_path('module', 'user') . '/user.css'); } function user_uid_optional_load($arg) { return user_load(isset($arg) ? $arg : $GLOBALS['user']->uid); } /** * Return a user object after checking if any profile category in the path exists. */ function user_category_load($uid, &$map, $index) { static $user_categories, $accounts; // Cache $account - this load function will get called for each profile tab. if (!isset($accounts[$uid])) { $accounts[$uid] = user_load($uid); } $valid = TRUE; if ($account = $accounts[$uid]) { // Since the path is like user/%/edit/category_name, the category name will // be at a position 2 beyond the index corresponding to the % wildcard. $category_index = $index + 2; // Valid categories may contain slashes, and hence need to be imploded. $category_path = implode('/', array_slice($map, $category_index)); if ($category_path) { // Check that the requested category exists. $valid = FALSE; if (!isset($user_categories)) { $user_categories = _user_categories(); } foreach ($user_categories as $category) { if ($category['name'] == $category_path) { $valid = TRUE; // Truncate the map array in case the category name had slashes. $map = array_slice($map, 0, $category_index); // Assign the imploded category name to the last map element. $map[$category_index] = $category_path; break; } } } } return $valid ? $account : FALSE; } /** * Returns the user id of the currently logged in user. */ function user_uid_optional_to_arg($arg) { // Give back the current user uid when called from eg. tracker, aka. // with an empty arg. Also use the current user uid when called from // the menu with a % for the current account link. return empty($arg) || $arg == '%' ? $GLOBALS['user']->uid : $arg; } /** * Menu item title callback - use the user name if it's not the current user. */ function user_page_title($account) { if ($account->uid == $GLOBALS['user']->uid) { return t('My account'); } return $account->name; } /** * Discover which external authentication module(s) authenticated a username. * * @param $authname * A username used by an external authentication module. * @return * An associative array with module as key and username as value. */ function user_get_authmaps($authname = NULL) { $authmaps = db_query("SELECT authname, module FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchAllKeyed(); return count($authmaps) ? $authmaps : 0; } /** * Save mappings of which external authentication module(s) authenticated * a user. Maps external usernames to user ids in the users table. * * @param $account * A user object. * @param $authmaps * An associative array with a compound key and the username as the value. * The key is made up of 'authname_' plus the name of the external authentication * module. * @see user_external_login_register() */ function user_set_authmaps($account, $authmaps) { foreach ($authmaps as $key => $value) { $module = explode('_', $key, 2); if ($value) { db_merge('authmap') ->key(array( 'uid' => $account->uid, 'module' => $module[1], )) ->fields(array('authname' => $value)) ->execute(); } else { db_delete('authmap') ->condition('uid', $account->uid) ->condition('module', $module[1]) ->execute(); } } } /** * Form builder; the main user login form. * * @ingroup forms */ function user_login(&$form_state) { global $user; // If we are already logged on, go to the user page instead. if ($user->uid) { drupal_goto('user/' . $user->uid); } // Display login form: $form['name'] = array('#type' => 'textfield', '#title' => t('Username'), '#size' => 60, '#maxlength' => USERNAME_MAX_LENGTH, '#required' => TRUE, ); $form['name']['#description'] = t('Enter your @s username.', array('@s' => variable_get('site_name', 'Drupal'))); $form['pass'] = array('#type' => 'password', '#title' => t('Password'), '#description' => t('Enter the password that accompanies your username.'), '#required' => TRUE, ); $form['#validate'] = user_login_default_validators(); $form['submit'] = array('#type' => 'submit', '#value' => t('Log in'), '#weight' => 2); return $form; } /** * Set up a series for validators which check for blocked users, * then authenticate against local database, then return an error if * authentication fails. Distributed authentication modules are welcome * to use hook_form_alter() to change this series in order to * authenticate against their user database instead of the local users * table. If a distributed authentication module is successful, it * should set $form_state['uid'] to a user ID. * * We use three validators instead of one since external authentication * modules usually only need to alter the second validator. * * @see user_login_name_validate() * @see user_login_authenticate_validate() * @see user_login_final_validate() * @return array * A simple list of validate functions. */ function user_login_default_validators() { return array('user_login_name_validate', 'user_login_authenticate_validate', 'user_login_final_validate'); } /** * A FAPI validate handler. Sets an error if supplied username has been blocked. */ function user_login_name_validate($form, &$form_state) { if (isset($form_state['values']['name']) && user_is_blocked($form_state['values']['name'])) { // Blocked in user administration. form_set_error('name', t('The username %name has not been activated or is blocked.', array('%name' => $form_state['values']['name']))); } } /** * A validate handler on the login form. Check supplied username/password * against local users table. If successful, $form_state['uid'] * is set to the matching user ID. */ function user_login_authenticate_validate($form, &$form_state) { $password = trim($form_state['values']['pass']); if (!empty($form_state['values']['name']) && !empty($password)) { // Do not allow any login from the current user's IP if the limit has been // reached. Default is 50 failed attempts allowed in one hour. This is // independent of the per-user limit to catch attempts from one IP to log // in to many different user accounts. We have a reasonably high limit // since there may be only one apparent IP for all users at an institution. if (!flood_is_allowed('failed_login_attempt_ip', variable_get('user_failed_login_ip_limit', 50), variable_get('user_failed_login_ip_window', 3600))) { $form_state['flood_control_triggered'] = 'ip'; return; } $account = db_query("SELECT * FROM {users} WHERE name = :name AND status = 1", array(':name' => $form_state['values']['name']))->fetchObject(); if ($account) { if (variable_get('user_failed_login_identifier_uid_only', FALSE)) { // Register flood events based on the uid only, so they apply for any // IP address. This is the most secure option. $identifier = $account->uid; } else { // The default identifier is a combination of uid and IP address. This // is less secure but more resistant to denial-of-service attacks that // could lock out all users with public user names. $identifier = $account->uid . '-' . ip_address(); } $form_state['flood_control_user_identifier'] = $identifier; // Don't allow login if the limit for this user has been reached. // Default is to allow 5 failed attempts every 6 hours. if (!flood_is_allowed('failed_login_attempt_user', variable_get('user_failed_login_user_limit', 5), variable_get('user_failed_login_user_window', 21600), $identifier)) { $form_state['flood_control_triggered'] = 'user'; return; } } // We are not limited by flood control, so try to authenticate. // Set $form_state['uid'] as a flag for user_login_final_validate(). $form_state['uid'] = user_authenticate($form_state['values']['name'], $password); } } /** * The final validation handler on the login form. * * Sets a form error if user has not been authenticated, or if too many * logins have been attempted. This validation function should always * be the last one. */ function user_login_final_validate($form, &$form_state) { if (empty($form_state['uid'])) { // Always register an IP-based failed login event. flood_register_event('failed_login_attempt_ip'); // Register a per-user failed login event. if (isset($form_state['flood_control_user_identifier'])) { flood_register_event('failed_login_attempt_user', $form_state['flood_control_user_identifier']); } if (isset($form_state['flood_control_triggered'])) { if ($form_state['flood_control_triggered'] == 'user') { form_set_error('name', format_plural(variable_get('user_failed_login_user_limit', 5), 'Sorry, there has been more than one failed login attempt for this account. It is temporarily blocked. Please try again later, or request a new password.', 'Sorry, there have been more than @count failed login attempts for this account. It is temporarily blocked. Please try again later, or request a new password.', array('@url' => url('user/password')))); } else { // We did not find a uid, so the limit is IP-based. form_set_error('name', t('Sorry, too many failed login attempts from your IP address. This IP address is temporarily blocked. Please try again later, or request a new password.', array('@url' => url('user/password')))); } } else { form_set_error('name', t('Sorry, unrecognized username or password. Have you forgotten your password?', array('@password' => url('user/password')))); watchdog('user', 'Login attempt failed for %user.', array('%user' => $form_state['values']['name'])); } } elseif (isset($form_state['flood_control_user_identifier'])) { // Clear past failures for this user so as not to block a user who might // log in and out more than once in an hour. flood_clear_event('failed_login_attempt_user', $form_state['flood_control_user_identifier']); } } /** * Try to validate the user's login credentials locally. * * @param $name * User name to authenticate. * @param $password * A plain-text password, such as trimmed text from form values. * @return * The user's uid on success, or FALSE on failure to authenticate. */ function user_authenticate($name, $password) { $uid = FALSE; if (!empty($name) && !empty($password)) { $account = db_query("SELECT * FROM {users} WHERE name = :name AND status = 1", array(':name' => $name))->fetchObject(); if ($account) { // Allow alternate password hashing schemes. require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc'); if (user_check_password($password, $account)) { // Successful authentication. $uid = $account->uid; // Update user to new password scheme if needed. if (user_needs_new_hash($account)) { $new_hash = user_hash_password($password); if ($new_hash) { db_update('users') ->fields(array('pass' => $new_hash)) ->condition('uid', $account->uid) ->execute(); } } } } } return $uid; } /** * Finalize the login process. Must be called when logging in a user. * * The function records a watchdog message about the new session, saves the * login timestamp, calls hook_user op 'login' and generates a new session. * */ function user_login_finalize(&$edit = array()) { global $user; watchdog('user', 'Session opened for %name.', array('%name' => $user->name)); // Update the user table timestamp noting user has logged in. // This is also used to invalidate one-time login links. $user->login = REQUEST_TIME; db_update('users') ->fields(array('login' => $user->login)) ->condition('uid', $user->uid) ->execute(); // Regenerate the session ID to prevent against session fixation attacks. // This is called before hook_user in case one of those functions fails // or incorrectly does a redirect which would leave the old session in place. drupal_session_regenerate(); user_module_invoke('login', $edit, $user); } /** * Submit handler for the login form. Load $user object and perform standard login * tasks. The user is then redirected to the My Account page. Setting the * destination in the query string overrides the redirect. */ function user_login_submit($form, &$form_state) { global $user; $user = user_load($form_state['uid']); user_login_finalize(); $form_state['redirect'] = 'user/' . $user->uid; } /** * Helper function for authentication modules. Either logs in or registers * the current user, based on username. Either way, the global $user object is * populated and login tasks are performed. */ function user_external_login_register($name, $module) { $account = user_load_by_name($name); if (!$account->uid) { // Register this new user. $userinfo = array( 'name' => $name, 'pass' => user_password(), 'init' => $name, 'status' => 1, 'access' => REQUEST_TIME ); $account = user_save('', $userinfo); // Terminate if an error occurred during user_save(). if (!$account) { drupal_set_message(t("Error saving user account."), 'error'); return; } user_set_authmaps($account, array("authname_$module" => $name)); } // Log user in. $form_state['uid'] = $account->uid; user_login_submit(array(), $form_state); } function user_pass_reset_url($account) { $timestamp = REQUEST_TIME; return url("user/reset/$account->uid/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login), array('absolute' => TRUE)); } /** * Generate a URL to confirm an account cancellation request. * * @see user_mail_tokens() * @see user_cancel_confirm() */ function user_cancel_url($account) { $timestamp = REQUEST_TIME; return url("user/$account->uid/cancel/confirm/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login), array('absolute' => TRUE)); } function user_pass_rehash($password, $timestamp, $login) { return md5($timestamp . $password . $login); } function user_edit_form(&$form_state, $uid, $edit, $register = FALSE) { _user_password_dynamic_validation(); $admin = user_access('administer users'); $form = array(); // Account information: $form['account'] = array('#type' => 'fieldset', '#title' => t('Account information'), '#weight' => -10, ); // Only show name field when: registration page; or user is editing own account and can change username; or an admin user. if ($register || ($GLOBALS['user']->uid == $uid && user_access('change own username')) || $admin) { $form['account']['name'] = array('#type' => 'textfield', '#title' => t('Username'), '#default_value' => $edit['name'], '#maxlength' => USERNAME_MAX_LENGTH, '#description' => t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'), '#required' => TRUE, '#attributes' => array('class' => 'username'), ); } $form['account']['mail'] = array('#type' => 'textfield', '#title' => t('E-mail address'), '#default_value' => $edit['mail'], '#maxlength' => EMAIL_MAX_LENGTH, '#description' => t('A valid e-mail address. All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail.'), '#required' => TRUE, ); if (!$register) { $form['account']['pass'] = array('#type' => 'password_confirm', '#description' => t('To change the current user password, enter the new password in both fields.'), '#size' => 25, ); } elseif (!variable_get('user_email_verification', TRUE) || $admin) { $form['account']['pass'] = array( '#type' => 'password_confirm', '#description' => t('Provide a password for the new account in both fields.'), '#required' => TRUE, '#size' => 25, ); } if ($admin) { $form['account']['status'] = array( '#type' => 'radios', '#title' => t('Status'), '#default_value' => isset($edit['status']) ? $edit['status'] : 1, '#options' => array(t('Blocked'), t('Active')) ); } if (user_access('administer permissions')) { $roles = user_roles(TRUE); // The disabled checkbox subelement for the 'authenticated user' role // must be generated separately and added to the checkboxes element, // because of a limitation in D6 FormAPI not supporting a single disabled // checkbox within a set of checkboxes. // TODO: This should be solved more elegantly. See issue #119038. $checkbox_authenticated = array( '#type' => 'checkbox', '#title' => $roles[DRUPAL_AUTHENTICATED_RID], '#default_value' => TRUE, '#disabled' => TRUE, ); unset($roles[DRUPAL_AUTHENTICATED_RID]); if ($roles) { $default = empty($edit['roles']) ? array() : array_keys($edit['roles']); $form['account']['roles'] = array( '#type' => 'checkboxes', '#title' => t('Roles'), '#default_value' => $default, '#options' => $roles, DRUPAL_AUTHENTICATED_RID => $checkbox_authenticated, ); } } // Signature: if (variable_get('user_signatures', 0) && module_exists('comment') && !$register) { $form['signature_settings'] = array( '#type' => 'fieldset', '#title' => t('Signature settings'), '#weight' => 1, ); $form['signature_settings']['signature'] = array( '#type' => 'textarea', '#title' => t('Signature'), '#default_value' => $edit['signature'], '#description' => t('Your signature will be publicly displayed at the end of your comments.'), ); } // Picture/avatar: if (variable_get('user_pictures', 0) && !$register) { $form['picture'] = array( '#type' => 'fieldset', '#title' => t('Picture'), '#weight' => 1, ); $form['picture']['picture'] = array( '#type' => 'value', '#value' => $edit['picture'], ); $form['picture']['picture_current'] = array( '#markup' => theme('user_picture', (object)$edit), ); $form['picture']['picture_delete'] = array( '#type' => 'checkbox', '#title' => t('Delete picture'), '#access' => !empty($edit['picture']->fid), '#description' => t('Check this box to delete your current picture.'), ); $form['picture']['picture_upload'] = array( '#type' => 'file', '#title' => t('Upload picture'), '#size' => 48, '#description' => t('Your virtual face or picture. Maximum dimensions are %dimensions pixels and the maximum size is %size kB.', array('%dimensions' => variable_get('user_picture_dimensions', '85x85'), '%size' => variable_get('user_picture_file_size', '30'))) . ' ' . variable_get('user_picture_guidelines', ''), ); $form['#validate'][] = 'user_validate_picture'; } $form['#uid'] = $uid; return $form; } /** * Cancel a user account. * * Since the user cancellation process needs to be run in a batch, either * Form API will invoke it, or batch_process() needs to be invoked after calling * this function and should define the path to redirect to. * * @param $edit * An array of submitted form values. * @param $uid * The user ID of the user account to cancel. * @param $method * The account cancellation method to use. * * @see _user_cancel() */ function user_cancel($edit, $uid, $method) { global $user; $account = user_load($uid); if (!$account) { drupal_set_message(t('The user account %id does not exist.', array('%id' => $uid)), 'error'); watchdog('user', 'Attempted to cancel non-existing user account: %id.', array('%id' => $uid), WATCHDOG_ERROR); return; } // Initialize batch (to set title). $batch = array( 'title' => t('Cancelling account'), 'operations' => array(), ); batch_set($batch); // Allow modules to add further sets to this batch. module_invoke_all('user_cancel', $edit, $account, $method); // Finish the batch and actually cancel the account. $batch = array( 'title' => t('Cancelling user account'), 'operations' => array( array('_user_cancel', array($edit, $account, $method)), ), ); batch_set($batch); // Batch processing is either handled via Form API or has to be invoked // manually. } /** * Last batch processing step for cancelling a user account. * * Since batch and session API require a valid user account, the actual * cancellation of a user account needs to happen last. * * @see user_cancel() */ function _user_cancel($edit, $account, $method) { global $user; switch ($method) { case 'user_cancel_block': case 'user_cancel_block_unpublish': default: // Send account blocked notification if option was checked. if (!empty($edit['user_cancel_notify'])) { _user_mail_notify('status_blocked', $account); } db_update('users') ->fields(array('status' => 0)) ->condition('uid', $account->uid) ->execute(); drupal_set_message(t('%name has been disabled.', array('%name' => $account->name))); watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE); break; case 'user_cancel_reassign': case 'user_cancel_delete': // Send account canceled notification if option was checked. if (!empty($edit['user_cancel_notify'])) { _user_mail_notify('status_canceled', $account); } db_delete('users') ->condition('uid', $account->uid) ->execute(); db_delete('users_roles') ->condition('uid', $account->uid) ->execute(); db_delete('authmap') ->condition('uid', $account->uid) ->execute(); drupal_set_message(t('%name has been deleted.', array('%name' => $account->name))); watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE); break; } // After cancelling account, ensure that user is logged out. if ($account->uid == $user->uid) { // Destroy the current session, and reset $user to the anonymous user. session_destroy(); } else { drupal_session_destroy_uid($account->uid); } // Clear the cache for anonymous users. cache_clear_all(); } /** * Builds a structured array representing the profile content. * * @param $account * A user object. * * @return * A structured array containing the individual elements of the profile. */ function user_build_content($account) { $account->content = array(); // Build fields content. // TODO D7 : figure out where exactly this needs to go $account->content += field_attach_view('user', $account); module_invoke_all('user_view', $account); return $account->content; } /** * Implement hook_mail(). */ function user_mail($key, &$message, $params) { $language = $message['language']; $variables = user_mail_tokens($params['account'], $language); $message['subject'] .= _user_mail_text($key . '_subject', $language, $variables); $message['body'][] = _user_mail_text($key . '_body', $language, $variables); } /** * Returns a mail string for a variable name. * * Used by user_mail() and the settings forms to retrieve strings. */ function _user_mail_text($key, $language = NULL, $variables = array()) { $langcode = isset($language) ? $language->language : NULL; if ($admin_setting = variable_get('user_mail_' . $key, FALSE)) { // An admin setting overrides the default string. return strtr($admin_setting, $variables); } else { // No override, return default string. switch ($key) { case 'register_no_approval_required_subject': return t('Account details for !username at !site', $variables, array('langcode' => $langcode)); case 'register_no_approval_required_body': return t("!username,\n\nThank you for registering at !site. You may now log in to !login_uri using the following username and password:\n\nusername: !username\npassword: !password\n\nYou may also log in by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.\n\n\n-- !site team", $variables, array('langcode' => $langcode)); case 'register_admin_created_subject': return t('An administrator created an account for you at !site', $variables, array('langcode' => $langcode)); case 'register_admin_created_body': return t("!username,\n\nA site administrator at !site has created an account for you. You may now log in to !login_uri using the following username and password:\n\nusername: !username\npassword: !password\n\nYou may also log in by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.\n\n\n-- !site team", $variables, array('langcode' => $langcode)); case 'register_pending_approval_subject': case 'register_pending_approval_admin_subject': return t('Account details for !username at !site (pending admin approval)', $variables, array('langcode' => $langcode)); case 'register_pending_approval_body': return t("!username,\n\nThank you for registering at !site. Your application for an account is currently pending approval. Once it has been approved, you will receive another e-mail containing information about how to log in, set your password, and other details.\n\n\n-- !site team", $variables, array('langcode' => $langcode)); case 'register_pending_approval_admin_body': return t("!username has applied for an account.\n\n!edit_uri", $variables, array('langcode' => $langcode)); case 'password_reset_subject': return t('Replacement login information for !username at !site', $variables, array('langcode' => $langcode)); case 'password_reset_body': return t("!username,\n\nA request to reset the password for your account has been made at !site.\n\nYou may now log in to !uri_brief by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once. It expires after one day and nothing will happen if it's not used.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.", $variables, array('langcode' => $langcode)); case 'status_activated_subject': return t('Account details for !username at !site (approved)', $variables, array('langcode' => $langcode)); case 'status_activated_body': return t("!username,\n\nYour account at !site has been activated.\n\nYou may now log in by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.\n\nOnce you have set your own password, you will be able to log in to !login_uri in the future using:\n\nusername: !username\n", $variables, array('langcode' => $langcode)); case 'status_blocked_subject': return t('Account details for !username at !site (blocked)', $variables, array('langcode' => $langcode)); case 'status_blocked_body': return t("!username,\n\nYour account on !site has been blocked.", $variables, array('langcode' => $langcode)); case 'cancel_confirm_subject': return t('Account cancellation request for !username at !site', $variables, array('langcode' => $langcode)); case 'cancel_confirm_body': return t("!username, A request to cancel your account has been made at !site. You may now cancel your account on !uri_brief by clicking this link or copying and pasting it into your browser: !cancel_url NOTE: The cancellation of your account is not reversible. This link expires in one day and nothing will happen if it is not used.", $variables, array('langcode' => $langcode)); case 'status_canceled_subject': return t('Account details for !username at !site (canceled)', $variables, array('langcode' => $langcode)); case 'status_canceled_body': return t("!username, Your account on !site has been canceled.", $variables, array('langcode' => $langcode)); } } } /*** Administrative features ***********************************************/ /** * Retrieve an array of roles matching specified conditions. * * @param $membersonly * Set this to TRUE to exclude the 'anonymous' role. * @param $permission * A string containing a permission. If set, only roles containing that * permission are returned. * * @return * An associative array with the role id as the key and the role name as * value. */ function user_roles($membersonly = FALSE, $permission = NULL) { // System roles take the first two positions. $roles = array( DRUPAL_ANONYMOUS_RID => NULL, DRUPAL_AUTHENTICATED_RID => NULL, ); if (!empty($permission)) { $result = db_query("SELECT r.* FROM {role} r INNER JOIN {role_permission} p ON r.rid = p.rid WHERE p.permission = :permission ORDER BY r.name", array(':permission' => $permission)); } else { $result = db_query('SELECT * FROM {role} ORDER BY name'); } foreach ($result as $role) { switch ($role->rid) { // We only translate the built in role names case DRUPAL_ANONYMOUS_RID: if (!$membersonly) { $roles[$role->rid] = t($role->name); } break; case DRUPAL_AUTHENTICATED_RID: $roles[$role->rid] = t($role->name); break; default: $roles[$role->rid] = $role->name; } } // Filter to remove unmatched system roles. return array_filter($roles); } /** * Implement hook_user_operations(). */ function user_user_operations($form_state = array()) { $operations = array( 'unblock' => array( 'label' => t('Unblock the selected users'), 'callback' => 'user_user_operations_unblock', ), 'block' => array( 'label' => t('Block the selected users'), 'callback' => 'user_user_operations_block', ), 'cancel' => array( 'label' => t('Cancel the selected user accounts'), ), ); if (user_access('administer permissions')) { $roles = user_roles(TRUE); unset($roles[DRUPAL_AUTHENTICATED_RID]); // Can't edit authenticated role. $add_roles = array(); foreach ($roles as $key => $value) { $add_roles['add_role-' . $key] = $value; } $remove_roles = array(); foreach ($roles as $key => $value) { $remove_roles['remove_role-' . $key] = $value; } if (count($roles)) { $role_operations = array( t('Add a role to the selected users') => array( 'label' => $add_roles, ), t('Remove a role from the selected users') => array( 'label' => $remove_roles, ), ); $operations += $role_operations; } } // If the form has been posted, we need to insert the proper data for // role editing if necessary. if (!empty($form_state['submitted'])) { $operation_rid = explode('-', $form_state['values']['operation']); $operation = $operation_rid[0]; if ($operation == 'add_role' || $operation == 'remove_role') { $rid = $operation_rid[1]; if (user_access('administer permissions')) { $operations[$form_state['values']['operation']] = array( 'callback' => 'user_multiple_role_edit', 'callback arguments' => array($operation, $rid), ); } else { watchdog('security', 'Detected malicious attempt to alter protected user fields.', array(), WATCHDOG_WARNING); return; } } } return $operations; } /** * Callback function for admin mass unblocking users. */ function user_user_operations_unblock($accounts) { foreach ($accounts as $uid) { $account = user_load($uid); // Skip unblocking user if they are already unblocked. if ($account !== FALSE && $account->status == 0) { user_save($account, array('status' => 1)); } } } /** * Callback function for admin mass blocking users. */ function user_user_operations_block($accounts) { foreach ($accounts as $uid) { $account = user_load($uid); // Skip blocking user if they are already blocked. if ($account !== FALSE && $account->status == 1) { user_save($account, array('status' => 0)); } } } /** * Callback function for admin mass adding/deleting a user role. */ function user_multiple_role_edit($accounts, $operation, $rid) { // The role name is not necessary as user_save() will reload the user // object, but some modules' hook_user() may look at this first. $role_name = db_query('SELECT name FROM {role} WHERE rid = :rid', array(':rid' => $rid))->fetchField(); switch ($operation) { case 'add_role': foreach ($accounts as $uid) { $account = user_load($uid); // Skip adding the role to the user if they already have it. if ($account !== FALSE && !isset($account->roles[$rid])) { $roles = $account->roles + array($rid => $role_name); user_save($account, array('roles' => $roles)); } } break; case 'remove_role': foreach ($accounts as $uid) { $account = user_load($uid); // Skip removing the role from the user if they already don't have it. if ($account !== FALSE && isset($account->roles[$rid])) { $roles = array_diff($account->roles, array($rid => $role_name)); user_save($account, array('roles' => $roles)); } } break; } } function user_multiple_cancel_confirm(&$form_state) { $edit = $form_state['input']; $form['accounts'] = array('#prefix' => '', '#tree' => TRUE); // array_filter() returns only elements with TRUE values. foreach (array_filter($edit['accounts']) as $uid => $value) { $user = db_query('SELECT name FROM {users} WHERE uid = :uid', array(':uid' => $uid))->fetchField(); $form['accounts'][$uid] = array('#type' => 'hidden', '#value' => $uid, '#prefix' => '
  • ', '#suffix' => check_plain($user) . "
  • \n"); } $form['operation'] = array('#type' => 'hidden', '#value' => 'cancel'); module_load_include('inc', 'user', 'user.pages'); $form['user_cancel_method'] = array( '#type' => 'item', '#title' => t('When cancelling these accounts'), ); $form['user_cancel_method'] += user_cancel_methods(); // Remove method descriptions. foreach (element_children($form['user_cancel_method']) as $element) { unset($form['user_cancel_method'][$element]['#description']); } // Allow to send the account cancellation confirmation mail. $form['user_cancel_confirm'] = array( '#type' => 'checkbox', '#title' => t('Require e-mail confirmation to cancel account.'), '#default_value' => FALSE, '#description' => t('When enabled, the user must confirm the account cancellation via e-mail.'), ); // Also allow to send account canceled notification mail, if enabled. $form['user_cancel_notify'] = array( '#type' => 'checkbox', '#title' => t('Notify user when account is canceled.'), '#default_value' => FALSE, '#access' => variable_get('user_mail_status_canceled_notify', FALSE), '#description' => t('When enabled, the user will receive an e-mail notification after the account has been cancelled.'), ); return confirm_form($form, t('Are you sure you want to cancel these user accounts?'), 'admin/people', t('This action cannot be undone.'), t('Cancel accounts'), t('Cancel')); } /** * Submit handler for mass-account cancellation form. * * @see user_multiple_cancel_confirm() * @see user_cancel_confirm_form_submit() */ function user_multiple_cancel_confirm_submit($form, &$form_state) { global $user; if ($form_state['values']['confirm']) { foreach ($form_state['values']['accounts'] as $uid => $value) { // Prevent user administrators from deleting themselves without confirmation. if ($uid == $user->uid) { $admin_form_state = $form_state; unset($admin_form_state['values']['user_cancel_confirm']); $admin_form_state['values']['_account'] = $user; user_cancel_confirm_form_submit(array(), $admin_form_state); } else { user_cancel($form_state['values'], $uid, $form_state['values']['user_cancel_method']); } } } $form_state['redirect'] = 'admin/people'; return; } /** * Implement hook_help(). */ function user_help($path, $arg) { global $user; switch ($path) { case 'admin/help#user': $output = '

    ' . t('The user module allows users to register, login, and log out. Users benefit from being able to sign on because it associates content they create with their account and allows various permissions to be set for their roles. The user module supports user roles which establish fine grained permissions allowing each role to do only what the administrator wants them to. Each user is assigned to one or more roles. By default there are two roles anonymous - a user who has not logged in, and authenticated a user who has signed up and who has been authorized.') . '

    '; $output .= '

    ' . t("Users can use their own name or handle and can specify personal configuration settings through their individual My account page. Users must authenticate by supplying a local username and password or through their OpenID, an optional and secure method for logging into many websites with a single username and password. In some configurations, users may authenticate using a username and password from another Drupal site, or through some other site-specific mechanism.") . '

    '; $output .= '

    ' . t('A visitor accessing your website is assigned a unique ID, or session ID, which is stored in a cookie. The cookie does not contain personal information, but acts as a key to retrieve information from your site. Users should have cookies enabled in their web browser when using your site.') . '

    '; $output .= '

    ' . t('For more information, see the online handbook entry for User module.', array('@user' => 'http://drupal.org/handbook/modules/user/')) . '

    '; return $output; case 'admin/people/create': return '

    ' . t("This web page allows administrators to register new users. Users' e-mail addresses and usernames must be unique.") . '

    '; case 'admin/settings/permissions': return '

    ' . t('Permissions let you control what users can do and see on your site. You can define a specific set of permissions for each role. (See the Roles page to create a role). Two important roles to consider are Authenticated Users and Administrators. Any permissions granted to the Authenticated Users role will be given to any user who can log into your site. You can make any role the Administrator role for the site, meaning this will be granted all new permissions automatically. You can do this on the User Settings page. You should be careful to ensure that only trusted users are given this access and level of control of your site.', array('@role' => url('admin/settings/roles'), '@settings' => url('admin/settings/user'))) . '

    '; case 'admin/settings/roles': return t('

    Roles allow you to fine tune the security and administration of Drupal. A role defines a group of users that have certain privileges as defined in user permissions. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the role names of the various roles. To delete a role choose "edit".

    By default, Drupal comes with two user roles:

    ', array('@permissions' => url('admin/settings/permissions'))); case 'admin/people/search': return '

    ' . t('Enter a simple pattern ("*" may be used as a wildcard match) to search for a username or e-mail address. For example, one may search for "br" and Drupal might return "brian", "brad", and "brenda@example.com".') . '

    '; } } /** * Retrieve a list of all user setting/information categories and sort them by weight. */ function _user_categories() { $categories = module_invoke_all('user_categories'); usort($categories, '_user_sort'); return $categories; } function _user_sort($a, $b) { $a = (array)$a + array('weight' => 0, 'title' => ''); $b = (array)$b + array('weight' => 0, 'title' => ''); return $a['weight'] < $b['weight'] ? -1 : ($a['weight'] > $b['weight'] ? 1 : ($a['title'] < $b['title'] ? -1 : 1)); } /** * List user administration filters that can be applied. */ function user_filters() { // Regular filters $filters = array(); $roles = user_roles(TRUE); unset($roles[DRUPAL_AUTHENTICATED_RID]); // Don't list authorized role. if (count($roles)) { $filters['role'] = array( 'title' => t('role'), 'field' => 'ur.rid', 'options' => $roles, ); } $options = array(); foreach (module_implements('permission') as $module) { $function = $module . '_permission'; if ($permissions = $function('permission')) { asort($permissions); foreach ($permissions as $permission => $description) { $options[t('@module module', array('@module' => $module))][$permission] = t($permission); } } } ksort($options); $filters['permission'] = array( 'title' => t('permission'), 'options' => $options, ); $filters['status'] = array( 'title' => t('status'), 'field' => 'u.status', 'options' => array(1 => t('active'), 0 => t('blocked')), ); return $filters; } /** * Extends a query object for user administration filters based on session. * * @param $query * Query object that should be filtered. */ function user_build_filter_query(SelectQuery $query) { $filters = user_filters(); // Extend Query with filter conditions. foreach (isset($_SESSION['user_overview_filter']) ? $_SESSION['user_overview_filter'] : array() as $filter) { list($key, $value) = $filter; // This checks to see if this permission filter is an enabled permission for // the authenticated role. If so, then all users would be listed, and we can // skip adding it to the filter query. if ($key == 'permission') { $account = new stdClass(); $account->uid = 'user_filter'; $account->roles = array(DRUPAL_AUTHENTICATED_RID => 1); if (user_access($value, $account)) { continue; } $query->leftJoin('role_permission', 'p', 'ur.rid = p.rid'); $query->condition(db_or()->condition('u.uid', 1)->condition('p.permission', $value)); } else { $query->condition($filters[$key]['field'], $value); } } } /** * Implement hook_forms(). */ function user_forms() { $forms['user_admin_access_add_form']['callback'] = 'user_admin_access_form'; $forms['user_admin_access_edit_form']['callback'] = 'user_admin_access_form'; $forms['user_admin_new_role']['callback'] = 'user_admin_role'; return $forms; } /** * Implement hook_comment_view(). */ function user_comment_view($comment) { if (variable_get('user_signatures', 0) && !empty($comment->signature)) { $comment->signature = check_markup($comment->signature, $comment->format); } else { $comment->signature = ''; } } /** * Theme output of user signature. * * @ingroup themeable */ function theme_user_signature($signature) { $output = ''; if ($signature) { $output .= '
    '; $output .= '
    '; $output .= $signature; $output .= '
    '; } return $output; } /** * Return an array of token to value mappings for user e-mail messages. * * @param $account * The user object of the account being notified. Must contain at * least the fields 'uid', 'name', and 'mail'. * @param $language * Language object to generate the tokens with. * @return * Array of mappings from token names to values (for use with strtr()). */ function user_mail_tokens($account, $language) { global $base_url; $tokens = array( '!username' => $account->name, '!site' => variable_get('site_name', 'Drupal'), '!login_url' => user_pass_reset_url($account), '!cancel_url' => user_cancel_url($account), '!uri' => $base_url, '!uri_brief' => preg_replace('!^https?://!', '', $base_url), '!mailto' => $account->mail, '!date' => format_date(REQUEST_TIME, 'medium', '', NULL, $language->language), '!login_uri' => url('user', array('absolute' => TRUE, 'language' => $language)), '!edit_uri' => url('user/' . $account->uid . '/edit', array('absolute' => TRUE, 'language' => $language)), ); if (!empty($account->password)) { $tokens['!password'] = $account->password; } return $tokens; } /** * Get the language object preferred by the user. This user preference can * be set on the user account editing page, and is only available if there * are more than one languages enabled on the site. If the user did not * choose a preferred language, or is the anonymous user, the $default * value, or if it is not set, the site default language will be returned. * * @param $account * User account to look up language for. * @param $default * Optional default language object to return if the account * has no valid language. */ function user_preferred_language($account, $default = NULL) { $language_list = language_list(); if ($account->language && isset($language_list[$account->language])) { return $language_list[$account->language]; } else { return $default ? $default : language_default(); } } /** * Conditionally create and send a notification email when a certain * operation happens on the given user account. * * @see user_mail_tokens() * @see drupal_mail() * * @param $op * The operation being performed on the account. Possible values: * 'register_admin_created': Welcome message for user created by the admin * 'register_no_approval_required': Welcome message when user self-registers * 'register_pending_approval': Welcome message, user pending admin approval * 'password_reset': Password recovery request * 'status_activated': Account activated * 'status_blocked': Account blocked * 'cancel_confirm': Account cancellation request * 'status_canceled': Account canceled * * @param $account * The user object of the account being notified. Must contain at * least the fields 'uid', 'name', and 'mail'. * @param $language * Optional language to use for the notification, overriding account language. * @return * The return value from drupal_mail_send(), if ends up being called. */ function _user_mail_notify($op, $account, $language = NULL) { // By default, we always notify except for canceled and blocked. $default_notify = ($op != 'status_canceled' && $op != 'status_blocked'); $notify = variable_get('user_mail_' . $op . '_notify', $default_notify); if ($notify) { $params['account'] = $account; $language = $language ? $language : user_preferred_language($account); $mail = drupal_mail('user', $op, $account->mail, $language, $params); if ($op == 'register_pending_approval') { // If a user registered requiring admin approval, notify the admin, too. // We use the site default language for this. drupal_mail('user', 'register_pending_approval_admin', variable_get('site_mail', ini_get('sendmail_from')), language_default(), $params); } } return empty($mail) ? NULL : $mail['result']; } /** * Add javascript and string translations for dynamic password validation * (strength and confirmation checking). * * This is an internal function that makes it easier to manage the translation * strings that need to be passed to the javascript code. */ function _user_password_dynamic_validation() { static $complete = FALSE; global $user; // Only need to do once per page. if (!$complete) { drupal_add_js(drupal_get_path('module', 'user') . '/user.js'); drupal_add_js(array( 'password' => array( 'strengthTitle' => t('Password strength:'), 'hasWeaknesses' => t('To make your password stronger:'), 'tooShort' => t('Make it at least 6 characters'), 'addLowerCase' => t('Add lowercase letters'), 'addUpperCase' => t('Add uppercase letters'), 'addNumbers' => t('Add numbers'), 'addPunctuation' => t('Add punctuation'), 'sameAsUsername' => t('Make it different from your username'), 'confirmSuccess' => t('yes'), 'confirmFailure' => t('no'), 'confirmTitle' => t('Passwords match:'), 'username' => (isset($user->name) ? $user->name : ''))), 'setting'); $complete = TRUE; } } /** * Implementation of hook_node_load(). */ function user_node_load($nodes, $types) { // Build an array of all uids for node authors, keyed by nid. $uids = array(); foreach ($nodes as $nid => $node) { $uids[$nid] = $node->uid; } // Fetch name, picture, and data for these users. $user_fields = db_query("SELECT uid, name, picture, data FROM {users} WHERE uid IN (:uids)", array(':uids' => $uids))->fetchAllAssoc('uid'); // Add these values back into the node objects. foreach ($uids as $nid => $uid) { $nodes[$nid]->name = $user_fields[$uid]->name; $nodes[$nid]->picture = $user_fields[$uid]->picture; $nodes[$nid]->data = $user_fields[$uid]->data; } } /** * Implement hook_image_style_delete(). */ function user_image_style_delete($style) { // If a style is deleted, update the variables. // Administrators choose a replacement style when deleting. user_image_style_save($style); } /** * Implement hook_image_style_save(). */ function user_image_style_save($style) { // If a style is renamed, update the variables that use it. if (isset($style['old_name']) && $style['old_name'] == variable_get('user_picture_style', '')) { variable_set('user_picture_style', $style['name']); } } /** * Implement hook_hook_info(). */ function user_hook_info() { return array( 'user' => array( 'user' => array( 'insert' => array( 'runs when' => t('After a user account has been created'), ), 'update' => array( 'runs when' => t("After a user's profile has been updated"), ), 'delete' => array( 'runs when' => t('After a user has been deleted') ), 'login' => array( 'runs when' => t('After a user has logged in') ), 'logout' => array( 'runs when' => t('After a user has logged out') ), 'view' => array( 'runs when' => t("When a user's profile is being viewed") ), ), ), ); } /** * Implement hook_action_info(). */ function user_action_info() { return array( 'user_block_user_action' => array( 'description' => t('Block current user'), 'type' => 'user', 'configurable' => FALSE, 'hooks' => array(), ), ); } /** * Implement a Drupal action. * Blocks the current user. */ function user_block_user_action(&$object, $context = array()) { if (isset($object->uid)) { $uid = $object->uid; } elseif (isset($context['uid'])) { $uid = $context['uid']; } else { global $user; $uid = $user->uid; } db_update('users') ->fields(array('status' => 0)) ->condition('uid', $uid) ->execute(); drupal_session_destroy_uid($uid); watchdog('action', 'Blocked user %name.', array('%name' => $user->name)); } /** * Submit handler for the user registration form. * * This function is shared by the installation form and the normal registration form, * which is why it can't be in the user.pages.inc file. */ function user_register_submit($form, &$form_state) { global $base_url; $admin = user_access('administer users'); $mail = $form_state['values']['mail']; $name = $form_state['values']['name']; if (!variable_get('user_email_verification', TRUE) || $admin) { $pass = $form_state['values']['pass']; } else { $pass = user_password(); }; $notify = isset($form_state['values']['notify']) ? $form_state['values']['notify'] : NULL; $from = variable_get('site_mail', ini_get('sendmail_from')); if (isset($form_state['values']['roles'])) { // Remove unset roles. $roles = array_filter($form_state['values']['roles']); } else { $roles = array(); } if (!$admin && array_intersect(array_keys($form_state['values']), array('uid', 'roles', 'init', 'session', 'status'))) { watchdog('security', 'Detected malicious attempt to alter protected user fields.', array(), WATCHDOG_WARNING); $form_state['redirect'] = 'user/register'; return; } // The unset below is needed to prevent these form values from being saved as // user data. unset($form_state['values']['form_token'], $form_state['values']['submit'], $form_state['values']['op'], $form_state['values']['notify'], $form_state['values']['form_id'], $form_state['values']['affiliates'], $form_state['values']['destination'], $form_state['values']['form_build_id']); $merge_data = array('pass' => $pass, 'init' => $mail, 'roles' => $roles); if (!$admin) { // Set the user's status because it was not displayed in the form. $merge_data['status'] = variable_get('user_register', 1) == 1; } $account = user_save('', array_merge($form_state['values'], $merge_data)); // 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' => $name, '%email' => $mail), WATCHDOG_NOTICE, l(t('edit'), 'user/' . $account->uid . '/edit')); // The first user may login immediately, and receives a customized welcome e-mail. if ($account->uid == 1) { drupal_set_message(t('Welcome to Drupal. You are now logged in as user #1, which gives you full control over your website.')); if (variable_get('user_email_verification', TRUE)) { drupal_set_message(t('

    Your password is %pass. You may change your password below.

    ', array('%pass' => $pass))); } $form_state['values'] += $merge_data; user_authenticate(array_merge($form_state)); $form_state['redirect'] = 'user/1/edit'; return; } else { // Add plain text password into user account to generate mail tokens. $account->password = $pass; if ($admin && !$notify) { drupal_set_message(t('Created a new user account for %name. No e-mail has been sent.', array('@url' => url("user/$account->uid"), '%name' => $account->name))); } elseif (!variable_get('user_email_verification', TRUE) && $account->status && !$admin) { // No e-mail verification is required, create new user account, and login // user immediately. _user_mail_notify('register_no_approval_required', $account); if (user_authenticate(array_merge($form_state['values'], $merge_data))) { drupal_set_message(t('Registration successful. You are now logged in.')); } $form_state['redirect'] = ''; return; } elseif ($account->status || $notify) { // Create new user account, no administrator approval required. $op = $notify ? 'register_admin_created' : 'register_no_approval_required'; _user_mail_notify($op, $account); if ($notify) { drupal_set_message(t('Password and further instructions have been e-mailed to the new user %name.', array('@url' => url("user/$account->uid"), '%name' => $account->name))); } else { drupal_set_message(t('Your password and further instructions have been sent to your e-mail address.')); $form_state['redirect'] = ''; return; } } else { // Create new user account, administrator approval required. _user_mail_notify('register_pending_approval', $account); drupal_set_message(t('Thank you for applying for an account. Your account is currently pending approval by the site administrator.
    In the meantime, a welcome message with further instructions has been sent to your e-mail address.')); $form_state['redirect'] = ''; return; } } } /** * Form builder; The user registration form. * * @ingroup forms * @see user_register_validate() * @see user_register_submit() */ function user_register() { global $user; $admin = user_access('administer users'); // If we aren't admin but already logged on, go to the user page instead. if (!$admin && $user->uid) { drupal_goto('user/' . $user->uid); } // Start with the default user edit fields. $form = user_edit_form($form_state, NULL, NULL, TRUE); if ($admin) { $form['account']['notify'] = array( '#type' => 'checkbox', '#title' => t('Notify user of new account') ); // Redirect back to page which initiated the create request; // usually admin/people/create. $form['destination'] = array('#type' => 'hidden', '#value' => $_GET['q']); } // Create a dummy variable for pass-by-reference parameters. $null = NULL; $extra = _user_forms($null, NULL, NULL, 'register'); if ($extra) { $form = array_merge_recursive($form, $extra); } // If the "account" fieldset is the only element at the top level, its // borders are hidden for aesthetic reasons. We do not remove the fieldset but // preserve the form structure so that modules implementing // hook_form_FORM_ID_alter() know where to find the basic elements. if (count(element_children($form)) == 1) { $form['account']['#type'] = 'markup'; } $form['submit'] = array('#type' => 'submit', '#value' => t('Create new account'), '#weight' => 30); $form['#validate'][] = 'user_register_validate'; return $form; } function user_register_validate($form, &$form_state) { user_module_invoke('validate', $form_state['values'], $form_state['values'], 'account'); } /** * Retrieve a list of all form elements for the specified category. */ function _user_forms(&$edit, $account, $category, $hook = 'form') { $groups = array(); foreach (module_implements('user_' . $hook) as $module) { $function = $module . '_user_' . $hook; if ($data = $function($edit, $account, $category)) { $groups = array_merge_recursive($data, $groups); } } uasort($groups, '_user_sort'); return empty($groups) ? FALSE : $groups; }