user.module 111 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3
<?php
// $Id$

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Enables the user registration and login system.
 */

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

/**
 * Maximum length of user e-mail text field.
 */
17 18
define('EMAIL_MAX_LENGTH', 64);

19

Dries's avatar
Dries committed
20 21 22
/**
 * Invokes hook_user() in every module.
 *
23
 * We cannot use module_invoke() for this, because the arguments need to
Dries's avatar
Dries committed
24 25
 * be passed by reference.
 */
26
function user_module_invoke($type, &$edit, $account, $category = NULL) {
27
  foreach (module_implements('user_' . $type) as $module) {
28
    $function = $module . '_user_' . $type;
29
    $function($edit, $account, $category);
Dries's avatar
 
Dries committed
30 31 32
  }
}

33
/**
34
 * Implement hook_theme().
35 36 37 38 39
 */
function user_theme() {
  return array(
    'user_picture' => array(
      'arguments' => array('account' => NULL),
40
      'template' => 'user-picture',
41 42
    ),
    'user_profile' => array(
43
      'arguments' => array('elements' => NULL),
44
      'template' => 'user-profile',
45
      'file' => 'user.pages.inc',
46 47 48
    ),
    'user_profile_category' => array(
      'arguments' => array('element' => NULL),
49
      'template' => 'user-profile-category',
50
      'file' => 'user.pages.inc',
51 52 53
    ),
    'user_profile_item' => array(
      'arguments' => array('element' => NULL),
54
      'template' => 'user-profile-item',
55
      'file' => 'user.pages.inc',
56 57 58 59
    ),
    'user_list' => array(
      'arguments' => array('users' => NULL, 'title' => NULL),
    ),
60
    'user_admin_permissions' => array(
61
      'arguments' => array('form' => NULL),
62
      'file' => 'user.admin.inc',
63 64 65
    ),
    'user_admin_new_role' => array(
      'arguments' => array('form' => NULL),
66
      'file' => 'user.admin.inc',
67 68 69
    ),
    'user_filter_form' => array(
      'arguments' => array('form' => NULL),
70
      'file' => 'user.admin.inc',
71 72 73
    ),
    'user_filters' => array(
      'arguments' => array('form' => NULL),
74
      'file' => 'user.admin.inc',
75
    ),
76 77 78
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
79 80 81
  );
}

Dries's avatar
 
Dries committed
82
/**
83
 * Implement hook_entity_info().
Dries's avatar
 
Dries committed
84
 */
85
function user_entity_info() {
Dries's avatar
 
Dries committed
86 87
  $return = array(
    'user' => array(
88
      'label' => t('User'),
89 90 91
      'controller class' => 'UserController',
      'base table' => 'users',
      'fieldable' => TRUE,
92 93 94 95 96 97 98
      'object keys' => array(
        'id' => 'uid',
      ),
      'bundles' => array(
        'user' => array(
          'label' => t('User'),
          'admin' => array(
99
            'path' => 'admin/config/people/accounts',
100 101 102 103
            'access arguments' => array('administer users'),
          ),
        ),
      ),
Dries's avatar
 
Dries committed
104 105 106 107 108 109
    ),
  );
  return $return;
}

/**
110
 * Implement hook_field_build_modes().
Dries's avatar
 
Dries committed
111 112 113 114 115 116 117 118 119 120 121
 */
function user_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'user') {
    $modes = array(
      'full' => t('User account'),
    );
  }
  return $modes;
}

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
/**
 * Implement hook_field_extra_fields().
 */
function user_field_extra_fields($bundle) {
  $extra = array();

  if ($bundle == 'user') {
    $extra['account'] = array(
      'label' => 'User name and password',
      'description' => t('User module account form elements'),
      'weight' => -10,
    );
    $extra['timezone'] = array(
      'label' => 'Timezone',
      'description' => t('User module timezone form element.'),
      'weight' => 6,
    );
    $extra['summary'] = array(
      'label' => 'History',
      'description' => t('User module history view element.'),
      'weight' => 5,
    );
  }

  return $extra;
}

Dries's avatar
 
Dries committed
149
function user_external_load($authname) {
150
  $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField();
Dries's avatar
 
Dries committed
151

152 153
  if ($uid) {
    return user_load($uid);
Dries's avatar
 
Dries committed
154 155
  }
  else {
156
    return FALSE;
Dries's avatar
 
Dries committed
157 158 159
  }
}

Dries's avatar
Dries committed
160
/**
161
 * Load multiple users based on certain conditions.
Dries's avatar
Dries committed
162
 *
163 164 165
 * This function should be used whenever you need to load more than one user
 * from the database. Users are loaded into memory and will not require
 * database access if loaded again during the same page request.
Dries's avatar
Dries committed
166
 *
167 168 169 170 171 172 173 174
 * @param $uids
 *   An array of user IDs.
 * @param $conditions
 *   An array of conditions to match against the {users} table. These
 *   should be supplied in the form array('field_name' => 'field_value').
 * @param $reset
 *   A boolean indicating that the internal cache should be reset. Use this if
 *   loading a user object which has been altered during the page request.
175
 * @return
176 177
 *   An array of user objects, indexed by uid.
 *
178
 * @see entity_load()
179 180 181
 * @see user_load()
 * @see user_load_by_mail()
 * @see user_load_by_name()
Dries's avatar
Dries committed
182
 */
183
function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
184 185
  return entity_load('user', $uids, $conditions, $reset);
}
186

187 188 189 190 191 192 193 194
/**
 * Controller class for users.
 *
 * This extends the DrupalDefaultEntityController class, adding required
 * special handling for user objects.
 */
class UserController extends DrupalDefaultEntityController {
  function attachLoad(&$queried_users) {
195 196
    // Build an array of user picture IDs so that these can be fetched later.
    $picture_fids = array();
197
    foreach ($queried_users as $key => $record) {
198
      $picture_fids[] = $record->picture;
199 200
      $queried_users[$key] = drupal_unpack($record);
      $queried_users[$key]->roles = array();
201 202 203 204 205 206
      if ($record->uid) {
        $queried_users[$record->uid]->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
      }
      else {
        $queried_users[$record->uid]->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
      }
207
    }
208

209 210 211 212 213
    // Add any additional roles from the database.
    $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)));
    foreach ($result as $record) {
      $queried_users[$record->uid]->roles[$record->rid] = $record->name;
    }
Dries's avatar
 
Dries committed
214

215 216 217 218 219 220 221 222 223
    // Add the full file objects for user pictures if enabled.
    if (!empty($picture_fids) && variable_get('user_pictures', 1) == 1) {
      $pictures = file_load_multiple($picture_fids);
      foreach ($queried_users as $account) {
        if (!empty($account->picture) && isset($pictures[$account->picture])) {
          $account->picture = $pictures[$account->picture];
        }
        else {
          $account->picture = NULL;
224 225 226
        }
      }
    }
227 228 229
    // Call the default attachLoad() method. This will add fields and call
    // hook_user_load().
    parent::attachLoad($queried_users);
Dries's avatar
 
Dries committed
230
  }
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
}

/**
 * Fetch a user object.
 *
 * @param $uid
 *   Integer specifying the user id.
 * @param $reset
 *   A boolean indicating that the internal cache should be reset.
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load($uid, $reset = FALSE) {
  $users = user_load_multiple(array($uid), array(), $reset);
  return reset($users);
}

/**
 * Fetch a user object by email address.
 *
 * @param $mail
 *   String with the account's e-mail address.
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load_by_mail($mail) {
  $users = user_load_multiple(array(), array('mail' => $mail));
  return reset($users);
}

/**
 * Fetch a user object by account name.
 *
 * @param $name
 *   String with the account's user name.
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load_by_name($name) {
  $users = user_load_multiple(array(), array('name' => $name));
  return reset($users);
Dries's avatar
 
Dries committed
281 282
}

283
/**
284
 * Save changes to a user account or add a new user.
285 286
 *
 * @param $account
287
 *   (optional) The user object to modify or add. If you want to modify
288 289
 *   an existing user account, you will need to ensure that (a) $account
 *   is an object, and (b) you have set $account->uid to the numeric
290 291
 *   user ID of the user account you wish to modify. If you
 *   want to create a new user account, you can set $account->is_new to
292
 *   TRUE or omit the $account->uid field.
293
 * @param $edit
294
 *   An array of fields and values to save. For example array('name'
295
 *   => 'My name'). Keys that do not belong to columns in the user-related
296 297
 *   tables are added to the a serialized array in the 'data' column
 *   and will be loaded in the $user->data array by user_load().
298 299
 *   Setting a field to NULL deletes it from the data column, if you are
 *   modifying an existing user account.
300 301
 * @param $category
 *   (optional) The category for storing profile information in.
302 303
 *
 * @return
304
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
305
 */
306
function user_save($account, $edit = array(), $category = 'account') {
307
  $table = drupal_get_schema('users');
308 309
  $user_fields = $table['fields'];

310
  if (!empty($edit['pass'])) {
311
    // Allow alternate password hashing schemes.
312
    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
313
    $edit['pass'] = user_hash_password(trim($edit['pass']));
314
    // Abort if the hashing failed and returned FALSE.
315
    if (!$edit['pass']) {
316 317
      return FALSE;
    }
318 319 320
  }
  else {
    // Avoid overwriting an existing password with a blank password.
321
    unset($edit['pass']);
322 323
  }

Dries's avatar
 
Dries committed
324 325 326 327 328 329 330 331 332 333 334 335
  // Get the fields form so we can recognize the fields in the $edit
  // form that should not go into the serialized data array.
  $field_form = array();
  $field_form_state = array();
  $edit = (object) $edit;
  field_attach_form('user', $edit, $field_form, $field_form_state);

  // Presave fields.
  field_attach_presave('user', $edit);

  $edit = (array) $edit;

336
  if (!isset($account->is_new)) {
337
    $account->is_new = empty($account->uid);
338
  }
339 340 341

  user_module_invoke('presave', $edit, $account, $category);

342
  if (is_object($account) && !$account->is_new) {
343
    $data = unserialize(db_query('SELECT data FROM {users} WHERE uid = :uid', array(':uid' => $account->uid))->fetchField());
344 345
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
346
    if (empty($edit['access']) && empty($account->access) && user_access('administer users')) {
347
      $edit['access'] = REQUEST_TIME;
348
    }
349
    foreach ($edit as $key => $value) {
Dries's avatar
 
Dries committed
350
      // Form fields that don't pertain to the users, user_roles, or
351
      // Field API are automatically serialized into the users.data
Dries's avatar
 
Dries committed
352
      // column.
353
      if (!in_array($key, array('roles', 'is_new')) && empty($user_fields[$key]) && empty($field_form[$key])) {
354 355
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
 
Dries committed
356
        }
357 358
        else {
          $data[$key] = $value;
Dries's avatar
 
Dries committed
359
        }
Dries's avatar
 
Dries committed
360 361 362
      }
    }

363 364 365 366 367 368
    // Process picture uploads.
    if (!empty($edit['picture']->fid)) {
      $picture = $edit['picture'];
      // If the picture is a temporary file move it to its final location and
      // make it permanent.
      if (($picture->status & FILE_STATUS_PERMANENT) == 0) {
369 370
        $info = image_get_info($picture->uri);
        $picture_directory =  variable_get('file_default_scheme', 'public') . '://' . variable_get('user_picture_path', 'pictures');
371

372 373 374 375
        // Prepare the pictures directory.
        file_prepare_directory($picture_directory, FILE_CREATE_DIRECTORY);
        $destination = file_stream_wrapper_uri_normalize($picture_directory . '/picture-' . $account->uid . '.' . $info['extension']);

376 377 378 379 380 381 382 383
        if ($picture = file_move($picture, $destination, FILE_EXISTS_REPLACE)) {
          $picture->status |= FILE_STATUS_PERMANENT;
          $edit['picture'] = file_save($picture);
        }
      }
    }
    $edit['picture'] = empty($edit['picture']->fid) ? 0 : $edit['picture']->fid;

384
    $edit['data'] = $data;
385
    // Do not allow 'uid' to be changed.
386
    $edit['uid'] = $account->uid;
387
    // Save changes to the user table.
388
    $success = drupal_write_record('users', $edit, 'uid');
389
    if ($success === FALSE) {
Dries's avatar
 
Dries committed
390 391
      // The query failed - better to abort the save than risk further
      // data loss.
392
      return FALSE;
393
    }
Dries's avatar
 
Dries committed
394

395
    // If the picture changed or was unset, remove the old one. This step needs
396
    // to occur after updating the {users} record so that user_file_references()
397 398 399 400 401
    // doesn't report it in use and block the deletion.
    if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) {
      file_delete($account->picture);
    }

402
    // Reload user roles if provided.
403
    if (isset($edit['roles']) && is_array($edit['roles'])) {
404 405 406
      db_delete('users_roles')
        ->condition('uid', $account->uid)
        ->execute();
Dries's avatar
 
Dries committed
407

408
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
409
      foreach (array_keys($edit['roles']) as $rid) {
410
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
411 412 413 414
          $query->values(array(
            'uid' => $account->uid,
            'rid' => $rid,
          ));
415
        }
416
      }
417
      $query->execute();
Dries's avatar
 
Dries committed
418 419
    }

420
    // Delete a blocked user's sessions to kick them if they are online.
421
    if (isset($edit['status']) && $edit['status'] == 0) {
422
      drupal_session_destroy_uid($account->uid);
423 424
    }

425 426
    // If the password changed, delete all open sessions and recreate
    // the current one.
427
    if (!empty($edit['pass'])) {
428
      drupal_session_destroy_uid($account->uid);
429 430 431
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
432 433
    }

Dries's avatar
 
Dries committed
434
    // Save Field data.
435 436
    $object = (object) $edit;
    field_attach_update('user', $object);
Dries's avatar
 
Dries committed
437

438
    // Refresh user object.
439
    $user = user_load($account->uid, TRUE);
440 441

    // Send emails after we have the new user object.
442
    if (isset($edit['status']) && $edit['status'] != $account->status) {
443
      // The user's status is changing; conditionally send notification email.
444
      $op = $edit['status'] == 1 ? 'status_activated' : 'status_blocked';
445 446 447
      _user_mail_notify($op, $user);
    }

448
    user_module_invoke('update', $edit, $user, $category);
Dries's avatar
 
Dries committed
449 450
  }
  else {
451
    // Allow 'created' to be set by the caller.
452
    if (!isset($edit['created'])) {
453
      $edit['created'] = REQUEST_TIME;
454
    }
455 456
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
457
    if (empty($edit['access']) && user_access('administer users')) {
458
      $edit['access'] = REQUEST_TIME;
459
    }
460

461
    $edit['mail'] = trim($edit['mail']);
462
    $success = drupal_write_record('users', $edit);
463
    if ($success === FALSE) {
464 465 466 467
      // On a failed INSERT some other existing user's uid may be returned.
      // We must abort to avoid overwriting their account.
      return FALSE;
    }
468

469
    // Build the initial user object.
470
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
 
Dries committed
471

472 473
    $object = (object) $edit;
    field_attach_insert('user', $object);
Dries's avatar
 
Dries committed
474

475
    user_module_invoke('insert', $edit, $user, $category);
476

477 478
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
479
    $data = array();
480
    foreach ($edit as $key => $value) {
481
      // Form fields that don't pertain to the users, user_roles, or
482
      // Field API are automatically serialized into the user.data
Dries's avatar
 
Dries committed
483
      // column.
484
      if ((!in_array($key, array('roles', 'is_new'))) && (empty($user_fields[$key]) && empty($field_form[$key])) && ($value !== NULL)) {
485 486 487
        $data[$key] = $value;
      }
    }
488 489
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
490
      drupal_write_record('users', $data_array, 'uid');
491
    }
492

493
    // Save user roles (delete just to be safe).
494
    if (isset($edit['roles']) && is_array($edit['roles'])) {
495 496 497 498
      db_delete('users_roles')
        ->condition('uid', $edit['uid'])
        ->execute();
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
499
      foreach (array_keys($edit['roles']) as $rid) {
500
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
501 502 503 504
          $query->values(array(
            'uid' => $edit['uid'],
            'rid' => $rid,
          ));
505
        }
506
      }
507
      $query->execute();
508 509
    }

510
    // Build the finished user object.
511
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
 
Dries committed
512 513 514 515 516
  }

  return $user;
}

Dries's avatar
Dries committed
517 518 519
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
520
function user_validate_name($name) {
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
  if (!$name) {
    return t('You must enter a username.');
  }
  if (substr($name, 0, 1) == ' ') {
    return t('The username cannot begin with a space.');
  }
  if (substr($name, -1) == ' ') {
    return t('The username cannot end with a space.');
  }
  if (strpos($name, '  ') !== FALSE) {
    return t('The username cannot contain multiple spaces in a row.');
  }
  if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)) {
    return t('The username contains an illegal character.');
  }
536
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
537 538 539 540 541 542 543 544 545
                  '\x{AD}' .                // Soft-hyphen
                  '\x{2000}-\x{200F}' .     // Various space characters
                  '\x{2028}-\x{202F}' .     // Bidirectional text overrides
                  '\x{205F}-\x{206F}' .     // Various text hinting characters
                  '\x{FEFF}' .              // Byte order mark
                  '\x{FF01}-\x{FF60}' .     // Full-width latin
                  '\x{FFF9}-\x{FFFD}' .     // Replacement characters
                  '\x{0}-\x{1F}]/u',        // NULL byte and control characters
                  $name)) {
546 547
    return t('The username contains an illegal character.');
  }
548 549 550
  if (drupal_strlen($name) > USERNAME_MAX_LENGTH) {
    return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
  }
Dries's avatar
 
Dries committed
551 552 553
}

function user_validate_mail($mail) {
554
  $mail = trim($mail);
555 556 557
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
558
  if (!valid_email_address($mail)) {
559
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
560 561 562
  }
}

563
function user_validate_picture(&$form, &$form_state) {
564
  // If required, validate the uploaded picture.
565 566 567 568 569
  $validators = array(
    'file_validate_is_image' => array(),
    'file_validate_image_resolution' => array(variable_get('user_picture_dimensions', '85x85')),
    'file_validate_size' => array(variable_get('user_picture_file_size', '30') * 1024),
  );
570

571 572 573 574 575 576 577
  // Save the file as a temporary file.
  $file = file_save_upload('picture_upload', $validators);
  if ($file === FALSE) {
    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'))));
  }
  elseif ($file !== NULL) {
    $form_state['values']['picture_upload'] = $file;
Dries's avatar
 
Dries committed
578 579 580
  }
}

Dries's avatar
Dries committed
581 582 583
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
584 585
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
586 587
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
588
  // of 'I', 1, and 'l'.
589
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
590

591 592
  // Zero-based count of characters in the allowable list:
  $len = strlen($allowable_characters) - 1;
Dries's avatar
 
Dries committed
593

Dries's avatar
Dries committed
594 595
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
596

Dries's avatar
Dries committed
597
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
598 599 600 601
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
602
    $pass .= $allowable_characters[mt_rand(0, $len)];
Dries's avatar
 
Dries committed
603 604 605
  }

  return $pass;
Dries's avatar
 
Dries committed
606 607
}

608 609 610 611 612 613 614 615 616 617
/**
 * Determine the permissions for one or more roles.
 *
 * @param $roles
 *   An array whose keys are the role IDs of interest, such as $user->roles.
 *
 * @return
 *   An array indexed by role ID. Each value is an array whose keys are the
 *   permission strings for the given role ID.
 */
618 619
function user_role_permissions($roles = array()) {
  $cache = &drupal_static(__FUNCTION__, array());
620 621 622 623 624

  $role_permissions = $fetch = array();

  if ($roles) {
    foreach ($roles as $rid => $name) {
625 626
      if (isset($cache[$rid])) {
        $role_permissions[$rid] = $cache[$rid];
627 628 629 630 631
      }
      else {
        // Add this rid to the list of those needing to be fetched.
        $fetch[] = $rid;
        // Prepare in case no permissions are returned.
632
        $cache[$rid] = array();
633 634 635 636 637 638
      }
    }

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

641
      foreach ($result as $row) {
642
        $cache[$row->rid][$row->permission] = TRUE;
643 644 645
      }
      foreach ($fetch as $rid) {
        // For every rid, we know we at least assigned an empty array.
646
        $role_permissions[$rid] = $cache[$rid];
647 648 649 650 651 652 653
      }
    }
  }

  return $role_permissions;
}

Dries's avatar
Dries committed
654 655 656 657 658
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
659 660
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
661 662
 *
 * @return
663
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
664 665 666 667 668
 *
 * All permission checks in Drupal should go through this function. This
 * way, we guarantee consistent behavior, and ensure that the superuser
 * can perform all actions.
 */
669
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
670
  global $user;
671
  $perm = &drupal_static(__FUNCTION__, array());
672

673
  if (!isset($account)) {
674 675 676
    $account = $user;
  }

677
  // User #1 has all privileges:
678
  if ($account->uid == 1) {
679
    return TRUE;
Dries's avatar
 
Dries committed
680 681
  }

Dries's avatar
Dries committed
682 683
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
684
  if (!isset($perm[$account->uid])) {
685
    $role_permissions = user_role_permissions($account->roles);
Dries's avatar
 
Dries committed
686

687
    $perms = array();
688 689
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
 
Dries committed
690
    }
691
    $perm[$account->uid] = $perms;
Dries's avatar
 
Dries committed
692
  }
693

694
  return isset($perm[$account->uid][$string]);
Dries's avatar
 
Dries committed
695 696
}

697
/**
698
 * Checks for usernames blocked by user administration.
699
 *
700
 * @return boolean TRUE for blocked users, FALSE for active.
701 702
 */
function user_is_blocked($name) {
703
  $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject();
704

705
  return $deny;
706 707
}

Dries's avatar
Dries committed
708
/**
709
 * Implement hook_permission().
Dries's avatar
Dries committed
710
 */
711
function user_permission() {
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
  return array(
    'administer permissions' =>  array(
      'title' => t('Administer permissions'),
      'description' => t('Manage the permissions assigned to user roles. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))),
    ),
    'administer users' => array(
      'title' => t('Administer users'),
      'description' => t('Manage or block users, and manage their role assignments.'),
    ),
    'access user profiles' => array(
      'title' => t('Access user profiles'),
      'description' => t('View profiles of users on the site, which may contain personal information.'),
    ),
    'change own username' => array(
      'title' => t('Change own username'),
      'description' => t('Select a different username.'),
    ),
    'cancel account' => array(
      'title' => t('Cancel account'),
731
      'description' => t('Remove or disable own user account and unpublish, anonymize, or remove own submissions depending on the configured <a href="@user-settings-url">user settings</a>.', array('@user-settings-url' => url('admin/config/people/accounts'))),
732 733 734 735 736 737
    ),
    'select account cancellation method' => array(
      'title' => t('Select method for cancelling own account'),
      'description' => t('Select the method for cancelling own user account. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))),
    ),
  );
Dries's avatar
 
Dries committed
738 739
}

Dries's avatar
Dries committed
740
/**
741
 * Implement hook_file_download().
Dries's avatar
Dries committed
742 743 744
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
745
function user_file_download($filepath) {
746 747
  if (strpos(file_uri_target($filepath), variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info($filepath);
748
    return array('Content-Type' => $info['mime_type']);
Dries's avatar
 
Dries committed
749 750 751
  }
}

752
/**
753
 * Implement hook_file_references().
754 755 756
 */
function user_file_references($file) {
  // Determine if the file is used by this module.
757
  $file_used = (bool) db_query_range('SELECT 1 FROM {users} WHERE picture = :fid', 0, 1, array(':fid' => $file->fid))->fetchField();
758
  if ($file_used) {
759 760 761 762 763 764
    // Return the name of the module and how many references it has to the file.
    return array('user' => $count);
  }
}

/**
765
 * Implement hook_file_delete().
766 767 768
 */
function user_file_delete($file) {
  // Remove any references to the file.
769
  db_update('users')
770 771 772 773 774
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

Dries's avatar
Dries committed
775
/**
776
 * Implement hook_search_info().
Dries's avatar
Dries committed
777
 */
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
function user_search_info() {
  return array(
    'title' => 'Users',
  );
}

/**
 * Implement hook_search_access().
 */
function user_search_access() {
  return user_access('access user profiles');
}

/**
 * Implement hook_search_execute().
 */
function user_search_execute($keys = NULL) {
  $find = array();
  // Replace wildcards with MySQL/PostgreSQL wildcards.
  $keys = preg_replace('!\*+!', '%', $keys);
  $query = db_select('users')->extend('PagerDefault');
  $query->fields('users', array('name', 'uid', 'mail'));
  if (user_access('administer users')) {
    // Administrators can also search in the otherwise private email field.
    $query->condition(db_or()->
      where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"))->
      where('LOWER(mail) LIKE LOWER(:mail)', array(':mail' => "%$keys%")));
  }
  else {
    $query->where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"));
  }
  $result = $query
    ->limit(15)
    ->execute();
  foreach ($result as $account) {
    $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
Dries's avatar
 
Dries committed
814
  }
815
  return $find;
Dries's avatar
 
Dries committed
816 817
}

Dries's avatar
Dries committed
818
/**
819
 * Implement hook_element_info().
Dries's avatar
Dries committed
820
 */
821 822 823 824 825 826
function user_element_info() {
  $types['user_profile_category'] = array(
    '#theme_wrappers' => array('user_profile_category'),
  );
  $types['user_profile_item'] = array(
    '#theme' => 'user_profile_item',
Dries's avatar
Dries committed
827
  );
828
  return $types;
Dries's avatar
Dries committed
829 830
}

Dries's avatar
Dries committed
831
/**
832
 * Implement hook_user_view().
Dries's avatar
Dries committed
833
 */
834
function user_user_view($account) {
835
  $account->content['user_picture'] = array(
836
    '#markup' => theme('user_picture', array('account' => $account)),
837 838 839 840 841 842 843
    '#weight' => -10,
  );
  if (!isset($account->content['summary'])) {
    $account->content['summary'] = array();
  }
  $account->content['summary'] += array(
    '#type' => 'user_profile_category',
844
    '#attributes' => array('class' => array('user-member')),
845 846 847
    '#weight' => 5,
    '#title' => t('History'),
  );
848
  $account->content['summary']['member_for'] = array(
849 850 851 852 853 854 855
    '#type' => 'user_profile_item',
    '#title' => t('Member for'),
    '#markup' => format_interval(REQUEST_TIME - $account->created),
  );
}

/**
856
 * Helper function to add default user account fields to user registration and edit form.
857
 */
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
function user_account_form(&$form, &$form_state) {
  global $user;

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

  _user_password_dynamic_validation();
  $admin = user_access('administer users');

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

  // Account information.
  $form['account'] = array(
    '#type' => 'fieldset',
    '#title' => t('Account information'),
    '#weight' => -10,
  );
  // Only show name field on registration form or user can change own username.
  $form['account']['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#maxlength' => USERNAME_MAX_LENGTH,
    '#description' => t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'),
    '#required' => TRUE,
    '#attributes' => array('class' => array('username')),
    '#default_value' => (!$register ? $account->name : ''),
    '#access' => ($register || ($user->uid == $account->uid && user_access('change own username')) || $admin),
  );

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

  // Display password field only for existing users or when user is allowed to
  // assign a password during registration.
  if (!$register) {
    $form['account']['pass'] = array(
      '#type' => 'password_confirm',
      '#size' => 25,
      '#description' => t('To change the current user password, enter the new password in both fields.'),
    );
  }
  elseif (!variable_get('user_email_verification', TRUE) || $admin) {
    $form['account']['pass'] = array(
      '#type' => 'password_confirm',
      '#size' => 25,
      '#description' => t('Provide a password for the new account in both fields.'),
      '#required' => TRUE,
    );
  }

  if ($admin) {
    $status = (isset($account->status) ? $account->status : 1);
  }
  else {
    $status = (variable_get('user_register', 1) == 1);
  }
  $form['account']['status'] = array(
    '#type' => 'radios',
    '#title' => t('Status'),
    '#default_value' => $status,
    '#options' => array(t('Blocked'), t('Active')),
    '#access' => $admin,
  );

  $roles = user_roles(TRUE);
  // The disabled checkbox subelement for the 'authenticated user' role
  // must be generated separately and added to the checkboxes element,
  // because of a limitation in Form API not supporting a single disabled
  // checkbox within a set of checkboxes.
  // @todo This should be solved more elegantly. See issue #119038.
  $checkbox_authenticated = array(
    '#type' => 'checkbox',
    '#title' => $roles[DRUPAL_AUTHENTICATED_RID],
    '#default_value' => TRUE,
    '#disabled' => TRUE,
  );
  unset($roles[DRUPAL_AUTHENTICATED_RID]);
  $form['account']['roles'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Roles'),
    '#default_value' => (!$register && isset($account->roles) ? array_keys($account->roles) : array()),
    '#options' => $roles,
    '#access' => $roles && user_access('administer permissions'),
    DRUPAL_AUTHENTICATED_RID => $checkbox_authenticated,
  );

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

  // Signature.
  $form['signature_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Signature settings'),
    '#weight' => 1,
    '#access' => (!$register && variable_get('user_signatures', 0)),
  );
  $form['signature_settings']['signature'] = array(
    '#type' => 'textarea',
    '#title' => t('Signature'),
    '#default_value' => isset($account->signature) ? $account->signature : '',
    '#description' => t('Your signature will be publicly displayed at the end of your comments.'),
  );

  // Picture/avatar.
  $form['picture'] = array(
    '#type' => 'fieldset',
    '#title' => t('Picture'),
    '#weight' => 1,
    '#access' => (!$register && variable_get('user_pictures', 0)),
  );
  $form['picture']['picture'] = array(
    '#type' => 'value',
    '#value' => isset($account->picture) ? $account->picture : NULL,
  );
  $form['picture']['picture_current'] = array(
    '#markup' => theme('user_picture', array('account' => $account)),
  );
  $form['picture']['picture_delete'] = array(
    '#type' => 'checkbox',
    '#title' => t('Delete picture'),
    '#access' => !empty($account->picture->fid),
    '#description' => t('Check this box to delete your current picture.'),
  );
  $form['picture']['picture_upload'] = array(
    '#type' => 'file',
    '#title' => t('Upload picture'),
    '#size' => 48,
    '#description' => t('Your virtual face or picture. Maximum dimensions are %dimensions pixels and the maximum size is %size kB.', array('%dimensions' => variable_get('user_picture_dimensions', '85x85'), '%size' => variable_get('user_picture_file_size', '30'))) . ' ' . variable_get('user_picture_guidelines', ''),
  );
  $form['#validate'][] = 'user_validate_picture';
}

/**
 * Form validation handler for user_account_form().
 */
function user_account_form_validate($form, &$form_state) {
  if ($form['#user_category'] == 'account' || $form['#user_category'] == 'register') {
    $account = $form['#user'];
    // Validate new or changing username.
    if (isset($form_state['values']['name'])) {
      if ($error = user_validate_name($form_state['values']['name'])) {
1008 1009
        form_set_error('name', $error);
      }
1010 1011
      elseif ((bool) db_query_range("SELECT 1 FROM {users} WHERE uid <> :uid AND LOWER(name) = LOWER(:name)", 0, 1, array(':uid' => $account->uid, ':name' => $form_state['values']['name']))->fetchField()) {
        form_set_error('name', t('The name %name is already taken.', array('%name' => $form_state['values']['name'])));
1012 1013 1014
      }
    }

1015
    // Validate the e-mail address, and check if it is taken by an existing user.
1016
    if ($error = user_validate_mail($form_state['values']['mail'])) {
1017 1018
      form_set_error('mail', $error);
    }
1019
    elseif ((bool) db_query_range("SELECT 1 FROM {users} WHERE uid <> :uid AND LOWER(mail) = LOWER(:mail)", 0, 1, array(':uid' => $account->uid, ':mail' => $form_state['values']['mail']))->fetchField()) {
1020 1021
      // Format error message dependent on whether the user is logged in or not.
      if ($GLOBALS['user']->uid) {
1022
        form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $form_state['values']['mail'])));
1023 1024
      }
      else {
1025
        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'))));
1026
      }
1027
    }
1028 1029 1030

    // Make sure the signature isn't longer than the size of the database field.
    // Signatures are disabled by default, so make sure it exists first.
1031
    if (isset($form_state['values']['signature'])) {
1032
      $user_schema = drupal_get_schema('users');
1033
      if (drupal_strlen($form_state['values']['signature']) > $user_schema['fields']['signature']['length']) {
1034 1035 1036
        form_set_error('signature', t('The signature is too long: it must be %max characters or less.', array('%max' => $user_schema['fields']['signature']['length'])));
      }
    }
1037
  }
1038
}
1039

1040
/**
1041
 * Implement hook_user_presave().
1042
 */
1043 1044
function user_user_presave(&$edit, $account, $category) {
  if ($category == 'account' || $category == 'register') {
1045 1046 1047
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
1048
    // Delete picture if requested, and if no replacement picture was given.
1049 1050
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
1051
    }
1052 1053 1054 1055
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

1056
    // Prepare user roles.
1057 1058 1059
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
1060
  }
1061
}
1062

1063
/**
1064
 * Implement hook_user_categories().
1065
 */
1066 1067 1068 1069 1070 1071
function user_user_categories() {
  return array(array(
    'name' => 'account',
    'title' => t('Account settings'),
    'weight' => 1,
  ));
Dries's avatar
Dries committed
1072 1073
}

1074 1075 1076 1077 1078
function user_login_block($form) {
  $form['#action'] = url($_GET['q'], array('query' => drupal_get_destination()));
  $form['#id'] = 'user-login-form';
  $form['#validate'] = user_login_default_validators();
  $form['#submit'][] = 'user_login_submit';
1079 1080
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
1081
    '#maxlength' => USERNAME_MAX_LENGTH,
1082 1083 1084 1085 1086
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
1087
    '#maxlength' => 60,
1088 1089 1090 1091 1092 1093 1094 1095
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
1096
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
1097
  }
1098
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
1099
  $form['links'] = array('#markup' => theme('item_list', array('items' => $items)));
1100 1101 1102
  return $form;
}

Dries's avatar
Dries committed
1103
/**
1104
 * Implement hook_block_info().
Dries's avatar
Dries committed
1105
 */
1106
function user_block_info() {
Dries's avatar
 
Dries committed
1107 1108
  global $user;

1109 1110
  $blocks['login']['info'] = t('User login');
  // Not worth caching.
1111
  $blocks['login']['cache'] = DRUPAL_NO_CACHE;
1112

1113
  $blocks['new']['info'] = t('Who\'s new');
1114

1115 1116
  // Too dynamic to cache.
  $blocks['online']['info'] = t('Who\'s online');
1117
  $blocks['online']['cache'] = DRUPAL_NO_CACHE;
1118 1119
  return $blocks;
}
1120

1121
/**
1122
 * Implement hook_block_configure().
1123 1124 1125 1126
 */
function user_block_configure($delta = '') {
  global $user;

1127