user.module 72.2 KB
Newer Older
1 2
<?php

3
use Drupal\Component\Utility\Crypt;
4
use Drupal\Core\Database\Query\SelectInterface;
5
use Drupal\Core\Entity\EntityInterface;
6
use Drupal\Core\Session\AccountInterface;
7
use Drupal\entity\Plugin\Core\Entity\EntityDisplay;
8
use Drupal\file\Plugin\Core\Entity\File;
9
use Drupal\user\Plugin\Core\Entity\User;
10
use Drupal\user\UserInterface;
11
use Drupal\user\RoleInterface;
12
use Drupal\Core\Template\Attribute;
13
use Symfony\Component\HttpFoundation\RedirectResponse;
14
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
15
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
Crell's avatar
Crell committed
16

17 18 19 20 21
/**
 * @file
 * Enables the user registration and login system.
 */

22 23 24
/**
 * Maximum length of username text field.
 */
25
const USERNAME_MAX_LENGTH = 60;
26 27 28 29

/**
 * Maximum length of user e-mail text field.
 */
30
const EMAIL_MAX_LENGTH = 254;
31

32 33 34
/**
 * Only administrators can create user accounts.
 */
35
const USER_REGISTER_ADMINISTRATORS_ONLY = 'admin_only';
36 37 38 39

/**
 * Visitors can create their own accounts.
 */
40
const USER_REGISTER_VISITORS = 'visitors';
41 42 43 44 45

/**
 * Visitors can create accounts, but they don't become active without
 * administrative approval.
 */
46
const USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL = 'visitors_admin_approval';
47

48 49 50 51 52 53 54 55 56 57
/**
 * Implement hook_help().
 */
function user_help($path, $arg) {
  global $user;

  switch ($path) {
    case 'admin/help#user':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
58
      $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>';
59 60 61
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Creating and managing users') . '</dt>';
62
      $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>';
63
      $output .= '<dt>' . t('User roles and permissions') . '</dt>';
64
      $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/roles'))) . '</dd>';
65
      $output .= '<dt>' . t('Account settings') . '</dt>';
66
      $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 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>';
67 68 69 70
      $output .= '</dl>';
      return $output;
    case 'admin/people/create':
      return '<p>' . t("This web page allows administrators to register new users. Users' e-mail addresses and usernames must be unique.") . '</p>';
71
    case 'admin/people/permissions':
72 73
      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/roles'), '@settings' => url('admin/config/people/accounts'))) . '</p>';
    case 'admin/people/roles':
74
      $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>';
75
      $output .= '<p>' . t('Drupal has three special user roles:') . '</p>';
76 77 78
      $output .= '<ul>';
      $output .= '<li>' . t("Anonymous user: this role is used for users that don't have a user account or that are not authenticated.") . '</li>';
      $output .= '<li>' . t('Authenticated user: this role is automatically granted to all logged in users.') . '</li>';
79
      $output .= '<li>' . t('Administrator role: this role is automatically granted all new permissions when you install a new module. Configure which role is the administrator role on the <a href="@account_settings">Account settings page</a>.', array('@account_settings' => url('admin/config/people/accounts'))) . '</li>';
80 81 82
      $output .= '</ul>';
      return $output;
    case 'admin/config/people/accounts/fields':
83 84 85
      return '<p>' . t('This form lets administrators add and edit fields for storing user data.') . '</p>';
    case 'admin/config/people/accounts/form-display':
      return '<p>' . t('This form lets administrators configure how form fields should be displayed when editing a user profile.') . '</p>';
86 87 88 89 90 91
    case 'admin/config/people/accounts/display':
      return '<p>' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '</p>';
    case 'admin/people/search':
      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>';
  }
}
92

93
/**
94
 * Implements hook_theme().
95 96 97
 */
function user_theme() {
  return array(
98
    'user' => array(
99
      'render element' => 'elements',
100
      'file' => 'user.pages.inc',
101
      'template' => 'user',
102
    ),
103 104 105 106
    'user_permission_description' => array(
      'variables' => array('permission_item' => NULL, 'hide' => NULL),
      'file' => 'user.admin.inc',
    ),
107
    'user_signature' => array(
108
      'variables' => array('signature' => NULL),
109
    ),
110
    'username' => array(
111
      'variables' => array('account' => NULL, 'attributes' => array()),
112
    ),
113 114 115
  );
}

116 117 118 119 120
/**
 * Implements hook_page_build().
 */
function user_page_build(&$page) {
  $path = drupal_get_path('module', 'user');
121
  $page['#attached']['css'][$path . '/css/user.module.css'] = array('every_page' => TRUE);
122 123
}

124 125 126 127
/**
 * Implements hook_entity_bundle_info().
 */
function user_entity_bundle_info() {
128
  $bundles['user']['user']['label'] = t('User');
129 130 131
  return $bundles;
}

132
/**
133
 * Entity URI callback.
134
 */
135 136
function user_uri($user) {
  return array(
137
    'path' => 'user/' . $user->id(),
138
  );
139 140
}

141 142 143
/**
 * Entity label callback.
 *
144 145 146
 * This label callback has langcode for security reasons. The username is the
 * visual identifier for a user and needs to be consistent in all languages.
 *
147 148 149 150 151 152 153 154
 * @param $entity_type
 *   The entity type.
 * @param $entity
 *   The entity object.
 *
 * @return
 *   The name of the user.
 *
155
 * @see user_format_name()
156 157
 */
function user_label($entity_type, $entity) {
158
  return $entity->getUsername();
159 160
}

161 162 163
/**
 * Populates $entity->account for each prepared entity.
 *
164 165
 * Called by Drupal\Core\Entity\EntityRenderControllerInterface::buildContent()
 * implementations.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
 *
 * @param array $entities
 *   The entities keyed by entity ID.
 */
function user_attach_accounts(array $entities) {
  $uids = array();
  foreach ($entities as $entity) {
    $uids[] = $entity->uid;
  }
  $uids = array_unique($uids);
  $accounts = user_load_multiple($uids);
  $anonymous = drupal_anonymous_user();
  foreach ($entities as $id => $entity) {
    if (isset($accounts[$entity->uid])) {
      $entities[$id]->account = $accounts[$entity->uid];
    }
    else {
      $entities[$id]->account = $anonymous;
    }
  }
}

/**
 * Returns whether this site supports the default user picture feature.
 *
 * This approach preserves compatibility with node/comment templates. Alternate
 * user picture implementations (e.g., Gravatar) should provide their own
 * add/edit/delete forms and populate the 'picture' variable during the
 * preprocess stage.
 */
function user_picture_enabled() {
  return (bool) field_info_instance('user', 'user_picture', 'user');
}

200
/**
201
 * Implements hook_field_extra_fields().
202
 */
203
function user_field_extra_fields() {
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
  $fields['user']['user']['form']['account'] = array(
    'label' => t('User name and password'),
    'description' => t('User module account form elements.'),
    'weight' => -10,
  );
  if (config('user.settings')->get('signatures')) {
    $fields['user']['user']['form']['signature_settings'] = array(
      'label' => t('Signature settings'),
      'description' => t('User module form element.'),
      'weight' => 1,
    );
  }
  $fields['user']['user']['form']['language'] = array(
    'label' => t('Language settings'),
    'description' => t('User module form element.'),
    'weight' => 0,
  );
  if (config('system.timezone')->get('user.configurable')) {
    $fields['user']['user']['form']['timezone'] = array(
      'label' => t('Timezone'),
      'description' => t('System module form element.'),
      'weight' => 6,
    );
  }

  $fields['user']['user']['display']['member_for'] = array(
    'label' => t('Member for'),
    'description' => t('User module \'member for\' view element.'),
    'weight' => 5,
233
  );
234

235
  return $fields;
236 237
}

Dries's avatar
Dries committed
238
/**
239
 * Loads multiple users based on certain conditions.
Dries's avatar
Dries committed
240
 *
241 242 243
 * This function should be used whenever you need to load more than one user
 * from the database. Users are loaded into memory and will not require
 * database access if loaded again during the same page request.
Dries's avatar
Dries committed
244
 *
245 246
 * @param array $uids
 *   (optional) An array of entity IDs. If omitted, all entities are loaded.
247
 * @param bool $reset
248 249
 *   A boolean indicating that the internal cache should be reset. Use this if
 *   loading a user object which has been altered during the page request.
250
 *
251
 * @return array
252 253
 *   An array of user objects, indexed by uid.
 *
254
 * @see entity_load_multiple()
255 256 257
 * @see user_load()
 * @see user_load_by_mail()
 * @see user_load_by_name()
258
 * @see \Drupal\Core\Entity\Query\QueryInterface
Dries's avatar
Dries committed
259
 */
260
function user_load_multiple(array $uids = NULL, $reset = FALSE) {
261 262 263 264 265 266
  $entities = entity_load_multiple('user', $uids, $reset);
  // Return BC-entities.
  foreach ($entities as $id => $entity) {
    $entities[$id] = $entity->getBCEntity();
  }
  return $entities;
267
}
268 269

/**
270 271 272 273 274 275
 * Loads a user object.
 *
 * Drupal has a global $user object, which represents the currently-logged-in
 * user. So to avoid confusion and to avoid clobbering the global $user object,
 * it is a good idea to assign the result of this function to a different local
 * variable, generally $account. If you actually do want to act as the user you
276 277 278 279
 * are loading, it is essential to call drupal_save_session(FALSE); first.
 * See
 * @link http://drupal.org/node/218104 Safely impersonating another user @endlink
 * for more information.
280
 *
281
 * @param int $uid
282
 *   Integer specifying the user ID to load.
283
 * @param bool $reset
284 285 286
 *   TRUE to reset the internal cache and load from the database; FALSE
 *   (default) to load from the internal cache, if set.
 *
287
 * @return object
288
 *   A fully-loaded user object upon successful user load, or NULL if the user
289 290 291 292 293
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load($uid, $reset = FALSE) {
294
  $user = entity_load('user', $uid, $reset);
295
  return $user ? $user->getBCEntity() : NULL;
296 297 298
}

/**
299
 * Fetches a user object by email address.
300
 *
301
 * @param string $mail
302
 *   String with the account's e-mail address.
303
 * @return object|bool
304 305 306 307 308 309
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load_by_mail($mail) {
310
  $users = entity_load_multiple_by_properties('user', array('mail' => $mail));
311
  return $users ? reset($users)->getBCEntity() : FALSE;
312 313 314
}

/**
315
 * Fetches a user object by account name.
316
 *
317
 * @param string $name
318
 *   String with the account's user name.
319
 * @return object|bool
320 321 322 323 324 325
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load_by_name($name) {
326
  $users = entity_load_multiple_by_properties('user', array('name' => $name));
327
  return $users ? reset($users)->getBCEntity() : FALSE;
328 329
}

Dries's avatar
Dries committed
330 331 332
/**
 * Verify the syntax of the given name.
 */
333
function user_validate_name($name) {
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
  if (!$name) {
    return t('You must enter a username.');
  }
  if (substr($name, 0, 1) == ' ') {
    return t('The username cannot begin with a space.');
  }
  if (substr($name, -1) == ' ') {
    return t('The username cannot end with a space.');
  }
  if (strpos($name, '  ') !== FALSE) {
    return t('The username cannot contain multiple spaces in a row.');
  }
  if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)) {
    return t('The username contains an illegal character.');
  }
349
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
350 351 352 353 354 355 356 357 358
                  '\x{AD}' .                // Soft-hyphen
                  '\x{2000}-\x{200F}' .     // Various space characters
                  '\x{2028}-\x{202F}' .     // Bidirectional text overrides
                  '\x{205F}-\x{206F}' .     // Various text hinting characters
                  '\x{FEFF}' .              // Byte order mark
                  '\x{FF01}-\x{FF60}' .     // Full-width latin
                  '\x{FFF9}-\x{FFFD}' .     // Replacement characters
                  '\x{0}-\x{1F}]/u',        // NULL byte and control characters
                  $name)) {
359 360
    return t('The username contains an illegal character.');
  }
361 362 363
  if (drupal_strlen($name) > USERNAME_MAX_LENGTH) {
    return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
  }
364 365
}

Dries's avatar
Dries committed
366 367 368
/**
 * Generate a random alphanumeric password.
 */
369 370
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
371 372
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
373
  // of 'I', 1, and 'l'.
374
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
375

376 377
  // Zero-based count of characters in the allowable list:
  $len = strlen($allowable_characters) - 1;
378

Dries's avatar
Dries committed
379 380
  // Declare the password as a blank string.
  $pass = '';
381

Dries's avatar
Dries committed
382
  // Loop the number of times specified by $length.
383 384 385 386
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
387
    $pass .= $allowable_characters[mt_rand(0, $len)];
388 389 390
  }

  return $pass;
391 392
}

393 394 395
/**
 * Determine the permissions for one or more roles.
 *
396 397
 * @param array $roles
 *   An array of role IDs.
398
 *
399 400 401
 * @return array
 *   An array indexed by role ID. Each value is an array of permission strings
 *   for the given role.
402
 */
403 404 405 406 407 408
function user_role_permissions(array $roles) {
  if (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'update') {
    return _user_role_permissions_update($roles);
  }
  $entities = entity_load_multiple('user_role', $roles);
  $role_permissions = array();
409
  foreach ($roles as $rid) {
410
    $role_permissions[$rid] = isset($entities[$rid]) ? $entities[$rid]->getPermissions() : array();
411
  }
412 413
  return $role_permissions;
}
414

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
/**
 * Determine the permissions for one or more roles during update.
 *
 * A separate version is needed because during update the entity system can't
 * be used and in non-update situations the entity system is preferred because
 * of the hook system.
 *
 * @param array $roles
 *   An array of role IDs.
 *
 * @return array
 *   An array indexed by role ID. Each value is an array of permission strings
 *   for the given role.
 */
function _user_role_permissions_update($roles) {
  $role_permissions = array();
  foreach ($roles as $rid) {
    $role_permissions[$rid] = Drupal::config("user.role.$rid")->get('permissions') ?: array();
433 434 435 436
  }
  return $role_permissions;
}

Dries's avatar
Dries committed
437 438 439 440 441
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
442
 * @param \Drupal\Core\Session\AccountInterface $account
443
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
444
 *
445
 * @return bool
446
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
447
 *
448 449
 * @deprecated as of Drupal 8.0. Use
 *   \Drupal\Core\Session\AccountInterface::hasPermission()
Dries's avatar
Dries committed
450
 */
451
function user_access($string, AccountInterface $account = NULL) {
452
  global $user;
453

454
  if (!isset($account)) {
455 456 457
    // In the installer request session is not set, so we have to fall back
    // to the global $user. In all other cases the session key is preferred.
    $account = Drupal::request()->attributes->get('account') ?: $user;
458 459
  }

460
  return $account->hasPermission($string);
461 462
}

463
/**
464
 * Checks for usernames blocked by user administration.
465
 *
466 467 468 469 470 471
 * @param $name
 *   A string containing a name of the user.
 *
 * @return
 *   Object with property 'name' (the user name), if the user is blocked;
 *   FALSE if the user is not blocked.
472 473
 */
function user_is_blocked($name) {
474 475 476 477 478
  return db_select('users')
    ->fields('users', array('name'))
    ->condition('name', db_like($name), 'LIKE')
    ->condition('status', 0)
    ->execute()->fetchObject();
479 480
}

Dries's avatar
Dries committed
481
/**
482
 * Implements hook_permission().
Dries's avatar
Dries committed
483
 */
484
function user_permission() {
485 486 487
  return array(
    'administer permissions' =>  array(
      'title' => t('Administer permissions'),
488
      'restrict access' => TRUE,
489 490 491
    ),
    'administer users' => array(
      'title' => t('Administer users'),
492
      'restrict access' => TRUE,
493 494
    ),
    'access user profiles' => array(
495
      'title' => t('View user profiles'),
496 497 498 499 500
    ),
    'change own username' => array(
      'title' => t('Change own username'),
    ),
    'cancel account' => array(
501
      'title' => t('Cancel own user account'),
502
      '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' => config('user.settings')->get('anonymous'), '@user-settings-url' => url('admin/config/people/accounts'))),
503 504 505
    ),
    'select account cancellation method' => array(
      'title' => t('Select method for cancelling own account'),
506
      'restrict access' => TRUE,
507 508
    ),
  );
509 510
}

Dries's avatar
Dries committed
511
/**
512
 * Implements hook_search_info().
Dries's avatar
Dries committed
513
 */
514 515 516 517 518 519 520
function user_search_info() {
  return array(
    'title' => 'Users',
  );
}

/**
521
 * Implements hook_search_access().
522 523 524 525 526 527
 */
function user_search_access() {
  return user_access('access user profiles');
}

/**
528
 * Implements hook_search_execute().
529
 */
530
function user_search_execute($keys = NULL, $conditions = NULL) {
531 532 533
  $find = array();
  // Replace wildcards with MySQL/PostgreSQL wildcards.
  $keys = preg_replace('!\*+!', '%', $keys);
534 535
  $query = db_select('users')
    ->extend('Drupal\Core\Database\Query\PagerSelectExtender');
536
  $query->fields('users', array('uid'));
537
  if (user_access('administer users')) {
538 539
    // Administrators can also search in the otherwise private email field, and
    // they don't need to be restricted to only active users.
540
    $query->fields('users', array('mail'));
541
    $query->condition(db_or()->
542 543
      condition('name', '%' . db_like($keys) . '%', 'LIKE')->
      condition('mail', '%' . db_like($keys) . '%', 'LIKE'));
544 545
  }
  else {
546 547 548 549
    // Regular users can only search via usernames, and we do not show them
    // blocked accounts.
    $query->condition('name', '%' . db_like($keys) . '%', 'LIKE')
      ->condition('status', 1);
550
  }
551
  $uids = $query
552
    ->limit(15)
553 554 555 556 557 558 559
    ->execute()
    ->fetchCol();
  $accounts = user_load_multiple($uids);

  $results = array();
  foreach ($accounts as $account) {
    $result = array(
560
      'title' => user_format_name($account),
561
      'link' => url('user/' . $account->id(), array('absolute' => TRUE)),
562 563
    );
    if (user_access('administer users')) {
564
      $result['title'] .= ' (' . $account->getEmail() . ')';
565
    }
566
    $results[] = $result;
567
  }
568 569

  return $results;
570 571
}

Dries's avatar
Dries committed
572
/**
573
 * Implements hook_user_view().
Dries's avatar
Dries committed
574
 */
575
function user_user_view(UserInterface $account, EntityDisplay $display) {
576 577 578 579
  if ($display->getComponent('member_for')) {
    $account->content['member_for'] = array(
      '#type' => 'item',
      '#title' => t('Member for'),
580
      '#markup' => format_interval(REQUEST_TIME - $account->getCreatedTime()),
581 582
    );
  }
583 584
}

585 586 587 588 589 590 591 592 593
/**
 * Sets the value of the user register and profile forms' langcode element.
 */
function _user_language_selector_langcode_value($element, $input, &$form_state) {
  // Only add to the description if the form element have a description.
  if (isset($form_state['complete_form']['language']['preferred_langcode']['#description'])) {
    $form_state['complete_form']['language']['preferred_langcode']['#description'] .= ' ' . t("This is also assumed to be the primary language of this account's profile information.");
  }
  return $form_state['values']['preferred_langcode'];
594 595
}

596
/**
597
 * Form validation handler for the current password on the user account form.
598
 *
599
 * @see AccountFormController::form()
600 601
 */
function user_validate_current_pass(&$form, &$form_state) {
602
  $account = $form_state['user'];
603 604 605 606 607
  foreach ($form_state['values']['current_pass_required_values'] as $key => $name) {
    // This validation only works for required textfields (like mail) or
    // form values like password_confirm that have their own validation
    // that prevent them from being empty if they are changed.
    if ((strlen(trim($form_state['values'][$key])) > 0) && ($form_state['values'][$key] != $account->$key)) {
608
      $current_pass_failed = empty($form_state['values']['current_pass']) || !drupal_container()->get('password')->check($form_state['values']['current_pass'], $account);
609 610 611 612 613 614 615 616 617 618
      if ($current_pass_failed) {
        form_set_error('current_pass', t("Your current password is missing or incorrect; it's required to change the %name.", array('%name' => $name)));
        form_set_error($key);
      }
      // We only need to check the password once.
      break;
    }
  }
}

619
/**
620
 * Implements hook_preprocess_HOOK() for block.html.twig.
621 622
 */
function user_preprocess_block(&$variables) {
623 624
  if ($variables['configuration']['module'] == 'user') {
    switch ($variables['elements']['#plugin_id']) {
625
      case 'user_login_block':
626
        $variables['attributes']['role'] = 'form';
627
        break;
628
      case 'user_new_block':
629
        $variables['attributes']['role'] = 'complementary';
630
        break;
631
      case 'user_online_block':
632
        $variables['attributes']['role'] = 'complementary';
633 634 635 636 637
        break;
    }
  }
}

638 639 640
/**
 * Format a username.
 *
641
 * @param \Drupal\Core\Session\Interface $account
642 643 644 645 646 647
 *   The account object for the user whose name is to be formatted.
 *
 * @return
 *   An unsanitized string with the username to display. The code receiving
 *   this result must ensure that check_plain() is called on it before it is
 *   printed to the page.
648 649
 *
 * @deprecated Use \Drupal\Core\Session\Interface::getUsername() instead.
650
 */
651 652
function user_format_name(AccountInterface $account) {
  return $account->getUsername();
653 654
}

655 656 657 658 659 660 661 662 663
/**
 * Implements hook_template_preprocess_default_variables_alter().
 *
 * @see user_user_login()
 * @see user_user_logout()
 */
function user_template_preprocess_default_variables_alter(&$variables) {
  global $user;

664 665 666 667 668 669
  // If this function is called from the installer after Drupal has been
  // installed then $user will not be set.
  if (!is_object($user)) {
    return;
  }

670 671 672 673 674
  $variables['user'] = clone $user;
  // Remove password and session IDs, since themes should not need nor see them.
  unset($variables['user']->pass, $variables['user']->sid, $variables['user']->ssid);

  $variables['is_admin'] = user_access('access administration pages');
675
  $variables['logged_in'] = $user->isAuthenticated();
676 677
}

678 679 680
/**
 * Preprocesses variables for theme_username().
 *
681
 * Modules that make any changes to variables like 'name' or 'extra' must ensure
682 683 684 685
 * that the final string is safe to include directly in the output by using
 * check_plain() or filter_xss().
 */
function template_preprocess_username(&$variables) {
686
  $account = $variables['account'] ?: drupal_anonymous_user();
687 688

  $variables['extra'] = '';
689 690 691 692 693
  $variables['uid'] = $account->id();
  if (empty($variables['uid'])) {
    if (theme_get_setting('features.comment_user_verification')) {
      $variables['extra'] = ' (' . t('not verified') . ')';
    }
694 695 696 697 698 699 700
  }

  // Set the name to a formatted name that is safe for printing and
  // that won't break tables by being too long. Keep an unshortened,
  // unsanitized version, in case other preprocess functions want to implement
  // their own shortening logic or add markup. If they do so, they must ensure
  // that $variables['name'] is safe for printing.
701
  $name = $variables['name_raw'] = $account->getUsername();
702 703 704 705 706
  if (drupal_strlen($name) > 20) {
    $name = drupal_substr($name, 0, 15) . '...';
  }
  $variables['name'] = check_plain($name);
  $variables['profile_access'] = user_access('access user profiles');
707

708 709 710
  // Populate link path and attributes if appropriate.
  if ($variables['uid'] && $variables['profile_access']) {
    // We are linking to a local user.
711
    $variables['link_options']['attributes']['title'] = t('View user profile.');
712 713 714 715 716 717
    $variables['link_path'] = 'user/' . $variables['uid'];
  }
  elseif (!empty($account->homepage)) {
    // Like the 'class' attribute, the 'rel' attribute can hold a
    // space-separated set of values, so initialize it as an array to make it
    // easier for other preprocess functions to append to it.
718
    $variables['link_options']['attributes']['rel'] = 'nofollow';
719 720 721 722 723 724
    $variables['link_path'] = $account->homepage;
    $variables['homepage'] = $account->homepage;
  }
  // We do not want the l() function to check_plain() a second time.
  $variables['link_options']['html'] = TRUE;
  // Set a default class.
725
  $variables['link_options']['attributes']['class'] = array('username');
726 727 728 729 730 731 732 733 734 735 736 737 738 739
}

/**
 * Returns HTML for a username, potentially linked to the user's page.
 *
 * @param $variables
 *   An associative array containing:
 *   - account: The user object to format.
 *   - name: The user's name, sanitized.
 *   - extra: Additional text to append to the user's name, sanitized.
 *   - link_path: The path or URL of the user's profile page, home page, or
 *     other desired page to link to for more information about the user.
 *   - link_options: An array of options to pass to the l() function's $options
 *     parameter if linking the user's name to the user's page.
740 741
 *   - attributes: An array of attributes to instantiate the
 *     Drupal\Core\Template\Attribute class if not linking to the user's page.
742 743 744 745 746 747 748 749 750 751 752 753 754
 *
 * @see template_preprocess_username()
 */
function theme_username($variables) {
  if (isset($variables['link_path'])) {
    // We have a link path, so we should generate a link using l().
    // Additional classes may be added as array elements like
    // $variables['link_options']['attributes']['class'][] = 'myclass';
    $output = l($variables['name'] . $variables['extra'], $variables['link_path'], $variables['link_options']);
  }
  else {
    // Modules may have added important attributes so they must be included
    // in the output. Additional classes may be added as array elements like
755
    // $variables['attributes']['class'][] = 'myclass';
756
    $output = '<span' . new Attribute($variables['attributes']) . '>' . $variables['name'] . $variables['extra'] . '</span>';
757 758 759 760
  }
  return $output;
}

761 762 763 764 765 766
/**
 * Determines if the current user is anonymous.
 *
 * @return bool
 *   TRUE if the user is anonymous, FALSE if the user is authenticated.
 */
767
function user_is_anonymous() {
768
  // Menu administrators can see items for anonymous when administering.
769
  return $GLOBALS['user']->isAnonymous() || !empty($GLOBALS['menu_admin']);
770 771
}

772 773 774 775 776
/**
 * Determines if the current user is logged in.
 *
 * @return bool
 *   TRUE if the user is logged in, FALSE if the user is anonymous.
777 778
 *
 * @deprecated Use \Drupal\Core\Session\UserSession::isAuthenticated().
779
 */
780
function user_is_logged_in() {
781
  return $GLOBALS['user']->isAuthenticated();
782 783
}

784 785 786 787 788 789
/**
 * Determines if the current user has access to the user registration page.
 *
 * @return bool
 *   TRUE if the user is not already logged in and can register for an account.
 */
790
function user_register_access() {
791
  return user_is_anonymous() && (config('user.settings')->get('register') != USER_REGISTER_ADMINISTRATORS_ONLY);
792 793
}

794
/**
795
 * Implements hook_menu().
796
 */
797 798
function user_menu() {
  // Registration and login pages.
799
  $items['user'] = array(
800
    'title' => 'User account',
801 802
    'title callback' => 'user_menu_title',
    'weight' => -10,
803
    'route_name' => 'user_page',
804
    'menu_name' => 'account',
805 806 807
  );

  $items['user/login'] = array(
808
    'title' => 'Log in',
809 810
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
811 812 813 814 815
  // Other authentication methods may add pages below user/login/.
  $items['user/login/default'] = array(
    'title' => 'Username and password',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
816

817
  $items['user/register'] = array(
818
    'title' => 'Create new account',
819
    'type' => MENU_LOCAL_TASK,
820
    'route_name' => 'user_register',
821 822 823
  );

  $items['user/password'] = array(
824
    'title' => 'Request new password',
825
    'route_name' => 'user_pass',
826 827 828
    'type' => MENU_LOCAL_TASK,
  );
  $items['user/reset/%/%/%'] = array(
829
    'title' => 'Reset password',
830 831 832 833
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
834
    'file' => 'user.pages.inc',
835 836
  );

837 838
  $items['user/logout'] = array(
    'title' => 'Log out',
839
    'route_name' => 'user_logout',
840
    'weight' => 10,
841
    'menu_name' => 'account',
842 843
  );

844
  // User listing pages.
845 846
  $items['admin/people'] = array(
    'title' => 'People',
847
    'description' => 'Manage user accounts, roles, and permissions.',
848
    'page callback' => 'user_admin_account',
849
    'access arguments' => array('administer users'),
850
    'position' => 'left',
851
    'weight' => -4,
852
    'file' => 'user.admin.inc',
853
  );
854
  // Permissions and role forms.
855 856 857
  $items['admin/people/permissions'] = array(
    'title' => 'Permissions',
    'description' => 'Determine access to features by selecting permissions for roles.',
858
    'route_name' => 'user_admin_permissions',
859 860
    'type' => MENU_LOCAL_TASK,
  );
861
  $items['admin/people/roles'] = array(
862 863
    'title' => 'Roles',
    'description' => 'List, edit, or add user roles.',
864
    'route_name' => 'user_role_list',
865 866
    'type' => MENU_LOCAL_TASK,
  );
867 868
  $items['admin/people/roles/add'] = array(
    'title' => 'Add role',
869
    'route_name' => 'user_role_add',
870 871 872 873
    'type' => MENU_LOCAL_ACTION,
  );

  $items['admin/people/roles/manage/%user_role'] = array(
874
    'title' => 'Edit role',
875
    'route_name' => 'user_role_edit',
876
  );
877 878 879 880 881
  $items['admin/people/roles/manage/%user_role/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/people/roles/manage/%user_role/delete'] = array(
882
    'title' => 'Delete role',
883
    'route_name' => 'user_role_delete',
884 885
    'weight' => 10,
    'context' => MENU_CONTEXT_INLINE,
886
  );
887

888
  $items['admin/people/create'] = array(
889
    'title' => 'Add user',
890
    'route_name' => 'user_admin_create',
891
    'type' => MENU_LOCAL_ACTION,
892
  );
893 894 895 896 897 898
  $items['admin/people/cancel'] = array(
    'title' => 'Cancel user',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_multiple_cancel_confirm'),
    'access arguments' => array('administer users'),
    'file' => 'user.admin.inc',
899
    'type' => MENU_CALLBACK,
900
  );
901 902 903

  // Administration pages.
  $items['admin/config/people'] = array(
904
   'title' => 'People',
905
   'description' => 'Configure user accounts.',
906 907
   'position' => 'left',
   'weight' => -20,
908
   'page callback' => 'system_admin_menu_block_page',
909
   'access arguments' => array('access administration pages'),
910 911
   'file' => 'system.admin.inc',
   'file path' => drupal_get_path('module', 'system'),
912 913 914
  );
  $items['admin/config/people/accounts'] = array(
    'title' => 'Account settings',
915
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, and fields.',
916
    'weight' => -10,
917
    'route_name' => 'user_account_settings',
918
  );
919
  $items['admin/config/people/accounts/settings'] = array(
920 921 922
    'title' => 'Settings',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
923

924
  $items['user/%user'] = array(
925
    'title' => 'My account',
926 927
    'title callback' => 'user_page_title',
    'title arguments' => array(1),
928
    'page callback' => 'user_view_page',
929
    'page arguments' => array(1),
930
    'access callback' => 'entity_page_access',
931 932
    'access arguments' => array(1),
  );
933
  $items['user/%user/view'] = array(
934
    'title' => 'View',
935 936
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
937 938
  $items['user/%user/cancel'] = array(
    'title' => 'Cancel account',
939
    'page callback' => 'drupal_get_form',
940
    'page arguments' => array('user_cancel_confirm_form', 1),
941 942
    'access callback' => 'entity_page_access',
    'access arguments' => array(1, 'delete'),
943
    'file' => 'user.pages.inc',
944 945 946 947 948
  );
  $items['user/%user/cancel/confirm/%/%'] = array(
    'title' => 'Confirm account cancellation',
    'page callback' => 'user_cancel_confirm',
    'page arguments' => array(1, 4, 5),
949 950
    'access callback' => 'entity_page_access',
    'access arguments' => array(1, 'delete'),
951
    'file' => 'user.pages.inc',
952
  );
953
  $items['user/%user/edit'] = array(
954
    'title' => 'Edit',
955
    'page callback' => 'entity_get_form',
956
    'page arguments' => array(1),
957 958
    'access callback' => 'entity_page_access',
    'access arguments' => array(1, 'update'),
959
    'type' => MENU_LOCAL_TASK,
960
    'file' => 'user.pages.inc',
961
  );
Dries's avatar
Dries committed
962
  return $items;
963 964
}

965
/**
966
 * Implements hook_menu_link_presave().
967
 */
968
function user_menu_link_presave(MenuLink $menu_link) {
969 970 971
  // The path 'user' must be accessible for anonymous users, but only visible
  // for authenticated users. Authenticated users should see "My account", but
  // anonymous users should not see it at all. Therefore, invoke
972
  // user_menu_link_load() to conditionally hide the link.
973 974
  if ($menu_link->link_path == 'user' && $menu_link->module == 'system') {
    $menu_link->options['alter'] = TRUE;
975 976
  }

977
  // Force the Logout link to appear on the top-level of 'account' menu by
978
  // default (i.e., unless it has been customized).
979 980
  if ($menu_link->link_path == 'user/logout' && $menu_link->module == 'system' && empty($menu_link->customized)) {
    $menu_link->plid = 0;
981 982 983
  }
}

984 985 986 987 988 989 990 991 992 993 994
/**
 * Implements hook_menu_breadcrumb_alter().
 */
function user_menu_breadcrumb_alter(&$active_trail, $item) {
  // Remove "My account" from the breadcrumb when $item is descendant-or-self
  // of system path user/%.
  if (isset($active_trail[1]['module']) && $active_trail[1]['module'] == 'system' && $active_trail[1]['link_path'] == 'user' && strpos($item['path'], 'user/%') === 0) {
    array_splice($active_trail, 1, 1);
  }
}

995
/**
996
 * Implements hook_menu_link_load().
997
 */
998
function user_menu_link_load($menu_links) {
999
  // Hide the "User account" link for anonymous users.
1000
  foreach ($menu_links as $link) {
1001
    if ($link['link_path'] == 'user' && $link['module'] == 'system' && !$GLOBALS['user']->id()) {
1002 1003
      $link['hidden'] = 1;
    }