Projet

Général

Profil

Paste
Télécharger (140 ko) Statistiques
| Branche: | Révision:

root / drupal7 / modules / user / user.module @ bceb9b7a

1
<?php
2

    
3
/**
4
 * @file
5
 * Enables the user registration and login system.
6
 */
7

    
8
/**
9
 * Maximum length of username text field.
10
 */
11
define('USERNAME_MAX_LENGTH', 60);
12

    
13
/**
14
 * Maximum length of user e-mail text field.
15
 */
16
define('EMAIL_MAX_LENGTH', 254);
17

    
18
/**
19
 * Only administrators can create user accounts.
20
 */
21
define('USER_REGISTER_ADMINISTRATORS_ONLY', 0);
22

    
23
/**
24
 * Visitors can create their own accounts.
25
 */
26
define('USER_REGISTER_VISITORS', 1);
27

    
28
/**
29
 * Visitors can create accounts, but they don't become active without
30
 * administrative approval.
31
 */
32
define('USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL', 2);
33

    
34
/**
35
 * Implement hook_help().
36
 */
37
function user_help($path, $arg) {
38
  global $user;
39

    
40
  switch ($path) {
41
    case 'admin/help#user':
42
      $output = '';
43
      $output .= '<h3>' . t('About') . '</h3>';
44
      $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>';
45
      $output .= '<h3>' . t('Uses') . '</h3>';
46
      $output .= '<dl>';
47
      $output .= '<dt>' . t('Creating and managing users') . '</dt>';
48
      $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>';
49
      $output .= '<dt>' . t('User roles and permissions') . '</dt>';
50
      $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>';
51
      $output .= '<dt>' . t('Account settings') . '</dt>';
52
      $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>';
53
      $output .= '</dl>';
54
      return $output;
55
    case 'admin/people/create':
56
      return '<p>' . t("This web page allows administrators to register new users. Users' e-mail addresses and usernames must be unique.") . '</p>';
57
    case 'admin/people/permissions':
58
      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>';
59
    case 'admin/people/permissions/roles':
60
      $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>';
61
      $output .= '<p>' . t('By default, Drupal comes with two user roles:') . '</p>';
62
      $output .= '<ul>';
63
      $output .= '<li>' . t("Anonymous user: this role is used for users that don't have a user account or that are not authenticated.") . '</li>';
64
      $output .= '<li>' . t('Authenticated user: this role is automatically granted to all logged in users.') . '</li>';
65
      $output .= '</ul>';
66
      return $output;
67
    case 'admin/config/people/accounts/fields':
68
      return '<p>' . t('This form lets administrators add, edit, and arrange fields for storing user data.') . '</p>';
69
    case 'admin/config/people/accounts/display':
70
      return '<p>' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '</p>';
71
    case 'admin/people/search':
72
      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>';
73
  }
74
}
75

    
76
/**
77
 * Invokes a user hook in every module.
78
 *
79
 * We cannot use module_invoke() for this, because the arguments need to
80
 * be passed by reference.
81
 *
82
 * @param $type
83
 *   A text string that controls which user hook to invoke.  Valid choices are:
84
 *   - cancel: Invokes hook_user_cancel().
85
 *   - insert: Invokes hook_user_insert().
86
 *   - login: Invokes hook_user_login().
87
 *   - presave: Invokes hook_user_presave().
88
 *   - update: Invokes hook_user_update().
89
 * @param $edit
90
 *   An associative array variable containing form values to be passed
91
 *   as the first parameter of the hook function.
92
 * @param $account
93
 *   The user account object to be passed as the second parameter of the hook
94
 *   function.
95
 * @param $category
96
 *   The category of user information being acted upon.
97
 */
98
function user_module_invoke($type, &$edit, $account, $category = NULL) {
99
  foreach (module_implements('user_' . $type) as $module) {
100
    $function = $module . '_user_' . $type;
101
    $function($edit, $account, $category);
102
  }
103
}
104

    
105
/**
106
 * Implements hook_theme().
107
 */
108
function user_theme() {
109
  return array(
110
    'user_picture' => array(
111
      'variables' => array('account' => NULL),
112
      'template' => 'user-picture',
113
    ),
114
    'user_profile' => array(
115
      'render element' => 'elements',
116
      'template' => 'user-profile',
117
      'file' => 'user.pages.inc',
118
    ),
119
    'user_profile_category' => array(
120
      'render element' => 'element',
121
      'template' => 'user-profile-category',
122
      'file' => 'user.pages.inc',
123
    ),
124
    'user_profile_item' => array(
125
      'render element' => 'element',
126
      'template' => 'user-profile-item',
127
      'file' => 'user.pages.inc',
128
    ),
129
    'user_list' => array(
130
      'variables' => array('users' => NULL, 'title' => NULL),
131
    ),
132
    'user_admin_permissions' => array(
133
      'render element' => 'form',
134
      'file' => 'user.admin.inc',
135
    ),
136
    'user_admin_roles' => array(
137
      'render element' => 'form',
138
      'file' => 'user.admin.inc',
139
    ),
140
    'user_permission_description' => array(
141
      'variables' => array('permission_item' => NULL, 'hide' => NULL),
142
      'file' => 'user.admin.inc',
143
    ),
144
    'user_signature' => array(
145
      'variables' => array('signature' => NULL),
146
    ),
147
  );
148
}
149

    
150
/**
151
 * Implements hook_entity_info().
152
 */
153
function user_entity_info() {
154
  $return = array(
155
    'user' => array(
156
      'label' => t('User'),
157
      'controller class' => 'UserController',
158
      'base table' => 'users',
159
      'uri callback' => 'user_uri',
160
      'label callback' => 'format_username',
161
      'fieldable' => TRUE,
162
      // $user->language is only the preferred user language for the user
163
      // interface textual elements. As it is not necessarily related to the
164
      // language assigned to fields, we do not define it as the entity language
165
      // key.
166
      'entity keys' => array(
167
        'id' => 'uid',
168
      ),
169
      'bundles' => array(
170
        'user' => array(
171
          'label' => t('User'),
172
          'admin' => array(
173
            'path' => 'admin/config/people/accounts',
174
            'access arguments' => array('administer users'),
175
          ),
176
        ),
177
      ),
178
      'view modes' => array(
179
        'full' => array(
180
          'label' => t('User account'),
181
          'custom settings' => FALSE,
182
        ),
183
      ),
184
    ),
185
  );
186
  return $return;
187
}
188

    
189
/**
190
 * Implements callback_entity_info_uri().
191
 */
192
function user_uri($user) {
193
  return array(
194
    'path' => 'user/' . $user->uid,
195
  );
196
}
197

    
198
/**
199
 * Implements hook_field_info_alter().
200
 */
201
function user_field_info_alter(&$info) {
202
  // Add the 'user_register_form' instance setting to all field types.
203
  foreach ($info as $field_type => &$field_type_info) {
204
    $field_type_info += array('instance_settings' => array());
205
    $field_type_info['instance_settings'] += array(
206
      'user_register_form' => FALSE,
207
    );
208
  }
209
}
210

    
211
/**
212
 * Implements hook_field_extra_fields().
213
 */
214
function user_field_extra_fields() {
215
  $return['user']['user'] = array(
216
    'form' => array(
217
      'account' => array(
218
        'label' => t('User name and password'),
219
        'description' => t('User module account form elements.'),
220
        'weight' => -10,
221
      ),
222
      'timezone' => array(
223
        'label' => t('Timezone'),
224
        'description' => t('User module timezone form element.'),
225
        'weight' => 6,
226
      ),
227
    ),
228
    'display' => array(
229
      'summary' => array(
230
        'label' => t('History'),
231
        'description' => t('User module history view element.'),
232
        'weight' => 5,
233
      ),
234
    ),
235
  );
236

    
237
  return $return;
238
}
239

    
240
/**
241
 * Fetches a user object based on an external authentication source.
242
 *
243
 * @param string $authname
244
 *   The external authentication username.
245
 *
246
 * @return
247
 *   A fully-loaded user object if the user is found or FALSE if not found.
248
 */
249
function user_external_load($authname) {
250
  $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField();
251

    
252
  if ($uid) {
253
    return user_load($uid);
254
  }
255
  else {
256
    return FALSE;
257
  }
258
}
259

    
260
/**
261
 * Load multiple users based on certain conditions.
262
 *
263
 * This function should be used whenever you need to load more than one user
264
 * from the database. Users are loaded into memory and will not require
265
 * database access if loaded again during the same page request.
266
 *
267
 * @param $uids
268
 *   An array of user IDs.
269
 * @param $conditions
270
 *   (deprecated) An associative array of conditions on the {users}
271
 *   table, where the keys are the database fields and the values are the
272
 *   values those fields must have. Instead, it is preferable to use
273
 *   EntityFieldQuery to retrieve a list of entity IDs loadable by
274
 *   this function.
275
 * @param $reset
276
 *   A boolean indicating that the internal cache should be reset. Use this if
277
 *   loading a user object which has been altered during the page request.
278
 *
279
 * @return
280
 *   An array of user objects, indexed by uid.
281
 *
282
 * @see entity_load()
283
 * @see user_load()
284
 * @see user_load_by_mail()
285
 * @see user_load_by_name()
286
 * @see EntityFieldQuery
287
 *
288
 * @todo Remove $conditions in Drupal 8.
289
 */
290
function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
291
  return entity_load('user', $uids, $conditions, $reset);
292
}
293

    
294
/**
295
 * Controller class for users.
296
 *
297
 * This extends the DrupalDefaultEntityController class, adding required
298
 * special handling for user objects.
299
 */
300
class UserController extends DrupalDefaultEntityController {
301

    
302
  function attachLoad(&$queried_users, $revision_id = FALSE) {
303
    // Build an array of user picture IDs so that these can be fetched later.
304
    $picture_fids = array();
305
    foreach ($queried_users as $key => $record) {
306
      $picture_fids[] = $record->picture;
307
      $queried_users[$key]->data = unserialize($record->data);
308
      $queried_users[$key]->roles = array();
309
      if ($record->uid) {
310
        $queried_users[$record->uid]->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
311
      }
312
      else {
313
        $queried_users[$record->uid]->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
314
      }
315
    }
316

    
317
    // Add any additional roles from the database.
318
    $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)));
319
    foreach ($result as $record) {
320
      $queried_users[$record->uid]->roles[$record->rid] = $record->name;
321
    }
322

    
323
    // Add the full file objects for user pictures if enabled.
324
    if (!empty($picture_fids) && variable_get('user_pictures', 0)) {
325
      $pictures = file_load_multiple($picture_fids);
326
      foreach ($queried_users as $account) {
327
        if (!empty($account->picture) && isset($pictures[$account->picture])) {
328
          $account->picture = $pictures[$account->picture];
329
        }
330
        else {
331
          $account->picture = NULL;
332
        }
333
      }
334
    }
335
    // Call the default attachLoad() method. This will add fields and call
336
    // hook_user_load().
337
    parent::attachLoad($queried_users, $revision_id);
338
  }
339
}
340

    
341
/**
342
 * Loads a user object.
343
 *
344
 * Drupal has a global $user object, which represents the currently-logged-in
345
 * user. So to avoid confusion and to avoid clobbering the global $user object,
346
 * it is a good idea to assign the result of this function to a different local
347
 * variable, generally $account. If you actually do want to act as the user you
348
 * are loading, it is essential to call drupal_save_session(FALSE); first.
349
 * See
350
 * @link http://drupal.org/node/218104 Safely impersonating another user @endlink
351
 * for more information.
352
 *
353
 * @param $uid
354
 *   Integer specifying the user ID to load.
355
 * @param $reset
356
 *   TRUE to reset the internal cache and load from the database; FALSE
357
 *   (default) to load from the internal cache, if set.
358
 *
359
 * @return
360
 *   A fully-loaded user object upon successful user load, or FALSE if the user
361
 *   cannot be loaded.
362
 *
363
 * @see user_load_multiple()
364
 */
365
function user_load($uid, $reset = FALSE) {
366
  $users = user_load_multiple(array($uid), array(), $reset);
367
  return reset($users);
368
}
369

    
370
/**
371
 * Fetch a user object by email address.
372
 *
373
 * @param $mail
374
 *   String with the account's e-mail address.
375
 * @return
376
 *   A fully-loaded $user object upon successful user load or FALSE if user
377
 *   cannot be loaded.
378
 *
379
 * @see user_load_multiple()
380
 */
381
function user_load_by_mail($mail) {
382
  $users = user_load_multiple(array(), array('mail' => $mail));
383
  return reset($users);
384
}
385

    
386
/**
387
 * Fetch a user object by account name.
388
 *
389
 * @param $name
390
 *   String with the account's user name.
391
 * @return
392
 *   A fully-loaded $user object upon successful user load or FALSE if user
393
 *   cannot be loaded.
394
 *
395
 * @see user_load_multiple()
396
 */
397
function user_load_by_name($name) {
398
  $users = user_load_multiple(array(), array('name' => $name));
399
  return reset($users);
400
}
401

    
402
/**
403
 * Save changes to a user account or add a new user.
404
 *
405
 * @param $account
406
 *   (optional) The user object to modify or add. If you want to modify
407
 *   an existing user account, you will need to ensure that (a) $account
408
 *   is an object, and (b) you have set $account->uid to the numeric
409
 *   user ID of the user account you wish to modify. If you
410
 *   want to create a new user account, you can set $account->is_new to
411
 *   TRUE or omit the $account->uid field.
412
 * @param $edit
413
 *   An array of fields and values to save. For example array('name'
414
 *   => 'My name'). Key / value pairs added to the $edit['data'] will be
415
 *   serialized and saved in the {users.data} column.
416
 * @param $category
417
 *   (optional) The category for storing profile information in.
418
 *
419
 * @return
420
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
421
 *
422
 * @todo D8: Drop $edit and fix user_save() to be consistent with others.
423
 */
424
function user_save($account, $edit = array(), $category = 'account') {
425
  $transaction = db_transaction();
426
  try {
427
    if (!empty($edit['pass'])) {
428
      // Allow alternate password hashing schemes.
429
      require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
430
      $edit['pass'] = user_hash_password(trim($edit['pass']));
431
      // Abort if the hashing failed and returned FALSE.
432
      if (!$edit['pass']) {
433
        return FALSE;
434
      }
435
    }
436
    else {
437
      // Avoid overwriting an existing password with a blank password.
438
      unset($edit['pass']);
439
    }
440
    if (isset($edit['mail'])) {
441
      $edit['mail'] = trim($edit['mail']);
442
    }
443

    
444
    // Load the stored entity, if any.
445
    if (!empty($account->uid) && !isset($account->original)) {
446
      $account->original = entity_load_unchanged('user', $account->uid);
447
    }
448

    
449
    if (empty($account)) {
450
      $account = new stdClass();
451
    }
452
    if (!isset($account->is_new)) {
453
      $account->is_new = empty($account->uid);
454
    }
455
    // Prepopulate $edit['data'] with the current value of $account->data.
456
    // Modules can add to or remove from this array in hook_user_presave().
457
    if (!empty($account->data)) {
458
      $edit['data'] = !empty($edit['data']) ? array_merge($account->data, $edit['data']) : $account->data;
459
    }
460

    
461
    // Invoke hook_user_presave() for all modules.
462
    user_module_invoke('presave', $edit, $account, $category);
463

    
464
    // Invoke presave operations of Field Attach API and Entity API. Those APIs
465
    // require a fully-fledged and updated entity object. Therefore, we need to
466
    // copy any new property values of $edit into it.
467
    foreach ($edit as $key => $value) {
468
      $account->$key = $value;
469
    }
470
    field_attach_presave('user', $account);
471
    module_invoke_all('entity_presave', $account, 'user');
472

    
473
    if (is_object($account) && !$account->is_new) {
474
      // Process picture uploads.
475
      if (!empty($account->picture->fid) && (!isset($account->original->picture->fid) || $account->picture->fid != $account->original->picture->fid)) {
476
        $picture = $account->picture;
477
        // If the picture is a temporary file move it to its final location and
478
        // make it permanent.
479
        if (!$picture->status) {
480
          $info = image_get_info($picture->uri);
481
          $picture_directory =  file_default_scheme() . '://' . variable_get('user_picture_path', 'pictures');
482

    
483
          // Prepare the pictures directory.
484
          file_prepare_directory($picture_directory, FILE_CREATE_DIRECTORY);
485
          $destination = file_stream_wrapper_uri_normalize($picture_directory . '/picture-' . $account->uid . '-' . REQUEST_TIME . '.' . $info['extension']);
486

    
487
          // Move the temporary file into the final location.
488
          if ($picture = file_move($picture, $destination, FILE_EXISTS_RENAME)) {
489
            $picture->status = FILE_STATUS_PERMANENT;
490
            $account->picture = file_save($picture);
491
            file_usage_add($picture, 'user', 'user', $account->uid);
492
          }
493
        }
494
        // Delete the previous picture if it was deleted or replaced.
495
        if (!empty($account->original->picture->fid)) {
496
          file_usage_delete($account->original->picture, 'user', 'user', $account->uid);
497
          file_delete($account->original->picture);
498
        }
499
      }
500
      elseif (isset($edit['picture_delete']) && $edit['picture_delete']) {
501
        file_usage_delete($account->original->picture, 'user', 'user', $account->uid);
502
        file_delete($account->original->picture);
503
      }
504
      // Save the picture object, if it is set. drupal_write_record() expects
505
      // $account->picture to be a FID.
506
      $picture = empty($account->picture) ? NULL : $account->picture;
507
      $account->picture = empty($account->picture->fid) ? 0 : $account->picture->fid;
508

    
509
      // Do not allow 'uid' to be changed.
510
      $account->uid = $account->original->uid;
511
      // Save changes to the user table.
512
      $success = drupal_write_record('users', $account, 'uid');
513
      // Restore the picture object.
514
      $account->picture = $picture;
515
      if ($success === FALSE) {
516
        // The query failed - better to abort the save than risk further
517
        // data loss.
518
        return FALSE;
519
      }
520

    
521
      // Reload user roles if provided.
522
      if ($account->roles != $account->original->roles) {
523
        db_delete('users_roles')
524
          ->condition('uid', $account->uid)
525
          ->execute();
526

    
527
        $query = db_insert('users_roles')->fields(array('uid', 'rid'));
528
        foreach (array_keys($account->roles) as $rid) {
529
          if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
530
            $query->values(array(
531
              'uid' => $account->uid,
532
              'rid' => $rid,
533
            ));
534
          }
535
        }
536
        $query->execute();
537
      }
538

    
539
      // Delete a blocked user's sessions to kick them if they are online.
540
      if ($account->original->status != $account->status && $account->status == 0) {
541
        drupal_session_destroy_uid($account->uid);
542
      }
543

    
544
      // If the password changed, delete all open sessions and recreate
545
      // the current one.
546
      if ($account->pass != $account->original->pass) {
547
        drupal_session_destroy_uid($account->uid);
548
        if ($account->uid == $GLOBALS['user']->uid) {
549
          drupal_session_regenerate();
550
        }
551
      }
552

    
553
      // Save Field data.
554
      field_attach_update('user', $account);
555

    
556
      // Send emails after we have the new user object.
557
      if ($account->status != $account->original->status) {
558
        // The user's status is changing; conditionally send notification email.
559
        $op = $account->status == 1 ? 'status_activated' : 'status_blocked';
560
        _user_mail_notify($op, $account);
561
      }
562

    
563
      // Update $edit with any interim changes to $account.
564
      foreach ($account as $key => $value) {
565
        if (!property_exists($account->original, $key) || $value !== $account->original->$key) {
566
          $edit[$key] = $value;
567
        }
568
      }
569
      user_module_invoke('update', $edit, $account, $category);
570
      module_invoke_all('entity_update', $account, 'user');
571
    }
572
    else {
573
      // Allow 'uid' to be set by the caller. There is no danger of writing an
574
      // existing user as drupal_write_record will do an INSERT.
575
      if (empty($account->uid)) {
576
        $account->uid = db_next_id(db_query('SELECT MAX(uid) FROM {users}')->fetchField());
577
      }
578
      // Allow 'created' to be set by the caller.
579
      if (!isset($account->created)) {
580
        $account->created = REQUEST_TIME;
581
      }
582
      $success = drupal_write_record('users', $account);
583
      if ($success === FALSE) {
584
        // On a failed INSERT some other existing user's uid may be returned.
585
        // We must abort to avoid overwriting their account.
586
        return FALSE;
587
      }
588

    
589
      // Make sure $account is properly initialized.
590
      $account->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
591

    
592
      field_attach_insert('user', $account);
593
      $edit = (array) $account;
594
      user_module_invoke('insert', $edit, $account, $category);
595
      module_invoke_all('entity_insert', $account, 'user');
596

    
597
      // Save user roles. Skip built-in roles, and ones that were already saved
598
      // to the database during hook calls.
599
      $rids_to_skip = array_merge(array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID), db_query('SELECT rid FROM {users_roles} WHERE uid = :uid', array(':uid' => $account->uid))->fetchCol());
600
      if ($rids_to_save = array_diff(array_keys($account->roles), $rids_to_skip)) {
601
        $query = db_insert('users_roles')->fields(array('uid', 'rid'));
602
        foreach ($rids_to_save as $rid) {
603
          $query->values(array(
604
            'uid' => $account->uid,
605
            'rid' => $rid,
606
          ));
607
        }
608
        $query->execute();
609
      }
610
    }
611
    // Clear internal properties.
612
    unset($account->is_new);
613
    unset($account->original);
614
    // Clear the static loading cache.
615
    entity_get_controller('user')->resetCache(array($account->uid));
616

    
617
    return $account;
618
  }
619
  catch (Exception $e) {
620
    $transaction->rollback();
621
    watchdog_exception('user', $e);
622
    throw $e;
623
  }
624
}
625

    
626
/**
627
 * Verify the syntax of the given name.
628
 */
629
function user_validate_name($name) {
630
  if (!$name) {
631
    return t('You must enter a username.');
632
  }
633
  if (substr($name, 0, 1) == ' ') {
634
    return t('The username cannot begin with a space.');
635
  }
636
  if (substr($name, -1) == ' ') {
637
    return t('The username cannot end with a space.');
638
  }
639
  if (strpos($name, '  ') !== FALSE) {
640
    return t('The username cannot contain multiple spaces in a row.');
641
  }
642
  if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)) {
643
    return t('The username contains an illegal character.');
644
  }
645
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
646
                  '\x{AD}' .                // Soft-hyphen
647
                  '\x{2000}-\x{200F}' .     // Various space characters
648
                  '\x{2028}-\x{202F}' .     // Bidirectional text overrides
649
                  '\x{205F}-\x{206F}' .     // Various text hinting characters
650
                  '\x{FEFF}' .              // Byte order mark
651
                  '\x{FF01}-\x{FF60}' .     // Full-width latin
652
                  '\x{FFF9}-\x{FFFD}' .     // Replacement characters
653
                  '\x{0}-\x{1F}]/u',        // NULL byte and control characters
654
                  $name)) {
655
    return t('The username contains an illegal character.');
656
  }
657
  if (drupal_strlen($name) > USERNAME_MAX_LENGTH) {
658
    return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
659
  }
660
}
661

    
662
/**
663
 * Validates a user's email address.
664
 *
665
 * Checks that a user's email address exists and follows all standard
666
 * validation rules. Returns error messages when the address is invalid.
667
 *
668
 * @param $mail
669
 *   A user's email address.
670
 *
671
 * @return
672
 *   If the address is invalid, a human-readable error message is returned.
673
 *   If the address is valid, nothing is returned.
674
 */
675
function user_validate_mail($mail) {
676
  if (!$mail) {
677
    return t('You must enter an e-mail address.');
678
  }
679
  if (!valid_email_address($mail)) {
680
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
681
  }
682
}
683

    
684
/**
685
 * Validates an image uploaded by a user.
686
 *
687
 * @see user_account_form()
688
 */
689
function user_validate_picture(&$form, &$form_state) {
690
  // If required, validate the uploaded picture.
691
  $validators = array(
692
    'file_validate_is_image' => array(),
693
    'file_validate_image_resolution' => array(variable_get('user_picture_dimensions', '85x85')),
694
    'file_validate_size' => array(variable_get('user_picture_file_size', '30') * 1024),
695
  );
696

    
697
  // Save the file as a temporary file.
698
  $file = file_save_upload('picture_upload', $validators);
699
  if ($file === FALSE) {
700
    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'))));
701
  }
702
  elseif ($file !== NULL) {
703
    $form_state['values']['picture_upload'] = $file;
704
  }
705
}
706

    
707
/**
708
 * Generate a random alphanumeric password.
709
 */
710
function user_password($length = 10) {
711
  // This variable contains the list of allowable characters for the
712
  // password. Note that the number 0 and the letter 'O' have been
713
  // removed to avoid confusion between the two. The same is true
714
  // of 'I', 1, and 'l'.
715
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
716

    
717
  // Zero-based count of characters in the allowable list:
718
  $len = strlen($allowable_characters) - 1;
719

    
720
  // Declare the password as a blank string.
721
  $pass = '';
722

    
723
  // Loop the number of times specified by $length.
724
  for ($i = 0; $i < $length; $i++) {
725
    do {
726
      // Find a secure random number within the range needed.
727
      $index = ord(drupal_random_bytes(1));
728
    } while ($index > $len);
729

    
730
    // Each iteration, pick a random character from the
731
    // allowable string and append it to the password:
732
    $pass .= $allowable_characters[$index];
733
  }
734

    
735
  return $pass;
736
}
737

    
738
/**
739
 * Determine the permissions for one or more roles.
740
 *
741
 * @param $roles
742
 *   An array whose keys are the role IDs of interest, such as $user->roles.
743
 *
744
 * @return
745
 *   If $roles is a non-empty array, an array indexed by role ID is returned.
746
 *   Each value is an array whose keys are the permission strings for the given
747
 *   role ID. If $roles is empty nothing is returned.
748
 */
749
function user_role_permissions($roles = array()) {
750
  $cache = &drupal_static(__FUNCTION__, array());
751

    
752
  $role_permissions = $fetch = array();
753

    
754
  if ($roles) {
755
    foreach ($roles as $rid => $name) {
756
      if (isset($cache[$rid])) {
757
        $role_permissions[$rid] = $cache[$rid];
758
      }
759
      else {
760
        // Add this rid to the list of those needing to be fetched.
761
        $fetch[] = $rid;
762
        // Prepare in case no permissions are returned.
763
        $cache[$rid] = array();
764
      }
765
    }
766

    
767
    if ($fetch) {
768
      // Get from the database permissions that were not in the static variable.
769
      // Only role IDs with at least one permission assigned will return rows.
770
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
771

    
772
      foreach ($result as $row) {
773
        $cache[$row->rid][$row->permission] = TRUE;
774
      }
775
      foreach ($fetch as $rid) {
776
        // For every rid, we know we at least assigned an empty array.
777
        $role_permissions[$rid] = $cache[$rid];
778
      }
779
    }
780
  }
781

    
782
  return $role_permissions;
783
}
784

    
785
/**
786
 * Determine whether the user has a given privilege.
787
 *
788
 * @param $string
789
 *   The permission, such as "administer nodes", being checked for.
790
 * @param $account
791
 *   (optional) The account to check, if not given use currently logged in user.
792
 *
793
 * @return
794
 *   Boolean TRUE if the current user has the requested permission.
795
 *
796
 * All permission checks in Drupal should go through this function. This
797
 * way, we guarantee consistent behavior, and ensure that the superuser
798
 * can perform all actions.
799
 */
800
function user_access($string, $account = NULL) {
801
  global $user;
802

    
803
  if (!isset($account)) {
804
    $account = $user;
805
  }
806

    
807
  // User #1 has all privileges:
808
  if ($account->uid == 1) {
809
    return TRUE;
810
  }
811

    
812
  // To reduce the number of SQL queries, we cache the user's permissions
813
  // in a static variable.
814
  // Use the advanced drupal_static() pattern, since this is called very often.
815
  static $drupal_static_fast;
816
  if (!isset($drupal_static_fast)) {
817
    $drupal_static_fast['perm'] = &drupal_static(__FUNCTION__);
818
  }
819
  $perm = &$drupal_static_fast['perm'];
820
  if (!isset($perm[$account->uid])) {
821
    $role_permissions = user_role_permissions($account->roles);
822

    
823
    $perms = array();
824
    foreach ($role_permissions as $one_role) {
825
      $perms += $one_role;
826
    }
827
    $perm[$account->uid] = $perms;
828
  }
829

    
830
  return isset($perm[$account->uid][$string]);
831
}
832

    
833
/**
834
 * Checks for usernames blocked by user administration.
835
 *
836
 * @param $name
837
 *   A string containing a name of the user.
838
 *
839
 * @return
840
 *   Object with property 'name' (the user name), if the user is blocked;
841
 *   FALSE if the user is not blocked.
842
 */
843
function user_is_blocked($name) {
844
  return db_select('users')
845
    ->fields('users', array('name'))
846
    ->condition('name', db_like($name), 'LIKE')
847
    ->condition('status', 0)
848
    ->execute()->fetchObject();
849
}
850

    
851
/**
852
 * Implements hook_permission().
853
 */
854
function user_permission() {
855
  return array(
856
    'administer permissions' =>  array(
857
      'title' => t('Administer permissions'),
858
      'restrict access' => TRUE,
859
    ),
860
    'administer users' => array(
861
      'title' => t('Administer users'),
862
      'restrict access' => TRUE,
863
    ),
864
    'access user profiles' => array(
865
      'title' => t('View user profiles'),
866
    ),
867
    'change own username' => array(
868
      'title' => t('Change own username'),
869
    ),
870
    'cancel account' => array(
871
      'title' => t('Cancel own user account'),
872
      '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'))),
873
    ),
874
    'select account cancellation method' => array(
875
      'title' => t('Select method for cancelling own account'),
876
      'restrict access' => TRUE,
877
    ),
878
  );
879
}
880

    
881
/**
882
 * Implements hook_file_download().
883
 *
884
 * Ensure that user pictures (avatars) are always downloadable.
885
 */
886
function user_file_download($uri) {
887
  if (strpos(file_uri_target($uri), variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
888
    $info = image_get_info($uri);
889
    return array('Content-Type' => $info['mime_type']);
890
  }
891
}
892

    
893
/**
894
 * Implements hook_file_move().
895
 */
896
function user_file_move($file, $source) {
897
  // If a user's picture is replaced with a new one, update the record in
898
  // the users table.
899
  if (isset($file->fid) && isset($source->fid) && $file->fid != $source->fid) {
900
    db_update('users')
901
      ->fields(array(
902
        'picture' => $file->fid,
903
      ))
904
      ->condition('picture', $source->fid)
905
      ->execute();
906
  }
907
}
908

    
909
/**
910
 * Implements hook_file_delete().
911
 */
912
function user_file_delete($file) {
913
  // Remove any references to the file.
914
  db_update('users')
915
    ->fields(array('picture' => 0))
916
    ->condition('picture', $file->fid)
917
    ->execute();
918
}
919

    
920
/**
921
 * Implements hook_search_info().
922
 */
923
function user_search_info() {
924
  return array(
925
    'title' => 'Users',
926
  );
927
}
928

    
929
/**
930
 * Implements hook_search_access().
931
 */
932
function user_search_access() {
933
  return user_access('access user profiles');
934
}
935

    
936
/**
937
 * Implements hook_search_execute().
938
 */
939
function user_search_execute($keys = NULL, $conditions = NULL) {
940
  $find = array();
941
  // Replace wildcards with MySQL/PostgreSQL wildcards.
942
  $keys = preg_replace('!\*+!', '%', $keys);
943
  $query = db_select('users')->extend('PagerDefault');
944
  $query->fields('users', array('uid'));
945
  if (user_access('administer users')) {
946
    // Administrators can also search in the otherwise private email field,
947
    // and they don't need to be restricted to only active users.
948
    $query->fields('users', array('mail'));
949
    $query->condition(db_or()->
950
      condition('name', '%' . db_like($keys) . '%', 'LIKE')->
951
      condition('mail', '%' . db_like($keys) . '%', 'LIKE'));
952
  }
953
  else {
954
    // Regular users can only search via usernames, and we do not show them
955
    // blocked accounts.
956
    $query->condition('name', '%' . db_like($keys) . '%', 'LIKE')
957
      ->condition('status', 1);
958
  }
959
  $uids = $query
960
    ->limit(15)
961
    ->execute()
962
    ->fetchCol();
963
  $accounts = user_load_multiple($uids);
964

    
965
  $results = array();
966
  foreach ($accounts as $account) {
967
    $result = array(
968
      'title' => format_username($account),
969
      'link' => url('user/' . $account->uid, array('absolute' => TRUE)),
970
    );
971
    if (user_access('administer users')) {
972
      $result['title'] .= ' (' . $account->mail . ')';
973
    }
974
    $results[] = $result;
975
  }
976

    
977
  return $results;
978
}
979

    
980
/**
981
 * Implements hook_element_info().
982
 */
983
function user_element_info() {
984
  $types['user_profile_category'] = array(
985
    '#theme_wrappers' => array('user_profile_category'),
986
  );
987
  $types['user_profile_item'] = array(
988
    '#theme' => 'user_profile_item',
989
  );
990
  return $types;
991
}
992

    
993
/**
994
 * Implements hook_user_view().
995
 */
996
function user_user_view($account) {
997
  $account->content['user_picture'] = array(
998
    '#markup' => theme('user_picture', array('account' => $account)),
999
    '#weight' => -10,
1000
  );
1001
  if (!isset($account->content['summary'])) {
1002
    $account->content['summary'] = array();
1003
  }
1004
  $account->content['summary'] += array(
1005
    '#type' => 'user_profile_category',
1006
    '#attributes' => array('class' => array('user-member')),
1007
    '#weight' => 5,
1008
    '#title' => t('History'),
1009
  );
1010
  $account->content['summary']['member_for'] = array(
1011
    '#type' => 'user_profile_item',
1012
    '#title' => t('Member for'),
1013
    '#markup' => format_interval(REQUEST_TIME - $account->created),
1014
  );
1015
}
1016

    
1017
/**
1018
 * Helper function to add default user account fields to user registration and edit form.
1019
 *
1020
 * @see user_account_form_validate()
1021
 * @see user_validate_current_pass()
1022
 * @see user_validate_picture()
1023
 * @see user_validate_mail()
1024
 */
1025
function user_account_form(&$form, &$form_state) {
1026
  global $user;
1027

    
1028
  $account = $form['#user'];
1029
  $register = ($form['#user']->uid > 0 ? FALSE : TRUE);
1030

    
1031
  $admin = user_access('administer users');
1032

    
1033
  $form['#validate'][] = 'user_account_form_validate';
1034

    
1035
  // Account information.
1036
  $form['account'] = array(
1037
    '#type'   => 'container',
1038
    '#weight' => -10,
1039
  );
1040
  // Only show name field on registration form or user can change own username.
1041
  $form['account']['name'] = array(
1042
    '#type' => 'textfield',
1043
    '#title' => t('Username'),
1044
    '#maxlength' => USERNAME_MAX_LENGTH,
1045
    '#description' => t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'),
1046
    '#required' => TRUE,
1047
    '#attributes' => array('class' => array('username')),
1048
    '#default_value' => (!$register ? $account->name : ''),
1049
    '#access' => ($register || ($user->uid == $account->uid && user_access('change own username')) || $admin),
1050
    '#weight' => -10,
1051
  );
1052

    
1053
  $form['account']['mail'] = array(
1054
    '#type' => 'textfield',
1055
    '#title' => t('E-mail address'),
1056
    '#maxlength' => EMAIL_MAX_LENGTH,
1057
    '#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.'),
1058
    '#required' => TRUE,
1059
    '#default_value' => (!$register ? $account->mail : ''),
1060
  );
1061

    
1062
  // Display password field only for existing users or when user is allowed to
1063
  // assign a password during registration.
1064
  if (!$register) {
1065
    $form['account']['pass'] = array(
1066
      '#type' => 'password_confirm',
1067
      '#size' => 25,
1068
      '#description' => t('To change the current user password, enter the new password in both fields.'),
1069
    );
1070
    // To skip the current password field, the user must have logged in via a
1071
    // one-time link and have the token in the URL.
1072
    $pass_reset = isset($_SESSION['pass_reset_' . $account->uid]) && isset($_GET['pass-reset-token']) && ($_GET['pass-reset-token'] == $_SESSION['pass_reset_' . $account->uid]);
1073
    $protected_values = array();
1074
    $current_pass_description = '';
1075
    // The user may only change their own password without their current
1076
    // password if they logged in via a one-time login link.
1077
    if (!$pass_reset) {
1078
      $protected_values['mail'] = $form['account']['mail']['#title'];
1079
      $protected_values['pass'] = t('Password');
1080
      $request_new = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
1081
      $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));
1082
    }
1083
    // The user must enter their current password to change to a new one.
1084
    if ($user->uid == $account->uid) {
1085
      $form['account']['current_pass_required_values'] = array(
1086
        '#type' => 'value',
1087
        '#value' => $protected_values,
1088
      );
1089
      $form['account']['current_pass'] = array(
1090
        '#type' => 'password',
1091
        '#title' => t('Current password'),
1092
        '#size' => 25,
1093
        '#access' => !empty($protected_values),
1094
        '#description' => $current_pass_description,
1095
        '#weight' => -5,
1096
        // Do not let web browsers remember this password, since we are trying
1097
        // to confirm that the person submitting the form actually knows the
1098
        // current one.
1099
        '#attributes' => array('autocomplete' => 'off'),
1100
      );
1101
      $form['#validate'][] = 'user_validate_current_pass';
1102
    }
1103
  }
1104
  elseif (!variable_get('user_email_verification', TRUE) || $admin) {
1105
    $form['account']['pass'] = array(
1106
      '#type' => 'password_confirm',
1107
      '#size' => 25,
1108
      '#description' => t('Provide a password for the new account in both fields.'),
1109
      '#required' => TRUE,
1110
    );
1111
  }
1112

    
1113
  if ($admin) {
1114
    $status = isset($account->status) ? $account->status : 1;
1115
  }
1116
  else {
1117
    $status = $register ? variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL) == USER_REGISTER_VISITORS : $account->status;
1118
  }
1119
  $form['account']['status'] = array(
1120
    '#type' => 'radios',
1121
    '#title' => t('Status'),
1122
    '#default_value' => $status,
1123
    '#options' => array(t('Blocked'), t('Active')),
1124
    '#access' => $admin,
1125
  );
1126

    
1127
  $roles = array_map('check_plain', user_roles(TRUE));
1128
  // The disabled checkbox subelement for the 'authenticated user' role
1129
  // must be generated separately and added to the checkboxes element,
1130
  // because of a limitation in Form API not supporting a single disabled
1131
  // checkbox within a set of checkboxes.
1132
  // @todo This should be solved more elegantly. See issue #119038.
1133
  $checkbox_authenticated = array(
1134
    '#type' => 'checkbox',
1135
    '#title' => $roles[DRUPAL_AUTHENTICATED_RID],
1136
    '#default_value' => TRUE,
1137
    '#disabled' => TRUE,
1138
  );
1139
  unset($roles[DRUPAL_AUTHENTICATED_RID]);
1140
  $form['account']['roles'] = array(
1141
    '#type' => 'checkboxes',
1142
    '#title' => t('Roles'),
1143
    '#default_value' => (!$register && isset($account->roles) ? array_keys($account->roles) : array()),
1144
    '#options' => $roles,
1145
    '#access' => $roles && user_access('administer permissions'),
1146
    DRUPAL_AUTHENTICATED_RID => $checkbox_authenticated,
1147
  );
1148

    
1149
  $form['account']['notify'] = array(
1150
    '#type' => 'checkbox',
1151
    '#title' => t('Notify user of new account'),
1152
    '#access' => $register && $admin,
1153
  );
1154

    
1155
  // Signature.
1156
  $form['signature_settings'] = array(
1157
    '#type' => 'fieldset',
1158
    '#title' => t('Signature settings'),
1159
    '#weight' => 1,
1160
    '#access' => (!$register && variable_get('user_signatures', 0)),
1161
  );
1162

    
1163
  $form['signature_settings']['signature'] = array(
1164
    '#type' => 'text_format',
1165
    '#title' => t('Signature'),
1166
    '#default_value' => isset($account->signature) ? $account->signature : '',
1167
    '#description' => t('Your signature will be publicly displayed at the end of your comments.'),
1168
    '#format' => isset($account->signature_format) ? $account->signature_format : NULL,
1169
  );
1170

    
1171
  // Picture/avatar.
1172
  $form['picture'] = array(
1173
    '#type' => 'fieldset',
1174
    '#title' => t('Picture'),
1175
    '#weight' => 1,
1176
    '#access' => (!$register && variable_get('user_pictures', 0)),
1177
  );
1178
  $form['picture']['picture'] = array(
1179
    '#type' => 'value',
1180
    '#value' => isset($account->picture) ? $account->picture : NULL,
1181
  );
1182
  $form['picture']['picture_current'] = array(
1183
    '#markup' => theme('user_picture', array('account' => $account)),
1184
  );
1185
  $form['picture']['picture_delete'] = array(
1186
    '#type' => 'checkbox',
1187
    '#title' => t('Delete picture'),
1188
    '#access' => !empty($account->picture->fid),
1189
    '#description' => t('Check this box to delete your current picture.'),
1190
  );
1191
  $form['picture']['picture_upload'] = array(
1192
    '#type' => 'file',
1193
    '#title' => t('Upload picture'),
1194
    '#size' => 48,
1195
    '#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', '')),
1196
  );
1197
  $form['#validate'][] = 'user_validate_picture';
1198
}
1199

    
1200
/**
1201
 * Form validation handler for the current password on the user_account_form().
1202
 *
1203
 * @see user_account_form()
1204
 */
1205
function user_validate_current_pass(&$form, &$form_state) {
1206
  $account = $form['#user'];
1207
  foreach ($form_state['values']['current_pass_required_values'] as $key => $name) {
1208
    // This validation only works for required textfields (like mail) or
1209
    // form values like password_confirm that have their own validation
1210
    // that prevent them from being empty if they are changed.
1211
    if ((strlen(trim($form_state['values'][$key])) > 0) && ($form_state['values'][$key] != $account->$key)) {
1212
      require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
1213
      $current_pass_failed = empty($form_state['values']['current_pass']) || !user_check_password($form_state['values']['current_pass'], $account);
1214
      if ($current_pass_failed) {
1215
        form_set_error('current_pass', t("Your current password is missing or incorrect; it's required to change the %name.", array('%name' => $name)));
1216
        form_set_error($key);
1217
      }
1218
      // We only need to check the password once.
1219
      break;
1220
    }
1221
  }
1222
}
1223

    
1224
/**
1225
 * Form validation handler for user_account_form().
1226
 *
1227
 * @see user_account_form()
1228
 */
1229
function user_account_form_validate($form, &$form_state) {
1230
  if ($form['#user_category'] == 'account' || $form['#user_category'] == 'register') {
1231
    $account = $form['#user'];
1232
    // Validate new or changing username.
1233
    if (isset($form_state['values']['name'])) {
1234
      if ($error = user_validate_name($form_state['values']['name'])) {
1235
        form_set_error('name', $error);
1236
      }
1237
      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()) {
1238
        form_set_error('name', t('The name %name is already taken.', array('%name' => $form_state['values']['name'])));
1239
      }
1240
    }
1241

    
1242
    // Trim whitespace from mail, to prevent confusing 'e-mail not valid'
1243
    // warnings often caused by cutting and pasting.
1244
    $mail = trim($form_state['values']['mail']);
1245
    form_set_value($form['account']['mail'], $mail, $form_state);
1246

    
1247
    // Validate the e-mail address, and check if it is taken by an existing user.
1248
    if ($error = user_validate_mail($form_state['values']['mail'])) {
1249
      form_set_error('mail', $error);
1250
    }
1251
    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()) {
1252
      // Format error message dependent on whether the user is logged in or not.
1253
      if ($GLOBALS['user']->uid) {
1254
        form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $form_state['values']['mail'])));
1255
      }
1256
      else {
1257
        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'))));
1258
      }
1259
    }
1260

    
1261
    // Make sure the signature isn't longer than the size of the database field.
1262
    // Signatures are disabled by default, so make sure it exists first.
1263
    if (isset($form_state['values']['signature'])) {
1264
      // Move text format for user signature into 'signature_format'.
1265
      $form_state['values']['signature_format'] = $form_state['values']['signature']['format'];
1266
      // Move text value for user signature into 'signature'.
1267
      $form_state['values']['signature'] = $form_state['values']['signature']['value'];
1268

    
1269
      $user_schema = drupal_get_schema('users');
1270
      if (drupal_strlen($form_state['values']['signature']) > $user_schema['fields']['signature']['length']) {
1271
        form_set_error('signature', t('The signature is too long: it must be %max characters or less.', array('%max' => $user_schema['fields']['signature']['length'])));
1272
      }
1273
    }
1274
  }
1275
}
1276

    
1277
/**
1278
 * Implements hook_user_presave().
1279
 */
1280
function user_user_presave(&$edit, $account, $category) {
1281
  if ($category == 'account' || $category == 'register') {
1282
    if (!empty($edit['picture_upload'])) {
1283
      $edit['picture'] = $edit['picture_upload'];
1284
    }
1285
    // Delete picture if requested, and if no replacement picture was given.
1286
    elseif (!empty($edit['picture_delete'])) {
1287
      $edit['picture'] = NULL;
1288
    }
1289
    // Prepare user roles.
1290
    if (isset($edit['roles'])) {
1291
      $edit['roles'] = array_filter($edit['roles']);
1292
    }
1293
  }
1294

    
1295
  // Move account cancellation information into $user->data.
1296
  foreach (array('user_cancel_method', 'user_cancel_notify') as $key) {
1297
    if (isset($edit[$key])) {
1298
      $edit['data'][$key] = $edit[$key];
1299
    }
1300
  }
1301
}
1302

    
1303
/**
1304
 * Implements hook_user_categories().
1305
 */
1306
function user_user_categories() {
1307
  return array(array(
1308
    'name' => 'account',
1309
    'title' => t('Account settings'),
1310
    'weight' => 1,
1311
  ));
1312
}
1313

    
1314
function user_login_block($form) {
1315
  $form['#action'] = url(current_path(), array('query' => drupal_get_destination(), 'external' => FALSE));
1316
  $form['#id'] = 'user-login-form';
1317
  $form['#validate'] = user_login_default_validators();
1318
  $form['#submit'][] = 'user_login_submit';
1319
  $form['name'] = array('#type' => 'textfield',
1320
    '#title' => t('Username'),
1321
    '#maxlength' => USERNAME_MAX_LENGTH,
1322
    '#size' => 15,
1323
    '#required' => TRUE,
1324
  );
1325
  $form['pass'] = array('#type' => 'password',
1326
    '#title' => t('Password'),
1327
    '#size' => 15,
1328
    '#required' => TRUE,
1329
  );
1330
  $form['actions'] = array('#type' => 'actions');
1331
  $form['actions']['submit'] = array('#type' => 'submit',
1332
    '#value' => t('Log in'),
1333
  );
1334
  $items = array();
1335
  if (variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)) {
1336
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
1337
  }
1338
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
1339
  $form['links'] = array('#markup' => theme('item_list', array('items' => $items)));
1340
  return $form;
1341
}
1342

    
1343
/**
1344
 * Implements hook_block_info().
1345
 */
1346
function user_block_info() {
1347
  global $user;
1348

    
1349
  $blocks['login']['info'] = t('User login');
1350
  // Not worth caching.
1351
  $blocks['login']['cache'] = DRUPAL_NO_CACHE;
1352

    
1353
  $blocks['new']['info'] = t('Who\'s new');
1354
  $blocks['new']['properties']['administrative'] = TRUE;
1355

    
1356
  // Too dynamic to cache.
1357
  $blocks['online']['info'] = t('Who\'s online');
1358
  $blocks['online']['cache'] = DRUPAL_NO_CACHE;
1359
  $blocks['online']['properties']['administrative'] = TRUE;
1360

    
1361
  return $blocks;
1362
}
1363

    
1364
/**
1365
 * Implements hook_block_configure().
1366
 */
1367
function user_block_configure($delta = '') {
1368
  global $user;
1369

    
1370
  switch ($delta) {
1371
    case 'new':
1372
      $form['user_block_whois_new_count'] = array(
1373
        '#type' => 'select',
1374
        '#title' => t('Number of users to display'),
1375
        '#default_value' => variable_get('user_block_whois_new_count', 5),
1376
        '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
1377
      );
1378
      return $form;
1379

    
1380
    case 'online':
1381
      $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
1382
      $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.'));
1383
      $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.'));
1384
      return $form;
1385
  }
1386
}
1387

    
1388
/**
1389
 * Implements hook_block_save().
1390
 */
1391
function user_block_save($delta = '', $edit = array()) {
1392
  global $user;
1393

    
1394
  switch ($delta) {
1395
    case 'new':
1396
      variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
1397
      break;
1398

    
1399
    case 'online':
1400
      variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
1401
      variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
1402
      break;
1403
  }
1404
}
1405

    
1406
/**
1407
 * Implements hook_block_view().
1408
 */
1409
function user_block_view($delta = '') {
1410
  global $user;
1411

    
1412
  $block = array();
1413

    
1414
  switch ($delta) {
1415
    case 'login':
1416
      // For usability's sake, avoid showing two login forms on one page.
1417
      if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
1418

    
1419
        $block['subject'] = t('User login');
1420
        $block['content'] = drupal_get_form('user_login_block');
1421
      }
1422
      return $block;
1423

    
1424
    case 'new':
1425
      if (user_access('access content')) {
1426
        // Retrieve a list of new users who have subsequently accessed the site successfully.
1427
        $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();
1428
        $output = theme('user_list', array('users' => $items));
1429

    
1430
        $block['subject'] = t('Who\'s new');
1431
        $block['content'] = $output;
1432
      }
1433
      return $block;
1434

    
1435
    case 'online':
1436
      if (user_access('access content')) {
1437
        // Count users active within the defined period.
1438
        $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
1439

    
1440
        // Perform database queries to gather online user lists. We use s.timestamp
1441
        // rather than u.access because it is much faster.
1442
        $authenticated_count = db_query("SELECT COUNT(DISTINCT s.uid) FROM {sessions} s WHERE s.timestamp >= :timestamp AND s.uid > 0", array(':timestamp' => $interval))->fetchField();
1443

    
1444
        $output = '<p>' . format_plural($authenticated_count, 'There is currently 1 user online.', 'There are currently @count users online.') . '</p>';
1445

    
1446
        // Display a list of currently online users.
1447
        $max_users = variable_get('user_block_max_list_count', 10);
1448
        if ($authenticated_count && $max_users) {
1449
          $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();
1450
          $output .= theme('user_list', array('users' => $items));
1451
        }
1452

    
1453
        $block['subject'] = t('Who\'s online');
1454
        $block['content'] = $output;
1455
      }
1456
      return $block;
1457
  }
1458
}
1459

    
1460
/**
1461
 * Process variables for user-picture.tpl.php.
1462
 *
1463
 * The $variables array contains the following arguments:
1464
 * - $account: A user, node or comment object with 'name', 'uid' and 'picture'
1465
 *   fields.
1466
 *
1467
 * @see user-picture.tpl.php
1468
 */
1469
function template_preprocess_user_picture(&$variables) {
1470
  $variables['user_picture'] = '';
1471
  if (variable_get('user_pictures', 0)) {
1472
    $account = $variables['account'];
1473
    if (!empty($account->picture)) {
1474
      // @TODO: Ideally this function would only be passed file objects, but
1475
      // since there's a lot of legacy code that JOINs the {users} table to
1476
      // {node} or {comments} and passes the results into this function if we
1477
      // a numeric value in the picture field we'll assume it's a file id
1478
      // and load it for them. Once we've got user_load_multiple() and
1479
      // comment_load_multiple() functions the user module will be able to load
1480
      // the picture files in mass during the object's load process.
1481
      if (is_numeric($account->picture)) {
1482
        $account->picture = file_load($account->picture);
1483
      }
1484
      if (!empty($account->picture->uri)) {
1485
        $filepath = $account->picture->uri;
1486
      }
1487
    }
1488
    elseif (variable_get('user_picture_default', '')) {
1489
      $filepath = variable_get('user_picture_default', '');
1490
    }
1491
    if (isset($filepath)) {
1492
      $alt = t("@user's picture", array('@user' => format_username($account)));
1493
      // If the image does not have a valid Drupal scheme (for eg. HTTP),
1494
      // don't load image styles.
1495
      if (module_exists('image') && file_valid_uri($filepath) && $style = variable_get('user_picture_style', '')) {
1496
        $variables['user_picture'] = theme('image_style', array('style_name' => $style, 'path' => $filepath, 'alt' => $alt, 'title' => $alt));
1497
      }
1498
      else {
1499
        $variables['user_picture'] = theme('image', array('path' => $filepath, 'alt' => $alt, 'title' => $alt));
1500
      }
1501
      if (!empty($account->uid) && user_access('access user profiles')) {
1502
        $attributes = array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE);
1503
        $variables['user_picture'] = l($variables['user_picture'], "user/$account->uid", $attributes);
1504
      }
1505
    }
1506
  }
1507
}
1508

    
1509
/**
1510
 * Returns HTML for a list of users.
1511
 *
1512
 * @param $variables
1513
 *   An associative array containing:
1514
 *   - users: An array with user objects. Should contain at least the name and
1515
 *     uid.
1516
 *   - title: (optional) Title to pass on to theme_item_list().
1517
 *
1518
 * @ingroup themeable
1519
 */
1520
function theme_user_list($variables) {
1521
  $users = $variables['users'];
1522
  $title = $variables['title'];
1523
  $items = array();
1524

    
1525
  if (!empty($users)) {
1526
    foreach ($users as $user) {
1527
      $items[] = theme('username', array('account' => $user));
1528
    }
1529
  }
1530
  return theme('item_list', array('items' => $items, 'title' => $title));
1531
}
1532

    
1533
/**
1534
 * Determines if the current user is anonymous.
1535
 *
1536
 * @return bool
1537
 *   TRUE if the user is anonymous, FALSE if the user is authenticated.
1538
 */
1539
function user_is_anonymous() {
1540
  // Menu administrators can see items for anonymous when administering.
1541
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
1542
}
1543

    
1544
/**
1545
 * Determines if the current user is logged in.
1546
 *
1547
 * @return bool
1548
 *   TRUE if the user is logged in, FALSE if the user is anonymous.
1549
 */
1550
function user_is_logged_in() {
1551
  return (bool) $GLOBALS['user']->uid;
1552
}
1553

    
1554
/**
1555
 * Determines if the current user has access to the user registration page.
1556
 *
1557
 * @return bool
1558
 *   TRUE if the user is not already logged in and can register for an account.
1559
 */
1560
function user_register_access() {
1561
  return user_is_anonymous() && variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
1562
}
1563

    
1564
/**
1565
 * User view access callback.
1566
 *
1567
 * @param $account
1568
 *   Can either be a full user object or a $uid.
1569
 */
1570
function user_view_access($account) {
1571
  $uid = is_object($account) ? $account->uid : (int) $account;
1572

    
1573
  // Never allow access to view the anonymous user account.
1574
  if ($uid) {
1575
    // Admins can view all, users can view own profiles at all times.
1576
    if ($GLOBALS['user']->uid == $uid || user_access('administer users')) {
1577
      return TRUE;
1578
    }
1579
    elseif (user_access('access user profiles')) {
1580
      // At this point, load the complete account object.
1581
      if (!is_object($account)) {
1582
        $account = user_load($uid);
1583
      }
1584
      return (is_object($account) && $account->status);
1585
    }
1586
  }
1587
  return FALSE;
1588
}
1589

    
1590
/**
1591
 * Access callback for user account editing.
1592
 */
1593
function user_edit_access($account) {
1594
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
1595
}
1596

    
1597
/**
1598
 * Menu access callback; limit access to account cancellation pages.
1599
 *
1600
 * Limit access to users with the 'cancel account' permission or administrative
1601
 * users, and prevent the anonymous user from cancelling the account.
1602
 */
1603
function user_cancel_access($account) {
1604
  return ((($GLOBALS['user']->uid == $account->uid) && user_access('cancel account')) || user_access('administer users')) && $account->uid > 0;
1605
}
1606

    
1607
/**
1608
 * Implements hook_menu().
1609
 */
1610
function user_menu() {
1611
  $items['user/autocomplete'] = array(
1612
    'title' => 'User autocomplete',
1613
    'page callback' => 'user_autocomplete',
1614
    'access callback' => 'user_access',
1615
    'access arguments' => array('access user profiles'),
1616
    'type' => MENU_CALLBACK,
1617
    'file' => 'user.pages.inc',
1618
  );
1619

    
1620
  // Registration and login pages.
1621
  $items['user'] = array(
1622
    'title' => 'User account',
1623
    'title callback' => 'user_menu_title',
1624
    'page callback' => 'user_page',
1625
    'access callback' => TRUE,
1626
    'file' => 'user.pages.inc',
1627
    'weight' => -10,
1628
    'menu_name' => 'user-menu',
1629
  );
1630

    
1631
  $items['user/login'] = array(
1632
    'title' => 'Log in',
1633
    'access callback' => 'user_is_anonymous',
1634
    'type' => MENU_DEFAULT_LOCAL_TASK,
1635
  );
1636

    
1637
  $items['user/register'] = array(
1638
    'title' => 'Create new account',
1639
    'page callback' => 'drupal_get_form',
1640
    'page arguments' => array('user_register_form'),
1641
    'access callback' => 'user_register_access',
1642
    'type' => MENU_LOCAL_TASK,
1643
  );
1644

    
1645
  $items['user/password'] = array(
1646
    'title' => 'Request new password',
1647
    'page callback' => 'drupal_get_form',
1648
    'page arguments' => array('user_pass'),
1649
    'access callback' => TRUE,
1650
    'type' => MENU_LOCAL_TASK,
1651
    'file' => 'user.pages.inc',
1652
  );
1653
  $items['user/reset/%/%/%'] = array(
1654
    'title' => 'Reset password',
1655
    'page callback' => 'drupal_get_form',
1656
    'page arguments' => array('user_pass_reset', 2, 3, 4),
1657
    'access callback' => TRUE,
1658
    'type' => MENU_CALLBACK,
1659
    'file' => 'user.pages.inc',
1660
  );
1661

    
1662
  $items['user/logout'] = array(
1663
    'title' => 'Log out',
1664
    'access callback' => 'user_is_logged_in',
1665
    'page callback' => 'user_logout',
1666
    'weight' => 10,
1667
    'menu_name' => 'user-menu',
1668
    'file' => 'user.pages.inc',
1669
  );
1670

    
1671
  // User listing pages.
1672
  $items['admin/people'] = array(
1673
    'title' => 'People',
1674
    'description' => 'Manage user accounts, roles, and permissions.',
1675
    'page callback' => 'user_admin',
1676
    'page arguments' => array('list'),
1677
    'access arguments' => array('administer users'),
1678
    'position' => 'left',
1679
    'weight' => -4,
1680
    'file' => 'user.admin.inc',
1681
  );
1682
  $items['admin/people/people'] = array(
1683
    'title' => 'List',
1684
    'description' => 'Find and manage people interacting with your site.',
1685
    'access arguments' => array('administer users'),
1686
    'type' => MENU_DEFAULT_LOCAL_TASK,
1687
    'weight' => -10,
1688
    'file' => 'user.admin.inc',
1689
  );
1690

    
1691
  // Permissions and role forms.
1692
  $items['admin/people/permissions'] = array(
1693
    'title' => 'Permissions',
1694
    'description' => 'Determine access to features by selecting permissions for roles.',
1695
    'page callback' => 'drupal_get_form',
1696
    'page arguments' => array('user_admin_permissions'),
1697
    'access arguments' => array('administer permissions'),
1698
    'file' => 'user.admin.inc',
1699
    'type' => MENU_LOCAL_TASK,
1700
  );
1701
  $items['admin/people/permissions/list'] = array(
1702
    'title' => 'Permissions',
1703
    'description' => 'Determine access to features by selecting permissions for roles.',
1704
    'type' => MENU_DEFAULT_LOCAL_TASK,
1705
    'weight' => -8,
1706
  );
1707
  $items['admin/people/permissions/roles'] = array(
1708
    'title' => 'Roles',
1709
    'description' => 'List, edit, or add user roles.',
1710
    'page callback' => 'drupal_get_form',
1711
    'page arguments' => array('user_admin_roles'),
1712
    'access arguments' => array('administer permissions'),
1713
    'file' => 'user.admin.inc',
1714
    'type' => MENU_LOCAL_TASK,
1715
    'weight' => -5,
1716
  );
1717
  $items['admin/people/permissions/roles/edit/%user_role'] = array(
1718
    'title' => 'Edit role',
1719
    'page arguments' => array('user_admin_role', 5),
1720
    'access callback' => 'user_role_edit_access',
1721
    'access arguments' => array(5),
1722
  );
1723
  $items['admin/people/permissions/roles/delete/%user_role'] = array(
1724
    'title' => 'Delete role',
1725
    'page callback' => 'drupal_get_form',
1726
    'page arguments' => array('user_admin_role_delete_confirm', 5),
1727
    'access callback' => 'user_role_edit_access',
1728
    'access arguments' => array(5),
1729
    'file' => 'user.admin.inc',
1730
  );
1731

    
1732
  $items['admin/people/create'] = array(
1733
    'title' => 'Add user',
1734
    'page arguments' => array('create'),
1735
    'access arguments' => array('administer users'),
1736
    'type' => MENU_LOCAL_ACTION,
1737
  );
1738

    
1739
  // Administration pages.
1740
  $items['admin/config/people'] = array(
1741
    'title' => 'People',
1742
    'description' => 'Configure user accounts.',
1743
    'position' => 'left',
1744
    'weight' => -20,
1745
    'page callback' => 'system_admin_menu_block_page',
1746
    'access arguments' => array('access administration pages'),
1747
    'file' => 'system.admin.inc',
1748
    'file path' => drupal_get_path('module', 'system'),
1749
  );
1750
  $items['admin/config/people/accounts'] = array(
1751
    'title' => 'Account settings',
1752
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, fields, and user pictures.',
1753
    'page callback' => 'drupal_get_form',
1754
    'page arguments' => array('user_admin_settings'),
1755
    'access arguments' => array('administer users'),
1756
    'file' => 'user.admin.inc',
1757
    'weight' => -10,
1758
  );
1759
  $items['admin/config/people/accounts/settings'] = array(
1760
    'title' => 'Settings',
1761
    'type' => MENU_DEFAULT_LOCAL_TASK,
1762
    'weight' => -10,
1763
  );
1764

    
1765
  $items['user/%user'] = array(
1766
    'title' => 'My account',
1767
    'title callback' => 'user_page_title',
1768
    'title arguments' => array(1),
1769
    'page callback' => 'user_view_page',
1770
    'page arguments' => array(1),
1771
    'access callback' => 'user_view_access',
1772
    'access arguments' => array(1),
1773
    // By assigning a different menu name, this item (and all registered child
1774
    // paths) are no longer considered as children of 'user'. When accessing the
1775
    // user account pages, the preferred menu link that is used to build the
1776
    // active trail (breadcrumb) will be found in this menu (unless there is
1777
    // more specific link), so the link to 'user' will not be in the breadcrumb.
1778
    'menu_name' => 'navigation',
1779
  );
1780

    
1781
  $items['user/%user/view'] = array(
1782
    'title' => 'View',
1783
    'type' => MENU_DEFAULT_LOCAL_TASK,
1784
    'weight' => -10,
1785
  );
1786

    
1787
  $items['user/%user/cancel'] = array(
1788
    'title' => 'Cancel account',
1789
    'page callback' => 'drupal_get_form',
1790
    'page arguments' => array('user_cancel_confirm_form', 1),
1791
    'access callback' => 'user_cancel_access',
1792
    'access arguments' => array(1),
1793
    'file' => 'user.pages.inc',
1794
  );
1795

    
1796
  $items['user/%user/cancel/confirm/%/%'] = array(
1797
    'title' => 'Confirm account cancellation',
1798
    'page callback' => 'user_cancel_confirm',
1799
    'page arguments' => array(1, 4, 5),
1800
    'access callback' => 'user_cancel_access',
1801
    'access arguments' => array(1),
1802
    'file' => 'user.pages.inc',
1803
  );
1804

    
1805
  $items['user/%user/edit'] = array(
1806
    'title' => 'Edit',
1807
    'page callback' => 'drupal_get_form',
1808
    'page arguments' => array('user_profile_form', 1),
1809
    'access callback' => 'user_edit_access',
1810
    'access arguments' => array(1),
1811
    'type' => MENU_LOCAL_TASK,
1812
    'file' => 'user.pages.inc',
1813
  );
1814

    
1815
  $items['user/%user_category/edit/account'] = array(
1816
    'title' => 'Account',
1817
    'type' => MENU_DEFAULT_LOCAL_TASK,
1818
    'load arguments' => array('%map', '%index'),
1819
  );
1820

    
1821
  if (($categories = _user_categories()) && (count($categories) > 1)) {
1822
    foreach ($categories as $key => $category) {
1823
      // 'account' is already handled by the MENU_DEFAULT_LOCAL_TASK.
1824
      if ($category['name'] != 'account') {
1825
        $items['user/%user_category/edit/' . $category['name']] = array(
1826
          'title callback' => 'check_plain',
1827
          'title arguments' => array($category['title']),
1828
          'page callback' => 'drupal_get_form',
1829
          'page arguments' => array('user_profile_form', 1, 3),
1830
          'access callback' => isset($category['access callback']) ? $category['access callback'] : 'user_edit_access',
1831
          'access arguments' => isset($category['access arguments']) ? $category['access arguments'] : array(1),
1832
          'type' => MENU_LOCAL_TASK,
1833
          'weight' => $category['weight'],
1834
          'load arguments' => array('%map', '%index'),
1835
          'tab_parent' => 'user/%/edit',
1836
          'file' => 'user.pages.inc',
1837
        );
1838
      }
1839
    }
1840
  }
1841
  return $items;
1842
}
1843

    
1844
/**
1845
 * Implements hook_menu_site_status_alter().
1846
 */
1847
function user_menu_site_status_alter(&$menu_site_status, $path) {
1848
  if ($menu_site_status == MENU_SITE_OFFLINE) {
1849
    // If the site is offline, log out unprivileged users.
1850
    if (user_is_logged_in() && !user_access('access site in maintenance mode')) {
1851
      module_load_include('pages.inc', 'user', 'user');
1852
      user_logout();
1853
    }
1854

    
1855
    if (user_is_anonymous()) {
1856
      switch ($path) {
1857
        case 'user':
1858
          // Forward anonymous user to login page.
1859
          drupal_goto('user/login');
1860
        case 'user/login':
1861
        case 'user/password':
1862
          // Disable offline mode.
1863
          $menu_site_status = MENU_SITE_ONLINE;
1864
          break;
1865
        default:
1866
          if (strpos($path, 'user/reset/') === 0) {
1867
            // Disable offline mode.
1868
            $menu_site_status = MENU_SITE_ONLINE;
1869
          }
1870
          break;
1871
      }
1872
    }
1873
  }
1874
  if (user_is_logged_in()) {
1875
    if ($path == 'user/login') {
1876
      // If user is logged in, redirect to 'user' instead of giving 403.
1877
      drupal_goto('user');
1878
    }
1879
    if ($path == 'user/register') {
1880
      // Authenticated user should be redirected to user edit page.
1881
      drupal_goto('user/' . $GLOBALS['user']->uid . '/edit');
1882
    }
1883
  }
1884
}
1885

    
1886
/**
1887
 * Implements hook_menu_link_alter().
1888
 */
1889
function user_menu_link_alter(&$link) {
1890
  // The path 'user' must be accessible for anonymous users, but only visible
1891
  // for authenticated users. Authenticated users should see "My account", but
1892
  // anonymous users should not see it at all. Therefore, invoke
1893
  // user_translated_menu_link_alter() to conditionally hide the link.
1894
  if ($link['link_path'] == 'user' && $link['module'] == 'system') {
1895
    $link['options']['alter'] = TRUE;
1896
  }
1897

    
1898
  // Force the Logout link to appear on the top-level of 'user-menu' menu by
1899
  // default (i.e., unless it has been customized).
1900
  if ($link['link_path'] == 'user/logout' && $link['module'] == 'system' && empty($link['customized'])) {
1901
    $link['plid'] = 0;
1902
  }
1903
}
1904

    
1905
/**
1906
 * Implements hook_translated_menu_link_alter().
1907
 */
1908
function user_translated_menu_link_alter(&$link) {
1909
  // Hide the "User account" link for anonymous users.
1910
  if ($link['link_path'] == 'user' && $link['module'] == 'system' && !$GLOBALS['user']->uid) {
1911
    $link['hidden'] = 1;
1912
  }
1913
}
1914

    
1915
/**
1916
 * Implements hook_admin_paths().
1917
 */
1918
function user_admin_paths() {
1919
  $paths = array(
1920
    'user/*/cancel' => TRUE,
1921
    'user/*/edit' => TRUE,
1922
    'user/*/edit/*' => TRUE,
1923
  );
1924
  return $paths;
1925
}
1926

    
1927
/**
1928
 * Returns $arg or the user ID of the current user if $arg is '%' or empty.
1929
 *
1930
 * Deprecated. Use %user_uid_optional instead.
1931
 *
1932
 * @todo D8: Remove.
1933
 */
1934
function user_uid_only_optional_to_arg($arg) {
1935
  return user_uid_optional_to_arg($arg);
1936
}
1937

    
1938
/**
1939
 * Load either a specified or the current user account.
1940
 *
1941
 * @param $uid
1942
 *   An optional user ID of the user to load. If not provided, the current
1943
 *   user's ID will be used.
1944
 * @return
1945
 *   A fully-loaded $user object upon successful user load, FALSE if user
1946
 *   cannot be loaded.
1947
 *
1948
 * @see user_load()
1949
 * @todo rethink the naming of this in Drupal 8.
1950
 */
1951
function user_uid_optional_load($uid = NULL) {
1952
  if (!isset($uid)) {
1953
    $uid = $GLOBALS['user']->uid;
1954
  }
1955
  return user_load($uid);
1956
}
1957

    
1958
/**
1959
 * Return a user object after checking if any profile category in the path exists.
1960
 */
1961
function user_category_load($uid, &$map, $index) {
1962
  static $user_categories, $accounts;
1963

    
1964
  // Cache $account - this load function will get called for each profile tab.
1965
  if (!isset($accounts[$uid])) {
1966
    $accounts[$uid] = user_load($uid);
1967
  }
1968
  $valid = TRUE;
1969
  if ($account = $accounts[$uid]) {
1970
    // Since the path is like user/%/edit/category_name, the category name will
1971
    // be at a position 2 beyond the index corresponding to the % wildcard.
1972
    $category_index = $index + 2;
1973
    // Valid categories may contain slashes, and hence need to be imploded.
1974
    $category_path = implode('/', array_slice($map, $category_index));
1975
    if ($category_path) {
1976
      // Check that the requested category exists.
1977
      $valid = FALSE;
1978
      if (!isset($user_categories)) {
1979
        $user_categories = _user_categories();
1980
      }
1981
      foreach ($user_categories as $category) {
1982
        if ($category['name'] == $category_path) {
1983
          $valid = TRUE;
1984
          // Truncate the map array in case the category name had slashes.
1985
          $map = array_slice($map, 0, $category_index);
1986
          // Assign the imploded category name to the last map element.
1987
          $map[$category_index] = $category_path;
1988
          break;
1989
        }
1990
      }
1991
    }
1992
  }
1993
  return $valid ? $account : FALSE;
1994
}
1995

    
1996
/**
1997
 * Returns $arg or the user ID of the current user if $arg is '%' or empty.
1998
 *
1999
 * @todo rethink the naming of this in Drupal 8.
2000
 */
2001
function user_uid_optional_to_arg($arg) {
2002
  // Give back the current user uid when called from eg. tracker, aka.
2003
  // with an empty arg. Also use the current user uid when called from
2004
  // the menu with a % for the current account link.
2005
  return empty($arg) || $arg == '%' ? $GLOBALS['user']->uid : $arg;
2006
}
2007

    
2008
/**
2009
 * Menu item title callback for the 'user' path.
2010
 *
2011
 * Anonymous users should see "User account", but authenticated users are
2012
 * expected to see "My account".
2013
 */
2014
function user_menu_title() {
2015
  return user_is_logged_in() ? t('My account') : t('User account');
2016
}
2017

    
2018
/**
2019
 * Menu item title callback - use the user name.
2020
 */
2021
function user_page_title($account) {
2022
  return is_object($account) ? format_username($account) : '';
2023
}
2024

    
2025
/**
2026
 * Discover which external authentication module(s) authenticated a username.
2027
 *
2028
 * @param $authname
2029
 *   A username used by an external authentication module.
2030
 * @return
2031
 *   An associative array with module as key and username as value.
2032
 */
2033
function user_get_authmaps($authname = NULL) {
2034
  $authmaps = db_query("SELECT module, authname FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchAllKeyed();
2035
  return count($authmaps) ? $authmaps : 0;
2036
}
2037

    
2038
/**
2039
 * Save mappings of which external authentication module(s) authenticated
2040
 * a user. Maps external usernames to user ids in the users table.
2041
 *
2042
 * @param $account
2043
 *   A user object.
2044
 * @param $authmaps
2045
 *   An associative array with a compound key and the username as the value.
2046
 *   The key is made up of 'authname_' plus the name of the external authentication
2047
 *   module.
2048
 * @see user_external_login_register()
2049
 */
2050
function user_set_authmaps($account, $authmaps) {
2051
  foreach ($authmaps as $key => $value) {
2052
    $module = explode('_', $key, 2);
2053
    if ($value) {
2054
      db_merge('authmap')
2055
        ->key(array(
2056
          'uid' => $account->uid,
2057
          'module' => $module[1],
2058
        ))
2059
        ->fields(array('authname' => $value))
2060
        ->execute();
2061
    }
2062
    else {
2063
      db_delete('authmap')
2064
        ->condition('uid', $account->uid)
2065
        ->condition('module', $module[1])
2066
        ->execute();
2067
    }
2068
  }
2069
}
2070

    
2071
/**
2072
 * Form builder; the main user login form.
2073
 *
2074
 * @ingroup forms
2075
 */
2076
function user_login($form, &$form_state) {
2077
  global $user;
2078

    
2079
  // If we are already logged on, go to the user page instead.
2080
  if ($user->uid) {
2081
    drupal_goto('user/' . $user->uid);
2082
  }
2083

    
2084
  // Display login form:
2085
  $form['name'] = array('#type' => 'textfield',
2086
    '#title' => t('Username'),
2087
    '#size' => 60,
2088
    '#maxlength' => USERNAME_MAX_LENGTH,
2089
    '#required' => TRUE,
2090
  );
2091

    
2092
  $form['name']['#description'] = t('Enter your @s username.', array('@s' => variable_get('site_name', 'Drupal')));
2093
  $form['pass'] = array('#type' => 'password',
2094
    '#title' => t('Password'),
2095
    '#description' => t('Enter the password that accompanies your username.'),
2096
    '#required' => TRUE,
2097
  );
2098
  $form['#validate'] = user_login_default_validators();
2099
  $form['actions'] = array('#type' => 'actions');
2100
  $form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Log in'));
2101

    
2102
  return $form;
2103
}
2104

    
2105
/**
2106
 * Set up a series for validators which check for blocked users,
2107
 * then authenticate against local database, then return an error if
2108
 * authentication fails. Distributed authentication modules are welcome
2109
 * to use hook_form_alter() to change this series in order to
2110
 * authenticate against their user database instead of the local users
2111
 * table. If a distributed authentication module is successful, it
2112
 * should set $form_state['uid'] to a user ID.
2113
 *
2114
 * We use three validators instead of one since external authentication
2115
 * modules usually only need to alter the second validator.
2116
 *
2117
 * @see user_login_name_validate()
2118
 * @see user_login_authenticate_validate()
2119
 * @see user_login_final_validate()
2120
 * @return array
2121
 *   A simple list of validate functions.
2122
 */
2123
function user_login_default_validators() {
2124
  return array('user_login_name_validate', 'user_login_authenticate_validate', 'user_login_final_validate');
2125
}
2126

    
2127
/**
2128
 * A FAPI validate handler. Sets an error if supplied username has been blocked.
2129
 */
2130
function user_login_name_validate($form, &$form_state) {
2131
  if (!empty($form_state['values']['name']) && user_is_blocked($form_state['values']['name'])) {
2132
    // Blocked in user administration.
2133
    form_set_error('name', t('The username %name has not been activated or is blocked.', array('%name' => $form_state['values']['name'])));
2134
  }
2135
}
2136

    
2137
/**
2138
 * A validate handler on the login form. Check supplied username/password
2139
 * against local users table. If successful, $form_state['uid']
2140
 * is set to the matching user ID.
2141
 */
2142
function user_login_authenticate_validate($form, &$form_state) {
2143
  $password = trim($form_state['values']['pass']);
2144
  if (!empty($form_state['values']['name']) && !empty($password)) {
2145
    // Do not allow any login from the current user's IP if the limit has been
2146
    // reached. Default is 50 failed attempts allowed in one hour. This is
2147
    // independent of the per-user limit to catch attempts from one IP to log
2148
    // in to many different user accounts.  We have a reasonably high limit
2149
    // since there may be only one apparent IP for all users at an institution.
2150
    if (!flood_is_allowed('failed_login_attempt_ip', variable_get('user_failed_login_ip_limit', 50), variable_get('user_failed_login_ip_window', 3600))) {
2151
      $form_state['flood_control_triggered'] = 'ip';
2152
      return;
2153
    }
2154
    $account = db_query("SELECT * FROM {users} WHERE name = :name AND status = 1", array(':name' => $form_state['values']['name']))->fetchObject();
2155
    if ($account) {
2156
      if (variable_get('user_failed_login_identifier_uid_only', FALSE)) {
2157
        // Register flood events based on the uid only, so they apply for any
2158
        // IP address. This is the most secure option.
2159
        $identifier = $account->uid;
2160
      }
2161
      else {
2162
        // The default identifier is a combination of uid and IP address. This
2163
        // is less secure but more resistant to denial-of-service attacks that
2164
        // could lock out all users with public user names.
2165
        $identifier = $account->uid . '-' . ip_address();
2166
      }
2167
      $form_state['flood_control_user_identifier'] = $identifier;
2168

    
2169
      // Don't allow login if the limit for this user has been reached.
2170
      // Default is to allow 5 failed attempts every 6 hours.
2171
      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)) {
2172
        $form_state['flood_control_triggered'] = 'user';
2173
        return;
2174
      }
2175
    }
2176
    // We are not limited by flood control, so try to authenticate.
2177
    // Set $form_state['uid'] as a flag for user_login_final_validate().
2178
    $form_state['uid'] = user_authenticate($form_state['values']['name'], $password);
2179
  }
2180
}
2181

    
2182
/**
2183
 * The final validation handler on the login form.
2184
 *
2185
 * Sets a form error if user has not been authenticated, or if too many
2186
 * logins have been attempted. This validation function should always
2187
 * be the last one.
2188
 */
2189
function user_login_final_validate($form, &$form_state) {
2190
  if (empty($form_state['uid'])) {
2191
    // Always register an IP-based failed login event.
2192
    flood_register_event('failed_login_attempt_ip', variable_get('user_failed_login_ip_window', 3600));
2193
    // Register a per-user failed login event.
2194
    if (isset($form_state['flood_control_user_identifier'])) {
2195
      flood_register_event('failed_login_attempt_user', variable_get('user_failed_login_user_window', 21600), $form_state['flood_control_user_identifier']);
2196
    }
2197

    
2198
    if (isset($form_state['flood_control_triggered'])) {
2199
      if ($form_state['flood_control_triggered'] == 'user') {
2200
        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'))));
2201
      }
2202
      else {
2203
        // We did not find a uid, so the limit is IP-based.
2204
        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'))));
2205
      }
2206
    }
2207
    else {
2208
      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']))))));
2209
      watchdog('user', 'Login attempt failed for %user.', array('%user' => $form_state['values']['name']));
2210
    }
2211
  }
2212
  elseif (isset($form_state['flood_control_user_identifier'])) {
2213
    // Clear past failures for this user so as not to block a user who might
2214
    // log in and out more than once in an hour.
2215
    flood_clear_event('failed_login_attempt_user', $form_state['flood_control_user_identifier']);
2216
  }
2217
}
2218

    
2219
/**
2220
 * Try to validate the user's login credentials locally.
2221
 *
2222
 * @param $name
2223
 *   User name to authenticate.
2224
 * @param $password
2225
 *   A plain-text password, such as trimmed text from form values.
2226
 * @return
2227
 *   The user's uid on success, or FALSE on failure to authenticate.
2228
 */
2229
function user_authenticate($name, $password) {
2230
  $uid = FALSE;
2231
  if (!empty($name) && !empty($password)) {
2232
    $account = user_load_by_name($name);
2233
    if ($account) {
2234
      // Allow alternate password hashing schemes.
2235
      require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
2236
      if (user_check_password($password, $account)) {
2237
        // Successful authentication.
2238
        $uid = $account->uid;
2239

    
2240
        // Update user to new password scheme if needed.
2241
        if (user_needs_new_hash($account)) {
2242
          user_save($account, array('pass' => $password));
2243
        }
2244
      }
2245
    }
2246
  }
2247
  return $uid;
2248
}
2249

    
2250
/**
2251
 * Finalize the login process. Must be called when logging in a user.
2252
 *
2253
 * The function records a watchdog message about the new session, saves the
2254
 * login timestamp, calls hook_user_login(), and generates a new session.
2255
 *
2256
 * @param array $edit
2257
 *   The array of form values submitted by the user.
2258
 *
2259
 * @see hook_user_login()
2260
 */
2261
function user_login_finalize(&$edit = array()) {
2262
  global $user;
2263
  watchdog('user', 'Session opened for %name.', array('%name' => $user->name));
2264
  // Update the user table timestamp noting user has logged in.
2265
  // This is also used to invalidate one-time login links.
2266
  $user->login = REQUEST_TIME;
2267
  db_update('users')
2268
    ->fields(array('login' => $user->login))
2269
    ->condition('uid', $user->uid)
2270
    ->execute();
2271

    
2272
  // Regenerate the session ID to prevent against session fixation attacks.
2273
  // This is called before hook_user in case one of those functions fails
2274
  // or incorrectly does a redirect which would leave the old session in place.
2275
  drupal_session_regenerate();
2276

    
2277
  user_module_invoke('login', $edit, $user);
2278
}
2279

    
2280
/**
2281
 * Submit handler for the login form. Load $user object and perform standard login
2282
 * tasks. The user is then redirected to the My Account page. Setting the
2283
 * destination in the query string overrides the redirect.
2284
 */
2285
function user_login_submit($form, &$form_state) {
2286
  global $user;
2287
  $user = user_load($form_state['uid']);
2288
  $form_state['redirect'] = 'user/' . $user->uid;
2289

    
2290
  user_login_finalize($form_state);
2291
}
2292

    
2293
/**
2294
 * Helper function for authentication modules. Either logs in or registers
2295
 * the current user, based on username. Either way, the global $user object is
2296
 * populated and login tasks are performed.
2297
 */
2298
function user_external_login_register($name, $module) {
2299
  $account = user_external_load($name);
2300
  if (!$account) {
2301
    // Register this new user.
2302
    $userinfo = array(
2303
      'name' => $name,
2304
      'pass' => user_password(),
2305
      'init' => $name,
2306
      'status' => 1,
2307
      'access' => REQUEST_TIME
2308
    );
2309
    $account = user_save(drupal_anonymous_user(), $userinfo);
2310
    // Terminate if an error occurred during user_save().
2311
    if (!$account) {
2312
      drupal_set_message(t("Error saving user account."), 'error');
2313
      return;
2314
    }
2315
    user_set_authmaps($account, array("authname_$module" => $name));
2316
  }
2317

    
2318
  // Log user in.
2319
  $form_state['uid'] = $account->uid;
2320
  user_login_submit(array(), $form_state);
2321
}
2322

    
2323
/**
2324
 * Generates a unique URL for a user to login and reset their password.
2325
 *
2326
 * @param object $account
2327
 *   An object containing the user account, which must contain at least the
2328
 *   following properties:
2329
 *   - uid: The user ID number.
2330
 *   - login: The UNIX timestamp of the user's last login.
2331
 *
2332
 * @return
2333
 *   A unique URL that provides a one-time log in for the user, from which
2334
 *   they can change their password.
2335
 */
2336
function user_pass_reset_url($account) {
2337
  $timestamp = REQUEST_TIME;
2338
  return url("user/reset/$account->uid/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login, $account->uid), array('absolute' => TRUE));
2339
}
2340

    
2341
/**
2342
 * Generates a URL to confirm an account cancellation request.
2343
 *
2344
 * @param object $account
2345
 *   The user account object, which must contain at least the following
2346
 *   properties:
2347
 *   - uid: The user ID number.
2348
 *   - pass: The hashed user password string.
2349
 *   - login: The UNIX timestamp of the user's last login.
2350
 *
2351
 * @return
2352
 *   A unique URL that may be used to confirm the cancellation of the user
2353
 *   account.
2354
 *
2355
 * @see user_mail_tokens()
2356
 * @see user_cancel_confirm()
2357
 */
2358
function user_cancel_url($account) {
2359
  $timestamp = REQUEST_TIME;
2360
  return url("user/$account->uid/cancel/confirm/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login, $account->uid), array('absolute' => TRUE));
2361
}
2362

    
2363
/**
2364
 * Creates a unique hash value for use in time-dependent per-user URLs.
2365
 *
2366
 * This hash is normally used to build a unique and secure URL that is sent to
2367
 * the user by email for purposes such as resetting the user's password. In
2368
 * order to validate the URL, the same hash can be generated again, from the
2369
 * same information, and compared to the hash value from the URL. The URL
2370
 * normally contains both the time stamp and the numeric user ID. The login
2371
 * timestamp and hashed password are retrieved from the database as necessary.
2372
 * For a usage example, see user_cancel_url() and user_cancel_confirm().
2373
 *
2374
 * @param string $password
2375
 *   The hashed user account password value.
2376
 * @param int $timestamp
2377
 *   A UNIX timestamp, typically REQUEST_TIME.
2378
 * @param int $login
2379
 *   The UNIX timestamp of the user's last login.
2380
 * @param int $uid
2381
 *   The user ID of the user account.
2382
 *
2383
 * @return
2384
 *   A string that is safe for use in URLs and SQL statements.
2385
 */
2386
function user_pass_rehash($password, $timestamp, $login, $uid) {
2387
  // Backwards compatibility: Try to determine a $uid if one was not passed.
2388
  // (Since $uid is a required parameter to this function, a PHP warning will
2389
  // be generated if it's not provided, which is an indication that the calling
2390
  // code should be updated. But the code below will try to generate a correct
2391
  // hash in the meantime.)
2392
  if (!isset($uid)) {
2393
    $uids = db_query_range('SELECT uid FROM {users} WHERE pass = :password AND login = :login AND uid > 0', 0, 2, array(':password' => $password, ':login' => $login))->fetchCol();
2394
    // If exactly one user account matches the provided password and login
2395
    // timestamp, proceed with that $uid.
2396
    if (count($uids) == 1) {
2397
      $uid = reset($uids);
2398
    }
2399
    // Otherwise there is no safe hash to return, so return a random string
2400
    // that will never be treated as a valid token.
2401
    else {
2402
      return drupal_random_key();
2403
    }
2404
  }
2405

    
2406
  return drupal_hmac_base64($timestamp . $login . $uid, drupal_get_hash_salt() . $password);
2407
}
2408

    
2409
/**
2410
 * Cancel a user account.
2411
 *
2412
 * Since the user cancellation process needs to be run in a batch, either
2413
 * Form API will invoke it, or batch_process() needs to be invoked after calling
2414
 * this function and should define the path to redirect to.
2415
 *
2416
 * @param $edit
2417
 *   An array of submitted form values.
2418
 * @param $uid
2419
 *   The user ID of the user account to cancel.
2420
 * @param $method
2421
 *   The account cancellation method to use.
2422
 *
2423
 * @see _user_cancel()
2424
 */
2425
function user_cancel($edit, $uid, $method) {
2426
  global $user;
2427

    
2428
  $account = user_load($uid);
2429

    
2430
  if (!$account) {
2431
    drupal_set_message(t('The user account %id does not exist.', array('%id' => $uid)), 'error');
2432
    watchdog('user', 'Attempted to cancel non-existing user account: %id.', array('%id' => $uid), WATCHDOG_ERROR);
2433
    return;
2434
  }
2435

    
2436
  // Initialize batch (to set title).
2437
  $batch = array(
2438
    'title' => t('Cancelling account'),
2439
    'operations' => array(),
2440
  );
2441
  batch_set($batch);
2442

    
2443
  // Modules use hook_user_delete() to respond to deletion.
2444
  if ($method != 'user_cancel_delete') {
2445
    // Allow modules to add further sets to this batch.
2446
    module_invoke_all('user_cancel', $edit, $account, $method);
2447
  }
2448

    
2449
  // Finish the batch and actually cancel the account.
2450
  $batch = array(
2451
    'title' => t('Cancelling user account'),
2452
    'operations' => array(
2453
      array('_user_cancel', array($edit, $account, $method)),
2454
    ),
2455
  );
2456

    
2457
  // After cancelling account, ensure that user is logged out.
2458
  if ($account->uid == $user->uid) {
2459
    // Batch API stores data in the session, so use the finished operation to
2460
    // manipulate the current user's session id.
2461
    $batch['finished'] = '_user_cancel_session_regenerate';
2462
  }
2463

    
2464
  batch_set($batch);
2465

    
2466
  // Batch processing is either handled via Form API or has to be invoked
2467
  // manually.
2468
}
2469

    
2470
/**
2471
 * Last batch processing step for cancelling a user account.
2472
 *
2473
 * Since batch and session API require a valid user account, the actual
2474
 * cancellation of a user account needs to happen last.
2475
 *
2476
 * @see user_cancel()
2477
 */
2478
function _user_cancel($edit, $account, $method) {
2479
  global $user;
2480

    
2481
  switch ($method) {
2482
    case 'user_cancel_block':
2483
    case 'user_cancel_block_unpublish':
2484
    default:
2485
      // Send account blocked notification if option was checked.
2486
      if (!empty($edit['user_cancel_notify'])) {
2487
        _user_mail_notify('status_blocked', $account);
2488
      }
2489
      user_save($account, array('status' => 0));
2490
      drupal_set_message(t('%name has been disabled.', array('%name' => $account->name)));
2491
      watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
2492
      break;
2493

    
2494
    case 'user_cancel_reassign':
2495
    case 'user_cancel_delete':
2496
      // Send account canceled notification if option was checked.
2497
      if (!empty($edit['user_cancel_notify'])) {
2498
        _user_mail_notify('status_canceled', $account);
2499
      }
2500
      user_delete($account->uid);
2501
      drupal_set_message(t('%name has been deleted.', array('%name' => $account->name)));
2502
      watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
2503
      break;
2504
  }
2505

    
2506
  // After cancelling account, ensure that user is logged out. We can't destroy
2507
  // their session though, as we might have information in it, and we can't
2508
  // regenerate it because batch API uses the session ID, we will regenerate it
2509
  // in _user_cancel_session_regenerate().
2510
  if ($account->uid == $user->uid) {
2511
    $user = drupal_anonymous_user();
2512
  }
2513

    
2514
  // Clear the cache for anonymous users.
2515
  cache_clear_all();
2516
}
2517

    
2518
/**
2519
 * Finished batch processing callback for cancelling a user account.
2520
 *
2521
 * @see user_cancel()
2522
 */
2523
function _user_cancel_session_regenerate() {
2524
  // Regenerate the users session instead of calling session_destroy() as we
2525
  // want to preserve any messages that might have been set.
2526
  drupal_session_regenerate();
2527
}
2528

    
2529
/**
2530
 * Delete a user.
2531
 *
2532
 * @param $uid
2533
 *   A user ID.
2534
 */
2535
function user_delete($uid) {
2536
  user_delete_multiple(array($uid));
2537
}
2538

    
2539
/**
2540
 * Delete multiple user accounts.
2541
 *
2542
 * @param $uids
2543
 *   An array of user IDs.
2544
 */
2545
function user_delete_multiple(array $uids) {
2546
  if (!empty($uids)) {
2547
    $accounts = user_load_multiple($uids, array());
2548

    
2549
    $transaction = db_transaction();
2550
    try {
2551
      foreach ($accounts as $uid => $account) {
2552
        module_invoke_all('user_delete', $account);
2553
        module_invoke_all('entity_delete', $account, 'user');
2554
        field_attach_delete('user', $account);
2555
        drupal_session_destroy_uid($account->uid);
2556
      }
2557

    
2558
      db_delete('users')
2559
        ->condition('uid', $uids, 'IN')
2560
        ->execute();
2561
      db_delete('users_roles')
2562
        ->condition('uid', $uids, 'IN')
2563
        ->execute();
2564
      db_delete('authmap')
2565
        ->condition('uid', $uids, 'IN')
2566
        ->execute();
2567
    }
2568
    catch (Exception $e) {
2569
      $transaction->rollback();
2570
      watchdog_exception('user', $e);
2571
      throw $e;
2572
    }
2573
    entity_get_controller('user')->resetCache();
2574
  }
2575
}
2576

    
2577
/**
2578
 * Page callback wrapper for user_view().
2579
 */
2580
function user_view_page($account) {
2581
  // An administrator may try to view a non-existent account,
2582
  // so we give them a 404 (versus a 403 for non-admins).
2583
  return is_object($account) ? user_view($account) : MENU_NOT_FOUND;
2584
}
2585

    
2586
/**
2587
 * Generate an array for rendering the given user.
2588
 *
2589
 * When viewing a user profile, the $page array contains:
2590
 *
2591
 * - $page['content']['Profile Category']:
2592
 *   Profile categories keyed by their human-readable names.
2593
 * - $page['content']['Profile Category']['profile_machine_name']:
2594
 *   Profile fields keyed by their machine-readable names.
2595
 * - $page['content']['user_picture']:
2596
 *   User's rendered picture.
2597
 * - $page['content']['summary']:
2598
 *   Contains the default "History" profile data for a user.
2599
 * - $page['content']['#account']:
2600
 *   The user account of the profile being viewed.
2601
 *
2602
 * To theme user profiles, copy modules/user/user-profile.tpl.php
2603
 * to your theme directory, and edit it as instructed in that file's comments.
2604
 *
2605
 * @param $account
2606
 *   A user object.
2607
 * @param $view_mode
2608
 *   View mode, e.g. 'full'.
2609
 * @param $langcode
2610
 *   (optional) A language code to use for rendering. Defaults to the global
2611
 *   content language of the current request.
2612
 *
2613
 * @return
2614
 *   An array as expected by drupal_render().
2615
 */
2616
function user_view($account, $view_mode = 'full', $langcode = NULL) {
2617
  if (!isset($langcode)) {
2618
    $langcode = $GLOBALS['language_content']->language;
2619
  }
2620

    
2621
  // Retrieve all profile fields and attach to $account->content.
2622
  user_build_content($account, $view_mode, $langcode);
2623

    
2624
  $build = $account->content;
2625
  // We don't need duplicate rendering info in account->content.
2626
  unset($account->content);
2627

    
2628
  $build += array(
2629
    '#theme' => 'user_profile',
2630
    '#account' => $account,
2631
    '#view_mode' => $view_mode,
2632
    '#language' => $langcode,
2633
  );
2634

    
2635
  // Allow modules to modify the structured user.
2636
  $type = 'user';
2637
  drupal_alter(array('user_view', 'entity_view'), $build, $type);
2638

    
2639
  return $build;
2640
}
2641

    
2642
/**
2643
 * Builds a structured array representing the profile content.
2644
 *
2645
 * @param $account
2646
 *   A user object.
2647
 * @param $view_mode
2648
 *   View mode, e.g. 'full'.
2649
 * @param $langcode
2650
 *   (optional) A language code to use for rendering. Defaults to the global
2651
 *   content language of the current request.
2652
 */
2653
function user_build_content($account, $view_mode = 'full', $langcode = NULL) {
2654
  if (!isset($langcode)) {
2655
    $langcode = $GLOBALS['language_content']->language;
2656
  }
2657

    
2658
  // Remove previously built content, if exists.
2659
  $account->content = array();
2660

    
2661
  // Allow modules to change the view mode.
2662
  $view_mode = key(entity_view_mode_prepare('user', array($account->uid => $account), $view_mode, $langcode));
2663

    
2664
  // Build fields content.
2665
  field_attach_prepare_view('user', array($account->uid => $account), $view_mode, $langcode);
2666
  entity_prepare_view('user', array($account->uid => $account), $langcode);
2667
  $account->content += field_attach_view('user', $account, $view_mode, $langcode);
2668

    
2669
  // Populate $account->content with a render() array.
2670
  module_invoke_all('user_view', $account, $view_mode, $langcode);
2671
  module_invoke_all('entity_view', $account, 'user', $view_mode, $langcode);
2672

    
2673
  // Make sure the current view mode is stored if no module has already
2674
  // populated the related key.
2675
  $account->content += array('#view_mode' => $view_mode);
2676
}
2677

    
2678
/**
2679
 * Implements hook_mail().
2680
 */
2681
function user_mail($key, &$message, $params) {
2682
  $language = $message['language'];
2683
  $variables = array('user' => $params['account']);
2684
  $message['subject'] .= _user_mail_text($key . '_subject', $language, $variables);
2685
  $message['body'][] = _user_mail_text($key . '_body', $language, $variables);
2686
}
2687

    
2688
/**
2689
 * Returns a mail string for a variable name.
2690
 *
2691
 * Used by user_mail() and the settings forms to retrieve strings.
2692
 */
2693
function _user_mail_text($key, $language = NULL, $variables = array(), $replace = TRUE) {
2694
  $langcode = isset($language) ? $language->language : NULL;
2695

    
2696
  if ($admin_setting = variable_get('user_mail_' . $key, FALSE)) {
2697
    // An admin setting overrides the default string.
2698
    $text = $admin_setting;
2699
  }
2700
  else {
2701
    // No override, return default string.
2702
    switch ($key) {
2703
      case 'register_no_approval_required_subject':
2704
        $text = t('Account details for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2705
        break;
2706
      case 'register_no_approval_required_body':
2707
        $text = t("[user:name],
2708

    
2709
Thank you for registering at [site:name]. You may now log in by clicking this link or copying and pasting it to your browser:
2710

    
2711
[user:one-time-login-url]
2712

    
2713
This link can only be used once to log in and will lead you to a page where you can set your password.
2714

    
2715
After setting your password, you will be able to log in at [site:login-url] in the future using:
2716

    
2717
username: [user:name]
2718
password: Your password
2719

    
2720
--  [site:name] team", array(), array('langcode' => $langcode));
2721
        break;
2722

    
2723
      case 'register_admin_created_subject':
2724
        $text = t('An administrator created an account for you at [site:name]', array(), array('langcode' => $langcode));
2725
        break;
2726
      case 'register_admin_created_body':
2727
        $text = t("[user:name],
2728

    
2729
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:
2730

    
2731
[user:one-time-login-url]
2732

    
2733
This link can only be used once to log in and will lead you to a page where you can set your password.
2734

    
2735
After setting your password, you will be able to log in at [site:login-url] in the future using:
2736

    
2737
username: [user:name]
2738
password: Your password
2739

    
2740
--  [site:name] team", array(), array('langcode' => $langcode));
2741
        break;
2742

    
2743
      case 'register_pending_approval_subject':
2744
      case 'register_pending_approval_admin_subject':
2745
        $text = t('Account details for [user:name] at [site:name] (pending admin approval)', array(), array('langcode' => $langcode));
2746
        break;
2747
      case 'register_pending_approval_body':
2748
        $text = t("[user:name],
2749

    
2750
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.
2751

    
2752

    
2753
--  [site:name] team", array(), array('langcode' => $langcode));
2754
        break;
2755
      case 'register_pending_approval_admin_body':
2756
        $text = t("[user:name] has applied for an account.
2757

    
2758
[user:edit-url]", array(), array('langcode' => $langcode));
2759
        break;
2760

    
2761
      case 'password_reset_subject':
2762
        $text = t('Replacement login information for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2763
        break;
2764
      case 'password_reset_body':
2765
        $text = t("[user:name],
2766

    
2767
A request to reset the password for your account has been made at [site:name].
2768

    
2769
You may now log in by clicking this link or copying and pasting it to your browser:
2770

    
2771
[user:one-time-login-url]
2772

    
2773
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.
2774

    
2775
--  [site:name] team", array(), array('langcode' => $langcode));
2776
        break;
2777

    
2778
      case 'status_activated_subject':
2779
        $text = t('Account details for [user:name] at [site:name] (approved)', array(), array('langcode' => $langcode));
2780
        break;
2781
      case 'status_activated_body':
2782
        $text = t("[user:name],
2783

    
2784
Your account at [site:name] has been activated.
2785

    
2786
You may now log in by clicking this link or copying and pasting it into your browser:
2787

    
2788
[user:one-time-login-url]
2789

    
2790
This link can only be used once to log in and will lead you to a page where you can set your password.
2791

    
2792
After setting your password, you will be able to log in at [site:login-url] in the future using:
2793

    
2794
username: [user:name]
2795
password: Your password
2796

    
2797
--  [site:name] team", array(), array('langcode' => $langcode));
2798
        break;
2799

    
2800
      case 'status_blocked_subject':
2801
        $text = t('Account details for [user:name] at [site:name] (blocked)', array(), array('langcode' => $langcode));
2802
        break;
2803
      case 'status_blocked_body':
2804
        $text = t("[user:name],
2805

    
2806
Your account on [site:name] has been blocked.
2807

    
2808
--  [site:name] team", array(), array('langcode' => $langcode));
2809
        break;
2810

    
2811
      case 'cancel_confirm_subject':
2812
        $text = t('Account cancellation request for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2813
        break;
2814
      case 'cancel_confirm_body':
2815
        $text = t("[user:name],
2816

    
2817
A request to cancel your account has been made at [site:name].
2818

    
2819
You may now cancel your account on [site:url-brief] by clicking this link or copying and pasting it into your browser:
2820

    
2821
[user:cancel-url]
2822

    
2823
NOTE: The cancellation of your account is not reversible.
2824

    
2825
This link expires in one day and nothing will happen if it is not used.
2826

    
2827
--  [site:name] team", array(), array('langcode' => $langcode));
2828
        break;
2829

    
2830
      case 'status_canceled_subject':
2831
        $text = t('Account details for [user:name] at [site:name] (canceled)', array(), array('langcode' => $langcode));
2832
        break;
2833
      case 'status_canceled_body':
2834
        $text = t("[user:name],
2835

    
2836
Your account on [site:name] has been canceled.
2837

    
2838
--  [site:name] team", array(), array('langcode' => $langcode));
2839
        break;
2840
    }
2841
  }
2842

    
2843
  if ($replace) {
2844
    // We do not sanitize the token replacement, since the output of this
2845
    // replacement is intended for an e-mail message, not a web browser.
2846
    return token_replace($text, $variables, array('language' => $language, 'callback' => 'user_mail_tokens', 'sanitize' => FALSE, 'clear' => TRUE));
2847
  }
2848

    
2849
  return $text;
2850
}
2851

    
2852
/**
2853
 * Token callback to add unsafe tokens for user mails.
2854
 *
2855
 * This function is used by the token_replace() call at the end of
2856
 * _user_mail_text() to set up some additional tokens that can be
2857
 * used in email messages generated by user_mail().
2858
 *
2859
 * @param $replacements
2860
 *   An associative array variable containing mappings from token names to
2861
 *   values (for use with strtr()).
2862
 * @param $data
2863
 *   An associative array of token replacement values. If the 'user' element
2864
 *   exists, it must contain a user account object with the following
2865
 *   properties:
2866
 *   - login: The UNIX timestamp of the user's last login.
2867
 *   - pass: The hashed account login password.
2868
 * @param $options
2869
 *   Unused parameter required by the token_replace() function.
2870
 */
2871
function user_mail_tokens(&$replacements, $data, $options) {
2872
  if (isset($data['user'])) {
2873
    $replacements['[user:one-time-login-url]'] = user_pass_reset_url($data['user']);
2874
    $replacements['[user:cancel-url]'] = user_cancel_url($data['user']);
2875
  }
2876
}
2877

    
2878
/*** Administrative features ***********************************************/
2879

    
2880
/**
2881
 * Retrieve an array of roles matching specified conditions.
2882
 *
2883
 * @param $membersonly
2884
 *   Set this to TRUE to exclude the 'anonymous' role.
2885
 * @param $permission
2886
 *   A string containing a permission. If set, only roles containing that
2887
 *   permission are returned.
2888
 *
2889
 * @return
2890
 *   An associative array with the role id as the key and the role name as
2891
 *   value.
2892
 */
2893
function user_roles($membersonly = FALSE, $permission = NULL) {
2894
  $query = db_select('role', 'r');
2895
  $query->addTag('translatable');
2896
  $query->fields('r', array('rid', 'name'));
2897
  $query->orderBy('weight');
2898
  $query->orderBy('name');
2899
  if (!empty($permission)) {
2900
    $query->innerJoin('role_permission', 'p', 'r.rid = p.rid');
2901
    $query->condition('p.permission', $permission);
2902
  }
2903
  $result = $query->execute();
2904

    
2905
  $roles = array();
2906
  foreach ($result as $role) {
2907
    switch ($role->rid) {
2908
      // We only translate the built in role names
2909
      case DRUPAL_ANONYMOUS_RID:
2910
        if (!$membersonly) {
2911
          $roles[$role->rid] = t($role->name);
2912
        }
2913
        break;
2914
      case DRUPAL_AUTHENTICATED_RID:
2915
        $roles[$role->rid] = t($role->name);
2916
        break;
2917
      default:
2918
        $roles[$role->rid] = $role->name;
2919
    }
2920
  }
2921

    
2922
  return $roles;
2923
}
2924

    
2925
/**
2926
 * Fetches a user role by role ID.
2927
 *
2928
 * @param $rid
2929
 *   An integer representing the role ID.
2930
 *
2931
 * @return
2932
 *   A fully-loaded role object if a role with the given ID exists, or FALSE
2933
 *   otherwise.
2934
 *
2935
 * @see user_role_load_by_name()
2936
 */
2937
function user_role_load($rid) {
2938
  return db_select('role', 'r')
2939
    ->fields('r')
2940
    ->condition('rid', $rid)
2941
    ->execute()
2942
    ->fetchObject();
2943
}
2944

    
2945
/**
2946
 * Fetches a user role by role name.
2947
 *
2948
 * @param $role_name
2949
 *   A string representing the role name.
2950
 *
2951
 * @return
2952
 *   A fully-loaded role object if a role with the given name exists, or FALSE
2953
 *   otherwise.
2954
 *
2955
 * @see user_role_load()
2956
 */
2957
function user_role_load_by_name($role_name) {
2958
  return db_select('role', 'r')
2959
    ->fields('r')
2960
    ->condition('name', $role_name)
2961
    ->execute()
2962
    ->fetchObject();
2963
}
2964

    
2965
/**
2966
 * Save a user role to the database.
2967
 *
2968
 * @param $role
2969
 *   A role object to modify or add. If $role->rid is not specified, a new
2970
 *   role will be created.
2971
 * @return
2972
 *   Status constant indicating if role was created or updated.
2973
 *   Failure to write the user role record will return FALSE. Otherwise.
2974
 *   SAVED_NEW or SAVED_UPDATED is returned depending on the operation
2975
 *   performed.
2976
 */
2977
function user_role_save($role) {
2978
  if ($role->name) {
2979
    // Prevent leading and trailing spaces in role names.
2980
    $role->name = trim($role->name);
2981
  }
2982
  if (!isset($role->weight)) {
2983
    // Set a role weight to make this new role last.
2984
    $query = db_select('role');
2985
    $query->addExpression('MAX(weight)');
2986
    $role->weight = $query->execute()->fetchField() + 1;
2987
  }
2988

    
2989
  // Let modules modify the user role before it is saved to the database.
2990
  module_invoke_all('user_role_presave', $role);
2991

    
2992
  if (!empty($role->rid) && $role->name) {
2993
    $status = drupal_write_record('role', $role, 'rid');
2994
    module_invoke_all('user_role_update', $role);
2995
  }
2996
  else {
2997
    $status = drupal_write_record('role', $role);
2998
    module_invoke_all('user_role_insert', $role);
2999
  }
3000

    
3001
  // Clear the user access cache.
3002
  drupal_static_reset('user_access');
3003
  drupal_static_reset('user_role_permissions');
3004

    
3005
  return $status;
3006
}
3007

    
3008
/**
3009
 * Delete a user role from database.
3010
 *
3011
 * @param $role
3012
 *   A string with the role name, or an integer with the role ID.
3013
 */
3014
function user_role_delete($role) {
3015
  if (is_int($role)) {
3016
    $role = user_role_load($role);
3017
  }
3018
  else {
3019
    $role = user_role_load_by_name($role);
3020
  }
3021

    
3022
  db_delete('role')
3023
    ->condition('rid', $role->rid)
3024
    ->execute();
3025
  db_delete('role_permission')
3026
    ->condition('rid', $role->rid)
3027
    ->execute();
3028
  // Update the users who have this role set:
3029
  db_delete('users_roles')
3030
    ->condition('rid', $role->rid)
3031
    ->execute();
3032

    
3033
  module_invoke_all('user_role_delete', $role);
3034

    
3035
  // Clear the user access cache.
3036
  drupal_static_reset('user_access');
3037
  drupal_static_reset('user_role_permissions');
3038
}
3039

    
3040
/**
3041
 * Menu access callback for user role editing.
3042
 */
3043
function user_role_edit_access($role) {
3044
  // Prevent the system-defined roles from being altered or removed.
3045
  if ($role->rid == DRUPAL_ANONYMOUS_RID || $role->rid == DRUPAL_AUTHENTICATED_RID) {
3046
    return FALSE;
3047
  }
3048

    
3049
  return user_access('administer permissions');
3050
}
3051

    
3052
/**
3053
 * Determine the modules that permissions belong to.
3054
 *
3055
 * @return
3056
 *   An associative array in the format $permission => $module.
3057
 */
3058
function user_permission_get_modules() {
3059
  $permissions = array();
3060
  foreach (module_implements('permission') as $module) {
3061
    $perms = module_invoke($module, 'permission');
3062
    foreach ($perms as $key => $value) {
3063
      $permissions[$key] = $module;
3064
    }
3065
  }
3066
  return $permissions;
3067
}
3068

    
3069
/**
3070
 * Change permissions for a user role.
3071
 *
3072
 * This function may be used to grant and revoke multiple permissions at once.
3073
 * For example, when a form exposes checkboxes to configure permissions for a
3074
 * role, the form submit handler may directly pass the submitted values for the
3075
 * checkboxes form element to this function.
3076
 *
3077
 * @param $rid
3078
 *   The ID of a user role to alter.
3079
 * @param $permissions
3080
 *   An associative array, where the key holds the permission name and the value
3081
 *   determines whether to grant or revoke that permission. Any value that
3082
 *   evaluates to TRUE will cause the permission to be granted. Any value that
3083
 *   evaluates to FALSE will cause the permission to be revoked.
3084
 *   @code
3085
 *     array(
3086
 *       'administer nodes' => 0,                // Revoke 'administer nodes'
3087
 *       'administer blocks' => FALSE,           // Revoke 'administer blocks'
3088
 *       'access user profiles' => 1,            // Grant 'access user profiles'
3089
 *       'access content' => TRUE,               // Grant 'access content'
3090
 *       'access comments' => 'access comments', // Grant 'access comments'
3091
 *     )
3092
 *   @endcode
3093
 *   Existing permissions are not changed, unless specified in $permissions.
3094
 *
3095
 * @see user_role_grant_permissions()
3096
 * @see user_role_revoke_permissions()
3097
 */
3098
function user_role_change_permissions($rid, array $permissions = array()) {
3099
  // Grant new permissions for the role.
3100
  $grant = array_filter($permissions);
3101
  if (!empty($grant)) {
3102
    user_role_grant_permissions($rid, array_keys($grant));
3103
  }
3104
  // Revoke permissions for the role.
3105
  $revoke = array_diff_assoc($permissions, $grant);
3106
  if (!empty($revoke)) {
3107
    user_role_revoke_permissions($rid, array_keys($revoke));
3108
  }
3109
}
3110

    
3111
/**
3112
 * Grant permissions to a user role.
3113
 *
3114
 * @param $rid
3115
 *   The ID of a user role to alter.
3116
 * @param $permissions
3117
 *   A list of permission names to grant.
3118
 *
3119
 * @see user_role_change_permissions()
3120
 * @see user_role_revoke_permissions()
3121
 */
3122
function user_role_grant_permissions($rid, array $permissions = array()) {
3123
  $modules = user_permission_get_modules();
3124
  // Grant new permissions for the role.
3125
  foreach ($permissions as $name) {
3126
    db_merge('role_permission')
3127
      ->key(array(
3128
        'rid' => $rid,
3129
        'permission' => $name,
3130
      ))
3131
      ->fields(array(
3132
        'module' => $modules[$name],
3133
      ))
3134
      ->execute();
3135
  }
3136

    
3137
  // Clear the user access cache.
3138
  drupal_static_reset('user_access');
3139
  drupal_static_reset('user_role_permissions');
3140
}
3141

    
3142
/**
3143
 * Revoke permissions from a user role.
3144
 *
3145
 * @param $rid
3146
 *   The ID of a user role to alter.
3147
 * @param $permissions
3148
 *   A list of permission names to revoke.
3149
 *
3150
 * @see user_role_change_permissions()
3151
 * @see user_role_grant_permissions()
3152
 */
3153
function user_role_revoke_permissions($rid, array $permissions = array()) {
3154
  // Revoke permissions for the role.
3155
  db_delete('role_permission')
3156
    ->condition('rid', $rid)
3157
    ->condition('permission', $permissions, 'IN')
3158
    ->execute();
3159

    
3160
  // Clear the user access cache.
3161
  drupal_static_reset('user_access');
3162
  drupal_static_reset('user_role_permissions');
3163
}
3164

    
3165
/**
3166
 * Implements hook_user_operations().
3167
 */
3168
function user_user_operations($form = array(), $form_state = array()) {
3169
  $operations = array(
3170
    'unblock' => array(
3171
      'label' => t('Unblock the selected users'),
3172
      'callback' => 'user_user_operations_unblock',
3173
    ),
3174
    'block' => array(
3175
      'label' => t('Block the selected users'),
3176
      'callback' => 'user_user_operations_block',
3177
    ),
3178
    'cancel' => array(
3179
      'label' => t('Cancel the selected user accounts'),
3180
    ),
3181
  );
3182

    
3183
  if (user_access('administer permissions')) {
3184
    $roles = user_roles(TRUE);
3185
    unset($roles[DRUPAL_AUTHENTICATED_RID]);  // Can't edit authenticated role.
3186

    
3187
    $add_roles = array();
3188
    foreach ($roles as $key => $value) {
3189
      $add_roles['add_role-' . $key] = $value;
3190
    }
3191

    
3192
    $remove_roles = array();
3193
    foreach ($roles as $key => $value) {
3194
      $remove_roles['remove_role-' . $key] = $value;
3195
    }
3196

    
3197
    if (count($roles)) {
3198
      $role_operations = array(
3199
        t('Add a role to the selected users') => array(
3200
          'label' => $add_roles,
3201
        ),
3202
        t('Remove a role from the selected users') => array(
3203
          'label' => $remove_roles,
3204
        ),
3205
      );
3206

    
3207
      $operations += $role_operations;
3208
    }
3209
  }
3210

    
3211
  // If the form has been posted, we need to insert the proper data for
3212
  // role editing if necessary.
3213
  if (!empty($form_state['submitted'])) {
3214
    $operation_rid = explode('-', $form_state['values']['operation']);
3215
    $operation = $operation_rid[0];
3216
    if ($operation == 'add_role' || $operation == 'remove_role') {
3217
      $rid = $operation_rid[1];
3218
      if (user_access('administer permissions')) {
3219
        $operations[$form_state['values']['operation']] = array(
3220
          'callback' => 'user_multiple_role_edit',
3221
          'callback arguments' => array($operation, $rid),
3222
        );
3223
      }
3224
      else {
3225
        watchdog('security', 'Detected malicious attempt to alter protected user fields.', array(), WATCHDOG_WARNING);
3226
        return;
3227
      }
3228
    }
3229
  }
3230

    
3231
  return $operations;
3232
}
3233

    
3234
/**
3235
 * Callback function for admin mass unblocking users.
3236
 */
3237
function user_user_operations_unblock($accounts) {
3238
  $accounts = user_load_multiple($accounts);
3239
  foreach ($accounts as $account) {
3240
    // Skip unblocking user if they are already unblocked.
3241
    if ($account !== FALSE && $account->status == 0) {
3242
      user_save($account, array('status' => 1));
3243
    }
3244
  }
3245
}
3246

    
3247
/**
3248
 * Callback function for admin mass blocking users.
3249
 */
3250
function user_user_operations_block($accounts) {
3251
  $accounts = user_load_multiple($accounts);
3252
  foreach ($accounts as $account) {
3253
    // Skip blocking user if they are already blocked.
3254
    if ($account !== FALSE && $account->status == 1) {
3255
      // For efficiency manually save the original account before applying any
3256
      // changes.
3257
      $account->original = clone $account;
3258
      user_save($account, array('status' => 0));
3259
    }
3260
  }
3261
}
3262

    
3263
/**
3264
 * Callback function for admin mass adding/deleting a user role.
3265
 */
3266
function user_multiple_role_edit($accounts, $operation, $rid) {
3267
  // The role name is not necessary as user_save() will reload the user
3268
  // object, but some modules' hook_user() may look at this first.
3269
  $role_name = db_query('SELECT name FROM {role} WHERE rid = :rid', array(':rid' => $rid))->fetchField();
3270

    
3271
  switch ($operation) {
3272
    case 'add_role':
3273
      $accounts = user_load_multiple($accounts);
3274
      foreach ($accounts as $account) {
3275
        // Skip adding the role to the user if they already have it.
3276
        if ($account !== FALSE && !isset($account->roles[$rid])) {
3277
          $roles = $account->roles + array($rid => $role_name);
3278
          // For efficiency manually save the original account before applying
3279
          // any changes.
3280
          $account->original = clone $account;
3281
          user_save($account, array('roles' => $roles));
3282
        }
3283
      }
3284
      break;
3285
    case 'remove_role':
3286
      $accounts = user_load_multiple($accounts);
3287
      foreach ($accounts as $account) {
3288
        // Skip removing the role from the user if they already don't have it.
3289
        if ($account !== FALSE && isset($account->roles[$rid])) {
3290
          $roles = array_diff($account->roles, array($rid => $role_name));
3291
          // For efficiency manually save the original account before applying
3292
          // any changes.
3293
          $account->original = clone $account;
3294
          user_save($account, array('roles' => $roles));
3295
        }
3296
      }
3297
      break;
3298
  }
3299
}
3300

    
3301
function user_multiple_cancel_confirm($form, &$form_state) {
3302
  $edit = $form_state['input'];
3303

    
3304
  $form['accounts'] = array('#prefix' => '<ul>', '#suffix' => '</ul>', '#tree' => TRUE);
3305
  $accounts = user_load_multiple(array_keys(array_filter($edit['accounts'])));
3306
  foreach ($accounts as $uid => $account) {
3307
    // Prevent user 1 from being canceled.
3308
    if ($uid <= 1) {
3309
      continue;
3310
    }
3311
    $form['accounts'][$uid] = array(
3312
      '#type' => 'hidden',
3313
      '#value' => $uid,
3314
      '#prefix' => '<li>',
3315
      '#suffix' => check_plain($account->name) . "</li>\n",
3316
    );
3317
  }
3318

    
3319
  // Output a notice that user 1 cannot be canceled.
3320
  if (isset($accounts[1])) {
3321
    $redirect = (count($accounts) == 1);
3322
    $message = t('The user account %name cannot be cancelled.', array('%name' => $accounts[1]->name));
3323
    drupal_set_message($message, $redirect ? 'error' : 'warning');
3324
    // If only user 1 was selected, redirect to the overview.
3325
    if ($redirect) {
3326
      drupal_goto('admin/people');
3327
    }
3328
  }
3329

    
3330
  $form['operation'] = array('#type' => 'hidden', '#value' => 'cancel');
3331

    
3332
  module_load_include('inc', 'user', 'user.pages');
3333
  $form['user_cancel_method'] = array(
3334
    '#type' => 'item',
3335
    '#title' => t('When cancelling these accounts'),
3336
  );
3337
  $form['user_cancel_method'] += user_cancel_methods();
3338
  // Remove method descriptions.
3339
  foreach (element_children($form['user_cancel_method']) as $element) {
3340
    unset($form['user_cancel_method'][$element]['#description']);
3341
  }
3342

    
3343
  // Allow to send the account cancellation confirmation mail.
3344
  $form['user_cancel_confirm'] = array(
3345
    '#type' => 'checkbox',
3346
    '#title' => t('Require e-mail confirmation to cancel account.'),
3347
    '#default_value' => FALSE,
3348
    '#description' => t('When enabled, the user must confirm the account cancellation via e-mail.'),
3349
  );
3350
  // Also allow to send account canceled notification mail, if enabled.
3351
  $form['user_cancel_notify'] = array(
3352
    '#type' => 'checkbox',
3353
    '#title' => t('Notify user when account is canceled.'),
3354
    '#default_value' => FALSE,
3355
    '#access' => variable_get('user_mail_status_canceled_notify', FALSE),
3356
    '#description' => t('When enabled, the user will receive an e-mail notification after the account has been cancelled.'),
3357
  );
3358

    
3359
  return confirm_form($form,
3360
                      t('Are you sure you want to cancel these user accounts?'),
3361
                      'admin/people', t('This action cannot be undone.'),
3362
                      t('Cancel accounts'), t('Cancel'));
3363
}
3364

    
3365
/**
3366
 * Submit handler for mass-account cancellation form.
3367
 *
3368
 * @see user_multiple_cancel_confirm()
3369
 * @see user_cancel_confirm_form_submit()
3370
 */
3371
function user_multiple_cancel_confirm_submit($form, &$form_state) {
3372
  global $user;
3373

    
3374
  if ($form_state['values']['confirm']) {
3375
    foreach ($form_state['values']['accounts'] as $uid => $value) {
3376
      // Prevent programmatic form submissions from cancelling user 1.
3377
      if ($uid <= 1) {
3378
        continue;
3379
      }
3380
      // Prevent user administrators from deleting themselves without confirmation.
3381
      if ($uid == $user->uid) {
3382
        $admin_form_state = $form_state;
3383
        unset($admin_form_state['values']['user_cancel_confirm']);
3384
        $admin_form_state['values']['_account'] = $user;
3385
        user_cancel_confirm_form_submit(array(), $admin_form_state);
3386
      }
3387
      else {
3388
        user_cancel($form_state['values'], $uid, $form_state['values']['user_cancel_method']);
3389
      }
3390
    }
3391
  }
3392
  $form_state['redirect'] = 'admin/people';
3393
}
3394

    
3395
/**
3396
 * Retrieve a list of all user setting/information categories and sort them by weight.
3397
 */
3398
function _user_categories() {
3399
  $categories = module_invoke_all('user_categories');
3400
  usort($categories, '_user_sort');
3401

    
3402
  return $categories;
3403
}
3404

    
3405
function _user_sort($a, $b) {
3406
  $a = (array) $a + array('weight' => 0, 'title' => '');
3407
  $b = (array) $b + array('weight' => 0, 'title' => '');
3408
  return $a['weight'] < $b['weight'] ? -1 : ($a['weight'] > $b['weight'] ? 1 : ($a['title'] < $b['title'] ? -1 : 1));
3409
}
3410

    
3411
/**
3412
 * List user administration filters that can be applied.
3413
 */
3414
function user_filters() {
3415
  // Regular filters
3416
  $filters = array();
3417
  $roles = user_roles(TRUE);
3418
  unset($roles[DRUPAL_AUTHENTICATED_RID]); // Don't list authorized role.
3419
  if (count($roles)) {
3420
    $filters['role'] = array(
3421
      'title' => t('role'),
3422
      'field' => 'ur.rid',
3423
      'options' => array(
3424
        '[any]' => t('any'),
3425
      ) + $roles,
3426
    );
3427
  }
3428

    
3429
  $options = array();
3430
  foreach (module_implements('permission') as $module) {
3431
    $function = $module . '_permission';
3432
    if ($permissions = $function()) {
3433
      asort($permissions);
3434
      foreach ($permissions as $permission => $description) {
3435
        $options[t('@module module', array('@module' => $module))][$permission] = t($permission);
3436
      }
3437
    }
3438
  }
3439
  ksort($options);
3440
  $filters['permission'] = array(
3441
    'title' => t('permission'),
3442
    'options' => array(
3443
      '[any]' => t('any'),
3444
    ) + $options,
3445
  );
3446

    
3447
  $filters['status'] = array(
3448
    'title' => t('status'),
3449
    'field' => 'u.status',
3450
    'options' => array(
3451
      '[any]' => t('any'),
3452
      1 => t('active'),
3453
      0 => t('blocked'),
3454
    ),
3455
  );
3456
  return $filters;
3457
}
3458

    
3459
/**
3460
 * Extends a query object for user administration filters based on session.
3461
 *
3462
 * @param $query
3463
 *   Query object that should be filtered.
3464
 */
3465
function user_build_filter_query(SelectQuery $query) {
3466
  $filters = user_filters();
3467
  // Extend Query with filter conditions.
3468
  foreach (isset($_SESSION['user_overview_filter']) ? $_SESSION['user_overview_filter'] : array() as $filter) {
3469
    list($key, $value) = $filter;
3470
    // This checks to see if this permission filter is an enabled permission for
3471
    // the authenticated role. If so, then all users would be listed, and we can
3472
    // skip adding it to the filter query.
3473
    if ($key == 'permission') {
3474
      $account = new stdClass();
3475
      $account->uid = 'user_filter';
3476
      $account->roles = array(DRUPAL_AUTHENTICATED_RID => 1);
3477
      if (user_access($value, $account)) {
3478
        continue;
3479
      }
3480
      $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
3481
      $permission_alias = $query->join('role_permission', 'p', $users_roles_alias . '.rid = %alias.rid');
3482
      $query->condition($permission_alias . '.permission', $value);
3483
    }
3484
    elseif ($key == 'role') {
3485
      $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
3486
      $query->condition($users_roles_alias . '.rid' , $value);
3487
    }
3488
    else {
3489
      $query->condition($filters[$key]['field'], $value);
3490
    }
3491
  }
3492
}
3493

    
3494
/**
3495
 * Implements hook_comment_view().
3496
 */
3497
function user_comment_view($comment) {
3498
  if (variable_get('user_signatures', 0) && !empty($comment->signature)) {
3499
    // @todo This alters and replaces the original object value, so a
3500
    //   hypothetical process of loading, viewing, and saving will hijack the
3501
    //   stored data. Consider renaming to $comment->signature_safe or similar
3502
    //   here and elsewhere in Drupal 8.
3503
    $comment->signature = check_markup($comment->signature, $comment->signature_format, '', TRUE);
3504
  }
3505
  else {
3506
    $comment->signature = '';
3507
  }
3508
}
3509

    
3510
/**
3511
 * Returns HTML for a user signature.
3512
 *
3513
 * @param $variables
3514
 *   An associative array containing:
3515
 *   - signature: The user's signature.
3516
 *
3517
 * @ingroup themeable
3518
 */
3519
function theme_user_signature($variables) {
3520
  $signature = $variables['signature'];
3521
  $output = '';
3522

    
3523
  if ($signature) {
3524
    $output .= '<div class="clear">';
3525
    $output .= '<div>—</div>';
3526
    $output .= $signature;
3527
    $output .= '</div>';
3528
  }
3529

    
3530
  return $output;
3531
}
3532

    
3533
/**
3534
 * Get the language object preferred by the user. This user preference can
3535
 * be set on the user account editing page, and is only available if there
3536
 * are more than one languages enabled on the site. If the user did not
3537
 * choose a preferred language, or is the anonymous user, the $default
3538
 * value, or if it is not set, the site default language will be returned.
3539
 *
3540
 * @param $account
3541
 *   User account to look up language for.
3542
 * @param $default
3543
 *   Optional default language object to return if the account
3544
 *   has no valid language.
3545
 */
3546
function user_preferred_language($account, $default = NULL) {
3547
  $language_list = language_list();
3548
  if (!empty($account->language) && isset($language_list[$account->language])) {
3549
    return $language_list[$account->language];
3550
  }
3551
  else {
3552
    return $default ? $default : language_default();
3553
  }
3554
}
3555

    
3556
/**
3557
 * Conditionally create and send a notification email when a certain
3558
 * operation happens on the given user account.
3559
 *
3560
 * @see user_mail_tokens()
3561
 * @see drupal_mail()
3562
 *
3563
 * @param $op
3564
 *   The operation being performed on the account. Possible values:
3565
 *   - 'register_admin_created': Welcome message for user created by the admin.
3566
 *   - 'register_no_approval_required': Welcome message when user
3567
 *     self-registers.
3568
 *   - 'register_pending_approval': Welcome message, user pending admin
3569
 *     approval.
3570
 *   - 'password_reset': Password recovery request.
3571
 *   - 'status_activated': Account activated.
3572
 *   - 'status_blocked': Account blocked.
3573
 *   - 'cancel_confirm': Account cancellation request.
3574
 *   - 'status_canceled': Account canceled.
3575
 *
3576
 * @param $account
3577
 *   The user object of the account being notified. Must contain at
3578
 *   least the fields 'uid', 'name', and 'mail'.
3579
 * @param $language
3580
 *   Optional language to use for the notification, overriding account language.
3581
 *
3582
 * @return
3583
 *   The return value from drupal_mail_system()->mail(), if ends up being
3584
 *   called.
3585
 */
3586
function _user_mail_notify($op, $account, $language = NULL) {
3587
  // By default, we always notify except for canceled and blocked.
3588
  $default_notify = ($op != 'status_canceled' && $op != 'status_blocked');
3589
  $notify = variable_get('user_mail_' . $op . '_notify', $default_notify);
3590
  if ($notify) {
3591
    $params['account'] = $account;
3592
    $language = $language ? $language : user_preferred_language($account);
3593
    $mail = drupal_mail('user', $op, $account->mail, $language, $params);
3594
    if ($op == 'register_pending_approval') {
3595
      // If a user registered requiring admin approval, notify the admin, too.
3596
      // We use the site default language for this.
3597
      drupal_mail('user', 'register_pending_approval_admin', variable_get('site_mail', ini_get('sendmail_from')), language_default(), $params);
3598
    }
3599
  }
3600
  return empty($mail) ? NULL : $mail['result'];
3601
}
3602

    
3603
/**
3604
 * Form element process handler for client-side password validation.
3605
 *
3606
 * This #process handler is automatically invoked for 'password_confirm' form
3607
 * elements to add the JavaScript and string translations for dynamic password
3608
 * validation.
3609
 *
3610
 * @see system_element_info()
3611
 */
3612
function user_form_process_password_confirm($element) {
3613
  global $user;
3614

    
3615
  $js_settings = array(
3616
    'password' => array(
3617
      'strengthTitle' => t('Password strength:'),
3618
      'hasWeaknesses' => t('To make your password stronger:'),
3619
      'tooShort' => t('Make it at least 6 characters'),
3620
      'addLowerCase' => t('Add lowercase letters'),
3621
      'addUpperCase' => t('Add uppercase letters'),
3622
      'addNumbers' => t('Add numbers'),
3623
      'addPunctuation' => t('Add punctuation'),
3624
      'sameAsUsername' => t('Make it different from your username'),
3625
      'confirmSuccess' => t('yes'),
3626
      'confirmFailure' => t('no'),
3627
      'weak' => t('Weak'),
3628
      'fair' => t('Fair'),
3629
      'good' => t('Good'),
3630
      'strong' => t('Strong'),
3631
      'confirmTitle' => t('Passwords match:'),
3632
      'username' => (isset($user->name) ? $user->name : ''),
3633
    ),
3634
  );
3635

    
3636
  $element['#attached']['js'][] = drupal_get_path('module', 'user') . '/user.js';
3637
  // Ensure settings are only added once per page.
3638
  static $already_added = FALSE;
3639
  if (!$already_added) {
3640
    $already_added = TRUE;
3641
    $element['#attached']['js'][] = array('data' => $js_settings, 'type' => 'setting');
3642
  }
3643

    
3644
  return $element;
3645
}
3646

    
3647
/**
3648
 * Implements hook_node_load().
3649
 */
3650
function user_node_load($nodes, $types) {
3651
  // Build an array of all uids for node authors, keyed by nid.
3652
  $uids = array();
3653
  foreach ($nodes as $nid => $node) {
3654
    $uids[$nid] = $node->uid;
3655
  }
3656

    
3657
  // Fetch name, picture, and data for these users.
3658
  $user_fields = db_query("SELECT uid, name, picture, data FROM {users} WHERE uid IN (:uids)", array(':uids' => $uids))->fetchAllAssoc('uid');
3659

    
3660
  // Add these values back into the node objects.
3661
  foreach ($uids as $nid => $uid) {
3662
    $nodes[$nid]->name = $user_fields[$uid]->name;
3663
    $nodes[$nid]->picture = $user_fields[$uid]->picture;
3664
    $nodes[$nid]->data = $user_fields[$uid]->data;
3665
  }
3666
}
3667

    
3668
/**
3669
 * Implements hook_image_style_delete().
3670
 */
3671
function user_image_style_delete($style) {
3672
  // If a style is deleted, update the variables.
3673
  // Administrators choose a replacement style when deleting.
3674
  user_image_style_save($style);
3675
}
3676

    
3677
/**
3678
 * Implements hook_image_style_save().
3679
 */
3680
function user_image_style_save($style) {
3681
  // If a style is renamed, update the variables that use it.
3682
  if (isset($style['old_name']) && $style['old_name'] == variable_get('user_picture_style', '')) {
3683
    variable_set('user_picture_style', $style['name']);
3684
  }
3685
}
3686

    
3687
/**
3688
 * Implements hook_action_info().
3689
 */
3690
function user_action_info() {
3691
  return array(
3692
    'user_block_user_action' => array(
3693
      'label' => t('Block current user'),
3694
      'type' => 'user',
3695
      'configurable' => FALSE,
3696
      'triggers' => array('any'),
3697
    ),
3698
  );
3699
}
3700

    
3701
/**
3702
 * Blocks a specific user or the current user, if one is not specified.
3703
 *
3704
 * @param $entity
3705
 *   (optional) An entity object; if it is provided and it has a uid property,
3706
 *   the user with that ID is blocked.
3707
 * @param $context
3708
 *   (optional) An associative array; if no user ID is found in $entity, the
3709
 *   'uid' element of this array determines the user to block.
3710
 *
3711
 * @ingroup actions
3712
 */
3713
function user_block_user_action(&$entity, $context = array()) {
3714
  // First priority: If there is a $entity->uid, block that user.
3715
  // This is most likely a user object or the author if a node or comment.
3716
  if (isset($entity->uid)) {
3717
    $uid = $entity->uid;
3718
  }
3719
  elseif (isset($context['uid'])) {
3720
    $uid = $context['uid'];
3721
  }
3722
  // If neither of those are valid, then block the current user.
3723
  else {
3724
    $uid = $GLOBALS['user']->uid;
3725
  }
3726
  $account = user_load($uid);
3727
  $account = user_save($account, array('status' => 0));
3728
  watchdog('action', 'Blocked user %name.', array('%name' => $account->name));
3729
}
3730

    
3731
/**
3732
 * Implements hook_form_FORM_ID_alter().
3733
 *
3734
 * Add a checkbox for the 'user_register_form' instance settings on the 'Edit
3735
 * field instance' form.
3736
 */
3737
function user_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
3738
  $instance = $form['#instance'];
3739

    
3740
  if ($instance['entity_type'] == 'user' && !$form['#field']['locked']) {
3741
    $form['instance']['settings']['user_register_form'] = array(
3742
      '#type' => 'checkbox',
3743
      '#title' => t('Display on user registration form.'),
3744
      '#description' => t("This is compulsory for 'required' fields."),
3745
      // Field instances created in D7 beta releases before the setting was
3746
      // introduced might be set as 'required' and 'not shown on user_register
3747
      // form'. We make sure the checkbox comes as 'checked' for those.
3748
      '#default_value' => $instance['settings']['user_register_form'] || $instance['required'],
3749
      // Display just below the 'required' checkbox.
3750
      '#weight' => $form['instance']['required']['#weight'] + .1,
3751
      // Disabled when the 'required' checkbox is checked.
3752
      '#states' => array(
3753
        'enabled' => array('input[name="instance[required]"]' => array('checked' => FALSE)),
3754
      ),
3755
      // Checked when the 'required' checkbox is checked. This is done through
3756
      // a custom behavior, since the #states system would also synchronize on
3757
      // uncheck.
3758
      '#attached' => array(
3759
        'js' => array(drupal_get_path('module', 'user') . '/user.js'),
3760
      ),
3761
    );
3762

    
3763
    array_unshift($form['#submit'], 'user_form_field_ui_field_edit_form_submit');
3764
  }
3765
}
3766

    
3767
/**
3768
 * Additional submit handler for the 'Edit field instance' form.
3769
 *
3770
 * Make sure the 'user_register_form' setting is set for required fields.
3771
 */
3772
function user_form_field_ui_field_edit_form_submit($form, &$form_state) {
3773
  $instance = $form_state['values']['instance'];
3774

    
3775
  if (!empty($instance['required'])) {
3776
    form_set_value($form['instance']['settings']['user_register_form'], 1, $form_state);
3777
  }
3778
}
3779

    
3780
/**
3781
 * Form builder; the user registration form.
3782
 *
3783
 * @ingroup forms
3784
 * @see user_account_form()
3785
 * @see user_account_form_validate()
3786
 * @see user_register_submit()
3787
 */
3788
function user_register_form($form, &$form_state) {
3789
  global $user;
3790

    
3791
  $admin = user_access('administer users');
3792

    
3793
  // Pass access information to the submit handler. Running an access check
3794
  // inside the submit function interferes with form processing and breaks
3795
  // hook_form_alter().
3796
  $form['administer_users'] = array(
3797
    '#type' => 'value',
3798
    '#value' => $admin,
3799
  );
3800

    
3801
  // If we aren't admin but already logged on, go to the user page instead.
3802
  if (!$admin && $user->uid) {
3803
    drupal_goto('user/' . $user->uid);
3804
  }
3805

    
3806
  $form['#user'] = drupal_anonymous_user();
3807
  $form['#user_category'] = 'register';
3808

    
3809
  $form['#attached']['library'][] = array('system', 'jquery.cookie');
3810
  $form['#attributes']['class'][] = 'user-info-from-cookie';
3811

    
3812
  // Start with the default user account fields.
3813
  user_account_form($form, $form_state);
3814

    
3815
  // Attach field widgets, and hide the ones where the 'user_register_form'
3816
  // setting is not on.
3817
  $langcode = entity_language('user', $form['#user']);
3818
  field_attach_form('user', $form['#user'], $form, $form_state, $langcode);
3819
  foreach (field_info_instances('user', 'user') as $field_name => $instance) {
3820
    if (empty($instance['settings']['user_register_form'])) {
3821
      $form[$field_name]['#access'] = FALSE;
3822
    }
3823
  }
3824

    
3825
  if ($admin) {
3826
    // Redirect back to page which initiated the create request;
3827
    // usually admin/people/create.
3828
    $form_state['redirect'] = $_GET['q'];
3829
  }
3830

    
3831
  $form['actions'] = array('#type' => 'actions');
3832
  $form['actions']['submit'] = array(
3833
    '#type' => 'submit',
3834
    '#value' => t('Create new account'),
3835
  );
3836

    
3837
  $form['#validate'][] = 'user_register_validate';
3838
  // Add the final user registration form submit handler.
3839
  $form['#submit'][] = 'user_register_submit';
3840

    
3841
  return $form;
3842
}
3843

    
3844
/**
3845
 * Validation function for the user registration form.
3846
 */
3847
function user_register_validate($form, &$form_state) {
3848
  entity_form_field_validate('user', $form, $form_state);
3849
}
3850

    
3851
/**
3852
 * Submit handler for the user registration form.
3853
 *
3854
 * This function is shared by the installation form and the normal registration form,
3855
 * which is why it can't be in the user.pages.inc file.
3856
 *
3857
 * @see user_register_form()
3858
 */
3859
function user_register_submit($form, &$form_state) {
3860
  $admin = $form_state['values']['administer_users'];
3861

    
3862
  if (!variable_get('user_email_verification', TRUE) || $admin) {
3863
    $pass = $form_state['values']['pass'];
3864
  }
3865
  else {
3866
    $pass = user_password();
3867
  }
3868
  $notify = !empty($form_state['values']['notify']);
3869

    
3870
  // Remove unneeded values.
3871
  form_state_values_clean($form_state);
3872

    
3873
  $form_state['values']['pass'] = $pass;
3874
  $form_state['values']['init'] = $form_state['values']['mail'];
3875

    
3876
  $account = $form['#user'];
3877

    
3878
  entity_form_submit_build_entity('user', $account, $form, $form_state);
3879

    
3880
  // Populate $edit with the properties of $account, which have been edited on
3881
  // this form by taking over all values, which appear in the form values too.
3882
  $edit = array_intersect_key((array) $account, $form_state['values']);
3883
  $account = user_save($account, $edit);
3884

    
3885
  // Terminate if an error occurred during user_save().
3886
  if (!$account) {
3887
    drupal_set_message(t("Error saving user account."), 'error');
3888
    $form_state['redirect'] = '';
3889
    return;
3890
  }
3891
  $form_state['user'] = $account;
3892
  $form_state['values']['uid'] = $account->uid;
3893

    
3894
  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'));
3895

    
3896
  // Add plain text password into user account to generate mail tokens.
3897
  $account->password = $pass;
3898

    
3899
  // New administrative account without notification.
3900
  $uri = entity_uri('user', $account);
3901
  if ($admin && !$notify) {
3902
    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)));
3903
  }
3904
  // No e-mail verification required; log in user immediately.
3905
  elseif (!$admin && !variable_get('user_email_verification', TRUE) && $account->status) {
3906
    _user_mail_notify('register_no_approval_required', $account);
3907
    $form_state['uid'] = $account->uid;
3908
    user_login_submit(array(), $form_state);
3909
    drupal_set_message(t('Registration successful. You are now logged in.'));
3910
    $form_state['redirect'] = '';
3911
  }
3912
  // No administrator approval required.
3913
  elseif ($account->status || $notify) {
3914
    $op = $notify ? 'register_admin_created' : 'register_no_approval_required';
3915
    _user_mail_notify($op, $account);
3916
    if ($notify) {
3917
      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)));
3918
    }
3919
    else {
3920
      drupal_set_message(t('A welcome message with further instructions has been sent to your e-mail address.'));
3921
      $form_state['redirect'] = '';
3922
    }
3923
  }
3924
  // Administrator approval required.
3925
  else {
3926
    _user_mail_notify('register_pending_approval', $account);
3927
    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.'));
3928
    $form_state['redirect'] = '';
3929
  }
3930
}
3931

    
3932
/**
3933
 * Implements hook_modules_installed().
3934
 */
3935
function user_modules_installed($modules) {
3936
  // Assign all available permissions to the administrator role.
3937
  $rid = variable_get('user_admin_role', 0);
3938
  if ($rid) {
3939
    $permissions = array();
3940
    foreach ($modules as $module) {
3941
      if ($module_permissions = module_invoke($module, 'permission')) {
3942
        $permissions = array_merge($permissions, array_keys($module_permissions));
3943
      }
3944
    }
3945
    if (!empty($permissions)) {
3946
      user_role_grant_permissions($rid, $permissions);
3947
    }
3948
  }
3949
}
3950

    
3951
/**
3952
 * Implements hook_modules_uninstalled().
3953
 */
3954
function user_modules_uninstalled($modules) {
3955
   db_delete('role_permission')
3956
     ->condition('module', $modules, 'IN')
3957
     ->execute();
3958
}
3959

    
3960
/**
3961
 * Helper function to rewrite the destination to avoid redirecting to login page after login.
3962
 *
3963
 * Third-party authentication modules may use this function to determine the
3964
 * proper destination after a user has been properly logged in.
3965
 */
3966
function user_login_destination() {
3967
  $destination = drupal_get_destination();
3968
  if ($destination['destination'] == 'user/login') {
3969
    $destination['destination'] = 'user';
3970
  }
3971
  return $destination;
3972
}
3973

    
3974
/**
3975
 * Saves visitor information as a cookie so it can be reused.
3976
 *
3977
 * @param $values
3978
 *   An array of key/value pairs to be saved into a cookie.
3979
 */
3980
function user_cookie_save(array $values) {
3981
  foreach ($values as $field => $value) {
3982
    // Set cookie for 365 days.
3983
    setrawcookie('Drupal.visitor.' . $field, rawurlencode($value), REQUEST_TIME + 31536000, '/');
3984
  }
3985
}
3986

    
3987
/**
3988
 * Delete a visitor information cookie.
3989
 *
3990
 * @param $cookie_name
3991
 *   A cookie name such as 'homepage'.
3992
 */
3993
function user_cookie_delete($cookie_name) {
3994
  setrawcookie('Drupal.visitor.' . $cookie_name, '', REQUEST_TIME - 3600, '/');
3995
}
3996

    
3997
/**
3998
 * Implements hook_rdf_mapping().
3999
 */
4000
function user_rdf_mapping() {
4001
  return array(
4002
    array(
4003
      'type' => 'user',
4004
      'bundle' => RDF_DEFAULT_BUNDLE,
4005
      'mapping' => array(
4006
        'rdftype' => array('sioc:UserAccount'),
4007
        'name' => array(
4008
          'predicates' => array('foaf:name'),
4009
        ),
4010
        'homepage' => array(
4011
          'predicates' => array('foaf:page'),
4012
          'type' => 'rel',
4013
        ),
4014
      ),
4015
    ),
4016
  );
4017
}
4018

    
4019
/**
4020
 * Implements hook_file_download_access().
4021
 */
4022
function user_file_download_access($field, $entity_type, $entity) {
4023
  if ($entity_type == 'user') {
4024
    return user_view_access($entity);
4025
  }
4026
}
4027

    
4028
/**
4029
 * Implements hook_system_info_alter().
4030
 *
4031
 * Drupal 7 ships with two methods to add additional fields to users: Profile
4032
 * module, a legacy module dating back from 2002, and Field API integration
4033
 * with users. While Field API support for users currently provides less end
4034
 * user features, the inefficient data storage mechanism of Profile module, as
4035
 * well as its lack of consistency with the rest of the entity / field based
4036
 * systems in Drupal 7, make this a sub-optimal solution to those who were not
4037
 * using it in previous releases of Drupal.
4038
 *
4039
 * To prevent new Drupal 7 sites from installing Profile module, and
4040
 * unwittingly ending up with two completely different and incompatible methods
4041
 * of extending users, only make the Profile module available if the profile_*
4042
 * tables are present.
4043
 *
4044
 * @todo: Remove in D8, pending upgrade path.
4045
 */
4046
function user_system_info_alter(&$info, $file, $type) {
4047
  if ($type == 'module' && $file->name == 'profile' && db_table_exists('profile_field')) {
4048
    $info['hidden'] = FALSE;
4049
  }
4050
}