Projet

Général

Profil

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

root / drupal7 / modules / user / user.module @ 582db59d

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
 * Implements 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
 * Checks if a user has a role.
853
 *
854
 * @param int $rid
855
 *   A role ID.
856
 *
857
 * @param object|null $account
858
 *   (optional) A user account. Defaults to the current user.
859
 *
860
 * @return bool
861
 *   TRUE if the user has the role, or FALSE if not.
862
 */
863
function user_has_role($rid, $account = NULL) {
864
  if (!$account) {
865
    $account = $GLOBALS['user'];
866
  }
867

    
868
  return isset($account->roles[$rid]);
869
}
870

    
871
/**
872
 * Implements hook_permission().
873
 */
874
function user_permission() {
875
  return array(
876
    'administer permissions' =>  array(
877
      'title' => t('Administer permissions'),
878
      'restrict access' => TRUE,
879
    ),
880
    'administer users' => array(
881
      'title' => t('Administer users'),
882
      'restrict access' => TRUE,
883
    ),
884
    'access user profiles' => array(
885
      'title' => t('View user profiles'),
886
    ),
887
    'change own username' => array(
888
      'title' => t('Change own username'),
889
    ),
890
    'cancel account' => array(
891
      'title' => t('Cancel own user account'),
892
      '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'))),
893
    ),
894
    'select account cancellation method' => array(
895
      'title' => t('Select method for cancelling own account'),
896
      'restrict access' => TRUE,
897
    ),
898
  );
899
}
900

    
901
/**
902
 * Implements hook_file_download().
903
 *
904
 * Ensure that user pictures (avatars) are always downloadable.
905
 */
906
function user_file_download($uri) {
907
  if (strpos(file_uri_target($uri), variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
908
    $info = image_get_info($uri);
909
    return array('Content-Type' => $info['mime_type']);
910
  }
911
}
912

    
913
/**
914
 * Implements hook_file_move().
915
 */
916
function user_file_move($file, $source) {
917
  // If a user's picture is replaced with a new one, update the record in
918
  // the users table.
919
  if (isset($file->fid) && isset($source->fid) && $file->fid != $source->fid) {
920
    db_update('users')
921
      ->fields(array(
922
        'picture' => $file->fid,
923
      ))
924
      ->condition('picture', $source->fid)
925
      ->execute();
926
  }
927
}
928

    
929
/**
930
 * Implements hook_file_delete().
931
 */
932
function user_file_delete($file) {
933
  // Remove any references to the file.
934
  db_update('users')
935
    ->fields(array('picture' => 0))
936
    ->condition('picture', $file->fid)
937
    ->execute();
938
}
939

    
940
/**
941
 * Implements hook_search_info().
942
 */
943
function user_search_info() {
944
  return array(
945
    'title' => 'Users',
946
  );
947
}
948

    
949
/**
950
 * Implements hook_search_access().
951
 */
952
function user_search_access() {
953
  return user_access('access user profiles');
954
}
955

    
956
/**
957
 * Implements hook_search_execute().
958
 */
959
function user_search_execute($keys = NULL, $conditions = NULL) {
960
  $find = array();
961
  // Replace wildcards with MySQL/PostgreSQL wildcards.
962
  $keys = preg_replace('!\*+!', '%', $keys);
963
  $query = db_select('users')->extend('PagerDefault');
964
  $query->fields('users', array('uid'));
965
  if (user_access('administer users')) {
966
    // Administrators can also search in the otherwise private email field,
967
    // and they don't need to be restricted to only active users.
968
    $query->fields('users', array('mail'));
969
    $query->condition(db_or()->
970
      condition('name', '%' . db_like($keys) . '%', 'LIKE')->
971
      condition('mail', '%' . db_like($keys) . '%', 'LIKE'));
972
  }
973
  else {
974
    // Regular users can only search via usernames, and we do not show them
975
    // blocked accounts.
976
    $query->condition('name', '%' . db_like($keys) . '%', 'LIKE')
977
      ->condition('status', 1);
978
  }
979
  $uids = $query
980
    ->limit(15)
981
    ->execute()
982
    ->fetchCol();
983
  $accounts = user_load_multiple($uids);
984

    
985
  $results = array();
986
  foreach ($accounts as $account) {
987
    $result = array(
988
      'title' => format_username($account),
989
      'link' => url('user/' . $account->uid, array('absolute' => TRUE)),
990
    );
991
    if (user_access('administer users')) {
992
      $result['title'] .= ' (' . $account->mail . ')';
993
    }
994
    $results[] = $result;
995
  }
996

    
997
  return $results;
998
}
999

    
1000
/**
1001
 * Implements hook_element_info().
1002
 */
1003
function user_element_info() {
1004
  $types['user_profile_category'] = array(
1005
    '#theme_wrappers' => array('user_profile_category'),
1006
  );
1007
  $types['user_profile_item'] = array(
1008
    '#theme' => 'user_profile_item',
1009
  );
1010
  return $types;
1011
}
1012

    
1013
/**
1014
 * Implements hook_user_view().
1015
 */
1016
function user_user_view($account) {
1017
  $account->content['user_picture'] = array(
1018
    '#markup' => theme('user_picture', array('account' => $account)),
1019
    '#weight' => -10,
1020
  );
1021
  if (!isset($account->content['summary'])) {
1022
    $account->content['summary'] = array();
1023
  }
1024
  $account->content['summary'] += array(
1025
    '#type' => 'user_profile_category',
1026
    '#attributes' => array('class' => array('user-member')),
1027
    '#weight' => 5,
1028
    '#title' => t('History'),
1029
  );
1030
  $account->content['summary']['member_for'] = array(
1031
    '#type' => 'user_profile_item',
1032
    '#title' => t('Member for'),
1033
    '#markup' => format_interval(REQUEST_TIME - $account->created),
1034
  );
1035
}
1036

    
1037
/**
1038
 * Helper function to add default user account fields to user registration and edit form.
1039
 *
1040
 * @see user_account_form_validate()
1041
 * @see user_validate_current_pass()
1042
 * @see user_validate_picture()
1043
 * @see user_validate_mail()
1044
 */
1045
function user_account_form(&$form, &$form_state) {
1046
  global $user;
1047

    
1048
  $account = $form['#user'];
1049
  $register = ($form['#user']->uid > 0 ? FALSE : TRUE);
1050

    
1051
  $admin = user_access('administer users');
1052

    
1053
  $form['#validate'][] = 'user_account_form_validate';
1054

    
1055
  // Account information.
1056
  $form['account'] = array(
1057
    '#type'   => 'container',
1058
    '#weight' => -10,
1059
  );
1060
  // Only show name field on registration form or user can change own username.
1061
  $form['account']['name'] = array(
1062
    '#type' => 'textfield',
1063
    '#title' => t('Username'),
1064
    '#maxlength' => USERNAME_MAX_LENGTH,
1065
    '#description' => t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'),
1066
    '#required' => TRUE,
1067
    '#attributes' => array('class' => array('username')),
1068
    '#default_value' => (!$register ? $account->name : ''),
1069
    '#access' => ($register || ($user->uid == $account->uid && user_access('change own username')) || $admin),
1070
    '#weight' => -10,
1071
  );
1072

    
1073
  $form['account']['mail'] = array(
1074
    '#type' => 'textfield',
1075
    '#title' => t('E-mail address'),
1076
    '#maxlength' => EMAIL_MAX_LENGTH,
1077
    '#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.'),
1078
    '#required' => TRUE,
1079
    '#default_value' => (!$register ? $account->mail : ''),
1080
  );
1081

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

    
1133
  if ($admin) {
1134
    $status = isset($account->status) ? $account->status : 1;
1135
  }
1136
  else {
1137
    $status = $register ? variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL) == USER_REGISTER_VISITORS : $account->status;
1138
  }
1139
  $form['account']['status'] = array(
1140
    '#type' => 'radios',
1141
    '#title' => t('Status'),
1142
    '#default_value' => $status,
1143
    '#options' => array(t('Blocked'), t('Active')),
1144
    '#access' => $admin,
1145
  );
1146

    
1147
  $roles = array_map('check_plain', user_roles(TRUE));
1148
  // The disabled checkbox subelement for the 'authenticated user' role
1149
  // must be generated separately and added to the checkboxes element,
1150
  // because of a limitation in Form API not supporting a single disabled
1151
  // checkbox within a set of checkboxes.
1152
  // @todo This should be solved more elegantly. See issue #119038.
1153
  $checkbox_authenticated = array(
1154
    '#type' => 'checkbox',
1155
    '#title' => $roles[DRUPAL_AUTHENTICATED_RID],
1156
    '#default_value' => TRUE,
1157
    '#disabled' => TRUE,
1158
  );
1159
  unset($roles[DRUPAL_AUTHENTICATED_RID]);
1160
  $form['account']['roles'] = array(
1161
    '#type' => 'checkboxes',
1162
    '#title' => t('Roles'),
1163
    '#default_value' => (!$register && isset($account->roles) ? array_keys($account->roles) : array()),
1164
    '#options' => $roles,
1165
    '#access' => $roles && user_access('administer permissions'),
1166
    DRUPAL_AUTHENTICATED_RID => $checkbox_authenticated,
1167
  );
1168

    
1169
  $form['account']['notify'] = array(
1170
    '#type' => 'checkbox',
1171
    '#title' => t('Notify user of new account'),
1172
    '#access' => $register && $admin,
1173
  );
1174

    
1175
  // Signature.
1176
  $form['signature_settings'] = array(
1177
    '#type' => 'fieldset',
1178
    '#title' => t('Signature settings'),
1179
    '#weight' => 1,
1180
    '#access' => (!$register && variable_get('user_signatures', 0)),
1181
  );
1182

    
1183
  $form['signature_settings']['signature'] = array(
1184
    '#type' => 'text_format',
1185
    '#title' => t('Signature'),
1186
    '#default_value' => isset($account->signature) ? $account->signature : '',
1187
    '#description' => t('Your signature will be publicly displayed at the end of your comments.'),
1188
    '#format' => isset($account->signature_format) ? $account->signature_format : NULL,
1189
  );
1190

    
1191
  // Picture/avatar.
1192
  $form['picture'] = array(
1193
    '#type' => 'fieldset',
1194
    '#title' => t('Picture'),
1195
    '#weight' => 1,
1196
    '#access' => (!$register && variable_get('user_pictures', 0)),
1197
  );
1198
  $form['picture']['picture'] = array(
1199
    '#type' => 'value',
1200
    '#value' => isset($account->picture) ? $account->picture : NULL,
1201
  );
1202
  $form['picture']['picture_current'] = array(
1203
    '#markup' => theme('user_picture', array('account' => $account)),
1204
  );
1205
  $form['picture']['picture_delete'] = array(
1206
    '#type' => 'checkbox',
1207
    '#title' => t('Delete picture'),
1208
    '#access' => !empty($account->picture->fid),
1209
    '#description' => t('Check this box to delete your current picture.'),
1210
  );
1211
  $form['picture']['picture_upload'] = array(
1212
    '#type' => 'file',
1213
    '#title' => t('Upload picture'),
1214
    '#size' => 48,
1215
    '#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', '')),
1216
  );
1217
  $form['#validate'][] = 'user_validate_picture';
1218
}
1219

    
1220
/**
1221
 * Form validation handler for the current password on the user_account_form().
1222
 *
1223
 * @see user_account_form()
1224
 */
1225
function user_validate_current_pass(&$form, &$form_state) {
1226
  $account = $form['#user'];
1227
  foreach ($form_state['values']['current_pass_required_values'] as $key => $name) {
1228
    // This validation only works for required textfields (like mail) or
1229
    // form values like password_confirm that have their own validation
1230
    // that prevent them from being empty if they are changed.
1231
    if ((strlen(trim($form_state['values'][$key])) > 0) && ($form_state['values'][$key] != $account->$key)) {
1232
      require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
1233
      $current_pass_failed = empty($form_state['values']['current_pass']) || !user_check_password($form_state['values']['current_pass'], $account);
1234
      if ($current_pass_failed) {
1235
        form_set_error('current_pass', t("Your current password is missing or incorrect; it's required to change the %name.", array('%name' => $name)));
1236
        form_set_error($key);
1237
      }
1238
      // We only need to check the password once.
1239
      break;
1240
    }
1241
  }
1242
}
1243

    
1244
/**
1245
 * Form validation handler for user_account_form().
1246
 *
1247
 * @see user_account_form()
1248
 */
1249
function user_account_form_validate($form, &$form_state) {
1250
  if ($form['#user_category'] == 'account' || $form['#user_category'] == 'register') {
1251
    $account = $form['#user'];
1252
    // Validate new or changing username.
1253
    if (isset($form_state['values']['name'])) {
1254
      if ($error = user_validate_name($form_state['values']['name'])) {
1255
        form_set_error('name', $error);
1256
      }
1257
      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()) {
1258
        form_set_error('name', t('The name %name is already taken.', array('%name' => $form_state['values']['name'])));
1259
      }
1260
    }
1261

    
1262
    // Trim whitespace from mail, to prevent confusing 'e-mail not valid'
1263
    // warnings often caused by cutting and pasting.
1264
    $mail = trim($form_state['values']['mail']);
1265
    form_set_value($form['account']['mail'], $mail, $form_state);
1266

    
1267
    // Validate the e-mail address, and check if it is taken by an existing user.
1268
    if ($error = user_validate_mail($form_state['values']['mail'])) {
1269
      form_set_error('mail', $error);
1270
    }
1271
    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()) {
1272
      // Format error message dependent on whether the user is logged in or not.
1273
      if ($GLOBALS['user']->uid) {
1274
        form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $form_state['values']['mail'])));
1275
      }
1276
      else {
1277
        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'))));
1278
      }
1279
    }
1280

    
1281
    // Make sure the signature isn't longer than the size of the database field.
1282
    // Signatures are disabled by default, so make sure it exists first.
1283
    if (isset($form_state['values']['signature'])) {
1284
      // Move text format for user signature into 'signature_format'.
1285
      $form_state['values']['signature_format'] = $form_state['values']['signature']['format'];
1286
      // Move text value for user signature into 'signature'.
1287
      $form_state['values']['signature'] = $form_state['values']['signature']['value'];
1288

    
1289
      $user_schema = drupal_get_schema('users');
1290
      if (drupal_strlen($form_state['values']['signature']) > $user_schema['fields']['signature']['length']) {
1291
        form_set_error('signature', t('The signature is too long: it must be %max characters or less.', array('%max' => $user_schema['fields']['signature']['length'])));
1292
      }
1293
    }
1294
  }
1295
}
1296

    
1297
/**
1298
 * Implements hook_user_presave().
1299
 */
1300
function user_user_presave(&$edit, $account, $category) {
1301
  if ($category == 'account' || $category == 'register') {
1302
    if (!empty($edit['picture_upload'])) {
1303
      $edit['picture'] = $edit['picture_upload'];
1304
    }
1305
    // Delete picture if requested, and if no replacement picture was given.
1306
    elseif (!empty($edit['picture_delete'])) {
1307
      $edit['picture'] = NULL;
1308
    }
1309
    // Prepare user roles.
1310
    if (isset($edit['roles'])) {
1311
      $edit['roles'] = array_filter($edit['roles']);
1312
    }
1313
  }
1314

    
1315
  // Move account cancellation information into $user->data.
1316
  foreach (array('user_cancel_method', 'user_cancel_notify') as $key) {
1317
    if (isset($edit[$key])) {
1318
      $edit['data'][$key] = $edit[$key];
1319
    }
1320
  }
1321
}
1322

    
1323
/**
1324
 * Implements hook_user_categories().
1325
 */
1326
function user_user_categories() {
1327
  return array(array(
1328
    'name' => 'account',
1329
    'title' => t('Account settings'),
1330
    'weight' => 1,
1331
  ));
1332
}
1333

    
1334
function user_login_block($form) {
1335
  $form['#action'] = url(current_path(), array('query' => drupal_get_destination(), 'external' => FALSE));
1336
  $form['#id'] = 'user-login-form';
1337
  $form['#validate'] = user_login_default_validators();
1338
  $form['#submit'][] = 'user_login_submit';
1339
  $form['name'] = array('#type' => 'textfield',
1340
    '#title' => t('Username'),
1341
    '#maxlength' => USERNAME_MAX_LENGTH,
1342
    '#size' => 15,
1343
    '#required' => TRUE,
1344
  );
1345
  $form['pass'] = array('#type' => 'password',
1346
    '#title' => t('Password'),
1347
    '#size' => 15,
1348
    '#required' => TRUE,
1349
  );
1350
  $form['actions'] = array('#type' => 'actions');
1351
  $form['actions']['submit'] = array('#type' => 'submit',
1352
    '#value' => t('Log in'),
1353
  );
1354
  $items = array();
1355
  if (variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)) {
1356
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
1357
  }
1358
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
1359
  $form['links'] = array('#markup' => theme('item_list', array('items' => $items)));
1360
  return $form;
1361
}
1362

    
1363
/**
1364
 * Implements hook_block_info().
1365
 */
1366
function user_block_info() {
1367
  global $user;
1368

    
1369
  $blocks['login']['info'] = t('User login');
1370
  // Not worth caching.
1371
  $blocks['login']['cache'] = DRUPAL_NO_CACHE;
1372

    
1373
  $blocks['new']['info'] = t('Who\'s new');
1374
  $blocks['new']['properties']['administrative'] = TRUE;
1375

    
1376
  // Too dynamic to cache.
1377
  $blocks['online']['info'] = t('Who\'s online');
1378
  $blocks['online']['cache'] = DRUPAL_NO_CACHE;
1379
  $blocks['online']['properties']['administrative'] = TRUE;
1380

    
1381
  return $blocks;
1382
}
1383

    
1384
/**
1385
 * Implements hook_block_configure().
1386
 */
1387
function user_block_configure($delta = '') {
1388
  global $user;
1389

    
1390
  switch ($delta) {
1391
    case 'new':
1392
      $form['user_block_whois_new_count'] = array(
1393
        '#type' => 'select',
1394
        '#title' => t('Number of users to display'),
1395
        '#default_value' => variable_get('user_block_whois_new_count', 5),
1396
        '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
1397
      );
1398
      return $form;
1399

    
1400
    case 'online':
1401
      $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
1402
      $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.'));
1403
      $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.'));
1404
      return $form;
1405
  }
1406
}
1407

    
1408
/**
1409
 * Implements hook_block_save().
1410
 */
1411
function user_block_save($delta = '', $edit = array()) {
1412
  global $user;
1413

    
1414
  switch ($delta) {
1415
    case 'new':
1416
      variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
1417
      break;
1418

    
1419
    case 'online':
1420
      variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
1421
      variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
1422
      break;
1423
  }
1424
}
1425

    
1426
/**
1427
 * Implements hook_block_view().
1428
 */
1429
function user_block_view($delta = '') {
1430
  global $user;
1431

    
1432
  $block = array();
1433

    
1434
  switch ($delta) {
1435
    case 'login':
1436
      // For usability's sake, avoid showing two login forms on one page.
1437
      if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
1438

    
1439
        $block['subject'] = t('User login');
1440
        $block['content'] = drupal_get_form('user_login_block');
1441
      }
1442
      return $block;
1443

    
1444
    case 'new':
1445
      if (user_access('access content')) {
1446
        // Retrieve a list of new users who have subsequently accessed the site successfully.
1447
        $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();
1448
        $output = theme('user_list', array('users' => $items));
1449

    
1450
        $block['subject'] = t('Who\'s new');
1451
        $block['content'] = $output;
1452
      }
1453
      return $block;
1454

    
1455
    case 'online':
1456
      if (user_access('access content')) {
1457
        // Count users active within the defined period.
1458
        $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
1459

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

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

    
1466
        // Display a list of currently online users.
1467
        $max_users = variable_get('user_block_max_list_count', 10);
1468
        if ($authenticated_count && $max_users) {
1469
          $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();
1470
          $output .= theme('user_list', array('users' => $items));
1471
        }
1472

    
1473
        $block['subject'] = t('Who\'s online');
1474
        $block['content'] = $output;
1475
      }
1476
      return $block;
1477
  }
1478
}
1479

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

    
1529
/**
1530
 * Returns HTML for a list of users.
1531
 *
1532
 * @param $variables
1533
 *   An associative array containing:
1534
 *   - users: An array with user objects. Should contain at least the name and
1535
 *     uid.
1536
 *   - title: (optional) Title to pass on to theme_item_list().
1537
 *
1538
 * @ingroup themeable
1539
 */
1540
function theme_user_list($variables) {
1541
  $users = $variables['users'];
1542
  $title = $variables['title'];
1543
  $items = array();
1544

    
1545
  if (!empty($users)) {
1546
    foreach ($users as $user) {
1547
      $items[] = theme('username', array('account' => $user));
1548
    }
1549
  }
1550
  return theme('item_list', array('items' => $items, 'title' => $title));
1551
}
1552

    
1553
/**
1554
 * Determines if the current user is anonymous.
1555
 *
1556
 * @return bool
1557
 *   TRUE if the user is anonymous, FALSE if the user is authenticated.
1558
 */
1559
function user_is_anonymous() {
1560
  // Menu administrators can see items for anonymous when administering.
1561
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
1562
}
1563

    
1564
/**
1565
 * Determines if the current user is logged in.
1566
 *
1567
 * @return bool
1568
 *   TRUE if the user is logged in, FALSE if the user is anonymous.
1569
 */
1570
function user_is_logged_in() {
1571
  return (bool) $GLOBALS['user']->uid;
1572
}
1573

    
1574
/**
1575
 * Determines if the current user has access to the user registration page.
1576
 *
1577
 * @return bool
1578
 *   TRUE if the user is not already logged in and can register for an account.
1579
 */
1580
function user_register_access() {
1581
  return user_is_anonymous() && variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
1582
}
1583

    
1584
/**
1585
 * User view access callback.
1586
 *
1587
 * @param $account
1588
 *   Can either be a full user object or a $uid.
1589
 */
1590
function user_view_access($account) {
1591
  $uid = is_object($account) ? $account->uid : (int) $account;
1592

    
1593
  // Never allow access to view the anonymous user account.
1594
  if ($uid) {
1595
    // Admins can view all, users can view own profiles at all times.
1596
    if ($GLOBALS['user']->uid == $uid || user_access('administer users')) {
1597
      return TRUE;
1598
    }
1599
    elseif (user_access('access user profiles')) {
1600
      // At this point, load the complete account object.
1601
      if (!is_object($account)) {
1602
        $account = user_load($uid);
1603
      }
1604
      return (is_object($account) && $account->status);
1605
    }
1606
  }
1607
  return FALSE;
1608
}
1609

    
1610
/**
1611
 * Access callback for user account editing.
1612
 */
1613
function user_edit_access($account) {
1614
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
1615
}
1616

    
1617
/**
1618
 * Menu access callback; limit access to account cancellation pages.
1619
 *
1620
 * Limit access to users with the 'cancel account' permission or administrative
1621
 * users, and prevent the anonymous user from cancelling the account.
1622
 */
1623
function user_cancel_access($account) {
1624
  return ((($GLOBALS['user']->uid == $account->uid) && user_access('cancel account')) || user_access('administer users')) && $account->uid > 0;
1625
}
1626

    
1627
/**
1628
 * Implements hook_menu().
1629
 */
1630
function user_menu() {
1631
  $items['user/autocomplete'] = array(
1632
    'title' => 'User autocomplete',
1633
    'page callback' => 'user_autocomplete',
1634
    'access callback' => 'user_access',
1635
    'access arguments' => array('access user profiles'),
1636
    'type' => MENU_CALLBACK,
1637
    'file' => 'user.pages.inc',
1638
  );
1639

    
1640
  // Registration and login pages.
1641
  $items['user'] = array(
1642
    'title' => 'User account',
1643
    'title callback' => 'user_menu_title',
1644
    'page callback' => 'user_page',
1645
    'access callback' => TRUE,
1646
    'file' => 'user.pages.inc',
1647
    'weight' => -10,
1648
    'menu_name' => 'user-menu',
1649
  );
1650

    
1651
  $items['user/login'] = array(
1652
    'title' => 'Log in',
1653
    'access callback' => 'user_is_anonymous',
1654
    'type' => MENU_DEFAULT_LOCAL_TASK,
1655
  );
1656

    
1657
  $items['user/register'] = array(
1658
    'title' => 'Create new account',
1659
    'page callback' => 'drupal_get_form',
1660
    'page arguments' => array('user_register_form'),
1661
    'access callback' => 'user_register_access',
1662
    'type' => MENU_LOCAL_TASK,
1663
  );
1664

    
1665
  $items['user/password'] = array(
1666
    'title' => 'Request new password',
1667
    'page callback' => 'drupal_get_form',
1668
    'page arguments' => array('user_pass'),
1669
    'access callback' => TRUE,
1670
    'type' => MENU_LOCAL_TASK,
1671
    'file' => 'user.pages.inc',
1672
  );
1673
  $items['user/reset/%/%/%'] = array(
1674
    'title' => 'Reset password',
1675
    'page callback' => 'drupal_get_form',
1676
    'page arguments' => array('user_pass_reset', 2, 3, 4),
1677
    'access callback' => TRUE,
1678
    'type' => MENU_CALLBACK,
1679
    'file' => 'user.pages.inc',
1680
  );
1681

    
1682
  $items['user/logout'] = array(
1683
    'title' => 'Log out',
1684
    'access callback' => 'user_is_logged_in',
1685
    'page callback' => 'user_logout',
1686
    'weight' => 10,
1687
    'menu_name' => 'user-menu',
1688
    'file' => 'user.pages.inc',
1689
  );
1690

    
1691
  // User listing pages.
1692
  $items['admin/people'] = array(
1693
    'title' => 'People',
1694
    'description' => 'Manage user accounts, roles, and permissions.',
1695
    'page callback' => 'user_admin',
1696
    'page arguments' => array('list'),
1697
    'access arguments' => array('administer users'),
1698
    'position' => 'left',
1699
    'weight' => -4,
1700
    'file' => 'user.admin.inc',
1701
  );
1702
  $items['admin/people/people'] = array(
1703
    'title' => 'List',
1704
    'description' => 'Find and manage people interacting with your site.',
1705
    'access arguments' => array('administer users'),
1706
    'type' => MENU_DEFAULT_LOCAL_TASK,
1707
    'weight' => -10,
1708
    'file' => 'user.admin.inc',
1709
  );
1710

    
1711
  // Permissions and role forms.
1712
  $items['admin/people/permissions'] = array(
1713
    'title' => 'Permissions',
1714
    'description' => 'Determine access to features by selecting permissions for roles.',
1715
    'page callback' => 'drupal_get_form',
1716
    'page arguments' => array('user_admin_permissions'),
1717
    'access arguments' => array('administer permissions'),
1718
    'file' => 'user.admin.inc',
1719
    'type' => MENU_LOCAL_TASK,
1720
  );
1721
  $items['admin/people/permissions/list'] = array(
1722
    'title' => 'Permissions',
1723
    'description' => 'Determine access to features by selecting permissions for roles.',
1724
    'type' => MENU_DEFAULT_LOCAL_TASK,
1725
    'weight' => -8,
1726
  );
1727
  $items['admin/people/permissions/roles'] = array(
1728
    'title' => 'Roles',
1729
    'description' => 'List, edit, or add user roles.',
1730
    'page callback' => 'drupal_get_form',
1731
    'page arguments' => array('user_admin_roles'),
1732
    'access arguments' => array('administer permissions'),
1733
    'file' => 'user.admin.inc',
1734
    'type' => MENU_LOCAL_TASK,
1735
    'weight' => -5,
1736
  );
1737
  $items['admin/people/permissions/roles/edit/%user_role'] = array(
1738
    'title' => 'Edit role',
1739
    'page arguments' => array('user_admin_role', 5),
1740
    'access callback' => 'user_role_edit_access',
1741
    'access arguments' => array(5),
1742
  );
1743
  $items['admin/people/permissions/roles/delete/%user_role'] = array(
1744
    'title' => 'Delete role',
1745
    'page callback' => 'drupal_get_form',
1746
    'page arguments' => array('user_admin_role_delete_confirm', 5),
1747
    'access callback' => 'user_role_edit_access',
1748
    'access arguments' => array(5),
1749
    'file' => 'user.admin.inc',
1750
  );
1751

    
1752
  $items['admin/people/create'] = array(
1753
    'title' => 'Add user',
1754
    'page arguments' => array('create'),
1755
    'access arguments' => array('administer users'),
1756
    'type' => MENU_LOCAL_ACTION,
1757
  );
1758

    
1759
  // Administration pages.
1760
  $items['admin/config/people'] = array(
1761
    'title' => 'People',
1762
    'description' => 'Configure user accounts.',
1763
    'position' => 'left',
1764
    'weight' => -20,
1765
    'page callback' => 'system_admin_menu_block_page',
1766
    'access arguments' => array('access administration pages'),
1767
    'file' => 'system.admin.inc',
1768
    'file path' => drupal_get_path('module', 'system'),
1769
  );
1770
  $items['admin/config/people/accounts'] = array(
1771
    'title' => 'Account settings',
1772
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, fields, and user pictures.',
1773
    'page callback' => 'drupal_get_form',
1774
    'page arguments' => array('user_admin_settings'),
1775
    'access arguments' => array('administer users'),
1776
    'file' => 'user.admin.inc',
1777
    'weight' => -10,
1778
  );
1779
  $items['admin/config/people/accounts/settings'] = array(
1780
    'title' => 'Settings',
1781
    'type' => MENU_DEFAULT_LOCAL_TASK,
1782
    'weight' => -10,
1783
  );
1784

    
1785
  $items['user/%user'] = array(
1786
    'title' => 'My account',
1787
    'title callback' => 'user_page_title',
1788
    'title arguments' => array(1),
1789
    'page callback' => 'user_view_page',
1790
    'page arguments' => array(1),
1791
    'access callback' => 'user_view_access',
1792
    'access arguments' => array(1),
1793
    // By assigning a different menu name, this item (and all registered child
1794
    // paths) are no longer considered as children of 'user'. When accessing the
1795
    // user account pages, the preferred menu link that is used to build the
1796
    // active trail (breadcrumb) will be found in this menu (unless there is
1797
    // more specific link), so the link to 'user' will not be in the breadcrumb.
1798
    'menu_name' => 'navigation',
1799
  );
1800

    
1801
  $items['user/%user/view'] = array(
1802
    'title' => 'View',
1803
    'type' => MENU_DEFAULT_LOCAL_TASK,
1804
    'weight' => -10,
1805
  );
1806

    
1807
  $items['user/%user/cancel'] = array(
1808
    'title' => 'Cancel account',
1809
    'page callback' => 'drupal_get_form',
1810
    'page arguments' => array('user_cancel_confirm_form', 1),
1811
    'access callback' => 'user_cancel_access',
1812
    'access arguments' => array(1),
1813
    'file' => 'user.pages.inc',
1814
  );
1815

    
1816
  $items['user/%user/cancel/confirm/%/%'] = array(
1817
    'title' => 'Confirm account cancellation',
1818
    'page callback' => 'user_cancel_confirm',
1819
    'page arguments' => array(1, 4, 5),
1820
    'access callback' => 'user_cancel_access',
1821
    'access arguments' => array(1),
1822
    'file' => 'user.pages.inc',
1823
  );
1824

    
1825
  $items['user/%user/edit'] = array(
1826
    'title' => 'Edit',
1827
    'page callback' => 'drupal_get_form',
1828
    'page arguments' => array('user_profile_form', 1),
1829
    'access callback' => 'user_edit_access',
1830
    'access arguments' => array(1),
1831
    'type' => MENU_LOCAL_TASK,
1832
    'file' => 'user.pages.inc',
1833
  );
1834

    
1835
  $items['user/%user_category/edit/account'] = array(
1836
    'title' => 'Account',
1837
    'type' => MENU_DEFAULT_LOCAL_TASK,
1838
    'load arguments' => array('%map', '%index'),
1839
  );
1840

    
1841
  if (($categories = _user_categories()) && (count($categories) > 1)) {
1842
    foreach ($categories as $key => $category) {
1843
      // 'account' is already handled by the MENU_DEFAULT_LOCAL_TASK.
1844
      if ($category['name'] != 'account') {
1845
        $items['user/%user_category/edit/' . $category['name']] = array(
1846
          'title callback' => 'check_plain',
1847
          'title arguments' => array($category['title']),
1848
          'page callback' => 'drupal_get_form',
1849
          'page arguments' => array('user_profile_form', 1, 3),
1850
          'access callback' => isset($category['access callback']) ? $category['access callback'] : 'user_edit_access',
1851
          'access arguments' => isset($category['access arguments']) ? $category['access arguments'] : array(1),
1852
          'type' => MENU_LOCAL_TASK,
1853
          'weight' => $category['weight'],
1854
          'load arguments' => array('%map', '%index'),
1855
          'tab_parent' => 'user/%/edit',
1856
          'file' => 'user.pages.inc',
1857
        );
1858
      }
1859
    }
1860
  }
1861
  return $items;
1862
}
1863

    
1864
/**
1865
 * Implements hook_menu_site_status_alter().
1866
 */
1867
function user_menu_site_status_alter(&$menu_site_status, $path) {
1868
  if ($menu_site_status == MENU_SITE_OFFLINE) {
1869
    // If the site is offline, log out unprivileged users.
1870
    if (user_is_logged_in() && !user_access('access site in maintenance mode')) {
1871
      module_load_include('pages.inc', 'user', 'user');
1872
      user_logout();
1873
    }
1874

    
1875
    if (user_is_anonymous()) {
1876
      switch ($path) {
1877
        case 'user':
1878
          // Forward anonymous user to login page.
1879
          drupal_goto('user/login');
1880
        case 'user/login':
1881
        case 'user/password':
1882
          // Disable offline mode.
1883
          $menu_site_status = MENU_SITE_ONLINE;
1884
          break;
1885
        default:
1886
          if (strpos($path, 'user/reset/') === 0) {
1887
            // Disable offline mode.
1888
            $menu_site_status = MENU_SITE_ONLINE;
1889
          }
1890
          break;
1891
      }
1892
    }
1893
  }
1894
  if (user_is_logged_in()) {
1895
    if ($path == 'user/login') {
1896
      // If user is logged in, redirect to 'user' instead of giving 403.
1897
      drupal_goto('user');
1898
    }
1899
    if ($path == 'user/register') {
1900
      // Authenticated user should be redirected to user edit page.
1901
      drupal_goto('user/' . $GLOBALS['user']->uid . '/edit');
1902
    }
1903
  }
1904
}
1905

    
1906
/**
1907
 * Implements hook_menu_link_alter().
1908
 */
1909
function user_menu_link_alter(&$link) {
1910
  // The path 'user' must be accessible for anonymous users, but only visible
1911
  // for authenticated users. Authenticated users should see "My account", but
1912
  // anonymous users should not see it at all. Therefore, invoke
1913
  // user_translated_menu_link_alter() to conditionally hide the link.
1914
  if ($link['link_path'] == 'user' && isset($link['module']) && $link['module'] == 'system') {
1915
    $link['options']['alter'] = TRUE;
1916
  }
1917

    
1918
  // Force the Logout link to appear on the top-level of 'user-menu' menu by
1919
  // default (i.e., unless it has been customized).
1920
  if ($link['link_path'] == 'user/logout' && isset($link['module']) && $link['module'] == 'system' && empty($link['customized'])) {
1921
    $link['plid'] = 0;
1922
  }
1923
}
1924

    
1925
/**
1926
 * Implements hook_translated_menu_link_alter().
1927
 */
1928
function user_translated_menu_link_alter(&$link) {
1929
  // Hide the "User account" link for anonymous users.
1930
  if ($link['link_path'] == 'user' && $link['module'] == 'system' && !$GLOBALS['user']->uid) {
1931
    $link['hidden'] = 1;
1932
  }
1933
}
1934

    
1935
/**
1936
 * Implements hook_admin_paths().
1937
 */
1938
function user_admin_paths() {
1939
  $paths = array(
1940
    'user/*/cancel' => TRUE,
1941
    'user/*/edit' => TRUE,
1942
    'user/*/edit/*' => TRUE,
1943
  );
1944
  return $paths;
1945
}
1946

    
1947
/**
1948
 * Returns $arg or the user ID of the current user if $arg is '%' or empty.
1949
 *
1950
 * Deprecated. Use %user_uid_optional instead.
1951
 *
1952
 * @todo D8: Remove.
1953
 */
1954
function user_uid_only_optional_to_arg($arg) {
1955
  return user_uid_optional_to_arg($arg);
1956
}
1957

    
1958
/**
1959
 * Load either a specified or the current user account.
1960
 *
1961
 * @param $uid
1962
 *   An optional user ID of the user to load. If not provided, the current
1963
 *   user's ID will be used.
1964
 * @return
1965
 *   A fully-loaded $user object upon successful user load, FALSE if user
1966
 *   cannot be loaded.
1967
 *
1968
 * @see user_load()
1969
 * @todo rethink the naming of this in Drupal 8.
1970
 */
1971
function user_uid_optional_load($uid = NULL) {
1972
  if (!isset($uid)) {
1973
    $uid = $GLOBALS['user']->uid;
1974
  }
1975
  return user_load($uid);
1976
}
1977

    
1978
/**
1979
 * Return a user object after checking if any profile category in the path exists.
1980
 */
1981
function user_category_load($uid, &$map, $index) {
1982
  static $user_categories, $accounts;
1983

    
1984
  // Cache $account - this load function will get called for each profile tab.
1985
  if (!isset($accounts[$uid])) {
1986
    $accounts[$uid] = user_load($uid);
1987
  }
1988
  $valid = TRUE;
1989
  if ($account = $accounts[$uid]) {
1990
    // Since the path is like user/%/edit/category_name, the category name will
1991
    // be at a position 2 beyond the index corresponding to the % wildcard.
1992
    $category_index = $index + 2;
1993
    // Valid categories may contain slashes, and hence need to be imploded.
1994
    $category_path = implode('/', array_slice($map, $category_index));
1995
    if ($category_path) {
1996
      // Check that the requested category exists.
1997
      $valid = FALSE;
1998
      if (!isset($user_categories)) {
1999
        $user_categories = _user_categories();
2000
      }
2001
      foreach ($user_categories as $category) {
2002
        if ($category['name'] == $category_path) {
2003
          $valid = TRUE;
2004
          // Truncate the map array in case the category name had slashes.
2005
          $map = array_slice($map, 0, $category_index);
2006
          // Assign the imploded category name to the last map element.
2007
          $map[$category_index] = $category_path;
2008
          break;
2009
        }
2010
      }
2011
    }
2012
  }
2013
  return $valid ? $account : FALSE;
2014
}
2015

    
2016
/**
2017
 * Returns $arg or the user ID of the current user if $arg is '%' or empty.
2018
 *
2019
 * @todo rethink the naming of this in Drupal 8.
2020
 */
2021
function user_uid_optional_to_arg($arg) {
2022
  // Give back the current user uid when called from eg. tracker, aka.
2023
  // with an empty arg. Also use the current user uid when called from
2024
  // the menu with a % for the current account link.
2025
  return empty($arg) || $arg == '%' ? $GLOBALS['user']->uid : $arg;
2026
}
2027

    
2028
/**
2029
 * Menu item title callback for the 'user' path.
2030
 *
2031
 * Anonymous users should see "User account", but authenticated users are
2032
 * expected to see "My account".
2033
 */
2034
function user_menu_title() {
2035
  return user_is_logged_in() ? t('My account') : t('User account');
2036
}
2037

    
2038
/**
2039
 * Menu item title callback - use the user name.
2040
 */
2041
function user_page_title($account) {
2042
  return is_object($account) ? format_username($account) : '';
2043
}
2044

    
2045
/**
2046
 * Discover which external authentication module(s) authenticated a username.
2047
 *
2048
 * @param $authname
2049
 *   A username used by an external authentication module.
2050
 * @return
2051
 *   An associative array with module as key and username as value.
2052
 */
2053
function user_get_authmaps($authname = NULL) {
2054
  $authmaps = db_query("SELECT module, authname FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchAllKeyed();
2055
  return count($authmaps) ? $authmaps : 0;
2056
}
2057

    
2058
/**
2059
 * Save mappings of which external authentication module(s) authenticated
2060
 * a user. Maps external usernames to user ids in the users table.
2061
 *
2062
 * @param $account
2063
 *   A user object.
2064
 * @param $authmaps
2065
 *   An associative array with a compound key and the username as the value.
2066
 *   The key is made up of 'authname_' plus the name of the external authentication
2067
 *   module.
2068
 * @see user_external_login_register()
2069
 */
2070
function user_set_authmaps($account, $authmaps) {
2071
  foreach ($authmaps as $key => $value) {
2072
    $module = explode('_', $key, 2);
2073
    if ($value) {
2074
      db_merge('authmap')
2075
        ->key(array(
2076
          'uid' => $account->uid,
2077
          'module' => $module[1],
2078
        ))
2079
        ->fields(array('authname' => $value))
2080
        ->execute();
2081
    }
2082
    else {
2083
      db_delete('authmap')
2084
        ->condition('uid', $account->uid)
2085
        ->condition('module', $module[1])
2086
        ->execute();
2087
    }
2088
  }
2089
}
2090

    
2091
/**
2092
 * Form builder; the main user login form.
2093
 *
2094
 * @ingroup forms
2095
 */
2096
function user_login($form, &$form_state) {
2097
  global $user;
2098

    
2099
  // If we are already logged on, go to the user page instead.
2100
  if ($user->uid) {
2101
    drupal_goto('user/' . $user->uid);
2102
  }
2103

    
2104
  // Display login form:
2105
  $form['name'] = array('#type' => 'textfield',
2106
    '#title' => t('Username'),
2107
    '#size' => 60,
2108
    '#maxlength' => USERNAME_MAX_LENGTH,
2109
    '#required' => TRUE,
2110
  );
2111

    
2112
  $form['name']['#description'] = t('Enter your @s username.', array('@s' => variable_get('site_name', 'Drupal')));
2113
  $form['pass'] = array('#type' => 'password',
2114
    '#title' => t('Password'),
2115
    '#description' => t('Enter the password that accompanies your username.'),
2116
    '#required' => TRUE,
2117
  );
2118
  $form['#validate'] = user_login_default_validators();
2119
  $form['actions'] = array('#type' => 'actions');
2120
  $form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Log in'));
2121

    
2122
  return $form;
2123
}
2124

    
2125
/**
2126
 * Set up a series for validators which check for blocked users,
2127
 * then authenticate against local database, then return an error if
2128
 * authentication fails. Distributed authentication modules are welcome
2129
 * to use hook_form_alter() to change this series in order to
2130
 * authenticate against their user database instead of the local users
2131
 * table. If a distributed authentication module is successful, it
2132
 * should set $form_state['uid'] to a user ID.
2133
 *
2134
 * We use three validators instead of one since external authentication
2135
 * modules usually only need to alter the second validator.
2136
 *
2137
 * @see user_login_name_validate()
2138
 * @see user_login_authenticate_validate()
2139
 * @see user_login_final_validate()
2140
 * @return array
2141
 *   A simple list of validate functions.
2142
 */
2143
function user_login_default_validators() {
2144
  return array('user_login_name_validate', 'user_login_authenticate_validate', 'user_login_final_validate');
2145
}
2146

    
2147
/**
2148
 * A FAPI validate handler. Sets an error if supplied username has been blocked.
2149
 */
2150
function user_login_name_validate($form, &$form_state) {
2151
  if (!empty($form_state['values']['name']) && user_is_blocked($form_state['values']['name'])) {
2152
    // Blocked in user administration.
2153
    form_set_error('name', t('The username %name has not been activated or is blocked.', array('%name' => $form_state['values']['name'])));
2154
  }
2155
}
2156

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

    
2189
      // Don't allow login if the limit for this user has been reached.
2190
      // Default is to allow 5 failed attempts every 6 hours.
2191
      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)) {
2192
        $form_state['flood_control_triggered'] = 'user';
2193
        return;
2194
      }
2195
    }
2196
    // We are not limited by flood control, so try to authenticate.
2197
    // Set $form_state['uid'] as a flag for user_login_final_validate().
2198
    $form_state['uid'] = user_authenticate($form_state['values']['name'], $password);
2199
  }
2200
}
2201

    
2202
/**
2203
 * The final validation handler on the login form.
2204
 *
2205
 * Sets a form error if user has not been authenticated, or if too many
2206
 * logins have been attempted. This validation function should always
2207
 * be the last one.
2208
 */
2209
function user_login_final_validate($form, &$form_state) {
2210
  if (empty($form_state['uid'])) {
2211
    // Always register an IP-based failed login event.
2212
    flood_register_event('failed_login_attempt_ip', variable_get('user_failed_login_ip_window', 3600));
2213
    // Register a per-user failed login event.
2214
    if (isset($form_state['flood_control_user_identifier'])) {
2215
      flood_register_event('failed_login_attempt_user', variable_get('user_failed_login_user_window', 21600), $form_state['flood_control_user_identifier']);
2216
    }
2217

    
2218
    if (isset($form_state['flood_control_triggered'])) {
2219
      if ($form_state['flood_control_triggered'] == 'user') {
2220
        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'))));
2221
      }
2222
      else {
2223
        // We did not find a uid, so the limit is IP-based.
2224
        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'))));
2225
      }
2226
    }
2227
    else {
2228
      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']))))));
2229
      watchdog('user', 'Login attempt failed for %user.', array('%user' => $form_state['values']['name']));
2230
    }
2231
  }
2232
  elseif (isset($form_state['flood_control_user_identifier'])) {
2233
    // Clear past failures for this user so as not to block a user who might
2234
    // log in and out more than once in an hour.
2235
    flood_clear_event('failed_login_attempt_user', $form_state['flood_control_user_identifier']);
2236
  }
2237
}
2238

    
2239
/**
2240
 * Try to validate the user's login credentials locally.
2241
 *
2242
 * @param $name
2243
 *   User name to authenticate.
2244
 * @param $password
2245
 *   A plain-text password, such as trimmed text from form values.
2246
 * @return
2247
 *   The user's uid on success, or FALSE on failure to authenticate.
2248
 */
2249
function user_authenticate($name, $password) {
2250
  $uid = FALSE;
2251
  if (!empty($name) && !empty($password)) {
2252
    $account = user_load_by_name($name);
2253
    if ($account) {
2254
      // Allow alternate password hashing schemes.
2255
      require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
2256
      if (user_check_password($password, $account)) {
2257
        // Successful authentication.
2258
        $uid = $account->uid;
2259

    
2260
        // Update user to new password scheme if needed.
2261
        if (user_needs_new_hash($account)) {
2262
          user_save($account, array('pass' => $password));
2263
        }
2264
      }
2265
    }
2266
  }
2267
  return $uid;
2268
}
2269

    
2270
/**
2271
 * Finalize the login process. Must be called when logging in a user.
2272
 *
2273
 * The function records a watchdog message about the new session, saves the
2274
 * login timestamp, calls hook_user_login(), and generates a new session.
2275
 *
2276
 * @param array $edit
2277
 *   The array of form values submitted by the user.
2278
 *
2279
 * @see hook_user_login()
2280
 */
2281
function user_login_finalize(&$edit = array()) {
2282
  global $user;
2283
  watchdog('user', 'Session opened for %name.', array('%name' => $user->name));
2284
  // Update the user table timestamp noting user has logged in.
2285
  // This is also used to invalidate one-time login links.
2286
  $user->login = REQUEST_TIME;
2287
  db_update('users')
2288
    ->fields(array('login' => $user->login))
2289
    ->condition('uid', $user->uid)
2290
    ->execute();
2291

    
2292
  // Regenerate the session ID to prevent against session fixation attacks.
2293
  // This is called before hook_user in case one of those functions fails
2294
  // or incorrectly does a redirect which would leave the old session in place.
2295
  drupal_session_regenerate();
2296

    
2297
  user_module_invoke('login', $edit, $user);
2298
}
2299

    
2300
/**
2301
 * Submit handler for the login form. Load $user object and perform standard login
2302
 * tasks. The user is then redirected to the My Account page. Setting the
2303
 * destination in the query string overrides the redirect.
2304
 */
2305
function user_login_submit($form, &$form_state) {
2306
  global $user;
2307
  $user = user_load($form_state['uid']);
2308
  $form_state['redirect'] = 'user/' . $user->uid;
2309

    
2310
  user_login_finalize($form_state);
2311
}
2312

    
2313
/**
2314
 * Helper function for authentication modules. Either logs in or registers
2315
 * the current user, based on username. Either way, the global $user object is
2316
 * populated and login tasks are performed.
2317
 */
2318
function user_external_login_register($name, $module) {
2319
  $account = user_external_load($name);
2320
  if (!$account) {
2321
    // Register this new user.
2322
    $userinfo = array(
2323
      'name' => $name,
2324
      'pass' => user_password(),
2325
      'init' => $name,
2326
      'status' => 1,
2327
      'access' => REQUEST_TIME
2328
    );
2329
    $account = user_save(drupal_anonymous_user(), $userinfo);
2330
    // Terminate if an error occurred during user_save().
2331
    if (!$account) {
2332
      drupal_set_message(t("Error saving user account."), 'error');
2333
      return;
2334
    }
2335
    user_set_authmaps($account, array("authname_$module" => $name));
2336
  }
2337

    
2338
  // Log user in.
2339
  $form_state['uid'] = $account->uid;
2340
  user_login_submit(array(), $form_state);
2341
}
2342

    
2343
/**
2344
 * Generates a unique URL for a user to login and reset their password.
2345
 *
2346
 * @param object $account
2347
 *   An object containing the user account, which must contain at least the
2348
 *   following properties:
2349
 *   - uid: The user ID number.
2350
 *   - login: The UNIX timestamp of the user's last login.
2351
 *
2352
 * @return
2353
 *   A unique URL that provides a one-time log in for the user, from which
2354
 *   they can change their password.
2355
 */
2356
function user_pass_reset_url($account) {
2357
  $timestamp = REQUEST_TIME;
2358
  return url("user/reset/$account->uid/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login, $account->uid), array('absolute' => TRUE));
2359
}
2360

    
2361
/**
2362
 * Generates a URL to confirm an account cancellation request.
2363
 *
2364
 * @param object $account
2365
 *   The user account object, which must contain at least the following
2366
 *   properties:
2367
 *   - uid: The user ID number.
2368
 *   - pass: The hashed user password string.
2369
 *   - login: The UNIX timestamp of the user's last login.
2370
 *
2371
 * @return
2372
 *   A unique URL that may be used to confirm the cancellation of the user
2373
 *   account.
2374
 *
2375
 * @see user_mail_tokens()
2376
 * @see user_cancel_confirm()
2377
 */
2378
function user_cancel_url($account) {
2379
  $timestamp = REQUEST_TIME;
2380
  return url("user/$account->uid/cancel/confirm/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login, $account->uid), array('absolute' => TRUE));
2381
}
2382

    
2383
/**
2384
 * Creates a unique hash value for use in time-dependent per-user URLs.
2385
 *
2386
 * This hash is normally used to build a unique and secure URL that is sent to
2387
 * the user by email for purposes such as resetting the user's password. In
2388
 * order to validate the URL, the same hash can be generated again, from the
2389
 * same information, and compared to the hash value from the URL. The URL
2390
 * normally contains both the time stamp and the numeric user ID. The login
2391
 * timestamp and hashed password are retrieved from the database as necessary.
2392
 * For a usage example, see user_cancel_url() and user_cancel_confirm().
2393
 *
2394
 * @param string $password
2395
 *   The hashed user account password value.
2396
 * @param int $timestamp
2397
 *   A UNIX timestamp, typically REQUEST_TIME.
2398
 * @param int $login
2399
 *   The UNIX timestamp of the user's last login.
2400
 * @param int $uid
2401
 *   The user ID of the user account.
2402
 *
2403
 * @return
2404
 *   A string that is safe for use in URLs and SQL statements.
2405
 */
2406
function user_pass_rehash($password, $timestamp, $login, $uid) {
2407
  // Backwards compatibility: Try to determine a $uid if one was not passed.
2408
  // (Since $uid is a required parameter to this function, a PHP warning will
2409
  // be generated if it's not provided, which is an indication that the calling
2410
  // code should be updated. But the code below will try to generate a correct
2411
  // hash in the meantime.)
2412
  if (!isset($uid)) {
2413
    $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();
2414
    // If exactly one user account matches the provided password and login
2415
    // timestamp, proceed with that $uid.
2416
    if (count($uids) == 1) {
2417
      $uid = reset($uids);
2418
    }
2419
    // Otherwise there is no safe hash to return, so return a random string
2420
    // that will never be treated as a valid token.
2421
    else {
2422
      return drupal_random_key();
2423
    }
2424
  }
2425

    
2426
  return drupal_hmac_base64($timestamp . $login . $uid, drupal_get_hash_salt() . $password);
2427
}
2428

    
2429
/**
2430
 * Cancel a user account.
2431
 *
2432
 * Since the user cancellation process needs to be run in a batch, either
2433
 * Form API will invoke it, or batch_process() needs to be invoked after calling
2434
 * this function and should define the path to redirect to.
2435
 *
2436
 * @param $edit
2437
 *   An array of submitted form values.
2438
 * @param $uid
2439
 *   The user ID of the user account to cancel.
2440
 * @param $method
2441
 *   The account cancellation method to use.
2442
 *
2443
 * @see _user_cancel()
2444
 */
2445
function user_cancel($edit, $uid, $method) {
2446
  global $user;
2447

    
2448
  $account = user_load($uid);
2449

    
2450
  if (!$account) {
2451
    drupal_set_message(t('The user account %id does not exist.', array('%id' => $uid)), 'error');
2452
    watchdog('user', 'Attempted to cancel non-existing user account: %id.', array('%id' => $uid), WATCHDOG_ERROR);
2453
    return;
2454
  }
2455

    
2456
  // Initialize batch (to set title).
2457
  $batch = array(
2458
    'title' => t('Cancelling account'),
2459
    'operations' => array(),
2460
  );
2461
  batch_set($batch);
2462

    
2463
  // Modules use hook_user_delete() to respond to deletion.
2464
  if ($method != 'user_cancel_delete') {
2465
    // Allow modules to add further sets to this batch.
2466
    module_invoke_all('user_cancel', $edit, $account, $method);
2467
  }
2468

    
2469
  // Finish the batch and actually cancel the account.
2470
  $batch = array(
2471
    'title' => t('Cancelling user account'),
2472
    'operations' => array(
2473
      array('_user_cancel', array($edit, $account, $method)),
2474
    ),
2475
  );
2476

    
2477
  // After cancelling account, ensure that user is logged out.
2478
  if ($account->uid == $user->uid) {
2479
    // Batch API stores data in the session, so use the finished operation to
2480
    // manipulate the current user's session id.
2481
    $batch['finished'] = '_user_cancel_session_regenerate';
2482
  }
2483

    
2484
  batch_set($batch);
2485

    
2486
  // Batch processing is either handled via Form API or has to be invoked
2487
  // manually.
2488
}
2489

    
2490
/**
2491
 * Implements callback_batch_operation().
2492
 *
2493
 * Last step for cancelling a user account.
2494
 *
2495
 * Since batch and session API require a valid user account, the actual
2496
 * cancellation of a user account needs to happen last.
2497
 *
2498
 * @see user_cancel()
2499
 */
2500
function _user_cancel($edit, $account, $method) {
2501
  global $user;
2502

    
2503
  switch ($method) {
2504
    case 'user_cancel_block':
2505
    case 'user_cancel_block_unpublish':
2506
    default:
2507
      // Send account blocked notification if option was checked.
2508
      if (!empty($edit['user_cancel_notify'])) {
2509
        _user_mail_notify('status_blocked', $account);
2510
      }
2511
      user_save($account, array('status' => 0));
2512
      drupal_set_message(t('%name has been disabled.', array('%name' => $account->name)));
2513
      watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
2514
      break;
2515

    
2516
    case 'user_cancel_reassign':
2517
    case 'user_cancel_delete':
2518
      // Send account canceled notification if option was checked.
2519
      if (!empty($edit['user_cancel_notify'])) {
2520
        _user_mail_notify('status_canceled', $account);
2521
      }
2522
      user_delete($account->uid);
2523
      drupal_set_message(t('%name has been deleted.', array('%name' => $account->name)));
2524
      watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
2525
      break;
2526
  }
2527

    
2528
  // After cancelling account, ensure that user is logged out. We can't destroy
2529
  // their session though, as we might have information in it, and we can't
2530
  // regenerate it because batch API uses the session ID, we will regenerate it
2531
  // in _user_cancel_session_regenerate().
2532
  if ($account->uid == $user->uid) {
2533
    $user = drupal_anonymous_user();
2534
  }
2535

    
2536
  // Clear the cache for anonymous users.
2537
  cache_clear_all();
2538
}
2539

    
2540
/**
2541
 * Implements callback_batch_finished().
2542
 *
2543
 * Finished batch processing callback for cancelling a user account.
2544
 *
2545
 * @see user_cancel()
2546
 */
2547
function _user_cancel_session_regenerate() {
2548
  // Regenerate the users session instead of calling session_destroy() as we
2549
  // want to preserve any messages that might have been set.
2550
  drupal_session_regenerate();
2551
}
2552

    
2553
/**
2554
 * Delete a user.
2555
 *
2556
 * @param $uid
2557
 *   A user ID.
2558
 */
2559
function user_delete($uid) {
2560
  user_delete_multiple(array($uid));
2561
}
2562

    
2563
/**
2564
 * Delete multiple user accounts.
2565
 *
2566
 * @param $uids
2567
 *   An array of user IDs.
2568
 */
2569
function user_delete_multiple(array $uids) {
2570
  if (!empty($uids)) {
2571
    $accounts = user_load_multiple($uids, array());
2572

    
2573
    $transaction = db_transaction();
2574
    try {
2575
      foreach ($accounts as $uid => $account) {
2576
        module_invoke_all('user_delete', $account);
2577
        module_invoke_all('entity_delete', $account, 'user');
2578
        field_attach_delete('user', $account);
2579
        drupal_session_destroy_uid($account->uid);
2580
      }
2581

    
2582
      db_delete('users')
2583
        ->condition('uid', $uids, 'IN')
2584
        ->execute();
2585
      db_delete('users_roles')
2586
        ->condition('uid', $uids, 'IN')
2587
        ->execute();
2588
      db_delete('authmap')
2589
        ->condition('uid', $uids, 'IN')
2590
        ->execute();
2591
    }
2592
    catch (Exception $e) {
2593
      $transaction->rollback();
2594
      watchdog_exception('user', $e);
2595
      throw $e;
2596
    }
2597
    entity_get_controller('user')->resetCache();
2598
  }
2599
}
2600

    
2601
/**
2602
 * Page callback wrapper for user_view().
2603
 */
2604
function user_view_page($account) {
2605
  // An administrator may try to view a non-existent account,
2606
  // so we give them a 404 (versus a 403 for non-admins).
2607
  return is_object($account) ? user_view($account) : MENU_NOT_FOUND;
2608
}
2609

    
2610
/**
2611
 * Generate an array for rendering the given user.
2612
 *
2613
 * When viewing a user profile, the $page array contains:
2614
 *
2615
 * - $page['content']['Profile Category']:
2616
 *   Profile categories keyed by their human-readable names.
2617
 * - $page['content']['Profile Category']['profile_machine_name']:
2618
 *   Profile fields keyed by their machine-readable names.
2619
 * - $page['content']['user_picture']:
2620
 *   User's rendered picture.
2621
 * - $page['content']['summary']:
2622
 *   Contains the default "History" profile data for a user.
2623
 * - $page['content']['#account']:
2624
 *   The user account of the profile being viewed.
2625
 *
2626
 * To theme user profiles, copy modules/user/user-profile.tpl.php
2627
 * to your theme directory, and edit it as instructed in that file's comments.
2628
 *
2629
 * @param $account
2630
 *   A user object.
2631
 * @param $view_mode
2632
 *   View mode, e.g. 'full'.
2633
 * @param $langcode
2634
 *   (optional) A language code to use for rendering. Defaults to the global
2635
 *   content language of the current request.
2636
 *
2637
 * @return
2638
 *   An array as expected by drupal_render().
2639
 */
2640
function user_view($account, $view_mode = 'full', $langcode = NULL) {
2641
  if (!isset($langcode)) {
2642
    $langcode = $GLOBALS['language_content']->language;
2643
  }
2644

    
2645
  // Retrieve all profile fields and attach to $account->content.
2646
  user_build_content($account, $view_mode, $langcode);
2647

    
2648
  $build = $account->content;
2649
  // We don't need duplicate rendering info in account->content.
2650
  unset($account->content);
2651

    
2652
  $build += array(
2653
    '#theme' => 'user_profile',
2654
    '#account' => $account,
2655
    '#view_mode' => $view_mode,
2656
    '#language' => $langcode,
2657
  );
2658

    
2659
  // Allow modules to modify the structured user.
2660
  $type = 'user';
2661
  drupal_alter(array('user_view', 'entity_view'), $build, $type);
2662

    
2663
  return $build;
2664
}
2665

    
2666
/**
2667
 * Builds a structured array representing the profile content.
2668
 *
2669
 * @param $account
2670
 *   A user object.
2671
 * @param $view_mode
2672
 *   View mode, e.g. 'full'.
2673
 * @param $langcode
2674
 *   (optional) A language code to use for rendering. Defaults to the global
2675
 *   content language of the current request.
2676
 */
2677
function user_build_content($account, $view_mode = 'full', $langcode = NULL) {
2678
  if (!isset($langcode)) {
2679
    $langcode = $GLOBALS['language_content']->language;
2680
  }
2681

    
2682
  // Remove previously built content, if exists.
2683
  $account->content = array();
2684

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

    
2688
  // Build fields content.
2689
  field_attach_prepare_view('user', array($account->uid => $account), $view_mode, $langcode);
2690
  entity_prepare_view('user', array($account->uid => $account), $langcode);
2691
  $account->content += field_attach_view('user', $account, $view_mode, $langcode);
2692

    
2693
  // Populate $account->content with a render() array.
2694
  module_invoke_all('user_view', $account, $view_mode, $langcode);
2695
  module_invoke_all('entity_view', $account, 'user', $view_mode, $langcode);
2696

    
2697
  // Make sure the current view mode is stored if no module has already
2698
  // populated the related key.
2699
  $account->content += array('#view_mode' => $view_mode);
2700
}
2701

    
2702
/**
2703
 * Implements hook_mail().
2704
 */
2705
function user_mail($key, &$message, $params) {
2706
  $language = $message['language'];
2707
  $variables = array('user' => $params['account']);
2708
  $message['subject'] .= _user_mail_text($key . '_subject', $language, $variables);
2709
  $message['body'][] = _user_mail_text($key . '_body', $language, $variables);
2710
}
2711

    
2712
/**
2713
 * Returns a mail string for a variable name.
2714
 *
2715
 * Used by user_mail() and the settings forms to retrieve strings.
2716
 */
2717
function _user_mail_text($key, $language = NULL, $variables = array(), $replace = TRUE) {
2718
  $langcode = isset($language) ? $language->language : NULL;
2719

    
2720
  if ($admin_setting = variable_get('user_mail_' . $key, FALSE)) {
2721
    // An admin setting overrides the default string.
2722
    $text = $admin_setting;
2723
  }
2724
  else {
2725
    // No override, return default string.
2726
    switch ($key) {
2727
      case 'register_no_approval_required_subject':
2728
        $text = t('Account details for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2729
        break;
2730
      case 'register_no_approval_required_body':
2731
        $text = t("[user:name],
2732

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

    
2735
[user:one-time-login-url]
2736

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

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

    
2741
username: [user:name]
2742
password: Your password
2743

    
2744
--  [site:name] team", array(), array('langcode' => $langcode));
2745
        break;
2746

    
2747
      case 'register_admin_created_subject':
2748
        $text = t('An administrator created an account for you at [site:name]', array(), array('langcode' => $langcode));
2749
        break;
2750
      case 'register_admin_created_body':
2751
        $text = t("[user:name],
2752

    
2753
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:
2754

    
2755
[user:one-time-login-url]
2756

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

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

    
2761
username: [user:name]
2762
password: Your password
2763

    
2764
--  [site:name] team", array(), array('langcode' => $langcode));
2765
        break;
2766

    
2767
      case 'register_pending_approval_subject':
2768
      case 'register_pending_approval_admin_subject':
2769
        $text = t('Account details for [user:name] at [site:name] (pending admin approval)', array(), array('langcode' => $langcode));
2770
        break;
2771
      case 'register_pending_approval_body':
2772
        $text = t("[user:name],
2773

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

    
2776

    
2777
--  [site:name] team", array(), array('langcode' => $langcode));
2778
        break;
2779
      case 'register_pending_approval_admin_body':
2780
        $text = t("[user:name] has applied for an account.
2781

    
2782
[user:edit-url]", array(), array('langcode' => $langcode));
2783
        break;
2784

    
2785
      case 'password_reset_subject':
2786
        $text = t('Replacement login information for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2787
        break;
2788
      case 'password_reset_body':
2789
        $text = t("[user:name],
2790

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

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

    
2795
[user:one-time-login-url]
2796

    
2797
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.
2798

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

    
2802
      case 'status_activated_subject':
2803
        $text = t('Account details for [user:name] at [site:name] (approved)', array(), array('langcode' => $langcode));
2804
        break;
2805
      case 'status_activated_body':
2806
        $text = t("[user:name],
2807

    
2808
Your account at [site:name] has been activated.
2809

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

    
2812
[user:one-time-login-url]
2813

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

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

    
2818
username: [user:name]
2819
password: Your password
2820

    
2821
--  [site:name] team", array(), array('langcode' => $langcode));
2822
        break;
2823

    
2824
      case 'status_blocked_subject':
2825
        $text = t('Account details for [user:name] at [site:name] (blocked)', array(), array('langcode' => $langcode));
2826
        break;
2827
      case 'status_blocked_body':
2828
        $text = t("[user:name],
2829

    
2830
Your account on [site:name] has been blocked.
2831

    
2832
--  [site:name] team", array(), array('langcode' => $langcode));
2833
        break;
2834

    
2835
      case 'cancel_confirm_subject':
2836
        $text = t('Account cancellation request for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2837
        break;
2838
      case 'cancel_confirm_body':
2839
        $text = t("[user:name],
2840

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

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

    
2845
[user:cancel-url]
2846

    
2847
NOTE: The cancellation of your account is not reversible.
2848

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

    
2851
--  [site:name] team", array(), array('langcode' => $langcode));
2852
        break;
2853

    
2854
      case 'status_canceled_subject':
2855
        $text = t('Account details for [user:name] at [site:name] (canceled)', array(), array('langcode' => $langcode));
2856
        break;
2857
      case 'status_canceled_body':
2858
        $text = t("[user:name],
2859

    
2860
Your account on [site:name] has been canceled.
2861

    
2862
--  [site:name] team", array(), array('langcode' => $langcode));
2863
        break;
2864
    }
2865
  }
2866

    
2867
  if ($replace) {
2868
    // We do not sanitize the token replacement, since the output of this
2869
    // replacement is intended for an e-mail message, not a web browser.
2870
    return token_replace($text, $variables, array('language' => $language, 'callback' => 'user_mail_tokens', 'sanitize' => FALSE, 'clear' => TRUE));
2871
  }
2872

    
2873
  return $text;
2874
}
2875

    
2876
/**
2877
 * Token callback to add unsafe tokens for user mails.
2878
 *
2879
 * This function is used by the token_replace() call at the end of
2880
 * _user_mail_text() to set up some additional tokens that can be
2881
 * used in email messages generated by user_mail().
2882
 *
2883
 * @param $replacements
2884
 *   An associative array variable containing mappings from token names to
2885
 *   values (for use with strtr()).
2886
 * @param $data
2887
 *   An associative array of token replacement values. If the 'user' element
2888
 *   exists, it must contain a user account object with the following
2889
 *   properties:
2890
 *   - login: The UNIX timestamp of the user's last login.
2891
 *   - pass: The hashed account login password.
2892
 * @param $options
2893
 *   Unused parameter required by the token_replace() function.
2894
 */
2895
function user_mail_tokens(&$replacements, $data, $options) {
2896
  if (isset($data['user'])) {
2897
    $replacements['[user:one-time-login-url]'] = user_pass_reset_url($data['user']);
2898
    $replacements['[user:cancel-url]'] = user_cancel_url($data['user']);
2899
  }
2900
}
2901

    
2902
/*** Administrative features ***********************************************/
2903

    
2904
/**
2905
 * Retrieve an array of roles matching specified conditions.
2906
 *
2907
 * @param $membersonly
2908
 *   Set this to TRUE to exclude the 'anonymous' role.
2909
 * @param $permission
2910
 *   A string containing a permission. If set, only roles containing that
2911
 *   permission are returned.
2912
 *
2913
 * @return
2914
 *   An associative array with the role id as the key and the role name as
2915
 *   value.
2916
 */
2917
function user_roles($membersonly = FALSE, $permission = NULL) {
2918
  $query = db_select('role', 'r');
2919
  $query->addTag('translatable');
2920
  $query->fields('r', array('rid', 'name'));
2921
  $query->orderBy('weight');
2922
  $query->orderBy('name');
2923
  if (!empty($permission)) {
2924
    $query->innerJoin('role_permission', 'p', 'r.rid = p.rid');
2925
    $query->condition('p.permission', $permission);
2926
  }
2927
  $result = $query->execute();
2928

    
2929
  $roles = array();
2930
  foreach ($result as $role) {
2931
    switch ($role->rid) {
2932
      // We only translate the built in role names
2933
      case DRUPAL_ANONYMOUS_RID:
2934
        if (!$membersonly) {
2935
          $roles[$role->rid] = t($role->name);
2936
        }
2937
        break;
2938
      case DRUPAL_AUTHENTICATED_RID:
2939
        $roles[$role->rid] = t($role->name);
2940
        break;
2941
      default:
2942
        $roles[$role->rid] = $role->name;
2943
    }
2944
  }
2945

    
2946
  return $roles;
2947
}
2948

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

    
2969
/**
2970
 * Fetches a user role by role name.
2971
 *
2972
 * @param $role_name
2973
 *   A string representing the role name.
2974
 *
2975
 * @return
2976
 *   A fully-loaded role object if a role with the given name exists, or FALSE
2977
 *   otherwise.
2978
 *
2979
 * @see user_role_load()
2980
 */
2981
function user_role_load_by_name($role_name) {
2982
  return db_select('role', 'r')
2983
    ->fields('r')
2984
    ->condition('name', $role_name)
2985
    ->execute()
2986
    ->fetchObject();
2987
}
2988

    
2989
/**
2990
 * Save a user role to the database.
2991
 *
2992
 * @param $role
2993
 *   A role object to modify or add. If $role->rid is not specified, a new
2994
 *   role will be created.
2995
 * @return
2996
 *   Status constant indicating if role was created or updated.
2997
 *   Failure to write the user role record will return FALSE. Otherwise.
2998
 *   SAVED_NEW or SAVED_UPDATED is returned depending on the operation
2999
 *   performed.
3000
 */
3001
function user_role_save($role) {
3002
  if ($role->name) {
3003
    // Prevent leading and trailing spaces in role names.
3004
    $role->name = trim($role->name);
3005
  }
3006
  if (!isset($role->weight)) {
3007
    // Set a role weight to make this new role last.
3008
    $query = db_select('role');
3009
    $query->addExpression('MAX(weight)');
3010
    $role->weight = $query->execute()->fetchField() + 1;
3011
  }
3012

    
3013
  // Let modules modify the user role before it is saved to the database.
3014
  module_invoke_all('user_role_presave', $role);
3015

    
3016
  if (!empty($role->rid) && $role->name) {
3017
    $status = drupal_write_record('role', $role, 'rid');
3018
    module_invoke_all('user_role_update', $role);
3019
  }
3020
  else {
3021
    $status = drupal_write_record('role', $role);
3022
    module_invoke_all('user_role_insert', $role);
3023
  }
3024

    
3025
  // Clear the user access cache.
3026
  drupal_static_reset('user_access');
3027
  drupal_static_reset('user_role_permissions');
3028

    
3029
  return $status;
3030
}
3031

    
3032
/**
3033
 * Delete a user role from database.
3034
 *
3035
 * @param $role
3036
 *   A string with the role name, or an integer with the role ID.
3037
 */
3038
function user_role_delete($role) {
3039
  if (is_int($role)) {
3040
    $role = user_role_load($role);
3041
  }
3042
  else {
3043
    $role = user_role_load_by_name($role);
3044
  }
3045

    
3046
  // If this is the administrator role, delete the user_admin_role variable.
3047
  if ($role->rid == variable_get('user_admin_role')) {
3048
    variable_del('user_admin_role');
3049
  }
3050

    
3051
  db_delete('role')
3052
    ->condition('rid', $role->rid)
3053
    ->execute();
3054
  db_delete('role_permission')
3055
    ->condition('rid', $role->rid)
3056
    ->execute();
3057
  // Update the users who have this role set:
3058
  db_delete('users_roles')
3059
    ->condition('rid', $role->rid)
3060
    ->execute();
3061

    
3062
  module_invoke_all('user_role_delete', $role);
3063

    
3064
  // Clear the user access cache.
3065
  drupal_static_reset('user_access');
3066
  drupal_static_reset('user_role_permissions');
3067
}
3068

    
3069
/**
3070
 * Menu access callback for user role editing.
3071
 */
3072
function user_role_edit_access($role) {
3073
  // Prevent the system-defined roles from being altered or removed.
3074
  if ($role->rid == DRUPAL_ANONYMOUS_RID || $role->rid == DRUPAL_AUTHENTICATED_RID) {
3075
    return FALSE;
3076
  }
3077

    
3078
  return user_access('administer permissions');
3079
}
3080

    
3081
/**
3082
 * Determine the modules that permissions belong to.
3083
 *
3084
 * @return
3085
 *   An associative array in the format $permission => $module.
3086
 */
3087
function user_permission_get_modules() {
3088
  $permissions = array();
3089
  foreach (module_implements('permission') as $module) {
3090
    $perms = module_invoke($module, 'permission');
3091
    foreach ($perms as $key => $value) {
3092
      $permissions[$key] = $module;
3093
    }
3094
  }
3095
  return $permissions;
3096
}
3097

    
3098
/**
3099
 * Change permissions for a user role.
3100
 *
3101
 * This function may be used to grant and revoke multiple permissions at once.
3102
 * For example, when a form exposes checkboxes to configure permissions for a
3103
 * role, the form submit handler may directly pass the submitted values for the
3104
 * checkboxes form element to this function.
3105
 *
3106
 * @param $rid
3107
 *   The ID of a user role to alter.
3108
 * @param $permissions
3109
 *   An associative array, where the key holds the permission name and the value
3110
 *   determines whether to grant or revoke that permission. Any value that
3111
 *   evaluates to TRUE will cause the permission to be granted. Any value that
3112
 *   evaluates to FALSE will cause the permission to be revoked.
3113
 *   @code
3114
 *     array(
3115
 *       'administer nodes' => 0,                // Revoke 'administer nodes'
3116
 *       'administer blocks' => FALSE,           // Revoke 'administer blocks'
3117
 *       'access user profiles' => 1,            // Grant 'access user profiles'
3118
 *       'access content' => TRUE,               // Grant 'access content'
3119
 *       'access comments' => 'access comments', // Grant 'access comments'
3120
 *     )
3121
 *   @endcode
3122
 *   Existing permissions are not changed, unless specified in $permissions.
3123
 *
3124
 * @see user_role_grant_permissions()
3125
 * @see user_role_revoke_permissions()
3126
 */
3127
function user_role_change_permissions($rid, array $permissions = array()) {
3128
  // Grant new permissions for the role.
3129
  $grant = array_filter($permissions);
3130
  if (!empty($grant)) {
3131
    user_role_grant_permissions($rid, array_keys($grant));
3132
  }
3133
  // Revoke permissions for the role.
3134
  $revoke = array_diff_assoc($permissions, $grant);
3135
  if (!empty($revoke)) {
3136
    user_role_revoke_permissions($rid, array_keys($revoke));
3137
  }
3138
}
3139

    
3140
/**
3141
 * Grant permissions to a user role.
3142
 *
3143
 * @param $rid
3144
 *   The ID of a user role to alter.
3145
 * @param $permissions
3146
 *   A list of permission names to grant.
3147
 *
3148
 * @see user_role_change_permissions()
3149
 * @see user_role_revoke_permissions()
3150
 */
3151
function user_role_grant_permissions($rid, array $permissions = array()) {
3152
  $modules = user_permission_get_modules();
3153
  // Grant new permissions for the role.
3154
  foreach ($permissions as $name) {
3155
    db_merge('role_permission')
3156
      ->key(array(
3157
        'rid' => $rid,
3158
        'permission' => $name,
3159
      ))
3160
      ->fields(array(
3161
        'module' => $modules[$name],
3162
      ))
3163
      ->execute();
3164
  }
3165

    
3166
  // Clear the user access cache.
3167
  drupal_static_reset('user_access');
3168
  drupal_static_reset('user_role_permissions');
3169
}
3170

    
3171
/**
3172
 * Revoke permissions from a user role.
3173
 *
3174
 * @param $rid
3175
 *   The ID of a user role to alter.
3176
 * @param $permissions
3177
 *   A list of permission names to revoke.
3178
 *
3179
 * @see user_role_change_permissions()
3180
 * @see user_role_grant_permissions()
3181
 */
3182
function user_role_revoke_permissions($rid, array $permissions = array()) {
3183
  // Revoke permissions for the role.
3184
  db_delete('role_permission')
3185
    ->condition('rid', $rid)
3186
    ->condition('permission', $permissions, 'IN')
3187
    ->execute();
3188

    
3189
  // Clear the user access cache.
3190
  drupal_static_reset('user_access');
3191
  drupal_static_reset('user_role_permissions');
3192
}
3193

    
3194
/**
3195
 * Implements hook_user_operations().
3196
 */
3197
function user_user_operations($form = array(), $form_state = array()) {
3198
  $operations = array(
3199
    'unblock' => array(
3200
      'label' => t('Unblock the selected users'),
3201
      'callback' => 'user_user_operations_unblock',
3202
    ),
3203
    'block' => array(
3204
      'label' => t('Block the selected users'),
3205
      'callback' => 'user_user_operations_block',
3206
    ),
3207
    'cancel' => array(
3208
      'label' => t('Cancel the selected user accounts'),
3209
    ),
3210
  );
3211

    
3212
  if (user_access('administer permissions')) {
3213
    $roles = user_roles(TRUE);
3214
    unset($roles[DRUPAL_AUTHENTICATED_RID]);  // Can't edit authenticated role.
3215

    
3216
    $add_roles = array();
3217
    foreach ($roles as $key => $value) {
3218
      $add_roles['add_role-' . $key] = $value;
3219
    }
3220

    
3221
    $remove_roles = array();
3222
    foreach ($roles as $key => $value) {
3223
      $remove_roles['remove_role-' . $key] = $value;
3224
    }
3225

    
3226
    if (count($roles)) {
3227
      $role_operations = array(
3228
        t('Add a role to the selected users') => array(
3229
          'label' => $add_roles,
3230
        ),
3231
        t('Remove a role from the selected users') => array(
3232
          'label' => $remove_roles,
3233
        ),
3234
      );
3235

    
3236
      $operations += $role_operations;
3237
    }
3238
  }
3239

    
3240
  // If the form has been posted, we need to insert the proper data for
3241
  // role editing if necessary.
3242
  if (!empty($form_state['submitted'])) {
3243
    $operation_rid = explode('-', $form_state['values']['operation']);
3244
    $operation = $operation_rid[0];
3245
    if ($operation == 'add_role' || $operation == 'remove_role') {
3246
      $rid = $operation_rid[1];
3247
      if (user_access('administer permissions')) {
3248
        $operations[$form_state['values']['operation']] = array(
3249
          'callback' => 'user_multiple_role_edit',
3250
          'callback arguments' => array($operation, $rid),
3251
        );
3252
      }
3253
      else {
3254
        watchdog('security', 'Detected malicious attempt to alter protected user fields.', array(), WATCHDOG_WARNING);
3255
        return;
3256
      }
3257
    }
3258
  }
3259

    
3260
  return $operations;
3261
}
3262

    
3263
/**
3264
 * Callback function for admin mass unblocking users.
3265
 */
3266
function user_user_operations_unblock($accounts) {
3267
  $accounts = user_load_multiple($accounts);
3268
  foreach ($accounts as $account) {
3269
    // Skip unblocking user if they are already unblocked.
3270
    if ($account !== FALSE && $account->status == 0) {
3271
      user_save($account, array('status' => 1));
3272
    }
3273
  }
3274
}
3275

    
3276
/**
3277
 * Callback function for admin mass blocking users.
3278
 */
3279
function user_user_operations_block($accounts) {
3280
  $accounts = user_load_multiple($accounts);
3281
  foreach ($accounts as $account) {
3282
    // Skip blocking user if they are already blocked.
3283
    if ($account !== FALSE && $account->status == 1) {
3284
      // For efficiency manually save the original account before applying any
3285
      // changes.
3286
      $account->original = clone $account;
3287
      user_save($account, array('status' => 0));
3288
    }
3289
  }
3290
}
3291

    
3292
/**
3293
 * Callback function for admin mass adding/deleting a user role.
3294
 */
3295
function user_multiple_role_edit($accounts, $operation, $rid) {
3296
  // The role name is not necessary as user_save() will reload the user
3297
  // object, but some modules' hook_user() may look at this first.
3298
  $role_name = db_query('SELECT name FROM {role} WHERE rid = :rid', array(':rid' => $rid))->fetchField();
3299

    
3300
  switch ($operation) {
3301
    case 'add_role':
3302
      $accounts = user_load_multiple($accounts);
3303
      foreach ($accounts as $account) {
3304
        // Skip adding the role to the user if they already have it.
3305
        if ($account !== FALSE && !isset($account->roles[$rid])) {
3306
          $roles = $account->roles + array($rid => $role_name);
3307
          // For efficiency manually save the original account before applying
3308
          // any changes.
3309
          $account->original = clone $account;
3310
          user_save($account, array('roles' => $roles));
3311
        }
3312
      }
3313
      break;
3314
    case 'remove_role':
3315
      $accounts = user_load_multiple($accounts);
3316
      foreach ($accounts as $account) {
3317
        // Skip removing the role from the user if they already don't have it.
3318
        if ($account !== FALSE && isset($account->roles[$rid])) {
3319
          $roles = array_diff($account->roles, array($rid => $role_name));
3320
          // For efficiency manually save the original account before applying
3321
          // any changes.
3322
          $account->original = clone $account;
3323
          user_save($account, array('roles' => $roles));
3324
        }
3325
      }
3326
      break;
3327
  }
3328
}
3329

    
3330
function user_multiple_cancel_confirm($form, &$form_state) {
3331
  $edit = $form_state['input'];
3332

    
3333
  $form['accounts'] = array('#prefix' => '<ul>', '#suffix' => '</ul>', '#tree' => TRUE);
3334
  $accounts = user_load_multiple(array_keys(array_filter($edit['accounts'])));
3335
  foreach ($accounts as $uid => $account) {
3336
    // Prevent user 1 from being canceled.
3337
    if ($uid <= 1) {
3338
      continue;
3339
    }
3340
    $form['accounts'][$uid] = array(
3341
      '#type' => 'hidden',
3342
      '#value' => $uid,
3343
      '#prefix' => '<li>',
3344
      '#suffix' => check_plain($account->name) . "</li>\n",
3345
    );
3346
  }
3347

    
3348
  // Output a notice that user 1 cannot be canceled.
3349
  if (isset($accounts[1])) {
3350
    $redirect = (count($accounts) == 1);
3351
    $message = t('The user account %name cannot be cancelled.', array('%name' => $accounts[1]->name));
3352
    drupal_set_message($message, $redirect ? 'error' : 'warning');
3353
    // If only user 1 was selected, redirect to the overview.
3354
    if ($redirect) {
3355
      drupal_goto('admin/people');
3356
    }
3357
  }
3358

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

    
3361
  module_load_include('inc', 'user', 'user.pages');
3362
  $form['user_cancel_method'] = array(
3363
    '#type' => 'item',
3364
    '#title' => t('When cancelling these accounts'),
3365
  );
3366
  $form['user_cancel_method'] += user_cancel_methods();
3367
  // Remove method descriptions.
3368
  foreach (element_children($form['user_cancel_method']) as $element) {
3369
    unset($form['user_cancel_method'][$element]['#description']);
3370
  }
3371

    
3372
  // Allow to send the account cancellation confirmation mail.
3373
  $form['user_cancel_confirm'] = array(
3374
    '#type' => 'checkbox',
3375
    '#title' => t('Require e-mail confirmation to cancel account.'),
3376
    '#default_value' => FALSE,
3377
    '#description' => t('When enabled, the user must confirm the account cancellation via e-mail.'),
3378
  );
3379
  // Also allow to send account canceled notification mail, if enabled.
3380
  $form['user_cancel_notify'] = array(
3381
    '#type' => 'checkbox',
3382
    '#title' => t('Notify user when account is canceled.'),
3383
    '#default_value' => FALSE,
3384
    '#access' => variable_get('user_mail_status_canceled_notify', FALSE),
3385
    '#description' => t('When enabled, the user will receive an e-mail notification after the account has been cancelled.'),
3386
  );
3387

    
3388
  return confirm_form($form,
3389
                      t('Are you sure you want to cancel these user accounts?'),
3390
                      'admin/people', t('This action cannot be undone.'),
3391
                      t('Cancel accounts'), t('Cancel'));
3392
}
3393

    
3394
/**
3395
 * Submit handler for mass-account cancellation form.
3396
 *
3397
 * @see user_multiple_cancel_confirm()
3398
 * @see user_cancel_confirm_form_submit()
3399
 */
3400
function user_multiple_cancel_confirm_submit($form, &$form_state) {
3401
  global $user;
3402

    
3403
  if ($form_state['values']['confirm']) {
3404
    foreach ($form_state['values']['accounts'] as $uid => $value) {
3405
      // Prevent programmatic form submissions from cancelling user 1.
3406
      if ($uid <= 1) {
3407
        continue;
3408
      }
3409
      // Prevent user administrators from deleting themselves without confirmation.
3410
      if ($uid == $user->uid) {
3411
        $admin_form_state = $form_state;
3412
        unset($admin_form_state['values']['user_cancel_confirm']);
3413
        $admin_form_state['values']['_account'] = $user;
3414
        user_cancel_confirm_form_submit(array(), $admin_form_state);
3415
      }
3416
      else {
3417
        user_cancel($form_state['values'], $uid, $form_state['values']['user_cancel_method']);
3418
      }
3419
    }
3420
  }
3421
  $form_state['redirect'] = 'admin/people';
3422
}
3423

    
3424
/**
3425
 * Retrieve a list of all user setting/information categories and sort them by weight.
3426
 */
3427
function _user_categories() {
3428
  $categories = module_invoke_all('user_categories');
3429
  usort($categories, '_user_sort');
3430

    
3431
  return $categories;
3432
}
3433

    
3434
function _user_sort($a, $b) {
3435
  $a = (array) $a + array('weight' => 0, 'title' => '');
3436
  $b = (array) $b + array('weight' => 0, 'title' => '');
3437
  return $a['weight'] < $b['weight'] ? -1 : ($a['weight'] > $b['weight'] ? 1 : ($a['title'] < $b['title'] ? -1 : 1));
3438
}
3439

    
3440
/**
3441
 * List user administration filters that can be applied.
3442
 */
3443
function user_filters() {
3444
  // Regular filters
3445
  $filters = array();
3446
  $roles = user_roles(TRUE);
3447
  unset($roles[DRUPAL_AUTHENTICATED_RID]); // Don't list authorized role.
3448
  if (count($roles)) {
3449
    $filters['role'] = array(
3450
      'title' => t('role'),
3451
      'field' => 'ur.rid',
3452
      'options' => array(
3453
        '[any]' => t('any'),
3454
      ) + $roles,
3455
    );
3456
  }
3457

    
3458
  $options = array();
3459
  foreach (module_implements('permission') as $module) {
3460
    $function = $module . '_permission';
3461
    if ($permissions = $function()) {
3462
      asort($permissions);
3463
      foreach ($permissions as $permission => $description) {
3464
        $options[t('@module module', array('@module' => $module))][$permission] = t($permission);
3465
      }
3466
    }
3467
  }
3468
  ksort($options);
3469
  $filters['permission'] = array(
3470
    'title' => t('permission'),
3471
    'options' => array(
3472
      '[any]' => t('any'),
3473
    ) + $options,
3474
  );
3475

    
3476
  $filters['status'] = array(
3477
    'title' => t('status'),
3478
    'field' => 'u.status',
3479
    'options' => array(
3480
      '[any]' => t('any'),
3481
      1 => t('active'),
3482
      0 => t('blocked'),
3483
    ),
3484
  );
3485
  return $filters;
3486
}
3487

    
3488
/**
3489
 * Extends a query object for user administration filters based on session.
3490
 *
3491
 * @param $query
3492
 *   Query object that should be filtered.
3493
 */
3494
function user_build_filter_query(SelectQuery $query) {
3495
  $filters = user_filters();
3496
  // Extend Query with filter conditions.
3497
  foreach (isset($_SESSION['user_overview_filter']) ? $_SESSION['user_overview_filter'] : array() as $filter) {
3498
    list($key, $value) = $filter;
3499
    // This checks to see if this permission filter is an enabled permission for
3500
    // the authenticated role. If so, then all users would be listed, and we can
3501
    // skip adding it to the filter query.
3502
    if ($key == 'permission') {
3503
      $account = new stdClass();
3504
      $account->uid = 'user_filter';
3505
      $account->roles = array(DRUPAL_AUTHENTICATED_RID => 1);
3506
      if (user_access($value, $account)) {
3507
        continue;
3508
      }
3509
      $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
3510
      $permission_alias = $query->join('role_permission', 'p', $users_roles_alias . '.rid = %alias.rid');
3511
      $query->condition($permission_alias . '.permission', $value);
3512
    }
3513
    elseif ($key == 'role') {
3514
      $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
3515
      $query->condition($users_roles_alias . '.rid' , $value);
3516
    }
3517
    else {
3518
      $query->condition($filters[$key]['field'], $value);
3519
    }
3520
  }
3521
}
3522

    
3523
/**
3524
 * Implements hook_comment_view().
3525
 */
3526
function user_comment_view($comment) {
3527
  if (variable_get('user_signatures', 0) && !empty($comment->signature)) {
3528
    // @todo This alters and replaces the original object value, so a
3529
    //   hypothetical process of loading, viewing, and saving will hijack the
3530
    //   stored data. Consider renaming to $comment->signature_safe or similar
3531
    //   here and elsewhere in Drupal 8.
3532
    $comment->signature = check_markup($comment->signature, $comment->signature_format, '', TRUE);
3533
  }
3534
  else {
3535
    $comment->signature = '';
3536
  }
3537
}
3538

    
3539
/**
3540
 * Returns HTML for a user signature.
3541
 *
3542
 * @param $variables
3543
 *   An associative array containing:
3544
 *   - signature: The user's signature.
3545
 *
3546
 * @ingroup themeable
3547
 */
3548
function theme_user_signature($variables) {
3549
  $signature = $variables['signature'];
3550
  $output = '';
3551

    
3552
  if ($signature) {
3553
    $output .= '<div class="clear">';
3554
    $output .= '<div>—</div>';
3555
    $output .= $signature;
3556
    $output .= '</div>';
3557
  }
3558

    
3559
  return $output;
3560
}
3561

    
3562
/**
3563
 * Get the language object preferred by the user. This user preference can
3564
 * be set on the user account editing page, and is only available if there
3565
 * are more than one languages enabled on the site. If the user did not
3566
 * choose a preferred language, or is the anonymous user, the $default
3567
 * value, or if it is not set, the site default language will be returned.
3568
 *
3569
 * @param $account
3570
 *   User account to look up language for.
3571
 * @param $default
3572
 *   Optional default language object to return if the account
3573
 *   has no valid language.
3574
 */
3575
function user_preferred_language($account, $default = NULL) {
3576
  $language_list = language_list();
3577
  if (!empty($account->language) && isset($language_list[$account->language])) {
3578
    return $language_list[$account->language];
3579
  }
3580
  else {
3581
    return $default ? $default : language_default();
3582
  }
3583
}
3584

    
3585
/**
3586
 * Conditionally create and send a notification email when a certain
3587
 * operation happens on the given user account.
3588
 *
3589
 * @see user_mail_tokens()
3590
 * @see drupal_mail()
3591
 *
3592
 * @param $op
3593
 *   The operation being performed on the account. Possible values:
3594
 *   - 'register_admin_created': Welcome message for user created by the admin.
3595
 *   - 'register_no_approval_required': Welcome message when user
3596
 *     self-registers.
3597
 *   - 'register_pending_approval': Welcome message, user pending admin
3598
 *     approval.
3599
 *   - 'password_reset': Password recovery request.
3600
 *   - 'status_activated': Account activated.
3601
 *   - 'status_blocked': Account blocked.
3602
 *   - 'cancel_confirm': Account cancellation request.
3603
 *   - 'status_canceled': Account canceled.
3604
 *
3605
 * @param $account
3606
 *   The user object of the account being notified. Must contain at
3607
 *   least the fields 'uid', 'name', and 'mail'.
3608
 * @param $language
3609
 *   Optional language to use for the notification, overriding account language.
3610
 *
3611
 * @return
3612
 *   The return value from drupal_mail_system()->mail(), if ends up being
3613
 *   called.
3614
 */
3615
function _user_mail_notify($op, $account, $language = NULL) {
3616
  // By default, we always notify except for canceled and blocked.
3617
  $default_notify = ($op != 'status_canceled' && $op != 'status_blocked');
3618
  $notify = variable_get('user_mail_' . $op . '_notify', $default_notify);
3619
  if ($notify) {
3620
    $params['account'] = $account;
3621
    $language = $language ? $language : user_preferred_language($account);
3622
    $mail = drupal_mail('user', $op, $account->mail, $language, $params);
3623
    if ($op == 'register_pending_approval') {
3624
      // If a user registered requiring admin approval, notify the admin, too.
3625
      // We use the site default language for this.
3626
      drupal_mail('user', 'register_pending_approval_admin', variable_get('site_mail', ini_get('sendmail_from')), language_default(), $params);
3627
    }
3628
  }
3629
  return empty($mail) ? NULL : $mail['result'];
3630
}
3631

    
3632
/**
3633
 * Form element process handler for client-side password validation.
3634
 *
3635
 * This #process handler is automatically invoked for 'password_confirm' form
3636
 * elements to add the JavaScript and string translations for dynamic password
3637
 * validation.
3638
 *
3639
 * @see system_element_info()
3640
 */
3641
function user_form_process_password_confirm($element) {
3642
  global $user;
3643

    
3644
  $js_settings = array(
3645
    'password' => array(
3646
      'strengthTitle' => t('Password strength:'),
3647
      'hasWeaknesses' => t('To make your password stronger:'),
3648
      'tooShort' => t('Make it at least 6 characters'),
3649
      'addLowerCase' => t('Add lowercase letters'),
3650
      'addUpperCase' => t('Add uppercase letters'),
3651
      'addNumbers' => t('Add numbers'),
3652
      'addPunctuation' => t('Add punctuation'),
3653
      'sameAsUsername' => t('Make it different from your username'),
3654
      'confirmSuccess' => t('yes'),
3655
      'confirmFailure' => t('no'),
3656
      'weak' => t('Weak'),
3657
      'fair' => t('Fair'),
3658
      'good' => t('Good'),
3659
      'strong' => t('Strong'),
3660
      'confirmTitle' => t('Passwords match:'),
3661
      'username' => (isset($user->name) ? $user->name : ''),
3662
    ),
3663
  );
3664

    
3665
  $element['#attached']['js'][] = drupal_get_path('module', 'user') . '/user.js';
3666
  // Ensure settings are only added once per page.
3667
  static $already_added = FALSE;
3668
  if (!$already_added) {
3669
    $already_added = TRUE;
3670
    $element['#attached']['js'][] = array('data' => $js_settings, 'type' => 'setting');
3671
  }
3672

    
3673
  return $element;
3674
}
3675

    
3676
/**
3677
 * Implements hook_node_load().
3678
 */
3679
function user_node_load($nodes, $types) {
3680
  // Build an array of all uids for node authors, keyed by nid.
3681
  $uids = array();
3682
  foreach ($nodes as $nid => $node) {
3683
    $uids[$nid] = $node->uid;
3684
  }
3685

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

    
3689
  // Add these values back into the node objects.
3690
  foreach ($uids as $nid => $uid) {
3691
    $nodes[$nid]->name = $user_fields[$uid]->name;
3692
    $nodes[$nid]->picture = $user_fields[$uid]->picture;
3693
    $nodes[$nid]->data = $user_fields[$uid]->data;
3694
  }
3695
}
3696

    
3697
/**
3698
 * Implements hook_image_style_delete().
3699
 */
3700
function user_image_style_delete($style) {
3701
  // If a style is deleted, update the variables.
3702
  // Administrators choose a replacement style when deleting.
3703
  user_image_style_save($style);
3704
}
3705

    
3706
/**
3707
 * Implements hook_image_style_save().
3708
 */
3709
function user_image_style_save($style) {
3710
  // If a style is renamed, update the variables that use it.
3711
  if (isset($style['old_name']) && $style['old_name'] == variable_get('user_picture_style', '')) {
3712
    variable_set('user_picture_style', $style['name']);
3713
  }
3714
}
3715

    
3716
/**
3717
 * Implements hook_action_info().
3718
 */
3719
function user_action_info() {
3720
  return array(
3721
    'user_block_user_action' => array(
3722
      'label' => t('Block current user'),
3723
      'type' => 'user',
3724
      'configurable' => FALSE,
3725
      'triggers' => array('any'),
3726
    ),
3727
  );
3728
}
3729

    
3730
/**
3731
 * Blocks a specific user or the current user, if one is not specified.
3732
 *
3733
 * @param $entity
3734
 *   (optional) An entity object; if it is provided and it has a uid property,
3735
 *   the user with that ID is blocked.
3736
 * @param $context
3737
 *   (optional) An associative array; if no user ID is found in $entity, the
3738
 *   'uid' element of this array determines the user to block.
3739
 *
3740
 * @ingroup actions
3741
 */
3742
function user_block_user_action(&$entity, $context = array()) {
3743
  // First priority: If there is a $entity->uid, block that user.
3744
  // This is most likely a user object or the author if a node or comment.
3745
  if (isset($entity->uid)) {
3746
    $uid = $entity->uid;
3747
  }
3748
  elseif (isset($context['uid'])) {
3749
    $uid = $context['uid'];
3750
  }
3751
  // If neither of those are valid, then block the current user.
3752
  else {
3753
    $uid = $GLOBALS['user']->uid;
3754
  }
3755
  $account = user_load($uid);
3756
  $account = user_save($account, array('status' => 0));
3757
  watchdog('action', 'Blocked user %name.', array('%name' => $account->name));
3758
}
3759

    
3760
/**
3761
 * Implements hook_form_FORM_ID_alter().
3762
 *
3763
 * Add a checkbox for the 'user_register_form' instance settings on the 'Edit
3764
 * field instance' form.
3765
 */
3766
function user_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
3767
  $instance = $form['#instance'];
3768

    
3769
  if ($instance['entity_type'] == 'user' && !$form['#field']['locked']) {
3770
    $form['instance']['settings']['user_register_form'] = array(
3771
      '#type' => 'checkbox',
3772
      '#title' => t('Display on user registration form.'),
3773
      '#description' => t("This is compulsory for 'required' fields."),
3774
      // Field instances created in D7 beta releases before the setting was
3775
      // introduced might be set as 'required' and 'not shown on user_register
3776
      // form'. We make sure the checkbox comes as 'checked' for those.
3777
      '#default_value' => $instance['settings']['user_register_form'] || $instance['required'],
3778
      // Display just below the 'required' checkbox.
3779
      '#weight' => $form['instance']['required']['#weight'] + .1,
3780
      // Disabled when the 'required' checkbox is checked.
3781
      '#states' => array(
3782
        'enabled' => array('input[name="instance[required]"]' => array('checked' => FALSE)),
3783
      ),
3784
      // Checked when the 'required' checkbox is checked. This is done through
3785
      // a custom behavior, since the #states system would also synchronize on
3786
      // uncheck.
3787
      '#attached' => array(
3788
        'js' => array(drupal_get_path('module', 'user') . '/user.js'),
3789
      ),
3790
    );
3791

    
3792
    array_unshift($form['#submit'], 'user_form_field_ui_field_edit_form_submit');
3793
  }
3794
}
3795

    
3796
/**
3797
 * Additional submit handler for the 'Edit field instance' form.
3798
 *
3799
 * Make sure the 'user_register_form' setting is set for required fields.
3800
 */
3801
function user_form_field_ui_field_edit_form_submit($form, &$form_state) {
3802
  $instance = $form_state['values']['instance'];
3803

    
3804
  if (!empty($instance['required'])) {
3805
    form_set_value($form['instance']['settings']['user_register_form'], 1, $form_state);
3806
  }
3807
}
3808

    
3809
/**
3810
 * Form builder; the user registration form.
3811
 *
3812
 * @ingroup forms
3813
 * @see user_account_form()
3814
 * @see user_account_form_validate()
3815
 * @see user_register_submit()
3816
 */
3817
function user_register_form($form, &$form_state) {
3818
  global $user;
3819

    
3820
  $admin = user_access('administer users');
3821

    
3822
  // Pass access information to the submit handler. Running an access check
3823
  // inside the submit function interferes with form processing and breaks
3824
  // hook_form_alter().
3825
  $form['administer_users'] = array(
3826
    '#type' => 'value',
3827
    '#value' => $admin,
3828
  );
3829

    
3830
  // If we aren't admin but already logged on, go to the user page instead.
3831
  if (!$admin && $user->uid) {
3832
    drupal_goto('user/' . $user->uid);
3833
  }
3834

    
3835
  $form['#user'] = drupal_anonymous_user();
3836
  $form['#user_category'] = 'register';
3837

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

    
3841
  // Start with the default user account fields.
3842
  user_account_form($form, $form_state);
3843

    
3844
  // Attach field widgets, and hide the ones where the 'user_register_form'
3845
  // setting is not on.
3846
  $langcode = entity_language('user', $form['#user']);
3847
  field_attach_form('user', $form['#user'], $form, $form_state, $langcode);
3848
  foreach (field_info_instances('user', 'user') as $field_name => $instance) {
3849
    if (empty($instance['settings']['user_register_form'])) {
3850
      $form[$field_name]['#access'] = FALSE;
3851
    }
3852
  }
3853

    
3854
  if ($admin) {
3855
    // Redirect back to page which initiated the create request;
3856
    // usually admin/people/create.
3857
    $form_state['redirect'] = $_GET['q'];
3858
  }
3859

    
3860
  $form['actions'] = array('#type' => 'actions');
3861
  $form['actions']['submit'] = array(
3862
    '#type' => 'submit',
3863
    '#value' => t('Create new account'),
3864
  );
3865

    
3866
  $form['#validate'][] = 'user_register_validate';
3867
  // Add the final user registration form submit handler.
3868
  $form['#submit'][] = 'user_register_submit';
3869

    
3870
  return $form;
3871
}
3872

    
3873
/**
3874
 * Validation function for the user registration form.
3875
 */
3876
function user_register_validate($form, &$form_state) {
3877
  entity_form_field_validate('user', $form, $form_state);
3878
}
3879

    
3880
/**
3881
 * Submit handler for the user registration form.
3882
 *
3883
 * This function is shared by the installation form and the normal registration form,
3884
 * which is why it can't be in the user.pages.inc file.
3885
 *
3886
 * @see user_register_form()
3887
 */
3888
function user_register_submit($form, &$form_state) {
3889
  $admin = $form_state['values']['administer_users'];
3890

    
3891
  if (!variable_get('user_email_verification', TRUE) || $admin) {
3892
    $pass = $form_state['values']['pass'];
3893
  }
3894
  else {
3895
    $pass = user_password();
3896
  }
3897
  $notify = !empty($form_state['values']['notify']);
3898

    
3899
  // Remove unneeded values.
3900
  form_state_values_clean($form_state);
3901

    
3902
  $form_state['values']['pass'] = $pass;
3903
  $form_state['values']['init'] = $form_state['values']['mail'];
3904

    
3905
  $account = $form['#user'];
3906

    
3907
  entity_form_submit_build_entity('user', $account, $form, $form_state);
3908

    
3909
  // Populate $edit with the properties of $account, which have been edited on
3910
  // this form by taking over all values, which appear in the form values too.
3911
  $edit = array_intersect_key((array) $account, $form_state['values']);
3912
  $account = user_save($account, $edit);
3913

    
3914
  // Terminate if an error occurred during user_save().
3915
  if (!$account) {
3916
    drupal_set_message(t("Error saving user account."), 'error');
3917
    $form_state['redirect'] = '';
3918
    return;
3919
  }
3920
  $form_state['user'] = $account;
3921
  $form_state['values']['uid'] = $account->uid;
3922

    
3923
  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'));
3924

    
3925
  // Add plain text password into user account to generate mail tokens.
3926
  $account->password = $pass;
3927

    
3928
  // New administrative account without notification.
3929
  $uri = entity_uri('user', $account);
3930
  if ($admin && !$notify) {
3931
    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)));
3932
  }
3933
  // No e-mail verification required; log in user immediately.
3934
  elseif (!$admin && !variable_get('user_email_verification', TRUE) && $account->status) {
3935
    _user_mail_notify('register_no_approval_required', $account);
3936
    $form_state['uid'] = $account->uid;
3937
    user_login_submit(array(), $form_state);
3938
    drupal_set_message(t('Registration successful. You are now logged in.'));
3939
    $form_state['redirect'] = '';
3940
  }
3941
  // No administrator approval required.
3942
  elseif ($account->status || $notify) {
3943
    $op = $notify ? 'register_admin_created' : 'register_no_approval_required';
3944
    _user_mail_notify($op, $account);
3945
    if ($notify) {
3946
      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)));
3947
    }
3948
    else {
3949
      drupal_set_message(t('A welcome message with further instructions has been sent to your e-mail address.'));
3950
      $form_state['redirect'] = '';
3951
    }
3952
  }
3953
  // Administrator approval required.
3954
  else {
3955
    _user_mail_notify('register_pending_approval', $account);
3956
    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.'));
3957
    $form_state['redirect'] = '';
3958
  }
3959
}
3960

    
3961
/**
3962
 * Implements hook_modules_installed().
3963
 */
3964
function user_modules_installed($modules) {
3965
  // Assign all available permissions to the administrator role.
3966
  $rid = variable_get('user_admin_role', 0);
3967
  if ($rid) {
3968
    $permissions = array();
3969
    foreach ($modules as $module) {
3970
      if ($module_permissions = module_invoke($module, 'permission')) {
3971
        $permissions = array_merge($permissions, array_keys($module_permissions));
3972
      }
3973
    }
3974
    if (!empty($permissions)) {
3975
      user_role_grant_permissions($rid, $permissions);
3976
    }
3977
  }
3978
}
3979

    
3980
/**
3981
 * Implements hook_modules_uninstalled().
3982
 */
3983
function user_modules_uninstalled($modules) {
3984
   db_delete('role_permission')
3985
     ->condition('module', $modules, 'IN')
3986
     ->execute();
3987
}
3988

    
3989
/**
3990
 * Helper function to rewrite the destination to avoid redirecting to login page after login.
3991
 *
3992
 * Third-party authentication modules may use this function to determine the
3993
 * proper destination after a user has been properly logged in.
3994
 */
3995
function user_login_destination() {
3996
  $destination = drupal_get_destination();
3997
  if ($destination['destination'] == 'user/login') {
3998
    $destination['destination'] = 'user';
3999
  }
4000
  return $destination;
4001
}
4002

    
4003
/**
4004
 * Saves visitor information as a cookie so it can be reused.
4005
 *
4006
 * @param $values
4007
 *   An array of key/value pairs to be saved into a cookie.
4008
 */
4009
function user_cookie_save(array $values) {
4010
  foreach ($values as $field => $value) {
4011
    // Set cookie for 365 days.
4012
    setrawcookie('Drupal.visitor.' . $field, rawurlencode($value), REQUEST_TIME + 31536000, '/');
4013
  }
4014
}
4015

    
4016
/**
4017
 * Delete a visitor information cookie.
4018
 *
4019
 * @param $cookie_name
4020
 *   A cookie name such as 'homepage'.
4021
 */
4022
function user_cookie_delete($cookie_name) {
4023
  setrawcookie('Drupal.visitor.' . $cookie_name, '', REQUEST_TIME - 3600, '/');
4024
}
4025

    
4026
/**
4027
 * Implements hook_rdf_mapping().
4028
 */
4029
function user_rdf_mapping() {
4030
  return array(
4031
    array(
4032
      'type' => 'user',
4033
      'bundle' => RDF_DEFAULT_BUNDLE,
4034
      'mapping' => array(
4035
        'rdftype' => array('sioc:UserAccount'),
4036
        'name' => array(
4037
          'predicates' => array('foaf:name'),
4038
        ),
4039
        'homepage' => array(
4040
          'predicates' => array('foaf:page'),
4041
          'type' => 'rel',
4042
        ),
4043
      ),
4044
    ),
4045
  );
4046
}
4047

    
4048
/**
4049
 * Implements hook_file_download_access().
4050
 */
4051
function user_file_download_access($field, $entity_type, $entity) {
4052
  if ($entity_type == 'user') {
4053
    return user_view_access($entity);
4054
  }
4055
}
4056

    
4057
/**
4058
 * Implements hook_system_info_alter().
4059
 *
4060
 * Drupal 7 ships with two methods to add additional fields to users: Profile
4061
 * module, a legacy module dating back from 2002, and Field API integration
4062
 * with users. While Field API support for users currently provides less end
4063
 * user features, the inefficient data storage mechanism of Profile module, as
4064
 * well as its lack of consistency with the rest of the entity / field based
4065
 * systems in Drupal 7, make this a sub-optimal solution to those who were not
4066
 * using it in previous releases of Drupal.
4067
 *
4068
 * To prevent new Drupal 7 sites from installing Profile module, and
4069
 * unwittingly ending up with two completely different and incompatible methods
4070
 * of extending users, only make the Profile module available if the profile_*
4071
 * tables are present.
4072
 *
4073
 * @todo: Remove in D8, pending upgrade path.
4074
 */
4075
function user_system_info_alter(&$info, $file, $type) {
4076
  if ($type == 'module' && $file->name == 'profile' && db_table_exists('profile_field')) {
4077
    $info['hidden'] = FALSE;
4078
  }
4079
}