Projet

Général

Profil

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

root / drupal7 / modules / user / user.module @ 4444412d

1
<?php
2

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

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

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

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

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

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

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

    
40
  switch ($path) {
41
    case 'admin/help#user':
42
      $output = '';
43
      $output .= '<h3>' . t('About') . '</h3>';
44
      $output .= '<p>' . t('The User module allows users to register, log in, and log out. It also allows users with proper permissions to manage user roles (used to classify users) and permissions associated with those roles. For more information, see the online handbook entry for <a href="@user">User module</a>.', array('@user' => 'http://drupal.org/documentation/modules/user')) . '</p>';
45
      $output .= '<h3>' . t('Uses') . '</h3>';
46
      $output .= '<dl>';
47
      $output .= '<dt>' . t('Creating and managing users') . '</dt>';
48
      $output .= '<dd>' . t('The User module allows users with the appropriate <a href="@permissions">permissions</a> to create user accounts through the <a href="@people">People administration page</a>, where they can also assign users to one or more roles, and block or delete user accounts. If allowed, users without accounts (anonymous users) can create their own accounts on the <a href="@register">Create new account</a> page.', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-user')), '@people' => url('admin/people'), '@register' => url('user/register'))) . '</dd>';
49
      $output .= '<dt>' . t('User roles and permissions') . '</dt>';
50
      $output .= '<dd>' . t('<em>Roles</em> are used to group and classify users; each user can be assigned one or more roles. By default there are two roles: <em>anonymous user</em> (users that are not logged in) and <em>authenticated user</em> (users that are registered and logged in). Depending on choices you made when you installed Drupal, the installation process may have defined more roles, and you can create additional custom roles on the <a href="@roles">Roles page</a>. After creating roles, you can set permissions for each role on the <a href="@permissions_user">Permissions page</a>. Granting a permission allows users who have been assigned a particular role to perform an action on the site, such as viewing a particular type of content, editing or creating content, administering settings for a particular module, or using a particular function of the site (such as search).', array('@permissions_user' => url('admin/people/permissions'), '@roles' => url('admin/people/permissions/roles'))) . '</dd>';
51
      $output .= '<dt>' . t('Account settings') . '</dt>';
52
      $output .= '<dd>' . t('The <a href="@accounts">Account settings page</a> allows you to manage settings for the displayed name of the anonymous user role, personal contact forms, user registration, and account cancellation. On this page you can also manage settings for account personalization (including signatures and user pictures), and adapt the text for the e-mail messages that are sent automatically during the user registration process.', array('@accounts'  => url('admin/config/people/accounts'))) . '</dd>';
53
      $output .= '</dl>';
54
      return $output;
55
    case 'admin/people/create':
56
      return '<p>' . t("This web page allows administrators to register new users. Users' e-mail addresses and usernames must be unique.") . '</p>';
57
    case 'admin/people/permissions':
58
      return '<p>' . t('Permissions let you control what users can do and see on your site. You can define a specific set of permissions for each role. (See the <a href="@role">Roles</a> page to create a role). Two important roles to consider are Authenticated Users and Administrators. Any permissions granted to the Authenticated Users role will be given to any user who can log into your site. You can make any role the Administrator role for the site, meaning this will be granted all new permissions automatically. You can do this on the <a href="@settings">User Settings</a> page. You should be careful to ensure that only trusted users are given this access and level of control of your site.', array('@role' => url('admin/people/permissions/roles'), '@settings' => url('admin/config/people/accounts'))) . '</p>';
59
    case 'admin/people/permissions/roles':
60
      $output = '<p>' . t('Roles allow you to fine tune the security and administration of Drupal. A role defines a group of users that have certain privileges as defined on the <a href="@permissions">permissions page</a>. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the names and order of the roles on your site. It is recommended to order your roles from least permissive (anonymous user) to most permissive (administrator). To delete a role choose "edit role".', array('@permissions' => url('admin/people/permissions'))) . '</p>';
61
      $output .= '<p>' . t('By default, Drupal comes with two user roles:') . '</p>';
62
      $output .= '<ul>';
63
      $output .= '<li>' . t("Anonymous user: this role is used for users that don't have a user account or that are not authenticated.") . '</li>';
64
      $output .= '<li>' . t('Authenticated user: this role is automatically granted to all logged in users.') . '</li>';
65
      $output .= '</ul>';
66
      return $output;
67
    case 'admin/config/people/accounts/fields':
68
      return '<p>' . t('This form lets administrators add, edit, and arrange fields for storing user data.') . '</p>';
69
    case 'admin/config/people/accounts/display':
70
      return '<p>' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '</p>';
71
    case 'admin/people/search':
72
      return '<p>' . t('Enter a simple pattern ("*" may be used as a wildcard match) to search for a username or e-mail address. For example, one may search for "br" and Drupal might return "brian", "brad", and "brenda@example.com".') . '</p>';
73
  }
74
}
75

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

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

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

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

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

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

    
237
  return $return;
238
}
239

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

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

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

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

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

    
317
    // Add any additional roles from the database.
318
    $result = db_query('SELECT r.rid, r.name, ur.uid FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid IN (:uids)', array(':uids' => array_keys($queried_users)));
319
    foreach ($result as $record) {
320
      $queried_users[$record->uid]->roles[$record->rid] = $record->name;
321
    }
322

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

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

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

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

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

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

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

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

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

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

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

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

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

    
516
      // Reload user roles if provided.
517
      if ($account->roles != $account->original->roles) {
518
        db_delete('users_roles')
519
          ->condition('uid', $account->uid)
520
          ->execute();
521

    
522
        $query = db_insert('users_roles')->fields(array('uid', 'rid'));
523
        foreach (array_keys($account->roles) as $rid) {
524
          if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
525
            $query->values(array(
526
              'uid' => $account->uid,
527
              'rid' => $rid,
528
            ));
529
          }
530
        }
531
        $query->execute();
532
      }
533

    
534
      // Delete a blocked user's sessions to kick them if they are online.
535
      if ($account->original->status != $account->status && $account->status == 0) {
536
        drupal_session_destroy_uid($account->uid);
537
      }
538

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

    
548
      // Save Field data.
549
      field_attach_update('user', $account);
550

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

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

    
584
      // Make sure $account is properly initialized.
585
      $account->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
586

    
587
      field_attach_insert('user', $account);
588
      $edit = (array) $account;
589
      user_module_invoke('insert', $edit, $account, $category);
590
      module_invoke_all('entity_insert', $account, 'user');
591

    
592
      // Save user roles.
593
      if (count($account->roles) > 1) {
594
        $query = db_insert('users_roles')->fields(array('uid', 'rid'));
595
        foreach (array_keys($account->roles) as $rid) {
596
          if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
597
            $query->values(array(
598
              'uid' => $account->uid,
599
              'rid' => $rid,
600
            ));
601
          }
602
        }
603
        $query->execute();
604
      }
605
    }
606
    // Clear internal properties.
607
    unset($account->is_new);
608
    unset($account->original);
609
    // Clear the static loading cache.
610
    entity_get_controller('user')->resetCache(array($account->uid));
611

    
612
    return $account;
613
  }
614
  catch (Exception $e) {
615
    $transaction->rollback();
616
    watchdog_exception('user', $e);
617
    throw $e;
618
  }
619
}
620

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

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

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

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

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

    
712
  // Zero-based count of characters in the allowable list:
713
  $len = strlen($allowable_characters) - 1;
714

    
715
  // Declare the password as a blank string.
716
  $pass = '';
717

    
718
  // Loop the number of times specified by $length.
719
  for ($i = 0; $i < $length; $i++) {
720
    do {
721
      // Find a secure random number within the range needed.
722
      $index = ord(drupal_random_bytes(1));
723
    } while ($index > $len);
724

    
725
    // Each iteration, pick a random character from the
726
    // allowable string and append it to the password:
727
    $pass .= $allowable_characters[$index];
728
  }
729

    
730
  return $pass;
731
}
732

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

    
747
  $role_permissions = $fetch = array();
748

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

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

    
767
      foreach ($result as $row) {
768
        $cache[$row->rid][$row->permission] = TRUE;
769
      }
770
      foreach ($fetch as $rid) {
771
        // For every rid, we know we at least assigned an empty array.
772
        $role_permissions[$rid] = $cache[$rid];
773
      }
774
    }
775
  }
776

    
777
  return $role_permissions;
778
}
779

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

    
798
  if (!isset($account)) {
799
    $account = $user;
800
  }
801

    
802
  // User #1 has all privileges:
803
  if ($account->uid == 1) {
804
    return TRUE;
805
  }
806

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

    
818
    $perms = array();
819
    foreach ($role_permissions as $one_role) {
820
      $perms += $one_role;
821
    }
822
    $perm[$account->uid] = $perms;
823
  }
824

    
825
  return isset($perm[$account->uid][$string]);
826
}
827

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

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

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

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

    
904
/**
905
 * Implements hook_file_delete().
906
 */
907
function user_file_delete($file) {
908
  // Remove any references to the file.
909
  db_update('users')
910
    ->fields(array('picture' => 0))
911
    ->condition('picture', $file->fid)
912
    ->execute();
913
}
914

    
915
/**
916
 * Implements hook_search_info().
917
 */
918
function user_search_info() {
919
  return array(
920
    'title' => 'Users',
921
  );
922
}
923

    
924
/**
925
 * Implements hook_search_access().
926
 */
927
function user_search_access() {
928
  return user_access('access user profiles');
929
}
930

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

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

    
972
  return $results;
973
}
974

    
975
/**
976
 * Implements hook_element_info().
977
 */
978
function user_element_info() {
979
  $types['user_profile_category'] = array(
980
    '#theme_wrappers' => array('user_profile_category'),
981
  );
982
  $types['user_profile_item'] = array(
983
    '#theme' => 'user_profile_item',
984
  );
985
  return $types;
986
}
987

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

    
1012
/**
1013
 * Helper function to add default user account fields to user registration and edit form.
1014
 *
1015
 * @see user_account_form_validate()
1016
 * @see user_validate_current_pass()
1017
 * @see user_validate_picture()
1018
 * @see user_validate_mail()
1019
 */
1020
function user_account_form(&$form, &$form_state) {
1021
  global $user;
1022

    
1023
  $account = $form['#user'];
1024
  $register = ($form['#user']->uid > 0 ? FALSE : TRUE);
1025

    
1026
  $admin = user_access('administer users');
1027

    
1028
  $form['#validate'][] = 'user_account_form_validate';
1029

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

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

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

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

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

    
1144
  $form['account']['notify'] = array(
1145
    '#type' => 'checkbox',
1146
    '#title' => t('Notify user of new account'),
1147
    '#access' => $register && $admin,
1148
  );
1149

    
1150
  // Signature.
1151
  $form['signature_settings'] = array(
1152
    '#type' => 'fieldset',
1153
    '#title' => t('Signature settings'),
1154
    '#weight' => 1,
1155
    '#access' => (!$register && variable_get('user_signatures', 0)),
1156
  );
1157

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

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

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

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

    
1237
    // Trim whitespace from mail, to prevent confusing 'e-mail not valid'
1238
    // warnings often caused by cutting and pasting.
1239
    $mail = trim($form_state['values']['mail']);
1240
    form_set_value($form['account']['mail'], $mail, $form_state);
1241

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

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

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

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

    
1290
  // Move account cancellation information into $user->data.
1291
  foreach (array('user_cancel_method', 'user_cancel_notify') as $key) {
1292
    if (isset($edit[$key])) {
1293
      $edit['data'][$key] = $edit[$key];
1294
    }
1295
  }
1296
}
1297

    
1298
/**
1299
 * Implements hook_user_categories().
1300
 */
1301
function user_user_categories() {
1302
  return array(array(
1303
    'name' => 'account',
1304
    'title' => t('Account settings'),
1305
    'weight' => 1,
1306
  ));
1307
}
1308

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

    
1338
/**
1339
 * Implements hook_block_info().
1340
 */
1341
function user_block_info() {
1342
  global $user;
1343

    
1344
  $blocks['login']['info'] = t('User login');
1345
  // Not worth caching.
1346
  $blocks['login']['cache'] = DRUPAL_NO_CACHE;
1347

    
1348
  $blocks['new']['info'] = t('Who\'s new');
1349
  $blocks['new']['properties']['administrative'] = TRUE;
1350

    
1351
  // Too dynamic to cache.
1352
  $blocks['online']['info'] = t('Who\'s online');
1353
  $blocks['online']['cache'] = DRUPAL_NO_CACHE;
1354
  $blocks['online']['properties']['administrative'] = TRUE;
1355

    
1356
  return $blocks;
1357
}
1358

    
1359
/**
1360
 * Implements hook_block_configure().
1361
 */
1362
function user_block_configure($delta = '') {
1363
  global $user;
1364

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

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

    
1383
/**
1384
 * Implements hook_block_save().
1385
 */
1386
function user_block_save($delta = '', $edit = array()) {
1387
  global $user;
1388

    
1389
  switch ($delta) {
1390
    case 'new':
1391
      variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
1392
      break;
1393

    
1394
    case 'online':
1395
      variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
1396
      variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
1397
      break;
1398
  }
1399
}
1400

    
1401
/**
1402
 * Implements hook_block_view().
1403
 */
1404
function user_block_view($delta = '') {
1405
  global $user;
1406

    
1407
  $block = array();
1408

    
1409
  switch ($delta) {
1410
    case 'login':
1411
      // For usability's sake, avoid showing two login forms on one page.
1412
      if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
1413

    
1414
        $block['subject'] = t('User login');
1415
        $block['content'] = drupal_get_form('user_login_block');
1416
      }
1417
      return $block;
1418

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

    
1425
        $block['subject'] = t('Who\'s new');
1426
        $block['content'] = $output;
1427
      }
1428
      return $block;
1429

    
1430
    case 'online':
1431
      if (user_access('access content')) {
1432
        // Count users active within the defined period.
1433
        $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
1434

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

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

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

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

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

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

    
1520
  if (!empty($users)) {
1521
    foreach ($users as $user) {
1522
      $items[] = theme('username', array('account' => $user));
1523
    }
1524
  }
1525
  return theme('item_list', array('items' => $items, 'title' => $title));
1526
}
1527

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

    
1539
/**
1540
 * Determines if the current user is logged in.
1541
 *
1542
 * @return bool
1543
 *   TRUE if the user is logged in, FALSE if the user is anonymous.
1544
 */
1545
function user_is_logged_in() {
1546
  return (bool) $GLOBALS['user']->uid;
1547
}
1548

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

    
1559
/**
1560
 * User view access callback.
1561
 *
1562
 * @param $account
1563
 *   Can either be a full user object or a $uid.
1564
 */
1565
function user_view_access($account) {
1566
  $uid = is_object($account) ? $account->uid : (int) $account;
1567

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

    
1585
/**
1586
 * Access callback for user account editing.
1587
 */
1588
function user_edit_access($account) {
1589
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
1590
}
1591

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

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

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

    
1626
  $items['user/login'] = array(
1627
    'title' => 'Log in',
1628
    'access callback' => 'user_is_anonymous',
1629
    'type' => MENU_DEFAULT_LOCAL_TASK,
1630
  );
1631

    
1632
  $items['user/register'] = array(
1633
    'title' => 'Create new account',
1634
    'page callback' => 'drupal_get_form',
1635
    'page arguments' => array('user_register_form'),
1636
    'access callback' => 'user_register_access',
1637
    'type' => MENU_LOCAL_TASK,
1638
  );
1639

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

    
1657
  $items['user/logout'] = array(
1658
    'title' => 'Log out',
1659
    'access callback' => 'user_is_logged_in',
1660
    'page callback' => 'user_logout',
1661
    'weight' => 10,
1662
    'menu_name' => 'user-menu',
1663
    'file' => 'user.pages.inc',
1664
  );
1665

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

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

    
1727
  $items['admin/people/create'] = array(
1728
    'title' => 'Add user',
1729
    'page arguments' => array('create'),
1730
    'access arguments' => array('administer users'),
1731
    'type' => MENU_LOCAL_ACTION,
1732
  );
1733

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

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

    
1776
  $items['user/%user/view'] = array(
1777
    'title' => 'View',
1778
    'type' => MENU_DEFAULT_LOCAL_TASK,
1779
    'weight' => -10,
1780
  );
1781

    
1782
  $items['user/%user/cancel'] = array(
1783
    'title' => 'Cancel account',
1784
    'page callback' => 'drupal_get_form',
1785
    'page arguments' => array('user_cancel_confirm_form', 1),
1786
    'access callback' => 'user_cancel_access',
1787
    'access arguments' => array(1),
1788
    'file' => 'user.pages.inc',
1789
  );
1790

    
1791
  $items['user/%user/cancel/confirm/%/%'] = array(
1792
    'title' => 'Confirm account cancellation',
1793
    'page callback' => 'user_cancel_confirm',
1794
    'page arguments' => array(1, 4, 5),
1795
    'access callback' => 'user_cancel_access',
1796
    'access arguments' => array(1),
1797
    'file' => 'user.pages.inc',
1798
  );
1799

    
1800
  $items['user/%user/edit'] = array(
1801
    'title' => 'Edit',
1802
    'page callback' => 'drupal_get_form',
1803
    'page arguments' => array('user_profile_form', 1),
1804
    'access callback' => 'user_edit_access',
1805
    'access arguments' => array(1),
1806
    'type' => MENU_LOCAL_TASK,
1807
    'file' => 'user.pages.inc',
1808
  );
1809

    
1810
  $items['user/%user_category/edit/account'] = array(
1811
    'title' => 'Account',
1812
    'type' => MENU_DEFAULT_LOCAL_TASK,
1813
    'load arguments' => array('%map', '%index'),
1814
  );
1815

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

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

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

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

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

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

    
1910
/**
1911
 * Implements hook_admin_paths().
1912
 */
1913
function user_admin_paths() {
1914
  $paths = array(
1915
    'user/*/cancel' => TRUE,
1916
    'user/*/edit' => TRUE,
1917
    'user/*/edit/*' => TRUE,
1918
  );
1919
  return $paths;
1920
}
1921

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

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

    
1953
/**
1954
 * Return a user object after checking if any profile category in the path exists.
1955
 */
1956
function user_category_load($uid, &$map, $index) {
1957
  static $user_categories, $accounts;
1958

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

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

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

    
2013
/**
2014
 * Menu item title callback - use the user name.
2015
 */
2016
function user_page_title($account) {
2017
  return is_object($account) ? format_username($account) : '';
2018
}
2019

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

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

    
2066
/**
2067
 * Form builder; the main user login form.
2068
 *
2069
 * @ingroup forms
2070
 */
2071
function user_login($form, &$form_state) {
2072
  global $user;
2073

    
2074
  // If we are already logged on, go to the user page instead.
2075
  if ($user->uid) {
2076
    drupal_goto('user/' . $user->uid);
2077
  }
2078

    
2079
  // Display login form:
2080
  $form['name'] = array('#type' => 'textfield',
2081
    '#title' => t('Username'),
2082
    '#size' => 60,
2083
    '#maxlength' => USERNAME_MAX_LENGTH,
2084
    '#required' => TRUE,
2085
  );
2086

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

    
2097
  return $form;
2098
}
2099

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

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

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

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

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

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

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

    
2235
        // Update user to new password scheme if needed.
2236
        if (user_needs_new_hash($account)) {
2237
          user_save($account, array('pass' => $password));
2238
        }
2239
      }
2240
    }
2241
  }
2242
  return $uid;
2243
}
2244

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

    
2267
  // Regenerate the session ID to prevent against session fixation attacks.
2268
  // This is called before hook_user in case one of those functions fails
2269
  // or incorrectly does a redirect which would leave the old session in place.
2270
  drupal_session_regenerate();
2271

    
2272
  user_module_invoke('login', $edit, $user);
2273
}
2274

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

    
2285
  user_login_finalize($form_state);
2286
}
2287

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

    
2313
  // Log user in.
2314
  $form_state['uid'] = $account->uid;
2315
  user_login_submit(array(), $form_state);
2316
}
2317

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

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

    
2358
/**
2359
 * Creates a unique hash value for use in time-dependent per-user URLs.
2360
 *
2361
 * This hash is normally used to build a unique and secure URL that is sent to
2362
 * the user by email for purposes such as resetting the user's password. In
2363
 * order to validate the URL, the same hash can be generated again, from the
2364
 * same information, and compared to the hash value from the URL. The URL
2365
 * normally contains both the time stamp and the numeric user ID. The login
2366
 * timestamp and hashed password are retrieved from the database as necessary.
2367
 * For a usage example, see user_cancel_url() and user_cancel_confirm().
2368
 *
2369
 * @param string $password
2370
 *   The hashed user account password value.
2371
 * @param int $timestamp
2372
 *   A UNIX timestamp, typically REQUEST_TIME.
2373
 * @param int $login
2374
 *   The UNIX timestamp of the user's last login.
2375
 *
2376
 * @return
2377
 *   A string that is safe for use in URLs and SQL statements.
2378
 */
2379
function user_pass_rehash($password, $timestamp, $login) {
2380
  return drupal_hmac_base64($timestamp . $login, drupal_get_hash_salt() . $password);
2381
}
2382

    
2383
/**
2384
 * Cancel a user account.
2385
 *
2386
 * Since the user cancellation process needs to be run in a batch, either
2387
 * Form API will invoke it, or batch_process() needs to be invoked after calling
2388
 * this function and should define the path to redirect to.
2389
 *
2390
 * @param $edit
2391
 *   An array of submitted form values.
2392
 * @param $uid
2393
 *   The user ID of the user account to cancel.
2394
 * @param $method
2395
 *   The account cancellation method to use.
2396
 *
2397
 * @see _user_cancel()
2398
 */
2399
function user_cancel($edit, $uid, $method) {
2400
  global $user;
2401

    
2402
  $account = user_load($uid);
2403

    
2404
  if (!$account) {
2405
    drupal_set_message(t('The user account %id does not exist.', array('%id' => $uid)), 'error');
2406
    watchdog('user', 'Attempted to cancel non-existing user account: %id.', array('%id' => $uid), WATCHDOG_ERROR);
2407
    return;
2408
  }
2409

    
2410
  // Initialize batch (to set title).
2411
  $batch = array(
2412
    'title' => t('Cancelling account'),
2413
    'operations' => array(),
2414
  );
2415
  batch_set($batch);
2416

    
2417
  // Modules use hook_user_delete() to respond to deletion.
2418
  if ($method != 'user_cancel_delete') {
2419
    // Allow modules to add further sets to this batch.
2420
    module_invoke_all('user_cancel', $edit, $account, $method);
2421
  }
2422

    
2423
  // Finish the batch and actually cancel the account.
2424
  $batch = array(
2425
    'title' => t('Cancelling user account'),
2426
    'operations' => array(
2427
      array('_user_cancel', array($edit, $account, $method)),
2428
    ),
2429
  );
2430

    
2431
  // After cancelling account, ensure that user is logged out.
2432
  if ($account->uid == $user->uid) {
2433
    // Batch API stores data in the session, so use the finished operation to
2434
    // manipulate the current user's session id.
2435
    $batch['finished'] = '_user_cancel_session_regenerate';
2436
  }
2437

    
2438
  batch_set($batch);
2439

    
2440
  // Batch processing is either handled via Form API or has to be invoked
2441
  // manually.
2442
}
2443

    
2444
/**
2445
 * Last batch processing step for cancelling a user account.
2446
 *
2447
 * Since batch and session API require a valid user account, the actual
2448
 * cancellation of a user account needs to happen last.
2449
 *
2450
 * @see user_cancel()
2451
 */
2452
function _user_cancel($edit, $account, $method) {
2453
  global $user;
2454

    
2455
  switch ($method) {
2456
    case 'user_cancel_block':
2457
    case 'user_cancel_block_unpublish':
2458
    default:
2459
      // Send account blocked notification if option was checked.
2460
      if (!empty($edit['user_cancel_notify'])) {
2461
        _user_mail_notify('status_blocked', $account);
2462
      }
2463
      user_save($account, array('status' => 0));
2464
      drupal_set_message(t('%name has been disabled.', array('%name' => $account->name)));
2465
      watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
2466
      break;
2467

    
2468
    case 'user_cancel_reassign':
2469
    case 'user_cancel_delete':
2470
      // Send account canceled notification if option was checked.
2471
      if (!empty($edit['user_cancel_notify'])) {
2472
        _user_mail_notify('status_canceled', $account);
2473
      }
2474
      user_delete($account->uid);
2475
      drupal_set_message(t('%name has been deleted.', array('%name' => $account->name)));
2476
      watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->name, '%email' => '<' . $account->mail . '>'), WATCHDOG_NOTICE);
2477
      break;
2478
  }
2479

    
2480
  // After cancelling account, ensure that user is logged out. We can't destroy
2481
  // their session though, as we might have information in it, and we can't
2482
  // regenerate it because batch API uses the session ID, we will regenerate it
2483
  // in _user_cancel_session_regenerate().
2484
  if ($account->uid == $user->uid) {
2485
    $user = drupal_anonymous_user();
2486
  }
2487

    
2488
  // Clear the cache for anonymous users.
2489
  cache_clear_all();
2490
}
2491

    
2492
/**
2493
 * Finished batch processing callback for cancelling a user account.
2494
 *
2495
 * @see user_cancel()
2496
 */
2497
function _user_cancel_session_regenerate() {
2498
  // Regenerate the users session instead of calling session_destroy() as we
2499
  // want to preserve any messages that might have been set.
2500
  drupal_session_regenerate();
2501
}
2502

    
2503
/**
2504
 * Delete a user.
2505
 *
2506
 * @param $uid
2507
 *   A user ID.
2508
 */
2509
function user_delete($uid) {
2510
  user_delete_multiple(array($uid));
2511
}
2512

    
2513
/**
2514
 * Delete multiple user accounts.
2515
 *
2516
 * @param $uids
2517
 *   An array of user IDs.
2518
 */
2519
function user_delete_multiple(array $uids) {
2520
  if (!empty($uids)) {
2521
    $accounts = user_load_multiple($uids, array());
2522

    
2523
    $transaction = db_transaction();
2524
    try {
2525
      foreach ($accounts as $uid => $account) {
2526
        module_invoke_all('user_delete', $account);
2527
        module_invoke_all('entity_delete', $account, 'user');
2528
        field_attach_delete('user', $account);
2529
        drupal_session_destroy_uid($account->uid);
2530
      }
2531

    
2532
      db_delete('users')
2533
        ->condition('uid', $uids, 'IN')
2534
        ->execute();
2535
      db_delete('users_roles')
2536
        ->condition('uid', $uids, 'IN')
2537
        ->execute();
2538
      db_delete('authmap')
2539
        ->condition('uid', $uids, 'IN')
2540
        ->execute();
2541
    }
2542
    catch (Exception $e) {
2543
      $transaction->rollback();
2544
      watchdog_exception('user', $e);
2545
      throw $e;
2546
    }
2547
    entity_get_controller('user')->resetCache();
2548
  }
2549
}
2550

    
2551
/**
2552
 * Page callback wrapper for user_view().
2553
 */
2554
function user_view_page($account) {
2555
  // An administrator may try to view a non-existent account,
2556
  // so we give them a 404 (versus a 403 for non-admins).
2557
  return is_object($account) ? user_view($account) : MENU_NOT_FOUND;
2558
}
2559

    
2560
/**
2561
 * Generate an array for rendering the given user.
2562
 *
2563
 * When viewing a user profile, the $page array contains:
2564
 *
2565
 * - $page['content']['Profile Category']:
2566
 *   Profile categories keyed by their human-readable names.
2567
 * - $page['content']['Profile Category']['profile_machine_name']:
2568
 *   Profile fields keyed by their machine-readable names.
2569
 * - $page['content']['user_picture']:
2570
 *   User's rendered picture.
2571
 * - $page['content']['summary']:
2572
 *   Contains the default "History" profile data for a user.
2573
 * - $page['content']['#account']:
2574
 *   The user account of the profile being viewed.
2575
 *
2576
 * To theme user profiles, copy modules/user/user-profile.tpl.php
2577
 * to your theme directory, and edit it as instructed in that file's comments.
2578
 *
2579
 * @param $account
2580
 *   A user object.
2581
 * @param $view_mode
2582
 *   View mode, e.g. 'full'.
2583
 * @param $langcode
2584
 *   (optional) A language code to use for rendering. Defaults to the global
2585
 *   content language of the current request.
2586
 *
2587
 * @return
2588
 *   An array as expected by drupal_render().
2589
 */
2590
function user_view($account, $view_mode = 'full', $langcode = NULL) {
2591
  if (!isset($langcode)) {
2592
    $langcode = $GLOBALS['language_content']->language;
2593
  }
2594

    
2595
  // Retrieve all profile fields and attach to $account->content.
2596
  user_build_content($account, $view_mode, $langcode);
2597

    
2598
  $build = $account->content;
2599
  // We don't need duplicate rendering info in account->content.
2600
  unset($account->content);
2601

    
2602
  $build += array(
2603
    '#theme' => 'user_profile',
2604
    '#account' => $account,
2605
    '#view_mode' => $view_mode,
2606
    '#language' => $langcode,
2607
  );
2608

    
2609
  // Allow modules to modify the structured user.
2610
  $type = 'user';
2611
  drupal_alter(array('user_view', 'entity_view'), $build, $type);
2612

    
2613
  return $build;
2614
}
2615

    
2616
/**
2617
 * Builds a structured array representing the profile content.
2618
 *
2619
 * @param $account
2620
 *   A user object.
2621
 * @param $view_mode
2622
 *   View mode, e.g. 'full'.
2623
 * @param $langcode
2624
 *   (optional) A language code to use for rendering. Defaults to the global
2625
 *   content language of the current request.
2626
 */
2627
function user_build_content($account, $view_mode = 'full', $langcode = NULL) {
2628
  if (!isset($langcode)) {
2629
    $langcode = $GLOBALS['language_content']->language;
2630
  }
2631

    
2632
  // Remove previously built content, if exists.
2633
  $account->content = array();
2634

    
2635
  // Allow modules to change the view mode.
2636
  $context = array(
2637
    'entity_type' => 'user',
2638
    'entity' => $account,
2639
    'langcode' => $langcode,
2640
  );
2641
  drupal_alter('entity_view_mode', $view_mode, $context);
2642

    
2643
  // Build fields content.
2644
  field_attach_prepare_view('user', array($account->uid => $account), $view_mode, $langcode);
2645
  entity_prepare_view('user', array($account->uid => $account), $langcode);
2646
  $account->content += field_attach_view('user', $account, $view_mode, $langcode);
2647

    
2648
  // Populate $account->content with a render() array.
2649
  module_invoke_all('user_view', $account, $view_mode, $langcode);
2650
  module_invoke_all('entity_view', $account, 'user', $view_mode, $langcode);
2651

    
2652
  // Make sure the current view mode is stored if no module has already
2653
  // populated the related key.
2654
  $account->content += array('#view_mode' => $view_mode);
2655
}
2656

    
2657
/**
2658
 * Implements hook_mail().
2659
 */
2660
function user_mail($key, &$message, $params) {
2661
  $language = $message['language'];
2662
  $variables = array('user' => $params['account']);
2663
  $message['subject'] .= _user_mail_text($key . '_subject', $language, $variables);
2664
  $message['body'][] = _user_mail_text($key . '_body', $language, $variables);
2665
}
2666

    
2667
/**
2668
 * Returns a mail string for a variable name.
2669
 *
2670
 * Used by user_mail() and the settings forms to retrieve strings.
2671
 */
2672
function _user_mail_text($key, $language = NULL, $variables = array(), $replace = TRUE) {
2673
  $langcode = isset($language) ? $language->language : NULL;
2674

    
2675
  if ($admin_setting = variable_get('user_mail_' . $key, FALSE)) {
2676
    // An admin setting overrides the default string.
2677
    $text = $admin_setting;
2678
  }
2679
  else {
2680
    // No override, return default string.
2681
    switch ($key) {
2682
      case 'register_no_approval_required_subject':
2683
        $text = t('Account details for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2684
        break;
2685
      case 'register_no_approval_required_body':
2686
        $text = t("[user:name],
2687

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

    
2690
[user:one-time-login-url]
2691

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

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

    
2696
username: [user:name]
2697
password: Your password
2698

    
2699
--  [site:name] team", array(), array('langcode' => $langcode));
2700
        break;
2701

    
2702
      case 'register_admin_created_subject':
2703
        $text = t('An administrator created an account for you at [site:name]', array(), array('langcode' => $langcode));
2704
        break;
2705
      case 'register_admin_created_body':
2706
        $text = t("[user:name],
2707

    
2708
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:
2709

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

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

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

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

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

    
2722
      case 'register_pending_approval_subject':
2723
      case 'register_pending_approval_admin_subject':
2724
        $text = t('Account details for [user:name] at [site:name] (pending admin approval)', array(), array('langcode' => $langcode));
2725
        break;
2726
      case 'register_pending_approval_body':
2727
        $text = t("[user:name],
2728

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

    
2731

    
2732
--  [site:name] team", array(), array('langcode' => $langcode));
2733
        break;
2734
      case 'register_pending_approval_admin_body':
2735
        $text = t("[user:name] has applied for an account.
2736

    
2737
[user:edit-url]", array(), array('langcode' => $langcode));
2738
        break;
2739

    
2740
      case 'password_reset_subject':
2741
        $text = t('Replacement login information for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2742
        break;
2743
      case 'password_reset_body':
2744
        $text = t("[user:name],
2745

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

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

    
2750
[user:one-time-login-url]
2751

    
2752
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.
2753

    
2754
--  [site:name] team", array(), array('langcode' => $langcode));
2755
        break;
2756

    
2757
      case 'status_activated_subject':
2758
        $text = t('Account details for [user:name] at [site:name] (approved)', array(), array('langcode' => $langcode));
2759
        break;
2760
      case 'status_activated_body':
2761
        $text = t("[user:name],
2762

    
2763
Your account at [site:name] has been activated.
2764

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

    
2767
[user:one-time-login-url]
2768

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

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

    
2773
username: [user:name]
2774
password: Your password
2775

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

    
2779
      case 'status_blocked_subject':
2780
        $text = t('Account details for [user:name] at [site:name] (blocked)', array(), array('langcode' => $langcode));
2781
        break;
2782
      case 'status_blocked_body':
2783
        $text = t("[user:name],
2784

    
2785
Your account on [site:name] has been blocked.
2786

    
2787
--  [site:name] team", array(), array('langcode' => $langcode));
2788
        break;
2789

    
2790
      case 'cancel_confirm_subject':
2791
        $text = t('Account cancellation request for [user:name] at [site:name]', array(), array('langcode' => $langcode));
2792
        break;
2793
      case 'cancel_confirm_body':
2794
        $text = t("[user:name],
2795

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

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

    
2800
[user:cancel-url]
2801

    
2802
NOTE: The cancellation of your account is not reversible.
2803

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

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

    
2809
      case 'status_canceled_subject':
2810
        $text = t('Account details for [user:name] at [site:name] (canceled)', array(), array('langcode' => $langcode));
2811
        break;
2812
      case 'status_canceled_body':
2813
        $text = t("[user:name],
2814

    
2815
Your account on [site:name] has been canceled.
2816

    
2817
--  [site:name] team", array(), array('langcode' => $langcode));
2818
        break;
2819
    }
2820
  }
2821

    
2822
  if ($replace) {
2823
    // We do not sanitize the token replacement, since the output of this
2824
    // replacement is intended for an e-mail message, not a web browser.
2825
    return token_replace($text, $variables, array('language' => $language, 'callback' => 'user_mail_tokens', 'sanitize' => FALSE, 'clear' => TRUE));
2826
  }
2827

    
2828
  return $text;
2829
}
2830

    
2831
/**
2832
 * Token callback to add unsafe tokens for user mails.
2833
 *
2834
 * This function is used by the token_replace() call at the end of
2835
 * _user_mail_text() to set up some additional tokens that can be
2836
 * used in email messages generated by user_mail().
2837
 *
2838
 * @param $replacements
2839
 *   An associative array variable containing mappings from token names to
2840
 *   values (for use with strtr()).
2841
 * @param $data
2842
 *   An associative array of token replacement values. If the 'user' element
2843
 *   exists, it must contain a user account object with the following
2844
 *   properties:
2845
 *   - login: The UNIX timestamp of the user's last login.
2846
 *   - pass: The hashed account login password.
2847
 * @param $options
2848
 *   Unused parameter required by the token_replace() function.
2849
 */
2850
function user_mail_tokens(&$replacements, $data, $options) {
2851
  if (isset($data['user'])) {
2852
    $replacements['[user:one-time-login-url]'] = user_pass_reset_url($data['user']);
2853
    $replacements['[user:cancel-url]'] = user_cancel_url($data['user']);
2854
  }
2855
}
2856

    
2857
/*** Administrative features ***********************************************/
2858

    
2859
/**
2860
 * Retrieve an array of roles matching specified conditions.
2861
 *
2862
 * @param $membersonly
2863
 *   Set this to TRUE to exclude the 'anonymous' role.
2864
 * @param $permission
2865
 *   A string containing a permission. If set, only roles containing that
2866
 *   permission are returned.
2867
 *
2868
 * @return
2869
 *   An associative array with the role id as the key and the role name as
2870
 *   value.
2871
 */
2872
function user_roles($membersonly = FALSE, $permission = NULL) {
2873
  $query = db_select('role', 'r');
2874
  $query->addTag('translatable');
2875
  $query->fields('r', array('rid', 'name'));
2876
  $query->orderBy('weight');
2877
  $query->orderBy('name');
2878
  if (!empty($permission)) {
2879
    $query->innerJoin('role_permission', 'p', 'r.rid = p.rid');
2880
    $query->condition('p.permission', $permission);
2881
  }
2882
  $result = $query->execute();
2883

    
2884
  $roles = array();
2885
  foreach ($result as $role) {
2886
    switch ($role->rid) {
2887
      // We only translate the built in role names
2888
      case DRUPAL_ANONYMOUS_RID:
2889
        if (!$membersonly) {
2890
          $roles[$role->rid] = t($role->name);
2891
        }
2892
        break;
2893
      case DRUPAL_AUTHENTICATED_RID:
2894
        $roles[$role->rid] = t($role->name);
2895
        break;
2896
      default:
2897
        $roles[$role->rid] = $role->name;
2898
    }
2899
  }
2900

    
2901
  return $roles;
2902
}
2903

    
2904
/**
2905
 * Fetches a user role by role ID.
2906
 *
2907
 * @param $rid
2908
 *   An integer representing the role ID.
2909
 *
2910
 * @return
2911
 *   A fully-loaded role object if a role with the given ID exists, or FALSE
2912
 *   otherwise.
2913
 *
2914
 * @see user_role_load_by_name()
2915
 */
2916
function user_role_load($rid) {
2917
  return db_select('role', 'r')
2918
    ->fields('r')
2919
    ->condition('rid', $rid)
2920
    ->execute()
2921
    ->fetchObject();
2922
}
2923

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

    
2944
/**
2945
 * Save a user role to the database.
2946
 *
2947
 * @param $role
2948
 *   A role object to modify or add. If $role->rid is not specified, a new
2949
 *   role will be created.
2950
 * @return
2951
 *   Status constant indicating if role was created or updated.
2952
 *   Failure to write the user role record will return FALSE. Otherwise.
2953
 *   SAVED_NEW or SAVED_UPDATED is returned depending on the operation
2954
 *   performed.
2955
 */
2956
function user_role_save($role) {
2957
  if ($role->name) {
2958
    // Prevent leading and trailing spaces in role names.
2959
    $role->name = trim($role->name);
2960
  }
2961
  if (!isset($role->weight)) {
2962
    // Set a role weight to make this new role last.
2963
    $query = db_select('role');
2964
    $query->addExpression('MAX(weight)');
2965
    $role->weight = $query->execute()->fetchField() + 1;
2966
  }
2967

    
2968
  // Let modules modify the user role before it is saved to the database.
2969
  module_invoke_all('user_role_presave', $role);
2970

    
2971
  if (!empty($role->rid) && $role->name) {
2972
    $status = drupal_write_record('role', $role, 'rid');
2973
    module_invoke_all('user_role_update', $role);
2974
  }
2975
  else {
2976
    $status = drupal_write_record('role', $role);
2977
    module_invoke_all('user_role_insert', $role);
2978
  }
2979

    
2980
  // Clear the user access cache.
2981
  drupal_static_reset('user_access');
2982
  drupal_static_reset('user_role_permissions');
2983

    
2984
  return $status;
2985
}
2986

    
2987
/**
2988
 * Delete a user role from database.
2989
 *
2990
 * @param $role
2991
 *   A string with the role name, or an integer with the role ID.
2992
 */
2993
function user_role_delete($role) {
2994
  if (is_int($role)) {
2995
    $role = user_role_load($role);
2996
  }
2997
  else {
2998
    $role = user_role_load_by_name($role);
2999
  }
3000

    
3001
  db_delete('role')
3002
    ->condition('rid', $role->rid)
3003
    ->execute();
3004
  db_delete('role_permission')
3005
    ->condition('rid', $role->rid)
3006
    ->execute();
3007
  // Update the users who have this role set:
3008
  db_delete('users_roles')
3009
    ->condition('rid', $role->rid)
3010
    ->execute();
3011

    
3012
  module_invoke_all('user_role_delete', $role);
3013

    
3014
  // Clear the user access cache.
3015
  drupal_static_reset('user_access');
3016
  drupal_static_reset('user_role_permissions');
3017
}
3018

    
3019
/**
3020
 * Menu access callback for user role editing.
3021
 */
3022
function user_role_edit_access($role) {
3023
  // Prevent the system-defined roles from being altered or removed.
3024
  if ($role->rid == DRUPAL_ANONYMOUS_RID || $role->rid == DRUPAL_AUTHENTICATED_RID) {
3025
    return FALSE;
3026
  }
3027

    
3028
  return user_access('administer permissions');
3029
}
3030

    
3031
/**
3032
 * Determine the modules that permissions belong to.
3033
 *
3034
 * @return
3035
 *   An associative array in the format $permission => $module.
3036
 */
3037
function user_permission_get_modules() {
3038
  $permissions = array();
3039
  foreach (module_implements('permission') as $module) {
3040
    $perms = module_invoke($module, 'permission');
3041
    foreach ($perms as $key => $value) {
3042
      $permissions[$key] = $module;
3043
    }
3044
  }
3045
  return $permissions;
3046
}
3047

    
3048
/**
3049
 * Change permissions for a user role.
3050
 *
3051
 * This function may be used to grant and revoke multiple permissions at once.
3052
 * For example, when a form exposes checkboxes to configure permissions for a
3053
 * role, the form submit handler may directly pass the submitted values for the
3054
 * checkboxes form element to this function.
3055
 *
3056
 * @param $rid
3057
 *   The ID of a user role to alter.
3058
 * @param $permissions
3059
 *   An associative array, where the key holds the permission name and the value
3060
 *   determines whether to grant or revoke that permission. Any value that
3061
 *   evaluates to TRUE will cause the permission to be granted. Any value that
3062
 *   evaluates to FALSE will cause the permission to be revoked.
3063
 *   @code
3064
 *     array(
3065
 *       'administer nodes' => 0,                // Revoke 'administer nodes'
3066
 *       'administer blocks' => FALSE,           // Revoke 'administer blocks'
3067
 *       'access user profiles' => 1,            // Grant 'access user profiles'
3068
 *       'access content' => TRUE,               // Grant 'access content'
3069
 *       'access comments' => 'access comments', // Grant 'access comments'
3070
 *     )
3071
 *   @endcode
3072
 *   Existing permissions are not changed, unless specified in $permissions.
3073
 *
3074
 * @see user_role_grant_permissions()
3075
 * @see user_role_revoke_permissions()
3076
 */
3077
function user_role_change_permissions($rid, array $permissions = array()) {
3078
  // Grant new permissions for the role.
3079
  $grant = array_filter($permissions);
3080
  if (!empty($grant)) {
3081
    user_role_grant_permissions($rid, array_keys($grant));
3082
  }
3083
  // Revoke permissions for the role.
3084
  $revoke = array_diff_assoc($permissions, $grant);
3085
  if (!empty($revoke)) {
3086
    user_role_revoke_permissions($rid, array_keys($revoke));
3087
  }
3088
}
3089

    
3090
/**
3091
 * Grant permissions to a user role.
3092
 *
3093
 * @param $rid
3094
 *   The ID of a user role to alter.
3095
 * @param $permissions
3096
 *   A list of permission names to grant.
3097
 *
3098
 * @see user_role_change_permissions()
3099
 * @see user_role_revoke_permissions()
3100
 */
3101
function user_role_grant_permissions($rid, array $permissions = array()) {
3102
  $modules = user_permission_get_modules();
3103
  // Grant new permissions for the role.
3104
  foreach ($permissions as $name) {
3105
    db_merge('role_permission')
3106
      ->key(array(
3107
        'rid' => $rid,
3108
        'permission' => $name,
3109
      ))
3110
      ->fields(array(
3111
        'module' => $modules[$name],
3112
      ))
3113
      ->execute();
3114
  }
3115

    
3116
  // Clear the user access cache.
3117
  drupal_static_reset('user_access');
3118
  drupal_static_reset('user_role_permissions');
3119
}
3120

    
3121
/**
3122
 * Revoke permissions from a user role.
3123
 *
3124
 * @param $rid
3125
 *   The ID of a user role to alter.
3126
 * @param $permissions
3127
 *   A list of permission names to revoke.
3128
 *
3129
 * @see user_role_change_permissions()
3130
 * @see user_role_grant_permissions()
3131
 */
3132
function user_role_revoke_permissions($rid, array $permissions = array()) {
3133
  // Revoke permissions for the role.
3134
  db_delete('role_permission')
3135
    ->condition('rid', $rid)
3136
    ->condition('permission', $permissions, 'IN')
3137
    ->execute();
3138

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

    
3144
/**
3145
 * Implements hook_user_operations().
3146
 */
3147
function user_user_operations($form = array(), $form_state = array()) {
3148
  $operations = array(
3149
    'unblock' => array(
3150
      'label' => t('Unblock the selected users'),
3151
      'callback' => 'user_user_operations_unblock',
3152
    ),
3153
    'block' => array(
3154
      'label' => t('Block the selected users'),
3155
      'callback' => 'user_user_operations_block',
3156
    ),
3157
    'cancel' => array(
3158
      'label' => t('Cancel the selected user accounts'),
3159
    ),
3160
  );
3161

    
3162
  if (user_access('administer permissions')) {
3163
    $roles = user_roles(TRUE);
3164
    unset($roles[DRUPAL_AUTHENTICATED_RID]);  // Can't edit authenticated role.
3165

    
3166
    $add_roles = array();
3167
    foreach ($roles as $key => $value) {
3168
      $add_roles['add_role-' . $key] = $value;
3169
    }
3170

    
3171
    $remove_roles = array();
3172
    foreach ($roles as $key => $value) {
3173
      $remove_roles['remove_role-' . $key] = $value;
3174
    }
3175

    
3176
    if (count($roles)) {
3177
      $role_operations = array(
3178
        t('Add a role to the selected users') => array(
3179
          'label' => $add_roles,
3180
        ),
3181
        t('Remove a role from the selected users') => array(
3182
          'label' => $remove_roles,
3183
        ),
3184
      );
3185

    
3186
      $operations += $role_operations;
3187
    }
3188
  }
3189

    
3190
  // If the form has been posted, we need to insert the proper data for
3191
  // role editing if necessary.
3192
  if (!empty($form_state['submitted'])) {
3193
    $operation_rid = explode('-', $form_state['values']['operation']);
3194
    $operation = $operation_rid[0];
3195
    if ($operation == 'add_role' || $operation == 'remove_role') {
3196
      $rid = $operation_rid[1];
3197
      if (user_access('administer permissions')) {
3198
        $operations[$form_state['values']['operation']] = array(
3199
          'callback' => 'user_multiple_role_edit',
3200
          'callback arguments' => array($operation, $rid),
3201
        );
3202
      }
3203
      else {
3204
        watchdog('security', 'Detected malicious attempt to alter protected user fields.', array(), WATCHDOG_WARNING);
3205
        return;
3206
      }
3207
    }
3208
  }
3209

    
3210
  return $operations;
3211
}
3212

    
3213
/**
3214
 * Callback function for admin mass unblocking users.
3215
 */
3216
function user_user_operations_unblock($accounts) {
3217
  $accounts = user_load_multiple($accounts);
3218
  foreach ($accounts as $account) {
3219
    // Skip unblocking user if they are already unblocked.
3220
    if ($account !== FALSE && $account->status == 0) {
3221
      user_save($account, array('status' => 1));
3222
    }
3223
  }
3224
}
3225

    
3226
/**
3227
 * Callback function for admin mass blocking users.
3228
 */
3229
function user_user_operations_block($accounts) {
3230
  $accounts = user_load_multiple($accounts);
3231
  foreach ($accounts as $account) {
3232
    // Skip blocking user if they are already blocked.
3233
    if ($account !== FALSE && $account->status == 1) {
3234
      // For efficiency manually save the original account before applying any
3235
      // changes.
3236
      $account->original = clone $account;
3237
      user_save($account, array('status' => 0));
3238
    }
3239
  }
3240
}
3241

    
3242
/**
3243
 * Callback function for admin mass adding/deleting a user role.
3244
 */
3245
function user_multiple_role_edit($accounts, $operation, $rid) {
3246
  // The role name is not necessary as user_save() will reload the user
3247
  // object, but some modules' hook_user() may look at this first.
3248
  $role_name = db_query('SELECT name FROM {role} WHERE rid = :rid', array(':rid' => $rid))->fetchField();
3249

    
3250
  switch ($operation) {
3251
    case 'add_role':
3252
      $accounts = user_load_multiple($accounts);
3253
      foreach ($accounts as $account) {
3254
        // Skip adding the role to the user if they already have it.
3255
        if ($account !== FALSE && !isset($account->roles[$rid])) {
3256
          $roles = $account->roles + array($rid => $role_name);
3257
          // For efficiency manually save the original account before applying
3258
          // any changes.
3259
          $account->original = clone $account;
3260
          user_save($account, array('roles' => $roles));
3261
        }
3262
      }
3263
      break;
3264
    case 'remove_role':
3265
      $accounts = user_load_multiple($accounts);
3266
      foreach ($accounts as $account) {
3267
        // Skip removing the role from the user if they already don't have it.
3268
        if ($account !== FALSE && isset($account->roles[$rid])) {
3269
          $roles = array_diff($account->roles, array($rid => $role_name));
3270
          // For efficiency manually save the original account before applying
3271
          // any changes.
3272
          $account->original = clone $account;
3273
          user_save($account, array('roles' => $roles));
3274
        }
3275
      }
3276
      break;
3277
  }
3278
}
3279

    
3280
function user_multiple_cancel_confirm($form, &$form_state) {
3281
  $edit = $form_state['input'];
3282

    
3283
  $form['accounts'] = array('#prefix' => '<ul>', '#suffix' => '</ul>', '#tree' => TRUE);
3284
  $accounts = user_load_multiple(array_keys(array_filter($edit['accounts'])));
3285
  foreach ($accounts as $uid => $account) {
3286
    // Prevent user 1 from being canceled.
3287
    if ($uid <= 1) {
3288
      continue;
3289
    }
3290
    $form['accounts'][$uid] = array(
3291
      '#type' => 'hidden',
3292
      '#value' => $uid,
3293
      '#prefix' => '<li>',
3294
      '#suffix' => check_plain($account->name) . "</li>\n",
3295
    );
3296
  }
3297

    
3298
  // Output a notice that user 1 cannot be canceled.
3299
  if (isset($accounts[1])) {
3300
    $redirect = (count($accounts) == 1);
3301
    $message = t('The user account %name cannot be cancelled.', array('%name' => $accounts[1]->name));
3302
    drupal_set_message($message, $redirect ? 'error' : 'warning');
3303
    // If only user 1 was selected, redirect to the overview.
3304
    if ($redirect) {
3305
      drupal_goto('admin/people');
3306
    }
3307
  }
3308

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

    
3311
  module_load_include('inc', 'user', 'user.pages');
3312
  $form['user_cancel_method'] = array(
3313
    '#type' => 'item',
3314
    '#title' => t('When cancelling these accounts'),
3315
  );
3316
  $form['user_cancel_method'] += user_cancel_methods();
3317
  // Remove method descriptions.
3318
  foreach (element_children($form['user_cancel_method']) as $element) {
3319
    unset($form['user_cancel_method'][$element]['#description']);
3320
  }
3321

    
3322
  // Allow to send the account cancellation confirmation mail.
3323
  $form['user_cancel_confirm'] = array(
3324
    '#type' => 'checkbox',
3325
    '#title' => t('Require e-mail confirmation to cancel account.'),
3326
    '#default_value' => FALSE,
3327
    '#description' => t('When enabled, the user must confirm the account cancellation via e-mail.'),
3328
  );
3329
  // Also allow to send account canceled notification mail, if enabled.
3330
  $form['user_cancel_notify'] = array(
3331
    '#type' => 'checkbox',
3332
    '#title' => t('Notify user when account is canceled.'),
3333
    '#default_value' => FALSE,
3334
    '#access' => variable_get('user_mail_status_canceled_notify', FALSE),
3335
    '#description' => t('When enabled, the user will receive an e-mail notification after the account has been cancelled.'),
3336
  );
3337

    
3338
  return confirm_form($form,
3339
                      t('Are you sure you want to cancel these user accounts?'),
3340
                      'admin/people', t('This action cannot be undone.'),
3341
                      t('Cancel accounts'), t('Cancel'));
3342
}
3343

    
3344
/**
3345
 * Submit handler for mass-account cancellation form.
3346
 *
3347
 * @see user_multiple_cancel_confirm()
3348
 * @see user_cancel_confirm_form_submit()
3349
 */
3350
function user_multiple_cancel_confirm_submit($form, &$form_state) {
3351
  global $user;
3352

    
3353
  if ($form_state['values']['confirm']) {
3354
    foreach ($form_state['values']['accounts'] as $uid => $value) {
3355
      // Prevent programmatic form submissions from cancelling user 1.
3356
      if ($uid <= 1) {
3357
        continue;
3358
      }
3359
      // Prevent user administrators from deleting themselves without confirmation.
3360
      if ($uid == $user->uid) {
3361
        $admin_form_state = $form_state;
3362
        unset($admin_form_state['values']['user_cancel_confirm']);
3363
        $admin_form_state['values']['_account'] = $user;
3364
        user_cancel_confirm_form_submit(array(), $admin_form_state);
3365
      }
3366
      else {
3367
        user_cancel($form_state['values'], $uid, $form_state['values']['user_cancel_method']);
3368
      }
3369
    }
3370
  }
3371
  $form_state['redirect'] = 'admin/people';
3372
}
3373

    
3374
/**
3375
 * Retrieve a list of all user setting/information categories and sort them by weight.
3376
 */
3377
function _user_categories() {
3378
  $categories = module_invoke_all('user_categories');
3379
  usort($categories, '_user_sort');
3380

    
3381
  return $categories;
3382
}
3383

    
3384
function _user_sort($a, $b) {
3385
  $a = (array) $a + array('weight' => 0, 'title' => '');
3386
  $b = (array) $b + array('weight' => 0, 'title' => '');
3387
  return $a['weight'] < $b['weight'] ? -1 : ($a['weight'] > $b['weight'] ? 1 : ($a['title'] < $b['title'] ? -1 : 1));
3388
}
3389

    
3390
/**
3391
 * List user administration filters that can be applied.
3392
 */
3393
function user_filters() {
3394
  // Regular filters
3395
  $filters = array();
3396
  $roles = user_roles(TRUE);
3397
  unset($roles[DRUPAL_AUTHENTICATED_RID]); // Don't list authorized role.
3398
  if (count($roles)) {
3399
    $filters['role'] = array(
3400
      'title' => t('role'),
3401
      'field' => 'ur.rid',
3402
      'options' => array(
3403
        '[any]' => t('any'),
3404
      ) + $roles,
3405
    );
3406
  }
3407

    
3408
  $options = array();
3409
  foreach (module_implements('permission') as $module) {
3410
    $function = $module . '_permission';
3411
    if ($permissions = $function()) {
3412
      asort($permissions);
3413
      foreach ($permissions as $permission => $description) {
3414
        $options[t('@module module', array('@module' => $module))][$permission] = t($permission);
3415
      }
3416
    }
3417
  }
3418
  ksort($options);
3419
  $filters['permission'] = array(
3420
    'title' => t('permission'),
3421
    'options' => array(
3422
      '[any]' => t('any'),
3423
    ) + $options,
3424
  );
3425

    
3426
  $filters['status'] = array(
3427
    'title' => t('status'),
3428
    'field' => 'u.status',
3429
    'options' => array(
3430
      '[any]' => t('any'),
3431
      1 => t('active'),
3432
      0 => t('blocked'),
3433
    ),
3434
  );
3435
  return $filters;
3436
}
3437

    
3438
/**
3439
 * Extends a query object for user administration filters based on session.
3440
 *
3441
 * @param $query
3442
 *   Query object that should be filtered.
3443
 */
3444
function user_build_filter_query(SelectQuery $query) {
3445
  $filters = user_filters();
3446
  // Extend Query with filter conditions.
3447
  foreach (isset($_SESSION['user_overview_filter']) ? $_SESSION['user_overview_filter'] : array() as $filter) {
3448
    list($key, $value) = $filter;
3449
    // This checks to see if this permission filter is an enabled permission for
3450
    // the authenticated role. If so, then all users would be listed, and we can
3451
    // skip adding it to the filter query.
3452
    if ($key == 'permission') {
3453
      $account = new stdClass();
3454
      $account->uid = 'user_filter';
3455
      $account->roles = array(DRUPAL_AUTHENTICATED_RID => 1);
3456
      if (user_access($value, $account)) {
3457
        continue;
3458
      }
3459
      $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
3460
      $permission_alias = $query->join('role_permission', 'p', $users_roles_alias . '.rid = %alias.rid');
3461
      $query->condition($permission_alias . '.permission', $value);
3462
    }
3463
    elseif ($key == 'role') {
3464
      $users_roles_alias = $query->join('users_roles', 'ur', '%alias.uid = u.uid');
3465
      $query->condition($users_roles_alias . '.rid' , $value);
3466
    }
3467
    else {
3468
      $query->condition($filters[$key]['field'], $value);
3469
    }
3470
  }
3471
}
3472

    
3473
/**
3474
 * Implements hook_comment_view().
3475
 */
3476
function user_comment_view($comment) {
3477
  if (variable_get('user_signatures', 0) && !empty($comment->signature)) {
3478
    // @todo This alters and replaces the original object value, so a
3479
    //   hypothetical process of loading, viewing, and saving will hijack the
3480
    //   stored data. Consider renaming to $comment->signature_safe or similar
3481
    //   here and elsewhere in Drupal 8.
3482
    $comment->signature = check_markup($comment->signature, $comment->signature_format, '', TRUE);
3483
  }
3484
  else {
3485
    $comment->signature = '';
3486
  }
3487
}
3488

    
3489
/**
3490
 * Returns HTML for a user signature.
3491
 *
3492
 * @param $variables
3493
 *   An associative array containing:
3494
 *   - signature: The user's signature.
3495
 *
3496
 * @ingroup themeable
3497
 */
3498
function theme_user_signature($variables) {
3499
  $signature = $variables['signature'];
3500
  $output = '';
3501

    
3502
  if ($signature) {
3503
    $output .= '<div class="clear">';
3504
    $output .= '<div>—</div>';
3505
    $output .= $signature;
3506
    $output .= '</div>';
3507
  }
3508

    
3509
  return $output;
3510
}
3511

    
3512
/**
3513
 * Get the language object preferred by the user. This user preference can
3514
 * be set on the user account editing page, and is only available if there
3515
 * are more than one languages enabled on the site. If the user did not
3516
 * choose a preferred language, or is the anonymous user, the $default
3517
 * value, or if it is not set, the site default language will be returned.
3518
 *
3519
 * @param $account
3520
 *   User account to look up language for.
3521
 * @param $default
3522
 *   Optional default language object to return if the account
3523
 *   has no valid language.
3524
 */
3525
function user_preferred_language($account, $default = NULL) {
3526
  $language_list = language_list();
3527
  if (!empty($account->language) && isset($language_list[$account->language])) {
3528
    return $language_list[$account->language];
3529
  }
3530
  else {
3531
    return $default ? $default : language_default();
3532
  }
3533
}
3534

    
3535
/**
3536
 * Conditionally create and send a notification email when a certain
3537
 * operation happens on the given user account.
3538
 *
3539
 * @see user_mail_tokens()
3540
 * @see drupal_mail()
3541
 *
3542
 * @param $op
3543
 *   The operation being performed on the account. Possible values:
3544
 *   - 'register_admin_created': Welcome message for user created by the admin.
3545
 *   - 'register_no_approval_required': Welcome message when user
3546
 *     self-registers.
3547
 *   - 'register_pending_approval': Welcome message, user pending admin
3548
 *     approval.
3549
 *   - 'password_reset': Password recovery request.
3550
 *   - 'status_activated': Account activated.
3551
 *   - 'status_blocked': Account blocked.
3552
 *   - 'cancel_confirm': Account cancellation request.
3553
 *   - 'status_canceled': Account canceled.
3554
 *
3555
 * @param $account
3556
 *   The user object of the account being notified. Must contain at
3557
 *   least the fields 'uid', 'name', and 'mail'.
3558
 * @param $language
3559
 *   Optional language to use for the notification, overriding account language.
3560
 *
3561
 * @return
3562
 *   The return value from drupal_mail_system()->mail(), if ends up being
3563
 *   called.
3564
 */
3565
function _user_mail_notify($op, $account, $language = NULL) {
3566
  // By default, we always notify except for canceled and blocked.
3567
  $default_notify = ($op != 'status_canceled' && $op != 'status_blocked');
3568
  $notify = variable_get('user_mail_' . $op . '_notify', $default_notify);
3569
  if ($notify) {
3570
    $params['account'] = $account;
3571
    $language = $language ? $language : user_preferred_language($account);
3572
    $mail = drupal_mail('user', $op, $account->mail, $language, $params);
3573
    if ($op == 'register_pending_approval') {
3574
      // If a user registered requiring admin approval, notify the admin, too.
3575
      // We use the site default language for this.
3576
      drupal_mail('user', 'register_pending_approval_admin', variable_get('site_mail', ini_get('sendmail_from')), language_default(), $params);
3577
    }
3578
  }
3579
  return empty($mail) ? NULL : $mail['result'];
3580
}
3581

    
3582
/**
3583
 * Form element process handler for client-side password validation.
3584
 *
3585
 * This #process handler is automatically invoked for 'password_confirm' form
3586
 * elements to add the JavaScript and string translations for dynamic password
3587
 * validation.
3588
 *
3589
 * @see system_element_info()
3590
 */
3591
function user_form_process_password_confirm($element) {
3592
  global $user;
3593

    
3594
  $js_settings = array(
3595
    'password' => array(
3596
      'strengthTitle' => t('Password strength:'),
3597
      'hasWeaknesses' => t('To make your password stronger:'),
3598
      'tooShort' => t('Make it at least 6 characters'),
3599
      'addLowerCase' => t('Add lowercase letters'),
3600
      'addUpperCase' => t('Add uppercase letters'),
3601
      'addNumbers' => t('Add numbers'),
3602
      'addPunctuation' => t('Add punctuation'),
3603
      'sameAsUsername' => t('Make it different from your username'),
3604
      'confirmSuccess' => t('yes'),
3605
      'confirmFailure' => t('no'),
3606
      'weak' => t('Weak'),
3607
      'fair' => t('Fair'),
3608
      'good' => t('Good'),
3609
      'strong' => t('Strong'),
3610
      'confirmTitle' => t('Passwords match:'),
3611
      'username' => (isset($user->name) ? $user->name : ''),
3612
    ),
3613
  );
3614

    
3615
  $element['#attached']['js'][] = drupal_get_path('module', 'user') . '/user.js';
3616
  // Ensure settings are only added once per page.
3617
  static $already_added = FALSE;
3618
  if (!$already_added) {
3619
    $already_added = TRUE;
3620
    $element['#attached']['js'][] = array('data' => $js_settings, 'type' => 'setting');
3621
  }
3622

    
3623
  return $element;
3624
}
3625

    
3626
/**
3627
 * Implements hook_node_load().
3628
 */
3629
function user_node_load($nodes, $types) {
3630
  // Build an array of all uids for node authors, keyed by nid.
3631
  $uids = array();
3632
  foreach ($nodes as $nid => $node) {
3633
    $uids[$nid] = $node->uid;
3634
  }
3635

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

    
3639
  // Add these values back into the node objects.
3640
  foreach ($uids as $nid => $uid) {
3641
    $nodes[$nid]->name = $user_fields[$uid]->name;
3642
    $nodes[$nid]->picture = $user_fields[$uid]->picture;
3643
    $nodes[$nid]->data = $user_fields[$uid]->data;
3644
  }
3645
}
3646

    
3647
/**
3648
 * Implements hook_image_style_delete().
3649
 */
3650
function user_image_style_delete($style) {
3651
  // If a style is deleted, update the variables.
3652
  // Administrators choose a replacement style when deleting.
3653
  user_image_style_save($style);
3654
}
3655

    
3656
/**
3657
 * Implements hook_image_style_save().
3658
 */
3659
function user_image_style_save($style) {
3660
  // If a style is renamed, update the variables that use it.
3661
  if (isset($style['old_name']) && $style['old_name'] == variable_get('user_picture_style', '')) {
3662
    variable_set('user_picture_style', $style['name']);
3663
  }
3664
}
3665

    
3666
/**
3667
 * Implements hook_action_info().
3668
 */
3669
function user_action_info() {
3670
  return array(
3671
    'user_block_user_action' => array(
3672
      'label' => t('Block current user'),
3673
      'type' => 'user',
3674
      'configurable' => FALSE,
3675
      'triggers' => array('any'),
3676
    ),
3677
  );
3678
}
3679

    
3680
/**
3681
 * Blocks a specific user or the current user, if one is not specified.
3682
 *
3683
 * @param $entity
3684
 *   (optional) An entity object; if it is provided and it has a uid property,
3685
 *   the user with that ID is blocked.
3686
 * @param $context
3687
 *   (optional) An associative array; if no user ID is found in $entity, the
3688
 *   'uid' element of this array determines the user to block.
3689
 *
3690
 * @ingroup actions
3691
 */
3692
function user_block_user_action(&$entity, $context = array()) {
3693
  // First priority: If there is a $entity->uid, block that user.
3694
  // This is most likely a user object or the author if a node or comment.
3695
  if (isset($entity->uid)) {
3696
    $uid = $entity->uid;
3697
  }
3698
  elseif (isset($context['uid'])) {
3699
    $uid = $context['uid'];
3700
  }
3701
  // If neither of those are valid, then block the current user.
3702
  else {
3703
    $uid = $GLOBALS['user']->uid;
3704
  }
3705
  $account = user_load($uid);
3706
  $account = user_save($account, array('status' => 0));
3707
  watchdog('action', 'Blocked user %name.', array('%name' => $account->name));
3708
}
3709

    
3710
/**
3711
 * Implements hook_form_FORM_ID_alter().
3712
 *
3713
 * Add a checkbox for the 'user_register_form' instance settings on the 'Edit
3714
 * field instance' form.
3715
 */
3716
function user_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
3717
  $instance = $form['#instance'];
3718

    
3719
  if ($instance['entity_type'] == 'user' && !$form['#field']['locked']) {
3720
    $form['instance']['settings']['user_register_form'] = array(
3721
      '#type' => 'checkbox',
3722
      '#title' => t('Display on user registration form.'),
3723
      '#description' => t("This is compulsory for 'required' fields."),
3724
      // Field instances created in D7 beta releases before the setting was
3725
      // introduced might be set as 'required' and 'not shown on user_register
3726
      // form'. We make sure the checkbox comes as 'checked' for those.
3727
      '#default_value' => $instance['settings']['user_register_form'] || $instance['required'],
3728
      // Display just below the 'required' checkbox.
3729
      '#weight' => $form['instance']['required']['#weight'] + .1,
3730
      // Disabled when the 'required' checkbox is checked.
3731
      '#states' => array(
3732
        'enabled' => array('input[name="instance[required]"]' => array('checked' => FALSE)),
3733
      ),
3734
      // Checked when the 'required' checkbox is checked. This is done through
3735
      // a custom behavior, since the #states system would also synchronize on
3736
      // uncheck.
3737
      '#attached' => array(
3738
        'js' => array(drupal_get_path('module', 'user') . '/user.js'),
3739
      ),
3740
    );
3741

    
3742
    array_unshift($form['#submit'], 'user_form_field_ui_field_edit_form_submit');
3743
  }
3744
}
3745

    
3746
/**
3747
 * Additional submit handler for the 'Edit field instance' form.
3748
 *
3749
 * Make sure the 'user_register_form' setting is set for required fields.
3750
 */
3751
function user_form_field_ui_field_edit_form_submit($form, &$form_state) {
3752
  $instance = $form_state['values']['instance'];
3753

    
3754
  if (!empty($instance['required'])) {
3755
    form_set_value($form['instance']['settings']['user_register_form'], 1, $form_state);
3756
  }
3757
}
3758

    
3759
/**
3760
 * Form builder; the user registration form.
3761
 *
3762
 * @ingroup forms
3763
 * @see user_account_form()
3764
 * @see user_account_form_validate()
3765
 * @see user_register_submit()
3766
 */
3767
function user_register_form($form, &$form_state) {
3768
  global $user;
3769

    
3770
  $admin = user_access('administer users');
3771

    
3772
  // Pass access information to the submit handler. Running an access check
3773
  // inside the submit function interferes with form processing and breaks
3774
  // hook_form_alter().
3775
  $form['administer_users'] = array(
3776
     '#type' => 'value',
3777
     '#value' => $admin,
3778
  );
3779

    
3780
  // If we aren't admin but already logged on, go to the user page instead.
3781
  if (!$admin && $user->uid) {
3782
    drupal_goto('user/' . $user->uid);
3783
  }
3784

    
3785
  $form['#user'] = drupal_anonymous_user();
3786
  $form['#user_category'] = 'register';
3787

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

    
3791
  // Start with the default user account fields.
3792
  user_account_form($form, $form_state);
3793

    
3794
  // Attach field widgets, and hide the ones where the 'user_register_form'
3795
  // setting is not on.
3796
  $langcode = entity_language('user', $form['#user']);
3797
  field_attach_form('user', $form['#user'], $form, $form_state, $langcode);
3798
  foreach (field_info_instances('user', 'user') as $field_name => $instance) {
3799
    if (empty($instance['settings']['user_register_form'])) {
3800
      $form[$field_name]['#access'] = FALSE;
3801
    }
3802
  }
3803

    
3804
  if ($admin) {
3805
    // Redirect back to page which initiated the create request;
3806
    // usually admin/people/create.
3807
    $form_state['redirect'] = $_GET['q'];
3808
  }
3809

    
3810
  $form['actions'] = array('#type' => 'actions');
3811
  $form['actions']['submit'] = array(
3812
    '#type' => 'submit',
3813
    '#value' => t('Create new account'),
3814
  );
3815

    
3816
  $form['#validate'][] = 'user_register_validate';
3817
  // Add the final user registration form submit handler.
3818
  $form['#submit'][] = 'user_register_submit';
3819

    
3820
  return $form;
3821
}
3822

    
3823
/**
3824
 * Validation function for the user registration form.
3825
 */
3826
function user_register_validate($form, &$form_state) {
3827
  entity_form_field_validate('user', $form, $form_state);
3828
}
3829

    
3830
/**
3831
 * Submit handler for the user registration form.
3832
 *
3833
 * This function is shared by the installation form and the normal registration form,
3834
 * which is why it can't be in the user.pages.inc file.
3835
 *
3836
 * @see user_register_form()
3837
 */
3838
function user_register_submit($form, &$form_state) {
3839
  $admin = $form_state['values']['administer_users'];
3840

    
3841
  if (!variable_get('user_email_verification', TRUE) || $admin) {
3842
    $pass = $form_state['values']['pass'];
3843
  }
3844
  else {
3845
    $pass = user_password();
3846
  }
3847
  $notify = !empty($form_state['values']['notify']);
3848

    
3849
  // Remove unneeded values.
3850
  form_state_values_clean($form_state);
3851

    
3852
  $form_state['values']['pass'] = $pass;
3853
  $form_state['values']['init'] = $form_state['values']['mail'];
3854

    
3855
  $account = $form['#user'];
3856

    
3857
  entity_form_submit_build_entity('user', $account, $form, $form_state);
3858

    
3859
  // Populate $edit with the properties of $account, which have been edited on
3860
  // this form by taking over all values, which appear in the form values too.
3861
  $edit = array_intersect_key((array) $account, $form_state['values']);
3862
  $account = user_save($account, $edit);
3863

    
3864
  // Terminate if an error occurred during user_save().
3865
  if (!$account) {
3866
    drupal_set_message(t("Error saving user account."), 'error');
3867
    $form_state['redirect'] = '';
3868
    return;
3869
  }
3870
  $form_state['user'] = $account;
3871
  $form_state['values']['uid'] = $account->uid;
3872

    
3873
  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'));
3874

    
3875
  // Add plain text password into user account to generate mail tokens.
3876
  $account->password = $pass;
3877

    
3878
  // New administrative account without notification.
3879
  $uri = entity_uri('user', $account);
3880
  if ($admin && !$notify) {
3881
    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)));
3882
  }
3883
  // No e-mail verification required; log in user immediately.
3884
  elseif (!$admin && !variable_get('user_email_verification', TRUE) && $account->status) {
3885
    _user_mail_notify('register_no_approval_required', $account);
3886
    $form_state['uid'] = $account->uid;
3887
    user_login_submit(array(), $form_state);
3888
    drupal_set_message(t('Registration successful. You are now logged in.'));
3889
    $form_state['redirect'] = '';
3890
  }
3891
  // No administrator approval required.
3892
  elseif ($account->status || $notify) {
3893
    $op = $notify ? 'register_admin_created' : 'register_no_approval_required';
3894
    _user_mail_notify($op, $account);
3895
    if ($notify) {
3896
      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)));
3897
    }
3898
    else {
3899
      drupal_set_message(t('A welcome message with further instructions has been sent to your e-mail address.'));
3900
      $form_state['redirect'] = '';
3901
    }
3902
  }
3903
  // Administrator approval required.
3904
  else {
3905
    _user_mail_notify('register_pending_approval', $account);
3906
    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.'));
3907
    $form_state['redirect'] = '';
3908
  }
3909
}
3910

    
3911
/**
3912
 * Implements hook_modules_installed().
3913
 */
3914
function user_modules_installed($modules) {
3915
  // Assign all available permissions to the administrator role.
3916
  $rid = variable_get('user_admin_role', 0);
3917
  if ($rid) {
3918
    $permissions = array();
3919
    foreach ($modules as $module) {
3920
      if ($module_permissions = module_invoke($module, 'permission')) {
3921
        $permissions = array_merge($permissions, array_keys($module_permissions));
3922
      }
3923
    }
3924
    if (!empty($permissions)) {
3925
      user_role_grant_permissions($rid, $permissions);
3926
    }
3927
  }
3928
}
3929

    
3930
/**
3931
 * Implements hook_modules_uninstalled().
3932
 */
3933
function user_modules_uninstalled($modules) {
3934
   db_delete('role_permission')
3935
     ->condition('module', $modules, 'IN')
3936
     ->execute();
3937
}
3938

    
3939
/**
3940
 * Helper function to rewrite the destination to avoid redirecting to login page after login.
3941
 *
3942
 * Third-party authentication modules may use this function to determine the
3943
 * proper destination after a user has been properly logged in.
3944
 */
3945
function user_login_destination() {
3946
  $destination = drupal_get_destination();
3947
  if ($destination['destination'] == 'user/login') {
3948
    $destination['destination'] = 'user';
3949
  }
3950
  return $destination;
3951
}
3952

    
3953
/**
3954
 * Saves visitor information as a cookie so it can be reused.
3955
 *
3956
 * @param $values
3957
 *   An array of key/value pairs to be saved into a cookie.
3958
 */
3959
function user_cookie_save(array $values) {
3960
  foreach ($values as $field => $value) {
3961
    // Set cookie for 365 days.
3962
    setrawcookie('Drupal.visitor.' . $field, rawurlencode($value), REQUEST_TIME + 31536000, '/');
3963
  }
3964
}
3965

    
3966
/**
3967
 * Delete a visitor information cookie.
3968
 *
3969
 * @param $cookie_name
3970
 *   A cookie name such as 'homepage'.
3971
 */
3972
function user_cookie_delete($cookie_name) {
3973
  setrawcookie('Drupal.visitor.' . $cookie_name, '', REQUEST_TIME - 3600, '/');
3974
}
3975

    
3976
/**
3977
 * Implements hook_rdf_mapping().
3978
 */
3979
function user_rdf_mapping() {
3980
  return array(
3981
    array(
3982
      'type' => 'user',
3983
      'bundle' => RDF_DEFAULT_BUNDLE,
3984
      'mapping' => array(
3985
        'rdftype' => array('sioc:UserAccount'),
3986
        'name' => array(
3987
          'predicates' => array('foaf:name'),
3988
        ),
3989
        'homepage' => array(
3990
          'predicates' => array('foaf:page'),
3991
          'type' => 'rel',
3992
        ),
3993
      ),
3994
    ),
3995
  );
3996
}
3997

    
3998
/**
3999
 * Implements hook_file_download_access().
4000
 */
4001
function user_file_download_access($field, $entity_type, $entity) {
4002
  if ($entity_type == 'user') {
4003
    return user_view_access($entity);
4004
  }
4005
}
4006

    
4007
/**
4008
 * Implements hook_system_info_alter().
4009
 *
4010
 * Drupal 7 ships with two methods to add additional fields to users: Profile
4011
 * module, a legacy module dating back from 2002, and Field API integration
4012
 * with users. While Field API support for users currently provides less end
4013
 * user features, the inefficient data storage mechanism of Profile module, as
4014
 * well as its lack of consistency with the rest of the entity / field based
4015
 * systems in Drupal 7, make this a sub-optimal solution to those who were not
4016
 * using it in previous releases of Drupal.
4017
 *
4018
 * To prevent new Drupal 7 sites from installing Profile module, and
4019
 * unwittingly ending up with two completely different and incompatible methods
4020
 * of extending users, only make the Profile module available if the profile_*
4021
 * tables are present.
4022
 *
4023
 * @todo: Remove in D8, pending upgrade path.
4024
 */
4025
function user_system_info_alter(&$info, $file, $type) {
4026
  if ($type == 'module' && $file->name == 'profile' && db_table_exists('profile_field')) {
4027
    $info['hidden'] = FALSE;
4028
  }
4029
}