user.module

You are here

  1. 7 modules/user/user.module
  2. 4.6 modules/user.module
  3. 4.7 modules/user.module
  4. 5 modules/user/user.module
  5. 6 modules/user/user.module
  6. 8 core/modules/user/user.module

Enables the user registration and login system.

Functions

Namesort descending Description
template_preprocess_user_picture Process variables for user-picture.tpl.php.
theme_user_list Returns HTML for a list of users.
theme_user_signature Returns HTML for a user signature.
user_access Determine whether the user has a given privilege.
user_account_form Helper function to add default user account fields to user registration and edit form.
user_account_form_validate Form validation handler for user_account_form().
user_action_info Implements hook_action_info().
user_admin_paths Implements hook_admin_paths().
user_authenticate Try to validate the user's login credentials locally.
user_block_configure Implements hook_block_configure().
user_block_info Implements hook_block_info().
user_block_save Implements hook_block_save().
user_block_user_action Blocks a specific user or the current user, if one is not specified.
user_block_view Implements hook_block_view().
user_build_content Builds a structured array representing the profile content.
user_build_filter_query Extends a query object for user administration filters based on session.
user_cancel Cancel a user account.
user_cancel_access Menu access callback; limit access to account cancellation pages.
user_cancel_url Generates a URL to confirm an account cancellation request.
user_category_load Return a user object after checking if any profile category in the path exists.
user_comment_view Implements hook_comment_view().
user_cookie_delete Delete a visitor information cookie.
user_cookie_save Saves visitor information as a cookie so it can be reused.
user_delete Delete a user.
user_delete_multiple Delete multiple user accounts.
user_edit_access Access callback for user account editing.
user_element_info Implements hook_element_info().
user_entity_info Implements hook_entity_info().
user_external_load Fetches a user object based on an external authentication source.
user_external_login_register 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.
user_field_extra_fields Implements hook_field_extra_fields().
user_field_info_alter Implements hook_field_info_alter().
user_file_delete Implements hook_file_delete().
user_file_download Implements hook_file_download().
user_file_download_access Implements hook_file_download_access().
user_file_move Implements hook_file_move().
user_filters List user administration filters that can be applied.
user_form_field_ui_field_edit_form_alter Implements hook_form_FORM_ID_alter().
user_form_field_ui_field_edit_form_submit Additional submit handler for the 'Edit field instance' form.
user_form_process_password_confirm Form element process handler for client-side password validation.
user_get_authmaps Discover which external authentication module(s) authenticated a username.
user_help Implement hook_help().
user_image_style_delete Implements hook_image_style_delete().
user_image_style_save Implements hook_image_style_save().
user_is_anonymous Determines if the current user is anonymous.
user_is_blocked Checks for usernames blocked by user administration.
user_is_logged_in Determines if the current user is logged in.
user_load Loads a user object.
user_load_by_mail Fetch a user object by email address.
user_load_by_name Fetch a user object by account name.
user_load_multiple Load multiple users based on certain conditions.
user_login Form builder; the main user login form.
user_login_authenticate_validate 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.
user_login_block
user_login_default_validators 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…
user_login_destination Helper function to rewrite the destination to avoid redirecting to login page after login.
user_login_finalize Finalize the login process. Must be called when logging in a user.
user_login_final_validate The final validation handler on the login form.
user_login_name_validate A FAPI validate handler. Sets an error if supplied username has been blocked.
user_login_submit 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.
user_mail Implements hook_mail().
user_mail_tokens Token callback to add unsafe tokens for user mails.
user_menu Implements hook_menu().
user_menu_link_alter Implements hook_menu_link_alter().
user_menu_site_status_alter Implements hook_menu_site_status_alter().
user_menu_title Menu item title callback for the 'user' path.
user_modules_installed Implements hook_modules_installed().
user_modules_uninstalled Implements hook_modules_uninstalled().
user_module_invoke Invokes a user hook in every module.
user_multiple_cancel_confirm
user_multiple_cancel_confirm_submit Submit handler for mass-account cancellation form.
user_multiple_role_edit Callback function for admin mass adding/deleting a user role.
user_node_load Implements hook_node_load().
user_page_title Menu item title callback - use the user name.
user_password Generate a random alphanumeric password.
user_pass_rehash Creates a unique hash value for use in time-dependent per-user URLs.
user_pass_reset_url Generates a unique URL for a user to login and reset their password.
user_permission Implements hook_permission().
user_permission_get_modules Determine the modules that permissions belong to.
user_preferred_language 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…
user_rdf_mapping Implements hook_rdf_mapping().
user_register_access Determines if the current user has access to the user registration page.
user_register_form Form builder; the user registration form.
user_register_submit Submit handler for the user registration form.
user_register_validate Validation function for the user registration form.
user_roles Retrieve an array of roles matching specified conditions.
user_role_change_permissions Change permissions for a user role.
user_role_delete Delete a user role from database.
user_role_edit_access Menu access callback for user role editing.
user_role_grant_permissions Grant permissions to a user role.
user_role_load Fetches a user role by role ID.
user_role_load_by_name Fetches a user role by role name.
user_role_permissions Determine the permissions for one or more roles.
user_role_revoke_permissions Revoke permissions from a user role.
user_role_save Save a user role to the database.
user_save Save changes to a user account or add a new user.
user_search_access Implements hook_search_access().
user_search_execute Implements hook_search_execute().
user_search_info Implements hook_search_info().
user_set_authmaps Save mappings of which external authentication module(s) authenticated a user. Maps external usernames to user ids in the users table.
user_system_info_alter Implements hook_system_info_alter().
user_theme Implements hook_theme().
user_translated_menu_link_alter Implements hook_translated_menu_link_alter().
user_uid_only_optional_to_arg Returns $arg or the user ID of the current user if $arg is '%' or empty.
user_uid_optional_load Load either a specified or the current user account.
user_uid_optional_to_arg Returns $arg or the user ID of the current user if $arg is '%' or empty.
user_uri Implements callback_entity_info_uri().
user_user_categories Implements hook_user_categories().
user_user_operations Implements hook_user_operations().
user_user_operations_block Callback function for admin mass blocking users.
user_user_operations_unblock Callback function for admin mass unblocking users.
user_user_presave Implements hook_user_presave().
user_user_view Implements hook_user_view().
user_validate_current_pass Form validation handler for the current password on the user_account_form().
user_validate_mail Validates a user's email address.
user_validate_name Verify the syntax of the given name.
user_validate_picture Validates an image uploaded by a user.
user_view Generate an array for rendering the given user.
user_view_access User view access callback.
user_view_page Page callback wrapper for user_view().
_user_cancel Last batch processing step for cancelling a user account.
_user_cancel_session_regenerate Finished batch processing callback for cancelling a user account.
_user_categories Retrieve a list of all user setting/information categories and sort them by weight.
_user_mail_notify Conditionally create and send a notification email when a certain operation happens on the given user account.
_user_mail_text Returns a mail string for a variable name.
_user_sort

Constants

Namesort descending Description
EMAIL_MAX_LENGTH Maximum length of user e-mail text field.
USERNAME_MAX_LENGTH Maximum length of username text field.
USER_REGISTER_ADMINISTRATORS_ONLY Only administrators can create user accounts.
USER_REGISTER_VISITORS Visitors can create their own accounts.
USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL Visitors can create accounts, but they don't become active without administrative approval.

Classes

Namesort descending Description
UserController Controller class for users.

File

modules/user/user.module
View source
  1. <?php
  2. /**
  3. * @file
  4. * Enables the user registration and login system.
  5. */
  6. /**
  7. * Maximum length of username text field.
  8. */
  9. define('USERNAME_MAX_LENGTH', 60);
  10. /**
  11. * Maximum length of user e-mail text field.
  12. */
  13. define('EMAIL_MAX_LENGTH', 254);
  14. /**
  15. * Only administrators can create user accounts.
  16. */
  17. define('USER_REGISTER_ADMINISTRATORS_ONLY', 0);
  18. /**
  19. * Visitors can create their own accounts.
  20. */
  21. define('USER_REGISTER_VISITORS', 1);
  22. /**
  23. * Visitors can create accounts, but they don't become active without
  24. * administrative approval.
  25. */
  26. define('USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL', 2);
  27. /**
  28. * Implement hook_help().
  29. */
  30. function user_help($path, $arg) {
  31. global $user;
  32. switch ($path) {
  33. case 'admin/help#user':
  34. $output = '';
  35. $output .= '<h3>' . t('About') . '</h3>';
  36. $output .= '<p>' . t('The User module allows users to register, log in, and log out. It also allows users with proper permissions to manage user roles (used to classify users) and permissions associated with those roles. For more information, see the online handbook entry for <a href="@user">User module</a>.', array('@user' => 'http://drupal.org/documentation/modules/user')) . '</p>';
  37. $output .= '<h3>' . t('Uses') . '</h3>';
  38. $output .= '<dl>';
  39. $output .= '<dt>' . t('Creating and managing users') . '</dt>';
  40. $output .= '<dd>' . t('The User module allows users with the appropriate <a href="@permissions">permissions</a> to create user accounts through the <a href="@people">People administration page</a>, where they can also assign users to one or more roles, and block or delete user accounts. If allowed, users without accounts (anonymous users) can create their own accounts on the <a href="@register">Create new account</a> page.', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-user')), '@people' => url('admin/people'), '@register' => url('user/register'))) . '</dd>';
  41. $output .= '<dt>' . t('User roles and permissions') . '</dt>';
  42. $output .= '<dd>' . t('<em>Roles</em> are used to group and classify users; each user can be assigned one or more roles. By default there are two roles: <em>anonymous user</em> (users that are not logged in) and <em>authenticated user</em> (users that are registered and logged in). Depending on choices you made when you installed Drupal, the installation process may have defined more roles, and you can create additional custom roles on the <a href="@roles">Roles page</a>. After creating roles, you can set permissions for each role on the <a href="@permissions_user">Permissions page</a>. Granting a permission allows users who have been assigned a particular role to perform an action on the site, such as viewing a particular type of content, editing or creating content, administering settings for a particular module, or using a particular function of the site (such as search).', array('@permissions_user' => url('admin/people/permissions'), '@roles' => url('admin/people/permissions/roles'))) . '</dd>';
  43. $output .= '<dt>' . t('Account settings') . '</dt>';
  44. $output .= '<dd>' . t('The <a href="@accounts">Account settings page</a> allows you to manage settings for the displayed name of the anonymous user role, personal contact forms, user registration, and account cancellation. On this page you can also manage settings for account personalization (including signatures and user pictures), and adapt the text for the e-mail messages that are sent automatically during the user registration process.', array('@accounts' => url('admin/config/people/accounts'))) . '</dd>';
  45. $output .= '</dl>';
  46. return $output;
  47. case 'admin/people/create':
  48. return '<p>' . t("This web page allows administrators to register new users. Users' e-mail addresses and usernames must be unique.") . '</p>';
  49. case 'admin/people/permissions':
  50. return '<p>' . 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 <a href="@role">Roles</a> 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 <a href="@settings">User Settings</a> 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/people/permissions/roles'), '@settings' => url('admin/config/people/accounts'))) . '</p>';
  51. case 'admin/people/permissions/roles':
  52. $output = '<p>' . 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 on the <a href="@permissions">permissions page</a>. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the names and order of the roles on your site. It is recommended to order your roles from least permissive (anonymous user) to most permissive (administrator). To delete a role choose "edit role".', array('@permissions' => url('admin/people/permissions'))) . '</p>';
  53. $output .= '<p>' . t('By default, Drupal comes with two user roles:') . '</p>';
  54. $output .= '<ul>';
  55. $output .= '<li>' . t("Anonymous user: this role is used for users that don't have a user account or that are not authenticated.") . '</li>';
  56. $output .= '<li>' . t('Authenticated user: this role is automatically granted to all logged in users.') . '</li>';
  57. $output .= '</ul>';
  58. return $output;
  59. case 'admin/config/people/accounts/fields':
  60. return '<p>' . t('This form lets administrators add, edit, and arrange fields for storing user data.') . '</p>';
  61. case 'admin/config/people/accounts/display':
  62. return '<p>' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '</p>';
  63. case 'admin/people/search':
  64. return '<p>' . 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".') . '</p>';
  65. }
  66. }
  67. /**
  68. * Invokes a user hook in every module.
  69. *
  70. * We cannot use module_invoke() for this, because the arguments need to
  71. * be passed by reference.
  72. *
  73. * @param $type
  74. * A text string that controls which user hook to invoke. Valid choices are:
  75. * - cancel: Invokes hook_user_cancel().
  76. * - insert: Invokes hook_user_insert().
  77. * - login: Invokes hook_user_login().
  78. * - presave: Invokes hook_user_presave().
  79. * - update: Invokes hook_user_update().
  80. * @param $edit
  81. * An associative array variable containing form values to be passed
  82. * as the first parameter of the hook function.
  83. * @param $account
  84. * The user account object to be passed as the second parameter of the hook
  85. * function.
  86. * @param $category
  87. * The category of user information being acted upon.
  88. */
  89. function user_module_invoke($type, &$edit, $account, $category = NULL) {
  90. foreach (module_implements('user_' . $type) as $module) {
  91. $function = $module . '_user_' . $type;
  92. $function($edit, $account, $category);
  93. }
  94. }
  95. /**
  96. * Implements hook_theme().
  97. */
  98. function user_theme() {
  99. return array(
  100. 'user_picture' => array(
  101. 'variables' => array('account' => NULL),
  102. 'template' => 'user-picture',
  103. ),
  104. 'user_profile' => array(
  105. 'render element' => 'elements',
  106. 'template' => 'user-profile',
  107. 'file' => 'user.pages.inc',
  108. ),
  109. 'user_profile_category' => array(
  110. 'render element' => 'element',
  111. 'template' => 'user-profile-category',
  112. 'file' => 'user.pages.inc',
  113. ),
  114. 'user_profile_item' => array(
  115. 'render element' => 'element',
  116. 'template' => 'user-profile-item',
  117. 'file' => 'user.pages.inc',
  118. ),
  119. 'user_list' => array(
  120. 'variables' => array('users' => NULL, 'title' => NULL),
  121. ),
  122. 'user_admin_permissions' => array(
  123. 'render element' => 'form',
  124. 'file' => 'user.admin.inc',
  125. ),
  126. 'user_admin_roles' => array(
  127. 'render element' => 'form',
  128. 'file' => 'user.admin.inc',
  129. ),
  130. 'user_permission_description' => array(
  131. 'variables' => array('permission_item' => NULL, 'hide' => NULL),
  132. 'file' => 'user.admin.inc',
  133. ),
  134. 'user_signature' => array(
  135. 'variables' => array('signature' => NULL),
  136. ),
  137. );
  138. }
  139. /**
  140. * Implements hook_entity_info().
  141. */
  142. function user_entity_info() {
  143. $return = array(
  144. 'user' => array(
  145. 'label' => t('User'),
  146. 'controller class' => 'UserController',
  147. 'base table' => 'users',
  148. 'uri callback' => 'user_uri',
  149. 'label callback' => 'format_username',
  150. 'fieldable' => TRUE,
  151. // $user->language is only the preferred user language for the user
  152. // interface textual elements. As it is not necessarily related to the
  153. // language assigned to fields, we do not define it as the entity language
  154. // key.
  155. 'entity keys' => array(
  156. 'id' => 'uid',
  157. ),
  158. 'bundles' => array(
  159. 'user' => array(
  160. 'label' => t('User'),
  161. 'admin' => array(
  162. 'path' => 'admin/config/people/accounts',
  163. 'access arguments' => array('administer users'),
  164. ),
  165. ),
  166. ),
  167. 'view modes' => array(
  168. 'full' => array(
  169. 'label' => t('User account'),
  170. 'custom settings' => FALSE,
  171. ),
  172. ),
  173. ),
  174. );
  175. return $return;
  176. }
  177. /**
  178. * Implements callback_entity_info_uri().
  179. */
  180. function user_uri($user) {
  181. return array(
  182. 'path' => 'user/' . $user->uid,
  183. );
  184. }
  185. /**
  186. * Implements hook_field_info_alter().
  187. */
  188. function user_field_info_alter(&$info) {
  189. // Add the 'user_register_form' instance setting to all field types.
  190. foreach ($info as $field_type => &$field_type_info) {
  191. $field_type_info += array('instance_settings' => array());
  192. $field_type_info['instance_settings'] += array(
  193. 'user_register_form' => FALSE,
  194. );
  195. }
  196. }
  197. /**
  198. * Implements hook_field_extra_fields().
  199. */
  200. function user_field_extra_fields() {
  201. $return['user']['user'] = array(
  202. 'form' => array(
  203. 'account' => array(
  204. 'label' => t('User name and password'),
  205. 'description' => t('User module account form elements.'),
  206. 'weight' => -10,
  207. ),
  208. 'timezone' => array(
  209. 'label' => t('Timezone'),
  210. 'description' => t('User module timezone form element.'),
  211. 'weight' => 6,
  212. ),
  213. ),
  214. 'display' => array(
  215. 'summary' => array(
  216. 'label' => t('History'),
  217. 'description' => t('User module history view element.'),
  218. 'weight' => 5,
  219. ),
  220. ),
  221. );
  222. return $return;
  223. }
  224. /**
  225. * Fetches a user object based on an external authentication source.
  226. *
  227. * @param string $authname
  228. * The external authentication username.
  229. *
  230. * @return
  231. * A fully-loaded user object if the user is found or FALSE if not found.
  232. */
  233. function user_external_load($authname) {
  234. $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField();
  235. if ($uid) {
  236. return user_load($uid);
  237. }
  238. else {
  239. return FALSE;
  240. }
  241. }
  242. /**
  243. * Load multiple users based on certain conditions.
  244. *
  245. * This function should be used whenever you need to load more than one user
  246. * from the database. Users are loaded into memory and will not require
  247. * database access if loaded again during the same page request.
  248. *
  249. * @param $uids
  250. * An array of user IDs.
  251. * @param $conditions
  252. * (deprecated) An associative array of conditions on the {users}
  253. * table, where the keys are the database fields and the values are the
  254. * values those fields must have. Instead, it is preferable to use
  255. * EntityFieldQuery to retrieve a list of entity IDs loadable by
  256. * this function.
  257. * @param $reset
  258. * A boolean indicating that the internal cache should be reset. Use this if
  259. * loading a user object which has been altered during the page request.
  260. *
  261. * @return
  262. * An array of user objects, indexed by uid.
  263. *
  264. * @see entity_load()
  265. * @see user_load()
  266. * @see user_load_by_mail()
  267. * @see user_load_by_name()
  268. * @see EntityFieldQuery
  269. *
  270. * @todo Remove $conditions in Drupal 8.
  271. */
  272. function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
  273. return entity_load('user', $uids, $conditions, $reset);
  274. }
  275. /**
  276. * Controller class for users.
  277. *
  278. * This extends the DrupalDefaultEntityController class, adding required
  279. * special handling for user objects.
  280. */
  281. class UserController extends DrupalDefaultEntityController {
  282. function attachLoad(&$queried_users, $revision_id = FALSE) {
  283. // Build an array of user picture IDs so that these can be fetched later.
  284. $picture_fids = array();
  285. foreach ($queried_users as $key => $record) {
  286. $picture_fids[] = $record->picture;
  287. $queried_users[$key]->data = unserialize($record->data);
  288. $queried_users[$key]->roles = array();
  289. if ($record->uid) {
  290. $queried_users[$record->uid]->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
  291. }
  292. else {
  293. $queried_users[$record->uid]->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
  294. }
  295. }
  296. // Add any additional roles from the database.
  297. $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)));
  298. foreach ($result as $record) {
  299. $queried_users[$record->uid]->roles[$record->rid] = $record->name;
  300. }
  301. // Add the full file objects for user pictures if enabled.
  302. if (!empty($picture_fids) && variable_get('user_pictures', 0)) {
  303. $pictures = file_load_multiple($picture_fids);
  304. foreach ($queried_users as $account) {
  305. if (!empty($account->picture) && isset($pictures[$account->picture])) {
  306. $account->picture = $pictures[$account->picture];
  307. }
  308. else {
  309. $account->picture = NULL;
  310. }
  311. }
  312. }
  313. // Call the default attachLoad() method. This will add fields and call
  314. // hook_user_load().
  315. parent::attachLoad($queried_users, $revision_id);
  316. }
  317. }
  318. /**
  319. * Loads a user object.
  320. *
  321. * Drupal has a global $user object, which represents the currently-logged-in
  322. * user. So to avoid confusion and to avoid clobbering the global $user object,
  323. * it is a good idea to assign the result of this function to a different local
  324. * variable, generally $account. If you actually do want to act as the user you
  325. * are loading, it is essential to call drupal_save_session(FALSE); first.
  326. * See
  327. * @link http://drupal.org/node/218104 Safely impersonating another user @endlink
  328. * for more information.
  329. *
  330. * @param $uid
  331. * Integer specifying the user ID to load.
  332. * @param $reset
  333. * TRUE to reset the internal cache and load from the database; FALSE
  334. * (default) to load from the internal cache, if set.
  335. *
  336. * @return
  337. * A fully-loaded user object upon successful user load, or FALSE if the user
  338. * cannot be loaded.
  339. *
  340. * @see user_load_multiple()
  341. */
  342. function user_load($uid, $reset = FALSE) {
  343. $users = user_load_multiple(array($uid), array(), $reset);
  344. return reset($users);
  345. }
  346. /**
  347. * Fetch a user object by email address.
  348. *
  349. * @param $mail
  350. * String with the account's e-mail address.
  351. * @return
  352. * A fully-loaded $user object upon successful user load or FALSE if user
  353. * cannot be loaded.
  354. *
  355. * @see user_load_multiple()
  356. */
  357. function user_load_by_mail($mail) {
  358. $users = user_load_multiple(array(), array('mail' => $mail));
  359. return reset($users);
  360. }
  361. /**
  362. * Fetch a user object by account name.
  363. *
  364. * @param $name
  365. * String with the account's user name.
  366. * @return
  367. * A fully-loaded $user object upon successful user load or FALSE if user
  368. * cannot be loaded.
  369. *
  370. * @see user_load_multiple()
  371. */
  372. function user_load_by_name($name) {
  373. $users = user_load_multiple(array(), array('name' => $name));
  374. return reset($users);
  375. }
  376. /**
  377. * Save changes to a user account or add a new user.
  378. *
  379. * @param $account
  380. * (optional) The user object to modify or add. If you want to modify
  381. * an existing user account, you will need to ensure that (a) $account
  382. * is an object, and (b) you have set $account->uid to the numeric
  383. * user ID of the user account you wish to modify. If you
  384. * want to create a new user account, you can set $account->is_new to
  385. * TRUE or omit the $account->uid field.
  386. * @param $edit
  387. * An array of fields and values to save. For example array('name'
  388. * => 'My name'). Key / value pairs added to the $edit['data'] will be
  389. * serialized and saved in the {users.data} column.
  390. * @param $category
  391. * (optional) The category for storing profile information in.
  392. *
  393. * @return
  394. * A fully-loaded $user object upon successful save or FALSE if the save failed.
  395. *
  396. * @todo D8: Drop $edit and fix user_save() to be consistent with others.
  397. */
  398. function user_save($account, $edit = array(), $category = 'account') {
  399. $transaction = db_transaction();
  400. try {
  401. if (!empty($edit['pass'])) {
  402. // Allow alternate password hashing schemes.
  403. require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
  404. $edit['pass'] = user_hash_password(trim($edit['pass']));
  405. // Abort if the hashing failed and returned FALSE.
  406. if (!$edit['pass']) {
  407. return FALSE;
  408. }
  409. }
  410. else {
  411. // Avoid overwriting an existing password with a blank password.
  412. unset($edit['pass']);
  413. }
  414. if (isset($edit['mail'])) {
  415. $edit['mail'] = trim($edit['mail']);
  416. }
  417. // Load the stored entity, if any.
  418. if (!empty($account->uid) && !isset($account->original)) {
  419. $account->original = entity_load_unchanged('user', $account->uid);
  420. }
  421. if (empty($account)) {
  422. $account = new stdClass();
  423. }
  424. if (!isset($account->is_new)) {
  425. $account->is_new = empty($account->uid);
  426. }
  427. // Prepopulate $edit['data'] with the current value of $account->data.
  428. // Modules can add to or remove from this array in hook_user_presave().
  429. if (!empty($account->data)) {
  430. $edit['data'] = !empty($edit['data']) ? array_merge($account->data, $edit['data']) : $account->data;
  431. }
  432. // Invoke hook_user_presave() for all modules.
  433. user_module_invoke('presave', $edit, $account, $category);
  434. // Invoke presave operations of Field Attach API and Entity API. Those APIs
  435. // require a fully-fledged and updated entity object. Therefore, we need to
  436. // copy any new property values of $edit into it.
  437. foreach ($edit as $key => $value) {
  438. $account->$key = $value;
  439. }
  440. field_attach_presave('user', $account);
  441. module_invoke_all('entity_presave', $account, 'user');
  442. if (is_object($account) && !$account->is_new) {
  443. // Process picture uploads.
  444. if (!empty($account->picture->fid) && (!isset($account->original->picture->fid) || $account->picture->fid != $account->original->picture->fid)) {
  445. $picture = $account->picture;
  446. // If the picture is a temporary file move it to its final location and
  447. // make it permanent.
  448. if (!$picture->status) {
  449. $info = image_get_info($picture->uri);
  450. $picture_directory = file_default_scheme() . '://' . variable_get('user_picture_path', 'pictures');
  451. // Prepare the pictures directory.
  452. file_prepare_directory($picture_directory, FILE_CREATE_DIRECTORY);
  453. $destination = file_stream_wrapper_uri_normalize($picture_directory . '/picture-' . $account->uid . '-' . REQUEST_TIME . '.' . $info['extension']);
  454. // Move the temporary file into the final location.
  455. if ($picture = file_move($picture, $destination, FILE_EXISTS_RENAME)) {
  456. $picture->status = FILE_STATUS_PERMANENT;
  457. $account->picture = file_save($picture);
  458. file_usage_add($picture, 'user', 'user', $account->uid);
  459. }
  460. }
  461. // Delete the previous picture if it was deleted or replaced.
  462. if (!empty($account->original->picture->fid)) {
  463. file_usage_delete($account->original->picture, 'user', 'user', $account->uid);
  464. file_delete($account->original->picture);
  465. }
  466. }
  467. elseif (isset($edit['picture_delete']) && $edit['picture_delete']) {
  468. file_usage_delete($account->original->picture, 'user', 'user', $account->uid);
  469. file_delete($account->original->picture);
  470. }
  471. $account->picture = empty($account->picture->fid) ? 0 : $account->picture->fid;
  472. // Do not allow 'uid' to be changed.
  473. $account->uid = $account->original->uid;
  474. // Save changes to the user table.
  475. $success = drupal_write_record('users', $account, 'uid');
  476. if ($success === FALSE) {
  477. // The query failed - better to abort the save than risk further
  478. // data loss.
  479. return FALSE;
  480. }
  481. // Reload user roles if provided.
  482. if ($account->roles != $account->original->roles) {
  483. db_delete('users_roles')
  484. ->condition('uid', $account->uid)
  485. ->execute();
  486. $query = db_insert('users_roles')->fields(array('uid', 'rid'));
  487. foreach (array_keys($account->roles) as $rid) {
  488. if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
  489. $query->values(array(
  490. 'uid' => $account->uid,
  491. 'rid' => $rid,
  492. ));
  493. }
  494. }
  495. $query->execute();
  496. }
  497. // Delete a blocked user's sessions to kick them if they are online.
  498. if ($account->original->status != $account->status && $account->status == 0) {
  499. drupal_session_destroy_uid($account->uid);
  500. }
  501. // If the password changed, delete all open sessions and recreate
  502. // the current one.
  503. if ($account->pass != $account->original->pass) {
  504. drupal_session_destroy_uid($account->uid);
  505. if ($account->uid == $GLOBALS['user']->uid) {
  506. drupal_session_regenerate();
  507. }
  508. }
  509. // Save Field data.
  510. field_attach_update('user', $account);
  511. // Send emails after we have the new user object.
  512. if ($account->status != $account->original->status) {
  513. // The user's status is changing; conditionally send notification email.
  514. $op = $account->status == 1 ? 'status_activated' : 'status_blocked';
  515. _user_mail_notify($op, $account);
  516. }
  517. // Update $edit with any interim changes to $account.
  518. foreach ($account as $key => $value) {
  519. if (!property_exists($account->original, $key) || $value !== $account->original->$key) {
  520. $edit[$key] = $value;
  521. }
  522. }
  523. user_module_invoke('update', $edit, $account, $category);
  524. module_invoke_all('entity_update', $account, 'user');
  525. }
  526. else {
  527. // Allow 'uid' to be set by the caller. There is no danger of writing an
  528. // existing user as drupal_write_record will do an INSERT.
  529. if (empty($account->uid)) {
  530. $account->uid = db_next_id(db_query('SELECT MAX(uid) FROM {users}')->fetchField());
  531. }
  532. // Allow 'created' to be set by the caller.
  533. if (!isset($account->created)) {
  534. $account->created = REQUEST_TIME;
  535. }
  536. $success = drupal_write_record('users', $account);
  537. if ($success === FALSE) {
  538. // On a failed INSERT some other existing user's uid may be returned.
  539. // We must abort to avoid overwriting their account.
  540. return FALSE;
  541. }
  542. // Make sure $account is properly initialized.
  543. $account->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
  544. field_attach_insert('user', $account);
  545. $edit = (array) $account;
  546. user_module_invoke('insert', $edit, $account, $category);
  547. module_invoke_all('entity_insert', $account, 'user');
  548. // Save user roles.
  549. if (count($account->roles) > 1) {
  550. $query = db_insert('users_roles')->fields(array('uid', 'rid'));
  551. foreach (array_keys($account->roles) as $rid) {
  552. if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
  553. $query->values(array(
  554. 'uid' => $account->uid,
  555. 'rid' => $rid,
  556. ));
  557. }
  558. }
  559. $query->execute();
  560. }
  561. }
  562. // Clear internal properties.
  563. unset($account->is_new);
  564. unset($account->original);
  565. // Clear the static loading cache.
  566. entity_get_controller('user')->resetCache(array($account->uid));
  567. return $account;
  568. }
  569. catch (Exception $e) {
  570. $transaction->rollback();
  571. watchdog_exception('user', $e);
  572. throw $e;
  573. }
  574. }
  575. /**
  576. * Verify the syntax of the given name.
  577. */
  578. function user_validate_name($name) {
  579. if (!$name) {
  580. return t('You must enter a username.');
  581. }
  582. if (substr($name, 0, 1) == ' ') {
  583. return t('The username cannot begin with a space.');
  584. }
  585. if (substr($name, -1) == ' ') {
  586. return t('The username cannot end with a space.');
  587. }
  588. if (strpos($name, ' ') !== FALSE) {
  589. return t('The username cannot contain multiple spaces in a row.');
  590. }
  591. if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)) {
  592. return t('The username contains an illegal character.');
  593. }
  594. if (preg_match('/[\x{80}-\x{A0}' . // Non-printable ISO-8859-1 + NBSP
  595. '\x{AD}' . // Soft-hyphen
  596. '\x{2000}-\x{200F}' . // Various space characters
  597. '\x{2028}-\x{202F}' . // Bidirectional text overrides
  598. '\x{205F}-\x{206F}' . // Various text hinting characters
  599. '\x{FEFF}' . // Byte order mark
  600. '\x{FF01}-\x{FF60}' . // Full-width latin
  601. '\x{FFF9}-\x{FFFD}' . // Replacement characters
  602. '\x{0}-\x{1F}]/u', // NULL byte and control characters
  603. $name)) {
  604. return t('The username contains an illegal character.');
  605. }
  606. if (drupal_strlen($name) > USERNAME_MAX_LENGTH) {
  607. return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
  608. }
  609. }
  610. /**
  611. * Validates a user's email address.
  612. *
  613. * Checks that a user's email address exists and follows all standard
  614. * validation rules. Returns error messages when the address is invalid.
  615. *
  616. * @param $mail
  617. * A user's email address.
  618. *
  619. * @return
  620. * If the address is invalid, a human-readable error message is returned.
  621. * If the address is valid, nothing is returned.
  622. */
  623. function user_validate_mail($mail) {
  624. if (!$mail) {
  625. return t('You must enter an e-mail address.');
  626. }
  627. if (!valid_email_address($mail)) {
  628. return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
  629. }
  630. }
  631. /**
  632. * Validates an image uploaded by a user.
  633. *
  634. * @see user_account_form()
  635. */
  636. function user_validate_picture(&$form, &$form_state) {
  637. // If required, validate the uploaded picture.
  638. $validators = array(
  639. 'file_validate_is_image' => array(),
  640. 'file_validate_image_resolution' => array(variable_get('user_picture_dimensions', '85x85')),
  641. 'file_validate_size' => array(variable_get('user_picture_file_size', '30') * 1024),
  642. );
  643. // Save the file as a temporary file.
  644. $file = file_save_upload('picture_upload', $validators);
  645. if ($file === FALSE) {
  646. 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'))));
  647. }
  648. elseif ($file !== NULL) {
  649. $form_state['values']['picture_upload'] = $file;
  650. }
  651. }
  652. /**
  653. * Generate a random alphanumeric password.
  654. */
  655. function user_password($length = 10) {
  656. // This variable contains the list of allowable characters for the
  657. // password. Note that the number 0 and the letter 'O' have been
  658. // removed to avoid confusion between the two. The same is true
  659. // of 'I', 1, and 'l'.
  660. $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
  661. // Zero-based count of characters in the allowable list:
  662. $len = strlen($allowable_characters) - 1;
  663. // Declare the password as a blank string.
  664. $pass = '';
  665. // Loop the number of times specified by $length.
  666. for ($i = 0; $i < $length; $i++) {
  667. do {
  668. // Find a secure random number within the range needed.
  669. $index = ord(drupal_random_bytes(1));
  670. } while ($index > $len);
  671. // Each iteration, pick a random character from the
  672. // allowable string and append it to the password:
  673. $pass .= $allowable_characters[$index];
  674. }
  675. return $pass;
  676. }
  677. /**
  678. * Determine the permissions for one or more roles.
  679. *
  680. * @param $roles
  681. * An array whose keys are the role IDs of interest, such as $user->roles.
  682. *
  683. * @return
  684. * If $roles is a non-empty array, an array indexed by role ID is returned.
  685. * Each value is an array whose keys are the permission strings for the given
  686. * role ID. If $roles is empty nothing is returned.
  687. */
  688. function user_role_permissions($roles = array()) {
  689. $cache = &drupal_static(__FUNCTION__, array());
  690. $role_permissions = $fetch = array();
  691. if ($roles) {
  692. foreach ($roles as $rid => $name) {
  693. if (isset($cache[$rid])) {
  694. $role_permissions[$rid] = $cache[$rid];
  695. }
  696. else {
  697. // Add this rid to the list of those needing to be fetched.
  698. $fetch[] = $rid;
  699. // Prepare in case no permissions are returned.
  700. $cache[$rid] = array();
  701. }
  702. }
  703. if ($fetch) {
  704. // Get from the database permissions that were not in the static variable.
  705. // Only role IDs with at least one permission assigned will return rows.
  706. $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
  707. foreach ($result as $row) {
  708. $cache[$row->rid][$row->permission] = TRUE;
  709. }
  710. foreach ($fetch as $rid) {
  711. // For every rid, we know we at least assigned an empty array.
  712. $role_permissions[$rid] = $cache[$rid];
  713. }
  714. }
  715. }
  716. return $role_permissions;
  717. }
  718. /**
  719. * Determine whether the user has a given privilege.
  720. *
  721. * @param $string
  722. * The permission, such as "administer nodes", being checked for.
  723. * @param $account
  724. * (optional) The account to check, if not given use currently logged in user.
  725. *
  726. * @return
  727. * Boolean TRUE if the current user has the requested permission.
  728. *
  729. * All permission checks in Drupal should go through this function. This
  730. * way, we guarantee consistent behavior, and ensure that the superuser
  731. * can perform all actions.
  732. */
  733. function user_access($string, $account = NULL) {
  734. global $user;
  735. if (!isset($account)) {
  736. $account = $user;
  737. }
  738. // User #1 has all privileges:
  739. if ($account->uid == 1) {
  740. return TRUE;
  741. }
  742. // To reduce the number of SQL queries, we cache the user's permissions
  743. // in a static variable.
  744. // Use the advanced drupal_static() pattern, since this is called very often.
  745. static $drupal_static_fast;
  746. if (!isset($drupal_static_fast)) {
  747. $drupal_static_fast['perm'] = &drupal_static(__FUNCTION__);
  748. }
  749. $perm = &$drupal_static_fast['perm'];
  750. if (!isset($perm[$account->uid])) {
  751. $role_permissions = user_role_permissions($account->roles);
  752. $perms = array();
  753. foreach ($role_permissions as $one_role) {
  754. $perms += $one_role;
  755. }
  756. $perm[$account->uid] = $perms;
  757. }
  758. return isset($perm[$account->uid][$string]);
  759. }
  760. /**
  761. * Checks for usernames blocked by user administration.
  762. *
  763. * @param $name
  764. * A string containing a name of the user.
  765. *
  766. * @return
  767. * Object with property 'name' (the user name), if the user is blocked;
  768. * FALSE if the user is not blocked.
  769. */
  770. function user_is_blocked($name) {
  771. return db_select('users')
  772. ->fields('users', array('name'))
  773. ->condition('name', db_like($name), 'LIKE')
  774. ->condition('status', 0)
  775. ->execute()->fetchObject();
  776. }
  777. /**
  778. * Implements hook_permission().
  779. */
  780. function user_permission() {
  781. return array(
  782. 'administer permissions' => array(
  783. 'title' => t('Administer permissions'),
  784. 'restrict access' => TRUE,
  785. ),
  786. 'administer users' => array(
  787. 'title' => t('Administer users'),
  788. 'restrict access' => TRUE,
  789. ),
  790. 'access user profiles' => array(
  791. 'title' => t('View user profiles'),
  792. ),
  793. 'change own username' => array(
  794. 'title' => t('Change own username'),
  795. ),
  796. 'cancel account' => array(
  797. 'title' => t('Cancel own user account'),
  798. 'description' => t('Note: content may be kept, unpublished, deleted or transferred to the %anonymous-name user depending on the configured <a href="@user-settings-url">user settings</a>.', array('%anonymous-name' => variable_get('anonymous', t('Anonymous')), '@user-settings-url' => url('admin/config/people/accounts'))),
  799. ),
  800. 'select account cancellation method' => array(
  801. 'title' => t('Select method for cancelling own account'),
  802. 'restrict access' => TRUE,
  803. ),
  804. );
  805. }
  806. /**
  807. * Implements hook_file_download().
  808. *
  809. * Ensure that user pictures (avatars) are always downloadable.
  810. */
  811. function user_file_download($uri) {
  812. if (strpos(file_uri_target($uri), variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
  813. $info = image_get_info($uri);
  814. return array('Content-Type' => $info['mime_type']);
  815. }
  816. }
  817. /**
  818. * Implements hook_file_move().
  819. */
  820. function user_file_move($file, $source) {
  821. // If a user's picture is replaced with a new one, update the record in
  822. // the users table.
  823. if (isset($file->fid) && isset($source->fid) && $file->fid != $source->fid) {
  824. db_update('users')
  825. ->fields(array(
  826. 'picture' => $file->fid,
  827. ))
  828. ->condition('picture', $source->fid)
  829. ->execute();
  830. }
  831. }
  832. /**
  833. * Implements hook_file_delete().
  834. */
  835. function user_file_delete($file) {
  836. // Remove any references to the file.
  837. db_update('users')
  838. ->fields(array('picture' => 0))
  839. ->condition('picture', $file->fid)
  840. ->execute();
  841. }
  842. /**
  843. * Implements hook_search_info().
  844. */
  845. function user_search_info() {
  846. return array(
  847. 'title' => 'Users',
  848. );
  849. }
  850. /**
  851. * Implements hook_search_access().
  852. */
  853. function user_search_access() {
  854. return user_access('access user profiles');
  855. }
  856. /**
  857. * Implements hook_search_execute().
  858. */
  859. function user_search_execute($keys = NULL, $conditions = NULL) {
  860. $find = array();
  861. // Replace wildcards with MySQL/PostgreSQL wildcards.
  862. $keys = preg_replace('!\*+!', '%', $keys);
  863. $query = db_select('users')->extend('PagerDefault');
  864. $query->fields('users', array('uid'));
  865. if (user_access('administer users')) {
  866. // Administrators can also search in the otherwise private email field,
  867. // and they don't need to be restricted to only active users.
  868. $query->fields('users', array('mail'));
  869. $query->condition(db_or()->
  870. condition('name', '%' . db_like($keys) . '%', 'LIKE')->
  871. condition('mail', '%' . db_like($keys) . '%', 'LIKE'));
  872. }
  873. else {
  874. // Regular users can only search via usernames, and we do not show them
  875. // blocked accounts.
  876. $query->condition('name', '%' . db_like($keys) . '%', 'LIKE')
  877. ->condition('status', 1);
  878. }
  879. $uids = $query
  880. ->limit(15)
  881. ->execute()
  882. ->fetchCol();
  883. $accounts = user_load_multiple($uids);
  884. $results = array();
  885. foreach ($accounts as $account) {
  886. $result = array(
  887. 'title' => format_username($account),
  888. 'link' => url('user/' . $account->uid, array('absolute' => TRUE)),
  889. );
  890. if (user_access('administer users')) {
  891. $result['title'] .= ' (' . $account->mail . ')';
  892. }
  893. $results[] = $result;
  894. }
  895. return $results;
  896. }
  897. /**
  898. * Implements hook_element_info().
  899. */
  900. function user_element_info() {
  901. $types['user_profile_category'] = array(
  902. '#theme_wrappers' => array('user_profile_category'),
  903. );
  904. $types['user_profile_item'] = array(
  905. '#theme' => 'user_profile_item',
  906. );
  907. return $types;
  908. }
  909. /**
  910. * Implements hook_user_view().
  911. */
  912. function user_user_view($account) {
  913. $account->content['user_picture'] = array(
  914. '#markup' => theme('user_picture', array('account' => $account)),
  915. '#weight' => -10,
  916. );
  917. if (!isset($account->content['summary'])) {
  918. $account->content['summary'] = array();
  919. }
  920. $account->content['summary'] += array(
  921. '#type' => 'user_profile_category',
  922. '#attributes' => array('class' => array('user-member')),
  923. '#weight' => 5,
  924. '#title' => t('History'),
  925. );
  926. $account->content['summary']['member_for'] = array(
  927. '#type' => 'user_profile_item',
  928. '#title' => t('Member for'),
  929. '#markup' => format_interval(REQUEST_TIME - $account->created),
  930. );
  931. }
  932. /**
  933. * Helper function to add default user account fields to user registration and edit form.
  934. *
  935. * @see user_account_form_validate()
  936. * @see user_validate_current_pass()
  937. * @see user_validate_picture()
  938. * @see user_validate_mail()
  939. */
  940. function user_account_form(&$form, &$form_state) {
  941. global $user;
  942. $account = $form['#user'];
  943. $register = ($form['#user']->uid > 0 ? FALSE : TRUE);
  944. $admin = user_access('administer users');
  945. $form['#validate'][] = 'user_account_form_validate';
  946. // Account information.
  947. $form['account'] = array(
  948. '#type' => 'container',
  949. '#weight' => -10,
  950. );
  951. // Only show name field on registration form or user can change own username.
  952. $form['account']['name'] = array(
  953. '#type' => 'textfield',
  954. '#title' => t('Username'),
  955. '#maxlength' => USERNAME_MAX_LENGTH,
  956. '#description' => t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'),
  957. '#required' => TRUE,
  958. '#attributes' => array('class' => array('username')),
  959. '#default_value' => (!$register ? $account->name : ''),
  960. '#access' => ($register || ($user->uid == $account->uid && user_access('change own username')) || $admin),
  961. '#weight' => -10,
  962. );
  963. $form['account']['mail'] = array(
  964. '#type' => 'textfield',
  965. '#title' => t('E-mail address'),
  966. '#maxlength' => EMAIL_MAX_LENGTH,
  967. '#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.'),
  968. '#required' => TRUE,
  969. '#default_value' => (!$register ? $account->mail : ''),
  970. );
  971. // Display password field only for existing users or when user is allowed to
  972. // assign a password during registration.
  973. if (!$register) {
  974. $form['account']['pass'] = array(
  975. '#type' => 'password_confirm',
  976. '#size' => 25,
  977. '#description' => t('To change the current user password, enter the new password in both fields.'),
  978. );
  979. // To skip the current password field, the user must have logged in via a
  980. // one-time link and have the token in the URL.
  981. $pass_reset = isset($_SESSION['pass_reset_' . $account->uid]) && isset($_GET['pass-reset-token']) && ($_GET['pass-reset-token'] == $_SESSION['pass_reset_' . $account->uid]);
  982. $protected_values = array();
  983. $current_pass_description = '';
  984. // The user may only change their own password without their current
  985. // password if they logged in via a one-time login link.
  986. if (!$pass_reset) {
  987. $protected_values['mail'] = $form['account']['mail']['#title'];
  988. $protected_values['pass'] = t('Password');
  989. $request_new = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
  990. $current_pass_description = t('Enter your current password to change the %mail or %pass. !request_new.', array('%mail' => $protected_values['mail'], '%pass' => $protected_values['pass'], '!request_new' => $request_new));
  991. }
  992. // The user must enter their current password to change to a new one.
  993. if ($user->uid == $account->uid) {
  994. $form['account']['current_pass_required_values'] = array(
  995. '#type' => 'value',
  996. '#value' => $protected_values,
  997. );
  998. $form['account']['current_pass'] = array(
  999. '#type' => 'password',
  1000. '#title' => t('Current password'),
  1001. '#size' => 25,
  1002. '#access' => !empty($protected_values),
  1003. '#description' => $current_pass_description,
  1004. '#weight' => -5,
  1005. // Do not let web browsers remember this password, since we are trying
  1006. // to confirm that the person submitting the form actually knows the
  1007. // current one.
  1008. '#attributes' => array('autocomplete' => 'off'),
  1009. );
  1010. $form['#validate'][] = 'user_validate_current_pass';
  1011. }
  1012. }
  1013. elseif (!variable_get('user_email_verification', TRUE) || $admin) {
  1014. $form['account']['pass'] = array(
  1015. '#type' => 'password_confirm',
  1016. '#size' => 25,
  1017. '#description' => t('Provide a password for the new account in both fields.'),
  1018. '#required' => TRUE,
  1019. );
  1020. }
  1021. if ($admin) {
  1022. $status = isset($account->status) ? $account->status : 1;
  1023. }
  1024. else {
  1025. $status = $register ? variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL) == USER_REGISTER_VISITORS : $account->status;
  1026. }
  1027. $form['account']['status'] = array(
  1028. '#type' => 'radios',
  1029. '#title' => t('Status'),
  1030. '#default_value' => $status,
  1031. '#options' => array(t('Blocked'), t('Active')),
  1032. '#access' => $admin,
  1033. );
  1034. $roles = array_map('check_plain', user_roles(TRUE));
  1035. // The disabled checkbox subelement for the 'authenticated user' role
  1036. // must be generated separately and added to the checkboxes element,
  1037. // because of a limitation in Form API not supporting a single disabled
  1038. // checkbox within a set of checkboxes.
  1039. // @todo This should be solved more elegantly. See issue #119038.
  1040. $checkbox_authenticated = array(
  1041. '#type' => 'checkbox',
  1042. '#title' => $roles[DRUPAL_AUTHENTICATED_RID],
  1043. '#default_value' => TRUE,
  1044. '#disabled' => TRUE,
  1045. );
  1046. unset($roles[DRUPAL_AUTHENTICATED_RID]);
  1047. $form['account']['roles'] = array(
  1048. '#type' => 'checkboxes',
  1049. '#title' => t('Roles'),
  1050. '#default_value' => (!$register && isset($account->roles) ? array_keys($account->roles) : array()),
  1051. '#options' => $roles,
  1052. '#access' => $roles && user_access('administer permissions'),
  1053. DRUPAL_AUTHENTICATED_RID => $checkbox_authenticated,
  1054. );
  1055. $form['account']['notify'] = array(
  1056. '#type' => 'checkbox',
  1057. '#title' => t('Notify user of new account'),
  1058. '#access' => $register && $admin,
  1059. );
  1060. // Signature.
  1061. $form['signature_settings'] = array(
  1062. '#type' => 'fieldset',
  1063. '#title' => t('Signature settings'),
  1064. '#weight' => 1,
  1065. '#access' => (!$register && variable_get('user_signatures', 0)),
  1066. );
  1067. $form['signature_settings']['signature'] = array(
  1068. '#type' => 'text_format',
  1069. '#title' => t('Signature'),
  1070. '#default_value' => isset($account->signature) ? $account->signature : '',
  1071. '#description' => t('Your signature will be publicly displayed at the end of your comments.'),
  1072. '#format' => isset($account->signature_format) ? $account->signature_format : NULL,
  1073. );
  1074. // Picture/avatar.
  1075. $form['picture'] = array(
  1076. '#type' => 'fieldset',
  1077. '#title' => t('Picture'),
  1078. '#weight' => 1,
  1079. '#access' => (!$register && variable_get('user_pictures', 0)),
  1080. );
  1081. $form['picture']['picture'] = array(
  1082. '#type' => 'value',
  1083. '#value' => isset($account->picture) ? $account->picture : NULL,
  1084. );
  1085. $form['picture']['picture_current'] = array(
  1086. '#markup' => theme('user_picture', array('account' => $account)),
  1087. );
  1088. $form['picture']['picture_delete'] = array(
  1089. '#type' => 'checkbox',
  1090. '#title' => t('Delete picture'),
  1091. '#access' => !empty($account->picture->fid),
  1092. '#description' => t('Check this box to delete your current picture.'),
  1093. );
  1094. $form['picture']['picture_upload'] = array(
  1095. '#type' => 'file',
  1096. '#title' => t('Upload picture'),
  1097. '#size' => 48,
  1098. '#description' => t('Your virtual face or picture. Pictures larger than @dimensions pixels will be scaled down.', array('@dimensions' => variable_get('user_picture_dimensions', '85x85'))) . ' ' . filter_xss_admin(variable_get('user_picture_guidelines', '')),
  1099. );
  1100. $form['#validate'][] = 'user_validate_picture';
  1101. }
  1102. /**
  1103. * Form validation handler for the current password on the user_account_form().
  1104. *
  1105. * @see user_account_form()
  1106. */
  1107. function user_validate_current_pass(&$form, &$form_state) {
  1108. $account = $form['#user'];
  1109. foreach ($form_state['values']['current_pass_required_values'] as $key => $name) {
  1110. // This validation only works for required textfields (like mail) or
  1111. // form values like password_confirm that have their own validation
  1112. // that prevent them from being empty if they are changed.
  1113. if ((strlen(trim($form_state['values'][$key])) > 0) && ($form_state['values'][$key] != $account->$key)) {
  1114. require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
  1115. $current_pass_failed = empty($form_state['values']['current_pass']) || !user_check_password($form_state['values']['current_pass'], $account);
  1116. if ($current_pass_failed) {
  1117. form_set_error('current_pass', t("Your current password is missing or incorrect; it's required to change the %name.", array('%name' => $name)));
  1118. form_set_error($key);
  1119. }
  1120. // We only need to check the password once.
  1121. break;
  1122. }
  1123. }
  1124. }
  1125. /**
  1126. * Form validation handler for user_account_form().
  1127. *
  1128. * @see user_account_form()
  1129. */
  1130. function user_account_form_validate($form, &$form_state) {
  1131. if ($form['#user_category'] == 'account' || $form['#user_category'] == 'register') {
  1132. $account = $form['#user'];
  1133. // Validate new or changing username.
  1134. if (isset($form_state['values']['name'])) {
  1135. if ($error = user_validate_name($form_state['values']['name'])) {
  1136. form_set_error('name', $error);
  1137. }
  1138. elseif ((bool) db_select('users')->fields('users', array('uid'))->condition('uid', $account->uid, '<>')->condition('name', db_like($form_state['values']['name']), 'LIKE')->range(0, 1)->execute()->fetchField()) {
  1139. form_set_error('name', t('The name %name is already taken.', array('%name' => $form_state['values']['name'])));
  1140. }
  1141. }
  1142. // Trim whitespace from mail, to prevent confusing 'e-mail not valid'
  1143. // warnings often caused by cutting and pasting.
  1144. $mail = trim($form_state['values']['mail']);
  1145. form_set_value($form['account']['mail'], $mail, $form_state);
  1146. // Validate the e-mail address, and check if it is taken by an existing user.
  1147. if ($error = user_validate_mail($form_state['values']['mail'])) {
  1148. form_set_error('mail', $error);
  1149. }
  1150. elseif ((bool) db_select('users')->fields('users', array('uid'))->condition('uid', $account->uid, '<>')->condition('mail', db_like($form_state['values']['mail']), 'LIKE')->range(0, 1)->execute()->fetchField()) {
  1151. // Format error message dependent on whether the user is logged in or not.
  1152. if ($GLOBALS['user']->uid) {
  1153. form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $form_state['values']['mail'])));
  1154. }
  1155. else {
  1156. form_set_error('mail', t('The e-mail address %email is already registered. <a href="@password">Have you forgotten your password?</a>', array('%email' => $form_state['values']['mail'], '@password' => url('user/password'))));
  1157. }
  1158. }
  1159. // Make sure the signature isn't longer than the size of the database field.
  1160. // Signatures are disabled by default, so make sure it exists first.
  1161. if (isset($form_state['values']['signature'])) {
  1162. // Move text format for user signature into 'signature_format'.
  1163. $form_state['values']['signature_format'] = $form_state['values']['signature']['format'];
  1164. // Move text value for user signature into 'signature'.
  1165. $form_state['values']['signature'] = $form_state['values']['signature']['value'];
  1166. $user_schema = drupal_get_schema('users');
  1167. if (drupal_strlen($form_state['values']['signature']) > $user_schema['fields']['signature']['length']) {
  1168. form_set_error('signature', t('The signature is too long: it must be %max characters or less.', array('%max' => $user_schema['fields']['signature']['length'])));
  1169. }
  1170. }
  1171. }
  1172. }
  1173. /**
  1174. * Implements hook_user_presave().
  1175. */
  1176. function user_user_presave(&$edit, $account, $category) {
  1177. if ($category == 'account' || $category == 'register') {
  1178. if (!empty($edit['picture_upload'])) {
  1179. $edit['picture'] = $edit['picture_upload'];
  1180. }
  1181. // Delete picture if requested, and if no replacement picture was given.
  1182. elseif (!empty($edit['picture_delete'])) {
  1183. $edit['picture'] = NULL;
  1184. }
  1185. // Prepare user roles.
  1186. if (isset($edit['roles'])) {
  1187. $edit['roles'] = array_filter($edit['roles']);
  1188. }
  1189. }
  1190. // Move account cancellation information into $user->data.
  1191. foreach (array('user_cancel_method', 'user_cancel_notify') as $key) {
  1192. if (isset($edit[$key])) {
  1193. $edit['data'][$key] = $edit[$key];
  1194. }
  1195. }
  1196. }
  1197. /**
  1198. * Implements hook_user_categories().
  1199. */
  1200. function user_user_categories() {
  1201. return array(array(
  1202. 'name' => 'account',
  1203. 'title' => t('Account settings'),
  1204. 'weight' => 1,
  1205. ));
  1206. }
  1207. function user_login_block($form) {
  1208. $form['#action'] = url(current_path(), array('query' => drupal_get_destination(), 'external' => FALSE));
  1209. $form['#id'] = 'user-login-form';
  1210. $form['#validate'] = user_login_default_validators();
  1211. $form['#submit'][] = 'user_login_submit';
  1212. $form['name'] = array('#type' => 'textfield',
  1213. '#title' => t('Username'),
  1214. '#maxlength' => USERNAME_MAX_LENGTH,
  1215. '#size' => 15,
  1216. '#required' => TRUE,
  1217. );
  1218. $form['pass'] = array('#type' => 'password',
  1219. '#title' => t('Password'),
  1220. '#size' => 15,
  1221. '#required' => TRUE,
  1222. );
  1223. $form['actions'] = array('#type' => 'actions');
  1224. $form['actions']['submit'] = array('#type' => 'submit',
  1225. '#value' => t('Log in'),
  1226. );
  1227. $items = array();
  1228. if (variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)) {
  1229. $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
  1230. }
  1231. $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
  1232. $form['links'] = array('#markup' => theme('item_list', array('items' => $items)));
  1233. return $form;
  1234. }
  1235. /**
  1236. * Implements hook_block_info().
  1237. */
  1238. function user_block_info() {
  1239. global $user;
  1240. $blocks['login']['info'] = t('User login');
  1241. // Not worth caching.
  1242. $blocks['login']['cache'] = DRUPAL_NO_CACHE;
  1243. $blocks['new']['info'] = t('Who\'s new');
  1244. $blocks['new']['properties']['administrative'] = TRUE;
  1245. // Too dynamic to cache.
  1246. $blocks['online']['info'] = t('Who\'s online');
  1247. $blocks['online']['cache'] = DRUPAL_NO_CACHE;
  1248. $blocks['online']['properties']['administrative'] = TRUE;
  1249. return $blocks;
  1250. }
  1251. /**
  1252. * Implements hook_block_configure().
  1253. */
  1254. function user_block_configure($delta = '') {
  1255. global $user;
  1256. switch ($delta) {
  1257. case 'new':
  1258. $form['user_block_whois_new_count'] = array(
  1259. '#type' => 'select',
  1260. '#title' => t('Number of users to display'),
  1261. '#default_value' => variable_get('user_block_whois_new_count', 5),
  1262. '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
  1263. );
  1264. return $form;
  1265. case 'online':
  1266. $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
  1267. $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.'));
  1268. $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.'));
  1269. return $form;
  1270. }
  1271. }
  1272. /**
  1273. * Implements hook_block_save().
  1274. */
  1275. function user_block_save($delta = '', $edit = array()) {
  1276. global $user;
  1277. switch ($delta) {
  1278. case 'new':
  1279. variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  1280. break;
  1281. case 'online':
  1282. variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
  1283. variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  1284. break;
  1285. }
  1286. }
  1287. /**
  1288. * Implements hook_block_view().
  1289. */
  1290. function user_block_view($delta = '') {
  1291. global $user;
  1292. $block = array();
  1293. switch ($delta) {
  1294. case 'login':
  1295. // For usability's sake, avoid showing two login forms on one page.
  1296. if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
  1297. $block['subject'] = t('User login');
  1298. $block['content'] = drupal_get_form('user_login_block');
  1299. }
  1300. return $block;
  1301. case 'new':
  1302. if (user_access('access content')) {
  1303. // Retrieve a list of new users who have subsequently accessed the site successfully.
  1304. $items = db_query_range('SELECT uid, name FROM {users} WHERE status <> 0 AND access <> 0 ORDER BY created DESC', 0, variable_get('user_block_whois_new_count', 5))->fetchAll();
  1305. $output = theme('user_list', array('users' => $items));
  1306. $block['subject'] = t('Who\'s new');
  1307. $block['content'] = $output;
  1308. }
  1309. return $block;
  1310. case 'online':
  1311. if (user_access('access content')) {
  1312. // Count users active within the defined period.
  1313. $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
  1314. // Perform database queries to gather online user lists. We use s.timestamp
  1315. // rather than u.access because it is much faster.
  1316. $authenticated_count = db_query("SELECT COUNT(DISTINCT s.uid) FROM {sessions} s WHERE s.timestamp >= :timestamp AND s.uid > 0", array(':timestamp' => $interval))->fetchField();
  1317. $output = '<p>' . format_plural($authenticated_count, 'There is currently 1 user online.', 'There are currently @count users online.') . '</p>';
  1318. // Display a list of currently online users.
  1319. $max_users = variable_get('user_block_max_list_count', 10);
  1320. if ($authenticated_count && $max_users) {
  1321. $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', 0, $max_users, array(':interval' => $interval))->fetchAll();
  1322. $output .= theme('user_list', array('users' => $items));
  1323. }
  1324. $block['subject'] = t('Who\'s online');
  1325. $block['content'] = $output;
  1326. }
  1327. return $block;
  1328. }
  1329. }
  1330. /**
  1331. * Process variables for user-picture.tpl.php.
  1332. *
  1333. * The $variables array contains the following arguments:
  1334. * - $account: A user, node or comment object with 'name', 'uid' and 'picture'
  1335. * fields.
  1336. *
  1337. * @see user-picture.tpl.php
  1338. */
  1339. function template_preprocess_user_picture(&$variables) {
  1340. $variables['user_picture'] = '';
  1341. if (variable_get('user_pictures', 0)) {
  1342. $account = $variables['account'];
  1343. if (!empty($account->picture)) {
  1344. // @TODO: Ideally this function would only be passed file objects, but
  1345. // since there's a lot of legacy code that JOINs the {users} table to
  1346. // {node} or {comments} and passes the results into this function if we
  1347. // a numeric value in the picture field we'll assume it's a file id
  1348. // and load it for them. Once we've got user_load_multiple() and
  1349. // comment_load_multiple() functions the user module will be able to load
  1350. // the picture files in mass during the object's load process.
  1351. if (is_numeric($account->picture)) {
  1352. $account->picture = file_load($account->picture);
  1353. }
  1354. if (!empty($account->picture->uri)) {
  1355. $filepath = $account->picture->uri;
  1356. }
  1357. }
  1358. elseif (variable_get('user_picture_default', '')) {
  1359. $filepath = variable_get('user_picture_default', '');
  1360. }
  1361. if (isset($filepath)) {
  1362. $alt = t("@user's picture", array('@user' => format_username($account)));
  1363. // If the image does not have a valid Drupal scheme (for eg. HTTP),
  1364. // don't load image styles.
  1365. if (module_exists('image') && file_valid_uri($filepath) && $style = variable_get('user_picture_style', '')) {
  1366. $variables['user_picture'] = theme('image_style', array('style_name' => $style, 'path' => $filepath, 'alt' => $alt, 'title' => $alt));
  1367. }
  1368. else {
  1369. $variables['user_picture'] = theme('image', array('path' => $filepath, 'alt' => $alt, 'title' => $alt));
  1370. }
  1371. if (!empty($account->uid) && user_access('access user profiles')) {
  1372. $attributes = array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE);
  1373. $variables['user_picture'] = l($variables['user_picture'], "user/$account->uid", $attributes);
  1374. }
  1375. }
  1376. }
  1377. }
  1378. /**
  1379. * Returns HTML for a list of users.
  1380. *
  1381. * @param $variables
  1382. * An associative array containing:
  1383. * - users: An array with user objects. Should contain at least the name and
  1384. * uid.
  1385. * - title: (optional) Title to pass on to theme_item_list().
  1386. *
  1387. * @ingroup themeable
  1388. */
  1389. function theme_user_list($variables) {
  1390. $users = $variables['users'];
  1391. $title = $variables['title'];
  1392. $items = array();
  1393. if (!empty($users)) {
  1394. foreach ($users as $user) {
  1395. $items[] = theme('username', array('account' => $user));
  1396. }
  1397. }
  1398. return theme('item_list', array('items' => $items, 'title' => $title));
  1399. }
  1400. /**
  1401. * Determines if the current user is anonymous.
  1402. *
  1403. * @return bool
  1404. * TRUE if the user is anonymous, FALSE if the user is authenticated.
  1405. */
  1406. function user_is_anonymous() {
  1407. // Menu administrators can see items for anonymous when administering.
  1408. return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
  1409. }
  1410. /**
  1411. * Determines if the current user is logged in.
  1412. *
  1413. * @return bool
  1414. * TRUE if the user is logged in, FALSE if the user is anonymous.
  1415. */
  1416. function user_is_logged_in() {
  1417. return (bool) $GLOBALS['user']->uid;
  1418. }
  1419. /**
  1420. * Determines if the current user has access to the user registration page.
  1421. *
  1422. * @return bool
  1423. * TRUE if the user is not already logged in and can register for an account.
  1424. */
  1425. function user_register_access() {
  1426. return user_is_anonymous() && variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
  1427. }
  1428. /**
  1429. * User view access callback.
  1430. *
  1431. * @param $account
  1432. * Can either be a full user object or a $uid.
  1433. */
  1434. function user_view_access($account) {
  1435. $uid = is_object($account) ? $account->uid : (int) $account;
  1436. // Never allow access to view the anonymous user account.
  1437. if ($uid) {
  1438. // Admins can view all, users can view own profiles at all times.
  1439. if ($GLOBALS['user']->uid == $uid || user_access('administer users')) {
  1440. return TRUE;
  1441. }
  1442. elseif (user_access('access user profiles')) {
  1443. // At this point, load the complete account object.
  1444. if (!is_object($account)) {
  1445. $account = user_load($uid);
  1446. }
  1447. return (is_object($account) && $account->status);
  1448. }
  1449. }
  1450. return FALSE;
  1451. }
  1452. /**
  1453. * Access callback for user account editing.
  1454. */
  1455. function user_edit_access($account) {
  1456. return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
  1457. }
  1458. /**
  1459. * Menu access callback; limit access to account cancellation pages.
  1460. *
  1461. * Limit access to users with the 'cancel account' permission or administrative
  1462. * users, and prevent the anonymous user from cancelling the account.
  1463. */
  1464. function user_cancel_access($account) {
  1465. return ((($GLOBALS['user']->uid == $account->uid) && user_access('cancel account')) || user_access('administer users')) && $account->uid > 0;
  1466. }
  1467. /**
  1468. * Implements hook_menu().
  1469. */
  1470. function user_menu() {
  1471. $items['user/autocomplete'] = array(
  1472. 'title' => 'User autocomplete',
  1473. 'page callback' => 'user_autocomplete',
  1474. 'access callback' => 'user_access',
  1475. 'access arguments' => array('access user profiles'),
  1476. 'type' => MENU_CALLBACK,
  1477. 'file' => 'user.pages.inc',
  1478. );
  1479. // Registration and login pages.
  1480. $items['user'] = array(
  1481. 'title' => 'User account',
  1482. 'title callback' => 'user_menu_title',
  1483. 'page callback' => 'user_page',
  1484. 'access callback' => TRUE,
  1485. 'file' => 'user.pages.inc',
  1486. 'weight' => -10,
  1487. 'menu_name' => 'user-menu',
  1488. );
  1489. $items['user/login'] = array(
  1490. 'title' => 'Log in',
  1491. 'access callback' => 'user_is_anonymous',
  1492. 'type' => MENU_DEFAULT_LOCAL_TASK,
  1493. );
  1494. $items['user/register'] = array(
  1495. 'title' => 'Create new account',
  1496. 'page callback' => 'drupal_get_form',
  1497. 'page arguments' => array('user_register_form'),
  1498. 'access callback' => 'user_register_access',
  1499. 'type' => MENU_LOCAL_TASK,
  1500. );
  1501. $items['user/password'] = array(
  1502. 'title' => 'Request new password',
  1503. 'page callback' => 'drupal_get_form',
  1504. 'page arguments' => array('user_pass'),
  1505. 'access callback' => TRUE,
  1506. 'type' => MENU_LOCAL_TASK,
  1507. 'file' => 'user.pages.inc',
  1508. );
  1509. $items['user/reset/%/%/%'] = array(
  1510. 'title' => 'Reset password',
  1511. 'page callback' => 'drupal_get_form',
  1512. 'page arguments' => array('user_pass_reset', 2, 3, 4),
  1513. 'access callback' => TRUE,
  1514. 'type' => MENU_CALLBACK,
  1515. 'file' => 'user.pages.inc',
  1516. );
  1517. $items['user/logout'] = array(
  1518. 'title' => 'Log out',
  1519. 'access callback' => 'user_is_logged_in',
  1520. 'page callback' => 'user_logout',
  1521. 'weight' => 10,
  1522. 'menu_name' => 'user-menu',
  1523. 'file' => 'user.pages.inc',
  1524. );
  1525. // User listing pages.
  1526. $items['admin/people'] = array(
  1527. 'title' => 'People',
  1528. 'description' => 'Manage user accounts, roles, and permissions.',
  1529. 'page callback' => 'user_admin',
  1530. 'page arguments' => array('list'),
  1531. 'access arguments' => array('administer users'),
  1532. 'position' => 'left',
  1533. 'weight' => -4,
  1534. 'file' => 'user.admin.inc',
  1535. );
  1536. $items['admin/people/people'] = array(
  1537. 'title' => 'List',
  1538. 'description' => 'Find and manage people interacting with your site.',
  1539. 'access arguments' => array('administer users'),
  1540. 'type' => MENU_DEFAULT_LOCAL_TASK,
  1541. 'weight' => -10,
  1542. 'file' => 'user.admin.inc',
  1543. );
  1544. // Permissions and role forms.
  1545. $items['admin/people/permissions'] = array(
  1546. 'title' => 'Permissions',
  1547. 'description' => 'Determine access to features by selecting permissions for roles.',
  1548. 'page callback' => 'drupal_get_form',
  1549. 'page arguments' => array('user_admin_permissions'),
  1550. 'access arguments' => array('administer permissions'),
  1551. 'file' => 'user.admin.inc',
  1552. 'type' => MENU_LOCAL_TASK,
  1553. );
  1554. $items['admin/people/permissions/list'] = array(
  1555. 'title' => 'Permissions',
  1556. 'description' => 'Determine access to features by selecting permissions for roles.',
  1557. 'type' => MENU_DEFAULT_LOCAL_TASK,
  1558. 'weight' => -8,
  1559. );
  1560. $items['admin/people/permissions/roles'] = array(
  1561. 'title' => 'Roles',
  1562. 'description' => 'List, edit, or add user roles.',
  1563. 'page callback' => 'drupal_get_form',
  1564. 'page arguments' => array('user_admin_roles'),
  1565. 'access arguments' => array('administer permissions'),
  1566. 'file' => 'user.admin.inc',
  1567. 'type' => MENU_LOCAL_TASK,
  1568. 'weight' => -5,
  1569. );
  1570. $items['admin/people/permissions/roles/edit/%user_role'] = array(
  1571. 'title' => 'Edit role',
  1572. 'page arguments' => array('user_admin_role', 5),
  1573. 'access callback' => 'user_role_edit_access',
  1574. 'access arguments' => array(5),
  1575. );
  1576. $items['admin/people/permissions/roles/delete/%user_role'] = array(
  1577. 'title' => 'Delete role',
  1578. 'page callback' => 'drupal_get_form',
  1579. 'page arguments' => array('user_admin_role_delete_confirm', 5),
  1580. 'access callback' => 'user_role_edit_access',
  1581. 'access arguments' => array(5),
  1582. 'file' => 'user.admin.inc',
  1583. );
  1584. $items['admin/people/create'] = array(
  1585. 'title' => 'Add user',
  1586. 'page arguments' => array('create'),
  1587. 'access arguments' => array('administer users'),
  1588. 'type' => MENU_LOCAL_ACTION,
  1589. );
  1590. // Administration pages.
  1591. $items['admin/config/people'] = array(
  1592. 'title' => 'People',
  1593. 'description' => 'Configure user accounts.',
  1594. 'position' => 'left',
  1595. 'weight' => -20,
  1596. 'page callback' => 'system_admin_menu_block_page',
  1597. 'access arguments' => array('access administration pages'),
  1598. 'file' => 'system.admin.inc',
  1599. 'file path' => drupal_get_path('module', 'system'),
  1600. );
  1601. $items['admin/config/people/accounts'] = array(
  1602. 'title' => 'Account settings',
  1603. 'description' => 'Configure default behavior of users, including registration requirements, e-mails, fields, and user pictures.',
  1604. 'page callback' => 'drupal_get_form',
  1605. 'page arguments' => array('user_admin_settings'),
  1606. 'access arguments' => array('administer users'),
  1607. 'file' => 'user.admin.inc',
  1608. 'weight' => -10,
  1609. );
  1610. $items['admin/config/people/accounts/settings'] = array(
  1611. 'title' => 'Settings',
  1612. 'type' => MENU_DEFAULT_LOCAL_TASK,
  1613. 'weight' => -10,
  1614. );
  1615. $items['user/%user'] = array(
  1616. 'title' => 'My account',
  1617. 'title callback' => 'user_page_title',
  1618. 'title arguments' => array(1),
  1619. 'page callback' => 'user_view_page',
  1620. 'page arguments' => array(1),
  1621. 'access callback' => 'user_view_access',
  1622. 'access arguments' => array(1),
  1623. // By assigning a different menu name, this item (and all registered child
  1624. // paths) are no longer considered as children of 'user'. When accessing the
  1625. // user account pages, the preferred menu link that is used to build the
  1626. // active trail (breadcrumb) will be found in this menu (unless there is
  1627. // more specific link), so the link to 'user' will not be in the breadcrumb.
  1628. 'menu_name' => 'navigation',
  1629. );
  1630. $items['user/%user/view'] = array(
  1631. 'title' => 'View',
  1632. 'type' => MENU_DEFAULT_LOCAL_TASK,
  1633. 'weight' => -10,
  1634. );
  1635. $items['user/%user/cancel'] = array(
  1636. 'title' => 'Cancel account',
  1637. 'page callback' => 'drupal_get_form',
  1638. 'page arguments' => array('user_cancel_confirm_form', 1),
  1639. 'access callback' => 'user_cancel_access',
  1640. 'access arguments' => array(1),
  1641. 'file' => 'user.pages.inc',
  1642. );
  1643. $items['user/%user/cancel/confirm/%/%'] = array(
  1644. 'title' => 'Confirm account cancellation',
  1645. 'page callback' => 'user_cancel_confirm',
  1646. 'page arguments' => array(1, 4, 5),
  1647. 'access callback' => 'user_cancel_access',
  1648. 'access arguments' => array(1),
  1649. 'file' => 'user.pages.inc',
  1650. );
  1651. $items['user/%user/edit'] = array(
  1652. 'title' => 'Edit',
  1653. 'page callback' => 'drupal_get_form',
  1654. 'page arguments' => array('user_profile_form', 1),
  1655. 'access callback' => 'user_edit_access',
  1656. 'access arguments' => array(1),
  1657. 'type' => MENU_LOCAL_TASK,
  1658. 'file' => 'user.pages.inc',
  1659. );
  1660. $items['user/%user_category/edit/account'] = array(
  1661. 'title' => 'Account',
  1662. 'type' => MENU_DEFAULT_LOCAL_TASK,
  1663. 'load arguments' => array('%map', '%index'),
  1664. );
  1665. if (($categories = _user_categories()) && (count($categories) > 1)) {
  1666. foreach ($categories as $key => $category) {
  1667. // 'account' is already handled by the MENU_DEFAULT_LOCAL_TASK.
  1668. if ($category['name'] != 'account') {
  1669. $items['user/%user_category/edit/' . $category['name']] = array(
  1670. 'title callback' => 'check_plain',
  1671. 'title arguments' => array($category['title']),
  1672. 'page callback' => 'drupal_get_form',
  1673. 'page arguments' => array('user_profile_form', 1, 3),
  1674. 'access callback' => isset($category['access callback']) ? $category['access callback'] : 'user_edit_access',
  1675. 'access arguments' => isset($category['access arguments']) ? $category['access arguments'] : array(1),
  1676. 'type' => MENU_LOCAL_TASK,
  1677. 'weight' => $category['weight'],
  1678. 'load arguments' => array('%map', '%index'),
  1679. 'tab_parent' => 'user/%/edit',
  1680. 'file' => 'user.pages.inc',
  1681. );
  1682. }
  1683. }
  1684. }
  1685. return $items;
  1686. }
  1687. /**
  1688. * Implements hook_menu_site_status_alter().
  1689. */
  1690. function user_menu_site_status_alter(&$menu_site_status, $path) {
  1691. if ($menu_site_status == MENU_SITE_OFFLINE) {
  1692. // If the site is offline, log out unprivileged users.
  1693. if (user_is_logged_in() && !user_access('access site in maintenance mode')) {
  1694. module_load_include('pages.inc', 'user', 'user');
  1695. user_logout();
  1696. }
  1697. if (user_is_anonymous()) {
  1698. switch ($path) {
  1699. case 'user':
  1700. // Forward anonymous user to login page.
  1701. drupal_goto('user/login');
  1702. case 'user/login':
  1703. case 'user/password':
  1704. // Disable offline mode.
  1705. $menu_site_status = MENU_SITE_ONLINE;
  1706. break;
  1707. default:
  1708. if (strpos($path, 'user/reset/') === 0) {
  1709. // Disable offline mode.
  1710. $menu_site_status = MENU_SITE_ONLINE;
  1711. }
  1712. break;
  1713. }
  1714. }
  1715. }
  1716. if (user_is_logged_in()) {
  1717. if ($path == 'user/login') {
  1718. // If user is logged in, redirect to 'user' instead of giving 403.
  1719. drupal_goto('user');
  1720. }
  1721. if ($path == 'user/register') {
  1722. // Authenticated user should be redirected to user edit page.
  1723. drupal_goto('user/' . $GLOBALS['user']->uid . '/edit');
  1724. }
  1725. }
  1726. }
  1727. /**
  1728. * Implements hook_menu_link_alter().
  1729. */
  1730. function user_menu_link_alter(&$link) {
  1731. // The path 'user' must be accessible for anonymous users, but only visible
  1732. // for authenticated users. Authenticated users should see "My account", but
  1733. // anonymous users should not see it at all. Therefore, invoke
  1734. // user_translated_menu_link_alter() to conditionally hide the link.
  1735. if ($link['link_path'] == 'user' && $link['module'] == 'system') {
  1736. $link['options']['alter'] = TRUE;
  1737. }
  1738. // Force the Logout link to appear on the top-level of 'user-menu' menu by
  1739. // default (i.e., unless it has been customized).
  1740. if ($link['link_path'] == 'user/logout' && $link['module'] == 'system' && empty($link['customized'])) {
  1741. $link['plid'] = 0;
  1742. }
  1743. }
  1744. /**
  1745. * Implements hook_translated_menu_link_alter().
  1746. */
  1747. function user_translated_menu_link_alter(&$link) {
  1748. // Hide the "User account" link for anonymous users.
  1749. if ($link['link_path'] == 'user' && $link['module'] == 'system' && !$GLOBALS['user']->uid) {
  1750. $link['hidden'] = 1;
  1751. }
  1752. }
  1753. /**
  1754. * Implements hook_admin_paths().
  1755. */
  1756. function user_admin_paths() {
  1757. $paths = array(
  1758. 'user/*/cancel' => TRUE,
  1759. 'user/*/edit' => TRUE,
  1760. 'user/*/edit/*' => TRUE,
  1761. );
  1762. return $paths;
  1763. }
  1764. /**
  1765. * Returns $arg or the user ID of the current user if $arg is '%' or empty.
  1766. *
  1767. * Deprecated. Use %user_uid_optional instead.
  1768. *
  1769. * @todo D8: Remove.
  1770. */
  1771. function user_uid_only_optional_to_arg($arg) {
  1772. return user_uid_optional_to_arg($arg);
  1773. }
  1774. /**
  1775. * Load either a specified or the current user account.
  1776. *
  1777. * @param $uid
  1778. * An optional user ID of the user to load. If not provided, the current
  1779. * user's ID will be used.
  1780. * @return
  1781. * A fully-loaded $user object upon successful user load, FALSE if user
  1782. * cannot be loaded.
  1783. *
  1784. * @see user_load()
  1785. * @todo rethink the naming of this in Drupal 8.
  1786. */
  1787. function user_uid_optional_load($uid = NULL) {
  1788. if (!isset($uid)) {
  1789. $uid = $GLOBALS['user']->uid;
  1790. }
  1791. return user_load($uid);
  1792. }
  1793. /**
  1794. * Return a user object after checking if any profile category in the path exists.
  1795. */
  1796. function user_category_load($uid, &$map, $index) {
  1797. static $user_categories, $accounts;
  1798. // Cache $account - this load function will get called for each profile tab.
  1799. if (!isset($accounts[$uid])) {
  1800. $accounts[$uid] = user_load($uid);
  1801. }
  1802. $valid = TRUE;
  1803. if ($account = $accounts[$uid]) {
  1804. // Since the path is like user/%/edit/category_name, the category name will
  1805. // be at a position 2 beyond the index corresponding to the % wildcard.
  1806. $category_index = $index + 2;
  1807. // Valid categories may contain slashes, and hence need to be imploded.
  1808. $category_path = implode('/', array_slice($map, $category_index));
  1809. if ($category_path) {
  1810. // Check that the requested category exists.
  1811. $valid = FALSE;
  1812. if (!isset($user_categories)) {
  1813. $user_categories = _user_categories();
  1814. }
  1815. foreach ($user_categories as $category) {
  1816. if ($category['name'] == $category_path) {
  1817. $valid = TRUE;
  1818. // Truncate the map array in case the category name had slashes.
  1819. $map = array_slice($map, 0, $category_index);
  1820. // Assign the imploded category name to the last map element.
  1821. $map[$category_index] = $category_path;
  1822. break;
  1823. }
  1824. }
  1825. }
  1826. }
  1827. return $valid ? $account : FALSE;
  1828. }
  1829. /**
  1830. * Returns $arg or the user ID of the current user if $arg is '%' or empty.
  1831. *
  1832. * @todo rethink the naming of this in Drupal 8.
  1833. */
  1834. function user_uid_optional_to_arg($arg) {
  1835. // Give back the current user uid when called from eg. tracker, aka.
  1836. // with an empty arg. Also use the current user uid when called from
  1837. // the menu with a % for the current account link.
  1838. return empty($arg) || $arg == '%' ? $GLOBALS['user']->uid : $arg;
  1839. }
  1840. /**
  1841. * Menu item title callback for the 'user' path.
  1842. *
  1843. * Anonymous users should see "User account", but authenticated users are
  1844. * expected to see "My account".
  1845. */
  1846. function user_menu_title() {
  1847. return user_is_logged_in() ? t('My account') : t('User account');
  1848. }
  1849. /**
  1850. * Menu item title callback - use the user name.
  1851. */
  1852. function user_page_title($account) {
  1853. return is_object($account) ? format_username($account) : '';
  1854. }
  1855. /**
  1856. * Discover which external authentication module(s) authenticated a username.
  1857. *
  1858. * @param $authname
  1859. * A username used by an external authentication module.
  1860. * @return
  1861. * An associative array with module as key and username as value.
  1862. */
  1863. function user_get_authmaps($authname = NULL) {
  1864. $authmaps = db_query("SELECT module, authname FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchAllKeyed();
  1865. return count($authmaps) ? $authmaps : 0;
  1866. }
  1867. /**
  1868. * Save mappings of which external authentication module(s) authenticated
  1869. * a user. Maps external usernames to user ids in the users table.
  1870. *
  1871. * @param $account
  1872. * A user object.
  1873. * @param $authmaps
  1874. * An associative array with a compound key and the username as the value.
  1875. * The key is made up of 'authname_' plus the name of the external authentication
  1876. * module.
  1877. * @see user_external_login_register()
  1878. */
  1879. function user_set_authmaps($account, $authmaps) {
  1880. foreach ($authmaps as $key => $value) {
  1881. $module = explode('_', $key, 2);
  1882. if ($value) {
  1883. db_merge('authmap')
  1884. ->key(array(
  1885. 'uid' => $account->uid,
  1886. 'module' => $module[1],
  1887. ))
  1888. ->fields(array('authname' => $value))
  1889. ->execute();
  1890. }
  1891. else {
  1892. db_delete('authmap')
  1893. ->condition('uid', $account->uid)
  1894. ->condition('module', $module[1])
  1895. ->execute();
  1896. }
  1897. }
  1898. }
  1899. /**
  1900. * Form builder; the main user login form.
  1901. *
  1902. * @ingroup forms
  1903. */
  1904. function user_login($form, &$form_state) {
  1905. global $user;
  1906. // If we are already logged on, go to the user page instead.
  1907. if ($user->uid) {
  1908. drupal_goto('user/' . $user->uid);
  1909. }
  1910. // Display login form:
  1911. $form['name'] = array('#type' => 'textfield',
  1912. '#title' => t('Username'),
  1913. '#size' => 60,
  1914. '#maxlength' => USERNAME_MAX_LENGTH,
  1915. '#required' => TRUE,
  1916. );
  1917. $form['name']['#description'] = t('Enter your @s username.', array('@s' => variable_get('site_name', 'Drupal')));
  1918. $form['pass'] = array('#type' => 'password',
  1919. '#title' => t('Password'),
  1920. '#description' => t('Enter the password that accompanies your username.'),
  1921. '#required' => TRUE,
  1922. );
  1923. $form['#validate'] = user_login_default_validators();
  1924. $form['actions'] = array('#type' => 'actions');
  1925. $form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Log in'));
  1926. return $form;
  1927. }
  1928. /**
  1929. * Set up a series for validators which check for blocked users,
  1930. * then authenticate against local database, then return an error if
  1931. * authentication fails. Distributed authentication modules are welcome
  1932. * to use hook_form_alter() to change this series in order to
  1933. * authenticate against their user database instead of the local users
  1934. * table. If a distributed authentication module is successful, it
  1935. * should set $form_state['uid'] to a user ID.
  1936. *
  1937. * We use three validators instead of one since external authentication
  1938. * modules usually only need to alter the second validator.
  1939. *
  1940. * @see user_login_name_validate()
  1941. * @see user_login_authenticate_validate()
  1942. * @see user_login_final_validate()
  1943. * @return array
  1944. * A simple list of validate functions.
  1945. */
  1946. function user_login_default_validators() {
  1947. return array('user_login_name_validate', 'user_login_authenticate_validate', 'user_login_final_validate');
  1948. }
  1949. /**
  1950. * A FAPI validate handler. Sets an error if supplied username has been blocked.
  1951. */
  1952. function user_login_name_validate($form, &$form_state) {
  1953. if (!empty($form_state['values']['name']) && user_is_blocked($form_state['values']['name'])) {
  1954. // Blocked in user administration.
  1955. form_set_error('name', t('The username %name has not been activated or is blocked.', array('%name' => $form_state['values']['name'])));
  1956. }
  1957. }
  1958. /**
  1959. * A validate handler on the login form. Check supplied username/password
  1960. * against local users table. If successful, $form_state['uid']
  1961. * is set to the matching user ID.
  1962. */
  1963. function user_login_authenticate_validate($form, &$form_state) {
  1964. $password = trim($form_state['values']['pass']);
  1965. if (!empty($form_state['values']['name']) && !empty($password)) {
  1966. // Do not allow any login from the current user's IP if the limit has been
  1967. // reached. Default is 50 failed attempts allowed in one hour. This is
  1968. // independent of the per-user limit to catch attempts from one IP to log
  1969. // in to many different user accounts. We have a reasonably high limit
  1970. // since there may be only one apparent IP for all users at an institution.
  1971. if (!flood_is_allowed('failed_login_attempt_ip', variable_get('user_failed_login_ip_limit', 50), variable_get('user_failed_login_ip_window', 3600))) {
  1972. $form_state['flood_control_triggered'] = 'ip';
  1973. return;
  1974. }
  1975. $account = db_query("SELECT * FROM {users} WHERE name = :name AND status = 1", array(':name' => $form_state['values']['name']))->fetchObject();
  1976. if ($account) {
  1977. if (variable_get('user_failed_login_identifier_uid_only', FALSE)) {
  1978. // Register flood events based on the uid only, so they apply for any
  1979. // IP address. This is the most secure option.
  1980. $identifier = $account->uid;
  1981. }
  1982. else {
  1983. // The default identifier is a combination of uid and IP address. This
  1984. // is less secure but more resistant to denial-of-service attacks that
  1985. // could lock out all users with public user names.
  1986. $identifier = $account->uid . '-' . ip_address();
  1987. }
  1988. $form_state['flood_control_user_identifier'] = $identifier;
  1989. // Don't allow login if the limit for this user has been reached.
  1990. // Default is to allow 5 failed attempts every 6 hours.
  1991. 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)) {
  1992. $form_state['flood_control_triggered'] = 'user';
  1993. return;
  1994. }
  1995. }
  1996. // We are not limited by flood control, so try to authenticate.
  1997. // Set $form_state['uid'] as a flag for user_login_final_validate().
  1998. $form_state['uid'] = user_authenticate($form_state['values']['name'], $password);
  1999. }
  2000. }
  2001. /**
  2002. * The final validation handler on the login form.
  2003. *
  2004. * Sets a form error if user has not been authenticated, or if too many
  2005. * logins have been attempted. This validation function should always
  2006. * be the last one.
  2007. */
  2008. function user_login_final_validate($form, &$form_state) {
  2009. if (empty($form_state['uid'])) {
  2010. // Always register an IP-based failed login event.
  2011. flood_register_event('failed_login_attempt_ip', variable_get('user_failed_login_ip_window', 3600));
  2012. // Register a per-user failed login event.
  2013. if (isset($form_state['flood_control_user_identifier'])) {
  2014. flood_register_event('failed_login_attempt_user', variable_get('user_failed_login_user_window', 21600), $form_state['flood_control_user_identifier']);
  2015. }
  2016. if (isset($form_state['flood_control_triggered'])) {
  2017. if ($form_state['flood_control_triggered'] == 'user') {
  2018. 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. Try again later or <a href="@url">request a new password</a>.', 'Sorry, there have been more than @count failed login attempts for this account. It is temporarily blocked. Try again later or <a href="@url">request a new password</a>.', array('@url' => url('user/password'))));
  2019. }
  2020. else {
  2021. // We did not find a uid, so the limit is IP-based.
  2022. form_set_error('name', t('Sorry, too many failed login attempts from your IP address. This IP address is temporarily blocked. Try again later or <a href="@url">request a new password</a>.', array('@url' => url('user/password'))));
  2023. }
  2024. }
  2025. else {
  2026. form_set_error('name', t('Sorry, unrecognized username or password. <a href="@password">Have you forgotten your password?</a>', array('@password' => url('user/password', array('query' => array('name' => $form_state['values']['name']))))));
  2027. watchdog('user', 'Login attempt failed for %user.', array('%user' => $form_state['values']['name']));
  2028. }
  2029. }
  2030. elseif (isset($form_state['flood_control_user_identifier'])) {
  2031. // Clear past failures for this user so as not to block a user who might
  2032. // log in and out more than once in an hour.
  2033. flood_clear_event('failed_login_attempt_user', $form_state['flood_control_user_identifier']);
  2034. }
  2035. }
  2036. /**
  2037. * Try to validate the user's login credentials locally.
  2038. *
  2039. * @param $name
  2040. * User name to authenticate.
  2041. * @param $password
  2042. * A plain-text password, such as trimmed text from form values.
  2043. * @return
  2044. * The user's uid on success, or FALSE on failure to authenticate.
  2045. */
  2046. function user_authenticate($name, $password) {
  2047. $uid = FALSE;
  2048. if (!empty($name) && !empty($password)) {
  2049. $account = user_load_by_name($name);
  2050. if ($account) {
  2051. // Allow alternate password hashing schemes.
  2052. require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
  2053. if (user_check_password($password, $account)) {
  2054. // Successful authentication.
  2055. $uid = $account->uid;
  2056. // Update user to new password scheme if needed.
  2057. if (user_needs_new_hash($account)) {
  2058. user_save($account, array('pass' => $password));
  2059. }
  2060. }
  2061. }
  2062. }
  2063. return $uid;
  2064. }
  2065. /**
  2066. * Finalize the login process. Must be called when logging in a user.
  2067. *
  2068. * The function records a watchdog message about the new session, saves the
  2069. * login timestamp, calls hook_user_login(), and generates a new session.
  2070. *
  2071. * @param array $edit
  2072. * The array of form values submitted by the user.
  2073. *
  2074. * @see hook_user_login()
  2075. */
  2076. function user_login_finalize(&$edit = array()) {
  2077. global $user;
  2078. watchdog('user', 'Session opened for %name.', array('%name' => $user->name));
  2079. // Update the user table timestamp noting user has logged in.
  2080. // This is also used to invalidate one-time login links.
  2081. $user->login = REQUEST_TIME;
  2082. db_update('users')
  2083. ->fields(array('login' => $user->login))
  2084. ->condition('uid', $user->uid)
  2085. ->execute();
  2086. // Regenerate the session ID to prevent against session fixation attacks.
  2087. // This is called before hook_user in case one of those functions fails
  2088. // or incorrectly does a redirect which would leave the old session in place.
  2089. drupal_session_regenerate();
  2090. user_module_invoke('login', $edit, $user);
  2091. }
  2092. /**
  2093. * Submit handler for the login form. Load $user object and perform standard login
  2094. * tasks. The user is then redirected to the My Account page. Setting the
  2095. * destination in the query string overrides the redirect.
  2096. */
  2097. function user_login_submit($form, &$form_state) {
  2098. global $user;
  2099. $user = user_load($form_state['uid']);
  2100. $form_state['redirect'] = 'user/' . $user->uid;
  2101. user_login_finalize($form_state);
  2102. }
  2103. /**
  2104. * Helper function for authentication modules. Either logs in or registers
  2105. * the current user, based on username. Either way, the global $user object is
  2106. * populated and login tasks are performed.
  2107. */
  2108. function user_external_login_register($name, $module) {
  2109. $account = user_external_load($name);
  2110. if (!$account) {
  2111. // Register this new user.
  2112. $userinfo = array(
  2113. 'name' => $name,
  2114. 'pass' => user_password(),
  2115. 'init' => $name,
  2116. 'status' => 1,
  2117. 'access' => REQUEST_TIME
  2118. );
  2119. $account = user_save(drupal_anonymous_user(), $userinfo);
  2120. // Terminate if an error occurred during user_save().
  2121. if (!$account) {
  2122. drupal_set_message(t("Error saving user account."), 'error');
  2123. return;
  2124. }
  2125. user_set_authmaps($account, array("authname_$module" => $name));
  2126. }
  2127. // Log user in.
  2128. $form_state['uid'] = $account->uid;
  2129. user_login_submit(array(), $form_state);
  2130. }
  2131. /**
  2132. * Generates a unique URL for a user to login and reset their password.
  2133. *
  2134. * @param object $account
  2135. * An object containing the user account, which must contain at least the
  2136. * following properties:
  2137. * - uid: The user ID number.
  2138. * - login: The UNIX timestamp of the user's last login.
  2139. *
  2140. * @return
  2141. * A unique URL that provides a one-time log in for the user, from which
  2142. * they can change their password.
  2143. */
  2144. function user_pass_reset_url($account) {
  2145. $timestamp = REQUEST_TIME;
  2146. return url("user/reset/$account->uid/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login), array('absolute' => TRUE));
  2147. }
  2148. /**
  2149. * Generates a URL to confirm an account cancellation request.
  2150. *
  2151. * @param object $account
  2152. * The user account object, which must contain at least the following
  2153. * properties:
  2154. * - uid: The user ID number.
  2155. * - pass: The hashed user password string.
  2156. * - login: The UNIX timestamp of the user's last login.
  2157. *
  2158. * @return
  2159. * A unique URL that may be used to confirm the cancellation of the user
  2160. * account.
  2161. *
  2162. * @see user_mail_tokens()
  2163. * @see user_cancel_confirm()
  2164. */
  2165. function user_cancel_url($account) {
  2166. $timestamp = REQUEST_TIME;
  2167. return url("user/$account->uid/cancel/confirm/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login), array('absolute' => TRUE));
  2168. }
  2169. /**
  2170. * Creates a unique hash value for use in time-dependent per-user URLs.
  2171. *
  2172. * This hash is normally used to build a unique and secure URL that is sent to
  2173. * the user by email for purposes such as resetting the user's password. In
  2174. * order to validate the URL, the same hash can be generated again, from the
  2175. * same information, and compared to the hash value from the URL. The URL
  2176. * normally contains both the time stamp and the numeric user ID. The login
  2177. * timestamp and hashed password are retrieved from the database as necessary.
  2178. * For a usage example, see user_cancel_url() and user_cancel_confirm().
  2179. *
  2180. * @param string $password
  2181. * The hashed user account password value.
  2182. * @param int $timestamp
  2183. * A UNIX timestamp, typically REQUEST_TIME.
  2184. * @param int $login
  2185. * The UNIX timestamp of the user's last login.
  2186. *
  2187. * @return
  2188. * A string that is safe for use in URLs and SQL statements.
  2189. */
  2190. function user_pass_rehash($password, $timestamp, $login) {
  2191. return drupal_hmac_base64($timestamp . $login, drupal_get_hash_salt() . $password);
  2192. }
  2193. /**
  2194. * Cancel a user account.
  2195. *
  2196. * Since the user cancellation process needs to be run in a batch, either
  2197. * Form API will invoke it, or batch_process() needs to be invoked after calling
  2198. * this function and should define the path to redirect to.
  2199. *
  2200. * @param $edit
  2201. * An array of submitted form values.
  2202. * @param $uid
  2203. * The user ID of the user account to cancel.
  2204. * @param $method
  2205. * The account cancellation method to use.
  2206. *
  2207. * @see _user_cancel()
  2208. */
  2209. function user_cancel($edit, $uid, $method) {
  2210. global $user;
  2211. $account = user_load($uid);
  2212. if (!$account) {
  2213. drupal_set_message(t('The user account %id does not exist.', array('%id' => $uid)), 'error');
  2214. watchdog('user', 'Attempted to cancel non-existing user account: %id.', array('%id' => $uid), WATCHDOG_ERROR);
  2215. return;
  2216. }
  2217. // Initialize batch (to set title).
  2218. $batch = array(
  2219. 'title' => t('Cancelling account'),
  2220. 'operations' => array(),
  2221. );
  2222. batch_set($batch);
  2223. // Modules use hook_user_delete() to respond to deletion.
  2224. if ($method != 'user_cancel_delete') {
  2225. // Allow modules to add further sets to this batch.
  2226. module_invoke_all('user_cancel', $edit, $account, $method);
  2227. }
  2228. // Finish the batch and actually cancel the account.
  2229. $batch = array(
  2230. 'title' => t('Cancelling user account'),
  2231. 'operations' => array(
  2232. array('_user_cancel', array($edit, $account, $method)),
  2233. ),
  2234. );
  2235. // After cancelling account, ensure that user is logged out.
  2236. if ($account->uid == $user->uid) {
  2237. // Batch API stores data in the session, so use the finished operation to
  2238. // manipulate the current user's session id.
  2239. $batch['finished'] = '_user_cancel_session_regenerate';
  2240. }
  2241. batch_set($batch);
  2242. // Batch processing is either handled via Form API or has to be invoked
  2243. // manually.
  2244. }
  2245. /**
  2246. * Last batch processing step for cancelling a user account.
  2247. *
  2248. * Since batch and session API require a valid user account, the actual
  2249. * cancellation of a user account needs to happen last.
  2250. *
  2251. * @see user_cancel()
  2252. */
  2253. function _user_cancel($edit, $account, $method) {
  2254. global $user;
  2255. switch ($method) {
  2256. case 'user_cancel_block':
  2257. case 'user_cancel_block_unpublish':
  2258. default:
  2259. // Send account blocked notification if option was checked.
  2260. if (!empty($edit['user_cancel_notify'])) {
  2261. _user_mail_notify('status_blocked', $account);
  2262. }
  2263. user_save($account, array('status' => 0));
  2264. drupal_set_message(t('%name has been disabled.', array('%name' => $account->name)));
  2265. watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
  2266. break;
  2267. case 'user_cancel_reassign':
  2268. case 'user_cancel_delete':
  2269. // Send account canceled notification if option was checked.
  2270. if (!empty($edit['user_cancel_notify'])) {
  2271. _user_mail_notify('status_canceled', $account);
  2272. }
  2273. user_delete($account->uid);
  2274. drupal_set_message(t('%name has been deleted.', array('%name' => $account->name)));
  2275. watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
  2276. break;
  2277. }
  2278. // After cancelling account, ensure that user is logged out. We can't destroy
  2279. // their session though, as we might have information in it, and we can't
  2280. // regenerate it because batch API uses the session ID, we will regenerate it
  2281. // in _user_cancel_session_regenerate().
  2282. if ($account->uid == $user->uid) {
  2283. $user = drupal_anonymous_user();
  2284. }
  2285. // Clear the cache for anonymous users.
  2286. cache_clear_all();
  2287. }
  2288. /**
  2289. * Finished batch processing callback for cancelling a user account.
  2290. *
  2291. * @see user_cancel()
  2292. */
  2293. function _user_cancel_session_regenerate() {
  2294. // Regenerate the users session instead of calling session_destroy() as we
  2295. // want to preserve any messages that might have been set.
  2296. drupal_session_regenerate();
  2297. }
  2298. /**
  2299. * Delete a user.
  2300. *
  2301. * @param $uid
  2302. * A user ID.
  2303. */
  2304. function user_delete($uid) {
  2305. user_delete_multiple(array($uid));
  2306. }
  2307. /**
  2308. * Delete multiple user accounts.
  2309. *
  2310. * @param $uids
  2311. * An array of user IDs.
  2312. */
  2313. function user_delete_multiple(array $uids) {
  2314. if (!empty($uids)) {
  2315. $accounts = user_load_multiple($uids, array());
  2316. $transaction = db_transaction();
  2317. try {
  2318. foreach ($accounts as $uid => $account) {
  2319. module_invoke_all('user_delete', $account);
  2320. module_invoke_all('entity_delete', $account, 'user');
  2321. field_attach_delete('user', $account);
  2322. drupal_session_destroy_uid($account->uid);
  2323. }
  2324. db_delete('users')
  2325. ->condition('uid', $uids, 'IN')
  2326. ->execute();
  2327. db_delete('users_roles')
  2328. ->condition('uid', $uids, 'IN')
  2329. ->execute();
  2330. db_delete('authmap')
  2331. ->condition('uid', $uids, 'IN')
  2332. ->execute();
  2333. }
  2334. catch (Exception $e) {
  2335. $transaction->rollback();
  2336. watchdog_exception('user', $e);
  2337. throw $e;
  2338. }
  2339. entity_get_controller('user')->resetCache();
  2340. }
  2341. }
  2342. /**
  2343. * Page callback wrapper for user_view().
  2344. */
  2345. function user_view_page($account) {
  2346. // An administrator may try to view a non-existent account,
  2347. // so we give them a 404 (versus a 403 for non-admins).
  2348. return is_object($account) ? user_view($account) : MENU_NOT_FOUND;
  2349. }
  2350. /**
  2351. * Generate an array for rendering the given user.
  2352. *
  2353. * When viewing a user profile, the $page array contains:
  2354. *
  2355. * - $page['content']['Profile Category']:
  2356. * Profile categories keyed by their human-readable names.
  2357. * - $page['content']['Profile Category']['profile_machine_name']:
  2358. * Profile fields keyed by their machine-readable names.
  2359. * - $page['content']['user_picture']:
  2360. * User's rendered picture.
  2361. * - $page['content']['summary']:
  2362. * Contains the default "History" profile data for a user.
  2363. * - $page['content']['#account']:
  2364. * The user account of the profile being viewed.
  2365. *
  2366. * To theme user profiles, copy modules/user/user-profile.tpl.php
  2367. * to your theme directory, and edit it as instructed in that file's comments.
  2368. *
  2369. * @param $account
  2370. * A user object.
  2371. * @param $view_mode
  2372. * View mode, e.g. 'full'.
  2373. * @param $langcode
  2374. * (optional) A language code to use for rendering. Defaults to the global
  2375. * content language of the current request.
  2376. *
  2377. * @return
  2378. * An array as expected by drupal_render().
  2379. */
  2380. function user_view($account, $view_mode = 'full', $langcode = NULL) {
  2381. if (!isset($langcode)) {
  2382. $langcode = $GLOBALS['language_content']->language;
  2383. }
  2384. // Retrieve all profile fields and attach to $account->content.
  2385. user_build_content($account, $view_mode, $langcode);
  2386. $build = $account->content;
  2387. // We don't need duplicate rendering info in account->content.
  2388. unset($account->content);
  2389. $build += array(
  2390. '#theme' => 'user_profile',
  2391. '#account' => $account,
  2392. '#view_mode' => $view_mode,
  2393. '#language' => $langcode,
  2394. );
  2395. // Allow modules to modify the structured user.
  2396. $type = 'user';
  2397. drupal_alter(array('user_view', 'entity_view'), $build, $type);
  2398. return $build;
  2399. }
  2400. /**
  2401. * Builds a structured array representing the profile content.
  2402. *
  2403. * @param $account
  2404. * A user object.
  2405. * @param $view_mode
  2406. * View mode, e.g. 'full'.
  2407. * @param $langcode
  2408. * (optional) A language code to use for rendering. Defaults to the global
  2409. * content language of the current request.
  2410. */
  2411. function user_build_content($account, $view_mode = 'full', $langcode = NULL) {
  2412. if (!isset($langcode)) {
  2413. $langcode = $GLOBALS['language_content']->language;
  2414. }
  2415. // Remove previously built content, if exists.
  2416. $account->content = array();
  2417. // Allow modules to change the view mode.
  2418. $context = array(
  2419. 'entity_type' => 'user',
  2420. 'entity' => $account,
  2421. 'langcode' => $langcode,
  2422. );
  2423. drupal_alter('entity_view_mode', $view_mode, $context);
  2424. // Build fields content.
  2425. field_attach_prepare_view('user', array($account->uid => $account), $view_mode, $langcode);
  2426. entity_prepare_view('user', array($account->uid => $account), $langcode);
  2427. $account->content += field_attach_view('user', $account, $view_mode, $langcode);
  2428. // Populate $account->content with a render() array.
  2429. module_invoke_all('user_view', $account, $view_mode, $langcode);
  2430. module_invoke_all('entity_view', $account, 'user', $view_mode, $langcode);
  2431. // Make sure the current view mode is stored if no module has already
  2432. // populated the related key.
  2433. $account->content += array('#view_mode' => $view_mode);
  2434. }
  2435. /**
  2436. * Implements hook_mail().
  2437. */
  2438. function user_mail($key, &$message, $params) {
  2439. $language = $message['language'];
  2440. $variables = array('user' => $params['account']);
  2441. $message['subject'] .= _user_mail_text($key . '_subject', $language, $variables);
  2442. $message['body'][] = _user_mail_text($key . '_body', $language, $variables);
  2443. }
  2444. /**
  2445. * Returns a mail string for a variable name.
  2446. *
  2447. * Used by user_mail() and the settings forms to retrieve strings.
  2448. */
  2449. function _user_mail_text($key, $language = NULL, $variables = array(), $replace = TRUE) {
  2450. $langcode = isset($language) ? $language->language : NULL;
  2451. if ($admin_setting = variable_get('user_mail_' . $key, FALSE)) {
  2452. // An admin setting overrides the default string.
  2453. $text = $admin_setting;
  2454. }
  2455. else {
  2456. // No override, return default string.
  2457. switch ($key) {
  2458. case 'register_no_approval_required_subject':
  2459. $text = t('Account details for [user:name] at [site:name]', array(), array('langcode' => $langcode));
  2460. break;
  2461. case 'register_no_approval_required_body':
  2462. $text = t("[user:name],
  2463. Thank you for registering at [site:name]. You may now log in by clicking this link or copying and pasting it to your browser:
  2464. [user:one-time-login-url]
  2465. This link can only be used once to log in and will lead you to a page where you can set your password.
  2466. After setting your password, you will be able to log in at [site:login-url] in the future using:
  2467. username: [user:name]
  2468. password: Your password
  2469. -- [site:name] team", array(), array('langcode' => $langcode));
  2470. break;
  2471. case 'register_admin_created_subject':
  2472. $text = t('An administrator created an account for you at [site:name]', array(), array('langcode' => $langcode));
  2473. break;
  2474. case 'register_admin_created_body':
  2475. $text = t("[user:name],
  2476. A site administrator at [site:name] has created an account for you. You may now log in by clicking this link or copying and pasting it to your browser:
  2477. [user:one-time-login-url]
  2478. This link can only be used once to log in and will lead you to a page where you can set your password.
  2479. After setting your password, you will be able to log in at [site:login-url] in the future using:
  2480. username: [user:name]
  2481. password: Your password
  2482. -- [site:name] team", array(), array('langcode' => $langcode));
  2483. break;
  2484. case 'register_pending_approval_subject':
  2485. case 'register_pending_approval_admin_subject':
  2486. $text = t('Account details for [user:name] at [site:name] (pending admin approval)', array(), array('langcode' => $langcode));
  2487. break;
  2488. case 'register_pending_approval_body':
  2489. $text = t("[user:name],
  2490. Thank you for registering at [site:name]. 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.
  2491. -- [site:name] team", array(), array('langcode' => $langcode));
  2492. break;
  2493. case 'register_pending_approval_admin_body':
  2494. $text = t("[user:name] has applied for an account.
  2495. [user:edit-url]", array(), array('langcode' => $langcode));
  2496. break;
  2497. case 'password_reset_subject':
  2498. $text = t('Replacement login information for [user:name] at [site:name]', array(), array('langcode' => $langcode));
  2499. break;
  2500. case 'password_reset_body':
  2501. $text = t("[user:name],
  2502. A request to reset the password for your account has been made at [site:name].
  2503. You may now log in by clicking this link or copying and pasting it to your browser:
  2504. [user:one-time-login-url]
  2505. This link can only be used once to log in and will lead you to a page where you can set your password. It expires after one day and nothing will happen if it's not used.
  2506. -- [site:name] team", array(), array('langcode' => $langcode));
  2507. break;
  2508. case 'status_activated_subject':
  2509. $text = t('Account details for [user:name] at [site:name] (approved)', array(), array('langcode' => $langcode));
  2510. break;
  2511. case 'status_activated_body':
  2512. $text = t("[user:name],
  2513. Your account at [site:name] has been activated.
  2514. You may now log in by clicking this link or copying and pasting it into your browser:
  2515. [user:one-time-login-url]
  2516. This link can only be used once to log in and will lead you to a page where you can set your password.
  2517. After setting your password, you will be able to log in at [site:login-url] in the future using:
  2518. username: [user:name]
  2519. password: Your password
  2520. -- [site:name] team", array(), array('langcode' => $langcode));
  2521. break;
  2522. case 'status_blocked_subject':
  2523. $text = t('Account details for [user:name] at [site:name] (blocked)', array(), array('langcode' => $langcode));
  2524. break;
  2525. case 'status_blocked_body':
  2526. $text = t("[user:name],
  2527. Your account on [site:name] has been blocked.
  2528. -- [site:name] team", array(), array('langcode' => $langcode));
  2529. break;
  2530. case 'cancel_confirm_subject':
  2531. $text = t('Account cancellation request for [user:name] at [site:name]', array(), array('langcode' => $langcode));
  2532. break;
  2533. case 'cancel_confirm_body':
  2534. $text = t("[user:name],
  2535. A request to cancel your account has been made at [site:name].
  2536. You may now cancel your account on [site:url-brief] by clicking this link or copying and pasting it into your browser:
  2537. [user:cancel-url]
  2538. NOTE: The cancellation of your account is not reversible.
  2539. This link expires in one day and nothing will happen if it is not used.
  2540. -- [site:name] team", array(), array('langcode' => $langcode));
  2541. break;
  2542. case 'status_canceled_subject':
  2543. $text = t('Account details for [user:name] at [site:name] (canceled)', array(), array('langcode' => $langcode));
  2544. break;
  2545. case 'status_canceled_body':
  2546. $text = t("[user:name],
  2547. Your account on [site:name] has been canceled.
  2548. -- [site:name] team", array(), array('langcode' => $langcode));
  2549. break;
  2550. }
  2551. }
  2552. if ($replace) {
  2553. // We do not sanitize the token replacement, since the output of this
  2554. // replacement is intended for an e-mail message, not a web browser.
  2555. return token_replace($text, $variables, array('language' => $language, 'callback' => 'user_mail_tokens', 'sanitize' => FALSE, 'clear' => TRUE));
  2556. }
  2557. return $text;
  2558. }
  2559. /**
  2560. * Token callback to add unsafe tokens for user mails.
  2561. *
  2562. * This function is used by the token_replace() call at the end of
  2563. * _user_mail_text() to set up some additional tokens that can be
  2564. * used in email messages generated by user_mail().
  2565. *
  2566. * @param $replacements
  2567. * An associative array variable containing mappings from token names to
  2568. * values (for use with strtr()).
  2569. * @param $data
  2570. * An associative array of token replacement values. If the 'user' element
  2571. * exists, it must contain a user account object with the following
  2572. * properties:
  2573. * - login: The UNIX timestamp of the user's last login.
  2574. * - pass: The hashed account login password.
  2575. * @param $options
  2576. * Unused parameter required by the token_replace() function.
  2577. */
  2578. function user_mail_tokens(&$replacements, $data, $options) {
  2579. if (isset($data['user'])) {
  2580. $replacements['[user:one-time-login-url]'] = user_pass_reset_url($data['user']);
  2581. $replacements['[user:cancel-url]'] = user_cancel_url($data['user']);
  2582. }
  2583. }
  2584. /*** Administrative features ***********************************************/
  2585. /**
  2586. * Retrieve an array of roles matching specified conditions.
  2587. *
  2588. * @param $membersonly
  2589. * Set this to TRUE to exclude the 'anonymous' role.
  2590. * @param $permission
  2591. * A string containing a permission. If set, only roles containing that
  2592. * permission are returned.
  2593. *
  2594. * @return
  2595. * An associative array with the role id as the key and the role name as
  2596. * value.
  2597. */
  2598. function user_roles($membersonly = FALSE, $permission = NULL) {
  2599. $query = db_select('role', 'r');
  2600. $query->addTag('translatable');
  2601. $query->fields('r', array('rid', 'name'));
  2602. $query->orderBy('weight');
  2603. $query->orderBy('name');
  2604. if (!empty($permission)) {
  2605. $query->innerJoin('role_permission', 'p', 'r.rid = p.rid');
  2606. $query->condition('p.permission', $permission);
  2607. }
  2608. $result = $query->execute();
  2609. $roles = array();
  2610. foreach ($result as $role) {
  2611. switch ($role->rid) {
  2612. // We only translate the built in role names
  2613. case DRUPAL_ANONYMOUS_RID:
  2614. if (!$membersonly) {
  2615. $roles[$role->rid] = t($role->name);
  2616. }
  2617. break;
  2618. case DRUPAL_AUTHENTICATED_RID:
  2619. $roles[$role->rid] = t($role->name);
  2620. break;
  2621. default:
  2622. $roles[$role->rid] = $role->name;
  2623. }
  2624. }
  2625. return $roles;
  2626. }
  2627. /**
  2628. * Fetches a user role by role ID.
  2629. *
  2630. * @param $rid
  2631. * An integer representing the role ID.
  2632. *
  2633. * @return
  2634. * A fully-loaded role object if a role with the given ID exists, or FALSE
  2635. * otherwise.
  2636. *
  2637. * @see user_role_load_by_name()
  2638. */
  2639. function user_role_load($rid) {
  2640. return db_select('role', 'r')
  2641. ->fields('r')
  2642. ->condition('rid', $rid)
  2643. ->execute()
  2644. ->fetchObject();
  2645. }
  2646. /**
  2647. * Fetches a user role by role name.
  2648. *
  2649. * @param $role_name
  2650. * A string representing the role name.
  2651. *
  2652. * @return
  2653. * A fully-loaded role object if a role with the given name exists, or FALSE
  2654. * otherwise.
  2655. *
  2656. * @see user_role_load()
  2657. */
  2658. function user_role_load_by_name($role_name) {
  2659. return db_select('role', 'r')
  2660. ->fields('r')
  2661. ->condition('name', $role_name)
  2662. ->execute()
  2663. ->fetchObject();
  2664. }
  2665. /**
  2666. * Save a user role to the database.
  2667. *
  2668. * @param $role
  2669. * A role object to modify or add. If $role->rid is not specified, a new
  2670. * role will be created.
  2671. * @return
  2672. * Status constant indicating if role was created or updated.
  2673. * Failure to write the user role record will return FALSE. Otherwise.
  2674. * SAVED_NEW or SAVED_UPDATED is returned depending on the operation
  2675. * performed.
  2676. */
  2677. function user_role_save($role) {
  2678. if ($role->name) {
  2679. // Prevent leading and trailing spaces in role names.
  2680. $role->name = trim($role->name);
  2681. }
  2682. if (!isset($role->weight)) {
  2683. // Set a role weight to make this new role last.
  2684. $query = db_select('role');
  2685. $query->addExpression('MAX(weight)');
  2686. $role->weight = $query->execute()->fetchField() + 1;
  2687. }
  2688. // Let modules modify the user role before it is saved to the database.
  2689. module_invoke_all('user_role_presave', $role);
  2690. if (!empty($role->rid) && $role->name) {
  2691. $status = drupal_write_record('role', $role, 'rid');
  2692. module_invoke_all('user_role_update', $role);
  2693. }
  2694. else {
  2695. $status = drupal_write_record('role', $role);
  2696. module_invoke_all('user_role_insert', $role);
  2697. }
  2698. // Clear the user access cache.
  2699. drupal_static_reset('user_access');
  2700. drupal_static_reset('user_role_permissions');
  2701. return $status;
  2702. }
  2703. /**
  2704. * Delete a user role from database.
  2705. *
  2706. * @param $role
  2707. * A string with the role name, or an integer with the role ID.
  2708. */
  2709. function user_role_delete($role) {
  2710. if (is_int($role)) {
  2711. $role = user_role_load($role);
  2712. }
  2713. else {
  2714. $role = user_role_load_by_name($role);
  2715. }
  2716. db_delete('role')
  2717. ->condition('rid', $role->rid)
  2718. ->execute();
  2719. db_delete('role_permission')
  2720. ->condition('rid', $role->rid)
  2721. ->execute();
  2722. // Update the users who have this role set:
  2723. db_delete('users_roles')
  2724. ->condition('rid', $role->rid)
  2725. ->execute();
  2726. module_invoke_all('user_role_delete', $role);
  2727. // Clear the user access cache.
  2728. drupal_static_reset('user_access');
  2729. drupal_static_reset('user_role_permissions');
  2730. }
  2731. /**
  2732. * Menu access callback for user role editing.
  2733. */
  2734. function user_role_edit_access($role) {
  2735. // Prevent the system-defined roles from being altered or removed.
  2736. if ($role->rid == DRUPAL_ANONYMOUS_RID || $role->rid == DRUPAL_AUTHENTICATED_RID) {
  2737. return FALSE;
  2738. }
  2739. return user_access('administer permissions');
  2740. }
  2741. /**
  2742. * Determine the modules that permissions belong to.
  2743. *
  2744. * @return
  2745. * An associative array in the format $permission => $module.
  2746. */
  2747. function user_permission_get_modules() {
  2748. $permissions = array();
  2749. foreach (module_implements('permission') as $module) {
  2750. $perms = module_invoke($module, 'permission');
  2751. foreach ($perms as $key => $value) {
  2752. $permissions[$key] = $module;
  2753. }
  2754. }
  2755. return $permissions;
  2756. }
  2757. /**
  2758. * Change permissions for a user role.
  2759. *
  2760. * This function may be used to grant and revoke multiple permissions at once.
  2761. * For example, when a form exposes checkboxes to configure permissions for a
  2762. * role, the form submit handler may directly pass the submitted values for the
  2763. * checkboxes form element to this function.
  2764. *
  2765. * @param $rid
  2766. * The ID of a user role to alter.
  2767. * @param $permissions
  2768. * An associative array, where the key holds the permission name and the value
  2769. * determines whether to grant or revoke that permission. Any value that
  2770. * evaluates to TRUE will cause the permission to be granted. Any value that
  2771. * evaluates to FALSE will cause the permission to be revoked.
  2772. * @code
  2773. * array(
  2774. * 'administer nodes' => 0, // Revoke 'administer nodes'
  2775. * 'administer blocks' => FALSE, // Revoke 'administer blocks'
  2776. * 'access user profiles' => 1, // Grant 'access user profiles'
  2777. * 'access content' => TRUE, // Grant 'access content'
  2778. * 'access comments' => 'access comments', // Grant 'access comments'
  2779. * )
  2780. * @endcode
  2781. * Existing permissions are not changed, unless specified in $permissions.
  2782. *
  2783. * @see user_role_grant_permissions()
  2784. * @see user_role_revoke_permissions()
  2785. */
  2786. function user_role_change_permissions($rid, array $permissions = array()) {
  2787. // Grant new permissions for the role.
  2788. $grant = array_filter($permissions);
  2789. if (!empty($grant)) {
  2790. user_role_grant_permissions($rid, array_keys($grant));
  2791. }
  2792. // Revoke permissions for the role.
  2793. $revoke = array_diff_assoc($permissions, $grant);
  2794. if (!empty($revoke)) {
  2795. user_role_revoke_permissions($rid, array_keys($revoke));
  2796. }
  2797. }
  2798. /**
  2799. * Grant permissions to a user role.
  2800. *
  2801. * @param $rid
  2802. * The ID of a user role to alter.
  2803. * @param $permissions
  2804. * A list of permission names to grant.
  2805. *
  2806. * @see user_role_change_permissions()
  2807. * @see user_role_revoke_permissions()
  2808. */
  2809. function user_role_grant_permissions($rid, array $permissions = array()) {
  2810. $modules = user_permission_get_modules();
  2811. // Grant new permissions for the role.
  2812. foreach ($permissions as $name) {
  2813. db_merge('role_permission')
  2814. ->key(array(
  2815. 'rid' => $rid,
  2816. 'permission' => $name,
  2817. ))
  2818. ->fields(array(
  2819. 'module' => $modules[$name],
  2820. ))
  2821. ->execute();
  2822. }
  2823. // Clear the user access cache.
  2824. drupal_static_reset('user_access');
  2825. drupal_static_reset('user_role_permissions');
  2826. }
  2827. /**
  2828. * Revoke permissions from a user role.
  2829. *
  2830. * @param $rid
  2831. * The ID of a user role to alter.
  2832. * @param $permissions
  2833. * A list of permission names to revoke.
  2834. *
  2835. * @see user_role_change_permissions()
  2836. * @see user_role_grant_permissions()
  2837. */
  2838. function user_role_revoke_permissions($rid, array $permissions = array()) {
  2839. // Revoke permissions for the role.
  2840. db_delete('role_permission')
  2841. ->condition('rid', $rid)
  2842. ->condition('permission', $permissions, 'IN')
  2843. ->execute();
  2844. // Clear the user access cache.
  2845. drupal_static_reset('user_access');
  2846. drupal_static_reset('user_role_permissions');
  2847. }
  2848. /**
  2849. * Implements hook_user_operations().
  2850. */
  2851. function user_user_operations($form = array(), $form_state = array()) {
  2852. $operations = array(
  2853. 'unblock' => array(
  2854. 'label' => t('Unblock the selected users'),
  2855. 'callback' => 'user_user_operations_unblock',
  2856. ),
  2857. 'block' => array(
  2858. 'label' => t('Block the selected users'),
  2859. 'callback' => 'user_user_operations_block',
  2860. ),
  2861. 'cancel' => array(
  2862. 'label' => t('Cancel the selected user accounts'),
  2863. ),
  2864. );
  2865. if (user_access('administer permissions')) {
  2866. $roles = user_roles(TRUE);
  2867. unset($roles[DRUPAL_AUTHENTICATED_RID]); // Can't edit authenticated role.
  2868. $add_roles = array();
  2869. foreach ($roles as $key => $value) {
  2870. $add_roles['add_role-' . $key] = $value;
  2871. }
  2872. $remove_roles = array();
  2873. foreach ($roles as $key => $value) {
  2874. $remove_roles['remove_role-' . $key] = $value;
  2875. }
  2876. if (count($roles)) {
  2877. $role_operations = array(
  2878. t('Add a role to the selected users') => array(
  2879. 'label' => $add_roles,
  2880. ),
  2881. t('Remove a role from the selected users') => array(
  2882. 'label' => $remove_roles,
  2883. ),
  2884. );
  2885. $operations += $role_operations;
  2886. }
  2887. }
  2888. // If the form has been posted, we need to insert the proper data for
  2889. // role editing if necessary.
  2890. if (!empty($form_state['submitted'])) {
  2891. $operation_rid = explode('-', $form_state['values']['operation']);
  2892. $operation = $operation_rid[0];
  2893. if ($operation == 'add_role' || $operation == 'remove_role') {
  2894. $rid = $operation_rid[1];
  2895. if (user_access('administer permissions')) {
  2896. $operations[$form_state['values']['operation']] = array(
  2897. 'callback' => 'user_multiple_role_edit',
  2898. 'callback arguments' => array($operation, $rid),
  2899. );
  2900. }
  2901. else {
  2902. watchdog('security', 'Detected malicious attempt to alter protected user fields.', array(), WATCHDOG_WARNING);
  2903. return;
  2904. }
  2905. }
  2906. }
  2907. return $operations;
  2908. }
  2909. /**
  2910. * Callback function for admin mass unblocking users.
  2911. */
  2912. function user_user_operations_unblock($accounts) {
  2913. $accounts = user_load_multiple($accounts);
  2914. foreach ($accounts as $account) {
  2915. // Skip unblocking user if they are already unblocked.
  2916. if ($account !== FALSE && $account->status == 0) {
  2917. user_save($account, array('status' => 1));
  2918. }
  2919. }
  2920. }
  2921. /**
  2922. * Callback function for admin mass blocking users.
  2923. */
  2924. function user_user_operations_block($accounts) {
  2925. $accounts = user_load_multiple($accounts);
  2926. foreach ($accounts as $account) {
  2927. // Skip blocking user if they are already blocked.
  2928. if ($account !== FALSE && $account->status == 1) {
  2929. // For efficiency manually save the original account before applying any
  2930. // changes.
  2931. $account->original = clone $account;
  2932. user_save($account, array('status' => 0));
  2933. }
  2934. }
  2935. }
  2936. /**
  2937. * Callback function for admin mass adding/deleting a user role.
  2938. */
  2939. function user_multiple_role_edit($accounts, $operation, $rid) {
  2940. // The role name is not necessary as user_save() will reload the user
  2941. // object, but some modules' hook_user() may look at this first.
  2942. $role_name = db_query('SELECT name FROM {role} WHERE rid = :rid', array(':rid' => $rid))->fetchField();
  2943. switch ($operation) {
  2944. case 'add_role':
  2945. $accounts = user_load_multiple($accounts);
  2946. foreach ($accounts as $account) {
  2947. // Skip adding the role to the user if they already have it.
  2948. if ($account !== FALSE && !isset($account->roles[$rid])) {
  2949. $roles = $account->roles + array($rid => $role_name);
  2950. // For efficiency manually save the original account before applying
  2951. // any changes.
  2952. $account->original = clone $account;
  2953. user_save($account, array('roles' => $roles));
  2954. }
  2955. }
  2956. break;
  2957. case 'remove_role':
  2958. $accounts = user_load_multiple($accounts);
  2959. foreach ($accounts as $account) {
  2960. // Skip removing the role from the user if they already don't have it.
  2961. if ($account !== FALSE && isset($account->roles[$rid])) {
  2962. $roles = array_diff($account->roles, array($rid => $role_name));
  2963. // For efficiency manually save the original account before applying
  2964. // any changes.
  2965. $account->original = clone $account;
  2966. user_save($account, array('roles' => $roles));
  2967. }
  2968. }
  2969. break;
  2970. }
  2971. }
  2972. function user_multiple_cancel_confirm($form, &$form_state) {
  2973. $edit = $form_state['input'];
  2974. $form['accounts'] = array('#prefix' => '<ul>', '#suffix' => '</ul>', '#tree' => TRUE);
  2975. $accounts = user_load_multiple(array_keys(array_filter($edit['accounts'])));
  2976. foreach ($accounts as $uid => $account) {
  2977. // Prevent user 1 from being canceled.
  2978. if ($uid <= 1) {
  2979. continue;
  2980. }
  2981. $form['accounts'][$uid] = array(
  2982. '#type' => 'hidden',
  2983. '#value' => $uid,
  2984. '#prefix' => '<li>',
  2985. '#suffix' => check_plain($account->name) . "</li>\n",
  2986. );
  2987. }
  2988. // Output a notice that user 1 cannot be canceled.
  2989. if (isset($accounts[1])) {
  2990. $redirect = (count($accounts) == 1);
  2991. $message = t('The user account %name cannot be cancelled.', array('%name' => $accounts[1]->name));
  2992. drupal_set_message($message, $redirect ? 'error' : 'warning');
  2993. // If only user 1 was selected, redirect to the overview.
  2994. if ($redirect) {
  2995. drupal_goto('admin/people');
  2996. }
  2997. }
  2998. $form['operation'] = array('#type' => 'hidden', '#value' => 'cancel');
  2999. module_load_include('inc', 'user', 'user.pages');
  3000. $form['user_cancel_method'] = array(
  3001. '#type' => 'item',
  3002. '#title' => t('When cancelling these accounts'),
  3003. );
  3004. $form['user_cancel_method'] += user_cancel_methods();
  3005. // Remove method descriptions.
  3006. foreach (element_children($form['user_cancel_method']) as $element) {
  3007. unset($form['user_cancel_method'][$element]['#description']);
  3008. }
  3009. // Allow to send the account cancellation confirmation mail.
  3010. $form['user_cancel_confirm'] = array(
  3011. '#type' => 'checkbox',
  3012. '#title' => t('Require e-mail confirmation to cancel account.'),
  3013. '#default_value' => FALSE,
  3014. '#description' => t('When enabled, the user must confirm the account cancellation via e-mail.'),
  3015. );
  3016. // Also allow to send account canceled notification mail, if enabled.
  3017. $form['user_cancel_notify'] = array(
  3018. '#type' => 'checkbox',
  3019. '#title' => t('Notify user when account is canceled.'),
  3020. '#default_value' => FALSE,
  3021. '#access' => variable_get('user_mail_status_canceled_notify', FALSE),
  3022. '#description' => t('When enabled, the user will receive an e-mail notification after the account has been cancelled.'),
  3023. );
  3024. return confirm_form($form,
  3025. t('Are you sure you want to cancel these user accounts?'),
  3026. 'admin/people', t('This action cannot be undone.'),
  3027. t('Cancel accounts'), t('Cancel'));
  3028. }
  3029. /**
  3030. * Submit handler for mass-account cancellation form.
  3031. *
  3032. * @see user_multiple_cancel_confirm()
  3033. * @see user_cancel_confirm_form_submit()
  3034. */
  3035. function user_multiple_cancel_confirm_submit($form, &$form_state) {
  3036. global $user;
  3037. if ($form_state['values']['confirm']) {
  3038. foreach ($form_state['values']['accounts'] as $uid => $value) {
  3039. // Prevent programmatic form submissions from cancelling user 1.
  3040. if ($uid <= 1) {
  3041. continue;
  3042. }
  3043. // Prevent user administrators from deleting themselves without confirmation.
  3044. if ($uid == $user->uid) {
  3045. $admin_form_state = $form_state;
  3046. unset($admin_form_state['values']['user_cancel_confirm']);
  3047. $admin_form_state['values']['_account'] = $user;
  3048. user_cancel_confirm_form_submit(array(), $admin_form_state);
  3049. }
  3050. else {
  3051. user_cancel($form_state['values'], $uid, $form_state['values']['user_cancel_method']);
  3052. }
  3053. }
  3054. }
  3055. $form_state['redirect'] = 'admin/people';
  3056. }
  3057. /**
  3058. * Retrieve a list of all user setting/information categories and sort them by weight.
  3059. */
  3060. function _user_categories() {
  3061. $categories = module_invoke_all('user_categories');
  3062. usort($categories, '_user_sort');
  3063. return $categories;
  3064. }
  3065. function _user_sort($a, $b) {
  3066. $a = (array) $a + array('weight' => 0, 'title' => '');
  3067. $b = (array) $b + array('weight' => 0, 'title' => '');
  3068. return $a['weight'] < $b['weight'] ? -1 : ($a['weight'] > $b['weight'] ? 1 : ($a['title'] < $b['title'] ? -1 : 1));
  3069. }
  3070. /**
  3071. * List user administration filters that can be applied.
  3072. */
  3073. function user_filters() {
  3074. // Regular filters
  3075. $filters = array();
  3076. $roles = user_roles(TRUE);
  3077. unset($roles[DRUPAL_AUTHENTICATED_RID]); // Don't list authorized role.
  3078. if (count($roles)) {
  3079. $filters['role'] = array(
  3080. 'title' => t('role'),
  3081. 'field' => 'ur.rid',
  3082. 'options' => array(
  3083. '[any]' => t('any'),
  3084. ) + $roles,
  3085. );
  3086. }
  3087. $options = array();
  3088. foreach (module_implements('permission') as $module) {
  3089. $function = $module . '_permission';
  3090. if ($permissions = $function()) {
  3091. asort($permissions);
  3092. foreach ($permissions as $permission => $description) {
  3093. $options[t('@module module', array('@module' => $module))][$permission] = t($permission);
  3094. }
  3095. }
  3096. }
  3097. ksort($options);
  3098. $filters['permission'] = array(
  3099. 'title' => t('permission'),
  3100. 'options' => array(
  3101. '[any]' => t('any'),
  3102. ) + $options,
  3103. );
  3104. $filters['status'] = array(
  3105. 'title' => t('status'),
  3106. 'field' => 'u.status',
  3107. 'options' => array(
  3108. '[any]' => t('any'),
  3109. 1 => t('active'),
  3110. 0 => t('blocked'),
  3111. ),
  3112. );
  3113. return $filters;
  3114. }
  3115. /**
  3116. * Extends a query object for user administration filters based on session.
  3117. *
  3118. * @param $query
  3119. * Query object that should be filtered.
  3120. */
  3121. function user_build_filter_query(SelectQuery $query) {
  3122. $filters = user_filters();
  3123. // Extend Query with filter conditions.
  3124. foreach (isset($_SESSION['user_overview_filter']) ? $_SESSION['user_overview_filter'] : array() as $filter) {
  3125. list($key, $value) = $filter;
  3126. // This checks to see if this permission filter is an enabled permission for
  3127. // the authenticated role. If so, then all users would be listed, and we can
  3128. // skip adding it to the filter query.
  3129. if ($key == 'permission') {
  3130. $account = new stdClass();
  3131. $account->uid = 'user_filter';
  3132. $account->roles = array(DRUPAL_AUTHENTICATED_RID => 1);
  3133. if (user_access($value, $account)) {
  3134. continue;
  3135. }
  3136. $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
  3137. $permission_alias = $query->join('role_permission', 'p', $users_roles_alias . '.rid = %alias.rid');
  3138. $query->condition($permission_alias . '.permission', $value);
  3139. }
  3140. elseif ($key == 'role') {
  3141. $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
  3142. $query->condition($users_roles_alias . '.rid' , $value);
  3143. }
  3144. else {
  3145. $query->condition($filters[$key]['field'], $value);
  3146. }
  3147. }
  3148. }
  3149. /**
  3150. * Implements hook_comment_view().
  3151. */
  3152. function user_comment_view($comment) {
  3153. if (variable_get('user_signatures', 0) && !empty($comment->signature)) {
  3154. // @todo This alters and replaces the original object value, so a
  3155. // hypothetical process of loading, viewing, and saving will hijack the
  3156. // stored data. Consider renaming to $comment->signature_safe or similar
  3157. // here and elsewhere in Drupal 8.
  3158. $comment->signature = check_markup($comment->signature, $comment->signature_format, '', TRUE);
  3159. }
  3160. else {
  3161. $comment->signature = '';
  3162. }
  3163. }
  3164. /**
  3165. * Returns HTML for a user signature.
  3166. *
  3167. * @param $variables
  3168. * An associative array containing:
  3169. * - signature: The user's signature.
  3170. *
  3171. * @ingroup themeable
  3172. */
  3173. function theme_user_signature($variables) {
  3174. $signature = $variables['signature'];
  3175. $output = '';
  3176. if ($signature) {
  3177. $output .= '<div class="clear">';
  3178. $output .= '<div>—</div>';
  3179. $output .= $signature;
  3180. $output .= '</div>';
  3181. }
  3182. return $output;
  3183. }
  3184. /**
  3185. * Get the language object preferred by the user. This user preference can
  3186. * be set on the user account editing page, and is only available if there
  3187. * are more than one languages enabled on the site. If the user did not
  3188. * choose a preferred language, or is the anonymous user, the $default
  3189. * value, or if it is not set, the site default language will be returned.
  3190. *
  3191. * @param $account
  3192. * User account to look up language for.
  3193. * @param $default
  3194. * Optional default language object to return if the account
  3195. * has no valid language.
  3196. */
  3197. function user_preferred_language($account, $default = NULL) {
  3198. $language_list = language_list();
  3199. if (!empty($account->language) && isset($language_list[$account->language])) {
  3200. return $language_list[$account->language];
  3201. }
  3202. else {
  3203. return $default ? $default : language_default();
  3204. }
  3205. }
  3206. /**
  3207. * Conditionally create and send a notification email when a certain
  3208. * operation happens on the given user account.
  3209. *
  3210. * @see user_mail_tokens()
  3211. * @see drupal_mail()
  3212. *
  3213. * @param $op
  3214. * The operation being performed on the account. Possible values:
  3215. * - 'register_admin_created': Welcome message for user created by the admin.
  3216. * - 'register_no_approval_required': Welcome message when user
  3217. * self-registers.
  3218. * - 'register_pending_approval': Welcome message, user pending admin
  3219. * approval.
  3220. * - 'password_reset': Password recovery request.
  3221. * - 'status_activated': Account activated.
  3222. * - 'status_blocked': Account blocked.
  3223. * - 'cancel_confirm': Account cancellation request.
  3224. * - 'status_canceled': Account canceled.
  3225. *
  3226. * @param $account
  3227. * The user object of the account being notified. Must contain at
  3228. * least the fields 'uid', 'name', and 'mail'.
  3229. * @param $language
  3230. * Optional language to use for the notification, overriding account language.
  3231. *
  3232. * @return
  3233. * The return value from drupal_mail_system()->mail(), if ends up being
  3234. * called.
  3235. */
  3236. function _user_mail_notify($op, $account, $language = NULL) {
  3237. // By default, we always notify except for canceled and blocked.
  3238. $default_notify = ($op != 'status_canceled' && $op != 'status_blocked');
  3239. $notify = variable_get('user_mail_' . $op . '_notify', $default_notify);
  3240. if ($notify) {
  3241. $params['account'] = $account;
  3242. $language = $language ? $language : user_preferred_language($account);
  3243. $mail = drupal_mail('user', $op, $account->mail, $language, $params);
  3244. if ($op == 'register_pending_approval') {
  3245. // If a user registered requiring admin approval, notify the admin, too.
  3246. // We use the site default language for this.
  3247. drupal_mail('user', 'register_pending_approval_admin', variable_get('site_mail', ini_get('sendmail_from')), language_default(), $params);
  3248. }
  3249. }
  3250. return empty($mail) ? NULL : $mail['result'];
  3251. }
  3252. /**
  3253. * Form element process handler for client-side password validation.
  3254. *
  3255. * This #process handler is automatically invoked for 'password_confirm' form
  3256. * elements to add the JavaScript and string translations for dynamic password
  3257. * validation.
  3258. *
  3259. * @see system_element_info()
  3260. */
  3261. function user_form_process_password_confirm($element) {
  3262. global $user;
  3263. $js_settings = array(
  3264. 'password' => array(
  3265. 'strengthTitle' => t('Password strength:'),
  3266. 'hasWeaknesses' => t('To make your password stronger:'),
  3267. 'tooShort' => t('Make it at least 6 characters'),
  3268. 'addLowerCase' => t('Add lowercase letters'),
  3269. 'addUpperCase' => t('Add uppercase letters'),
  3270. 'addNumbers' => t('Add numbers'),
  3271. 'addPunctuation' => t('Add punctuation'),
  3272. 'sameAsUsername' => t('Make it different from your username'),
  3273. 'confirmSuccess' => t('yes'),
  3274. 'confirmFailure' => t('no'),
  3275. 'weak' => t('Weak'),
  3276. 'fair' => t('Fair'),
  3277. 'good' => t('Good'),
  3278. 'strong' => t('Strong'),
  3279. 'confirmTitle' => t('Passwords match:'),
  3280. 'username' => (isset($user->name) ? $user->name : ''),
  3281. ),
  3282. );
  3283. $element['#attached']['js'][] = drupal_get_path('module', 'user') . '/user.js';
  3284. // Ensure settings are only added once per page.
  3285. static $already_added = FALSE;
  3286. if (!$already_added) {
  3287. $already_added = TRUE;
  3288. $element['#attached']['js'][] = array('data' => $js_settings, 'type' => 'setting');
  3289. }
  3290. return $element;
  3291. }
  3292. /**
  3293. * Implements hook_node_load().
  3294. */
  3295. function user_node_load($nodes, $types) {
  3296. // Build an array of all uids for node authors, keyed by nid.
  3297. $uids = array();
  3298. foreach ($nodes as $nid => $node) {
  3299. $uids[$nid] = $node->uid;
  3300. }
  3301. // Fetch name, picture, and data for these users.
  3302. $user_fields = db_query("SELECT uid, name, picture, data FROM {users} WHERE uid IN (:uids)", array(':uids' => $uids))->fetchAllAssoc('uid');
  3303. // Add these values back into the node objects.
  3304. foreach ($uids as $nid => $uid) {
  3305. $nodes[$nid]->name = $user_fields[$uid]->name;
  3306. $nodes[$nid]->picture = $user_fields[$uid]->picture;
  3307. $nodes[$nid]->data = $user_fields[$uid]->data;
  3308. }
  3309. }
  3310. /**
  3311. * Implements hook_image_style_delete().
  3312. */
  3313. function user_image_style_delete($style) {
  3314. // If a style is deleted, update the variables.
  3315. // Administrators choose a replacement style when deleting.
  3316. user_image_style_save($style);
  3317. }
  3318. /**
  3319. * Implements hook_image_style_save().
  3320. */
  3321. function user_image_style_save($style) {
  3322. // If a style is renamed, update the variables that use it.
  3323. if (isset($style['old_name']) && $style['old_name'] == variable_get('user_picture_style', '')) {
  3324. variable_set('user_picture_style', $style['name']);
  3325. }
  3326. }
  3327. /**
  3328. * Implements hook_action_info().
  3329. */
  3330. function user_action_info() {
  3331. return array(
  3332. 'user_block_user_action' => array(
  3333. 'label' => t('Block current user'),
  3334. 'type' => 'user',
  3335. 'configurable' => FALSE,
  3336. 'triggers' => array('any'),
  3337. ),
  3338. );
  3339. }
  3340. /**
  3341. * Blocks a specific user or the current user, if one is not specified.
  3342. *
  3343. * @param $entity
  3344. * (optional) An entity object; if it is provided and it has a uid property,
  3345. * the user with that ID is blocked.
  3346. * @param $context
  3347. * (optional) An associative array; if no user ID is found in $entity, the
  3348. * 'uid' element of this array determines the user to block.
  3349. *
  3350. * @ingroup actions
  3351. */
  3352. function user_block_user_action(&$entity, $context = array()) {
  3353. // First priority: If there is a $entity->uid, block that user.
  3354. // This is most likely a user object or the author if a node or comment.
  3355. if (isset($entity->uid)) {
  3356. $uid = $entity->uid;
  3357. }
  3358. elseif (isset($context['uid'])) {
  3359. $uid = $context['uid'];
  3360. }
  3361. // If neither of those are valid, then block the current user.
  3362. else {
  3363. $uid = $GLOBALS['user']->uid;
  3364. }
  3365. $account = user_load($uid);
  3366. $account = user_save($account, array('status' => 0));
  3367. watchdog('action', 'Blocked user %name.', array('%name' => $account->name));
  3368. }
  3369. /**
  3370. * Implements hook_form_FORM_ID_alter().
  3371. *
  3372. * Add a checkbox for the 'user_register_form' instance settings on the 'Edit
  3373. * field instance' form.
  3374. */
  3375. function user_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
  3376. $instance = $form['#instance'];
  3377. if ($instance['entity_type'] == 'user' && !$form['#field']['locked']) {
  3378. $form['instance']['settings']['user_register_form'] = array(
  3379. '#type' => 'checkbox',
  3380. '#title' => t('Display on user registration form.'),
  3381. '#description' => t("This is compulsory for 'required' fields."),
  3382. // Field instances created in D7 beta releases before the setting was
  3383. // introduced might be set as 'required' and 'not shown on user_register
  3384. // form'. We make sure the checkbox comes as 'checked' for those.
  3385. '#default_value' => $instance['settings']['user_register_form'] || $instance['required'],
  3386. // Display just below the 'required' checkbox.
  3387. '#weight' => $form['instance']['required']['#weight'] + .1,
  3388. // Disabled when the 'required' checkbox is checked.
  3389. '#states' => array(
  3390. 'enabled' => array('input[name="instance[required]"]' => array('checked' => FALSE)),
  3391. ),
  3392. // Checked when the 'required' checkbox is checked. This is done through
  3393. // a custom behavior, since the #states system would also synchronize on
  3394. // uncheck.
  3395. '#attached' => array(
  3396. 'js' => array(drupal_get_path('module', 'user') . '/user.js'),
  3397. ),
  3398. );
  3399. array_unshift($form['#submit'], 'user_form_field_ui_field_edit_form_submit');
  3400. }
  3401. }
  3402. /**
  3403. * Additional submit handler for the 'Edit field instance' form.
  3404. *
  3405. * Make sure the 'user_register_form' setting is set for required fields.
  3406. */
  3407. function user_form_field_ui_field_edit_form_submit($form, &$form_state) {
  3408. $instance = $form_state['values']['instance'];
  3409. if (!empty($instance['required'])) {
  3410. form_set_value($form['instance']['settings']['user_register_form'], 1, $form_state);
  3411. }
  3412. }
  3413. /**
  3414. * Form builder; the user registration form.
  3415. *
  3416. * @ingroup forms
  3417. * @see user_account_form()
  3418. * @see user_account_form_validate()
  3419. * @see user_register_submit()
  3420. */
  3421. function user_register_form($form, &$form_state) {
  3422. global $user;
  3423. $admin = user_access('administer users');
  3424. // Pass access information to the submit handler. Running an access check
  3425. // inside the submit function interferes with form processing and breaks
  3426. // hook_form_alter().
  3427. $form['administer_users'] = array(
  3428. '#type' => 'value',
  3429. '#value' => $admin,
  3430. );
  3431. // If we aren't admin but already logged on, go to the user page instead.
  3432. if (!$admin && $user->uid) {
  3433. drupal_goto('user/' . $user->uid);
  3434. }
  3435. $form['#user'] = drupal_anonymous_user();
  3436. $form['#user_category'] = 'register';
  3437. $form['#attached']['library'][] = array('system', 'jquery.cookie');
  3438. $form['#attributes']['class'][] = 'user-info-from-cookie';
  3439. // Start with the default user account fields.
  3440. user_account_form($form, $form_state);
  3441. // Attach field widgets, and hide the ones where the 'user_register_form'
  3442. // setting is not on.
  3443. $langcode = entity_language('user', $form['#user']);
  3444. field_attach_form('user', $form['#user'], $form, $form_state, $langcode);
  3445. foreach (field_info_instances('user', 'user') as $field_name => $instance) {
  3446. if (empty($instance['settings']['user_register_form'])) {
  3447. $form[$field_name]['#access'] = FALSE;
  3448. }
  3449. }
  3450. if ($admin) {
  3451. // Redirect back to page which initiated the create request;
  3452. // usually admin/people/create.
  3453. $form_state['redirect'] = $_GET['q'];
  3454. }
  3455. $form['actions'] = array('#type' => 'actions');
  3456. $form['actions']['submit'] = array(
  3457. '#type' => 'submit',
  3458. '#value' => t('Create new account'),
  3459. );
  3460. $form['#validate'][] = 'user_register_validate';
  3461. // Add the final user registration form submit handler.
  3462. $form['#submit'][] = 'user_register_submit';
  3463. return $form;
  3464. }
  3465. /**
  3466. * Validation function for the user registration form.
  3467. */
  3468. function user_register_validate($form, &$form_state) {
  3469. entity_form_field_validate('user', $form, $form_state);
  3470. }
  3471. /**
  3472. * Submit handler for the user registration form.
  3473. *
  3474. * This function is shared by the installation form and the normal registration form,
  3475. * which is why it can't be in the user.pages.inc file.
  3476. *
  3477. * @see user_register_form()
  3478. */
  3479. function user_register_submit($form, &$form_state) {
  3480. $admin = $form_state['values']['administer_users'];
  3481. if (!variable_get('user_email_verification', TRUE) || $admin) {
  3482. $pass = $form_state['values']['pass'];
  3483. }
  3484. else {
  3485. $pass = user_password();
  3486. }
  3487. $notify = !empty($form_state['values']['notify']);
  3488. // Remove unneeded values.
  3489. form_state_values_clean($form_state);
  3490. $form_state['values']['pass'] = $pass;
  3491. $form_state['values']['init'] = $form_state['values']['mail'];
  3492. $account = $form['#user'];
  3493. entity_form_submit_build_entity('user', $account, $form, $form_state);
  3494. // Populate $edit with the properties of $account, which have been edited on
  3495. // this form by taking over all values, which appear in the form values too.
  3496. $edit = array_intersect_key((array) $account, $form_state['values']);
  3497. $account = user_save($account, $edit);
  3498. // Terminate if an error occurred during user_save().
  3499. if (!$account) {
  3500. drupal_set_message(t("Error saving user account."), 'error');
  3501. $form_state['redirect'] = '';
  3502. return;
  3503. }
  3504. $form_state['user'] = $account;
  3505. $form_state['values']['uid'] = $account->uid;
  3506. watchdog('user', 'New user: %name (%email).', array('%name' => $form_state['values']['name'], '%email' => $form_state['values']['mail']), WATCHDOG_NOTICE, l(t('edit'), 'user/' . $account->uid . '/edit'));
  3507. // Add plain text password into user account to generate mail tokens.
  3508. $account->password = $pass;
  3509. // New administrative account without notification.
  3510. $uri = entity_uri('user', $account);
  3511. if ($admin && !$notify) {
  3512. drupal_set_message(t('Created a new user account for <a href="@url">%name</a>. No e-mail has been sent.', array('@url' => url($uri['path'], $uri['options']), '%name' => $account->name)));
  3513. }
  3514. // No e-mail verification required; log in user immediately.
  3515. elseif (!$admin && !variable_get('user_email_verification', TRUE) && $account->status) {
  3516. _user_mail_notify('register_no_approval_required', $account);
  3517. $form_state['uid'] = $account->uid;
  3518. user_login_submit(array(), $form_state);
  3519. drupal_set_message(t('Registration successful. You are now logged in.'));
  3520. $form_state['redirect'] = '';
  3521. }
  3522. // No administrator approval required.
  3523. elseif ($account->status || $notify) {
  3524. $op = $notify ? 'register_admin_created' : 'register_no_approval_required';
  3525. _user_mail_notify($op, $account);
  3526. if ($notify) {
  3527. drupal_set_message(t('A welcome message with further instructions has been e-mailed to the new user <a href="@url">%name</a>.', array('@url' => url($uri['path'], $uri['options']), '%name' => $account->name)));
  3528. }
  3529. else {
  3530. drupal_set_message(t('A welcome message with further instructions has been sent to your e-mail address.'));
  3531. $form_state['redirect'] = '';
  3532. }
  3533. }
  3534. // Administrator approval required.
  3535. else {
  3536. _user_mail_notify('register_pending_approval', $account);
  3537. drupal_set_message(t('Thank you for applying for an account. Your account is currently pending approval by the site administrator.<br />In the meantime, a welcome message with further instructions has been sent to your e-mail address.'));
  3538. $form_state['redirect'] = '';
  3539. }
  3540. }
  3541. /**
  3542. * Implements hook_modules_installed().
  3543. */
  3544. function user_modules_installed($modules) {
  3545. // Assign all available permissions to the administrator role.
  3546. $rid = variable_get('user_admin_role', 0);
  3547. if ($rid) {
  3548. $permissions = array();
  3549. foreach ($modules as $module) {
  3550. if ($module_permissions = module_invoke($module, 'permission')) {
  3551. $permissions = array_merge($permissions, array_keys($module_permissions));
  3552. }
  3553. }
  3554. if (!empty($permissions)) {
  3555. user_role_grant_permissions($rid, $permissions);
  3556. }
  3557. }
  3558. }
  3559. /**
  3560. * Implements hook_modules_uninstalled().
  3561. */
  3562. function user_modules_uninstalled($modules) {
  3563. db_delete('role_permission')
  3564. ->condition('module', $modules, 'IN')
  3565. ->execute();
  3566. }
  3567. /**
  3568. * Helper function to rewrite the destination to avoid redirecting to login page after login.
  3569. *
  3570. * Third-party authentication modules may use this function to determine the
  3571. * proper destination after a user has been properly logged in.
  3572. */
  3573. function user_login_destination() {
  3574. $destination = drupal_get_destination();
  3575. if ($destination['destination'] == 'user/login') {
  3576. $destination['destination'] = 'user';
  3577. }
  3578. return $destination;
  3579. }
  3580. /**
  3581. * Saves visitor information as a cookie so it can be reused.
  3582. *
  3583. * @param $values
  3584. * An array of key/value pairs to be saved into a cookie.
  3585. */
  3586. function user_cookie_save(array $values) {
  3587. foreach ($values as $field => $value) {
  3588. // Set cookie for 365 days.
  3589. setrawcookie('Drupal.visitor.' . $field, rawurlencode($value), REQUEST_TIME + 31536000, '/');
  3590. }
  3591. }
  3592. /**
  3593. * Delete a visitor information cookie.
  3594. *
  3595. * @param $cookie_name
  3596. * A cookie name such as 'homepage'.
  3597. */
  3598. function user_cookie_delete($cookie_name) {
  3599. setrawcookie('Drupal.visitor.' . $cookie_name, '', REQUEST_TIME - 3600, '/');
  3600. }
  3601. /**
  3602. * Implements hook_rdf_mapping().
  3603. */
  3604. function user_rdf_mapping() {
  3605. return array(
  3606. array(
  3607. 'type' => 'user',
  3608. 'bundle' => RDF_DEFAULT_BUNDLE,
  3609. 'mapping' => array(
  3610. 'rdftype' => array('sioc:UserAccount'),
  3611. 'name' => array(
  3612. 'predicates' => array('foaf:name'),
  3613. ),
  3614. 'homepage' => array(
  3615. 'predicates' => array('foaf:page'),
  3616. 'type' => 'rel',
  3617. ),
  3618. ),
  3619. ),
  3620. );
  3621. }
  3622. /**
  3623. * Implements hook_file_download_access().
  3624. */
  3625. function user_file_download_access($field, $entity_type, $entity) {
  3626. if ($entity_type == 'user') {
  3627. return user_view_access($entity);
  3628. }
  3629. }
  3630. /**
  3631. * Implements hook_system_info_alter().
  3632. *
  3633. * Drupal 7 ships with two methods to add additional fields to users: Profile
  3634. * module, a legacy module dating back from 2002, and Field API integration
  3635. * with users. While Field API support for users currently provides less end
  3636. * user features, the inefficient data storage mechanism of Profile module, as
  3637. * well as its lack of consistency with the rest of the entity / field based
  3638. * systems in Drupal 7, make this a sub-optimal solution to those who were not
  3639. * using it in previous releases of Drupal.
  3640. *
  3641. * To prevent new Drupal 7 sites from installing Profile module, and
  3642. * unwittingly ending up with two completely different and incompatible methods
  3643. * of extending users, only make the Profile module available if the profile_*
  3644. * tables are present.
  3645. *
  3646. * @todo: Remove in D8, pending upgrade path.
  3647. */
  3648. function user_system_info_alter(&$info, $file, $type) {
  3649. if ($type == 'module' && $file->name == 'profile' && db_table_exists('profile_field')) {
  3650. $info['hidden'] = FALSE;
  3651. }
  3652. }

Comments

I've searched for 2 days, and cannot find an answer.

When a user uploads a new image, it displays on their account and their database entry under the "picture" column. As soon as they log out, and log back on their picture disappears. We checked the database, and unlike another thread I saw which is related to a user picture disappearing, the database entry goes to 0 immediately after logout, before logging back in.

I've confirmed that our pictures directory contains the picture, so this is a database issue.

I checked the user_logout function, and don't see anything that could make this database entry zero.

I made changes to this file, but they are not showing on the site. Specifically, I made changes to the content of the Welcome new user email. Is this overridden somewhere? How can I get Drupal to re-read this file. I flushed all caches to no avail.

The welcome new user email is set via the web interface in admin/config/people/accounts . I suspect changing the code only changes the default value. You really shouldn't edit Drupal core code unless you have an especially compelling reason.