user.module 102 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, &$array, &$user, $category = NULL) {
27
  foreach (module_implements('user_' . $type) as $module) {
28
    $function = $module . '_user_' . $type;
29
    $function($array, $user, $category);
Dries's avatar
 
Dries committed
30 31 32
  }
}

33
/**
34
 * Implementation of 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 60 61
    ),
    'user_list' => array(
      'arguments' => array('users' => NULL, 'title' => NULL),
    ),
    'user_admin_perm' => array(
      '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_admin_account' => array(
      'arguments' => array('form' => NULL),
70
      'file' => 'user.admin.inc',
71 72 73
    ),
    'user_filter_form' => array(
      'arguments' => array('form' => NULL),
74
      'file' => 'user.admin.inc',
75 76 77
    ),
    'user_filters' => array(
      'arguments' => array('form' => NULL),
78
      'file' => 'user.admin.inc',
79
    ),
80 81 82
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
83 84 85
  );
}

Dries's avatar
 
Dries committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
/**
 * Implementation of hook_fieldable_info().
 */
function user_fieldable_info() {
  $return = array(
    'user' => array(
      'name' => t('User'),
      'id key' => 'uid',
    ),
  );
  return $return;
}

/**
 * Implementation of hook_field_build_modes().
 */
function user_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'user') {
    $modes = array(
      'full' => t('User account'),
    );
  }
  return $modes;
}

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

115 116
  if ($uid) {
    return user_load($uid);
Dries's avatar
 
Dries committed
117 118
  }
  else {
119
    return FALSE;
Dries's avatar
 
Dries committed
120 121 122
  }
}

123
/**
124 125 126
 * Perform standard Drupal login operations for a user object.
 *
 * The user object must already be authenticated. This function verifies
127
 * that the user account is not blocked and then performs the login,
128
 * updates the login timestamp in the database, invokes hook_user('login'),
129
 * and regenerates the session.
130 131 132 133 134 135
 *
 * @param $account
 *    An authenticated user object to be set as the currently logged
 *    in user.
 * @param $edit
 *    The array of form values submitted by the user, if any.
136
 *    This array is passed to hook_user op login.
137 138 139 140
 * @return boolean
 *    TRUE if the login succeeds, FALSE otherwise.
 */
function user_external_login($account, $edit = array()) {
141 142
  $form = drupal_get_form('user_login');

143 144 145 146 147
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

148
  // Check if user is blocked.
149 150
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
151
    // Invalid login.
152 153
    return FALSE;
  }
154

155
  // Valid login.
156 157
  global $user;
  $user = $account;
158
  user_authenticate_finalize($state['values']);
159 160 161
  return TRUE;
}

Dries's avatar
Dries committed
162
/**
163
 * Load multiple users based on certain conditions.
Dries's avatar
Dries committed
164
 *
165 166 167
 * 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
168
 *
169 170 171 172 173 174 175 176
 * @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.
177
 * @return
178 179 180 181 182
 *   An array of user objects, indexed by uid.
 *
 * @see user_load()
 * @see user_load_by_mail()
 * @see user_load_by_name()
Dries's avatar
Dries committed
183
 */
184 185 186 187
function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
  static $user_cache = array();
  if ($reset) {
    $user_cache = array();
188
  }
189

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
  $users = array();

  // Create a new variable which is either a prepared version of the $uids
  // array for later comparison with the user cache, or FALSE if no $uids were
  // passed. The $uids array is reduced as items are loaded from cache, and we
  // need to know if it's empty for this reason to avoid querying the database
  // when all requested users are loaded from cache.
  $passed_uids = !empty($uids) ? array_flip($uids) : FALSE;

  // Load any available users from the internal cache.
  if ($user_cache) {
    if ($uids && !$conditions) {
      $users += array_intersect_key($user_cache, $passed_uids);
      // If any users were loaded, remove them from the $uids still to load.
      $uids = array_keys(array_diff_key($passed_uids, $users));
Dries's avatar
 
Dries committed
205 206 207
    }
  }

208 209 210 211
  // Load any remaining users from the database, this is necessary if we have
  // $uids still to load, or if $conditions was passed without $uids.
  if ($uids || ($conditions && !$passed_uids)) {
    $query = db_select('users', 'u')->fields('u');
Dries's avatar
 
Dries committed
212

213 214 215
    // If the $uids array is populated, add those to the query.
    if ($uids) {
      $query->condition('u.uid', $uids, 'IN');
216
    }
217 218
    // If the conditions array is populated, add those to the query.
    if ($conditions) {
219 220
      // TODO D7: Using LIKE() to get a case insensitive comparison because Crell
      // and chx promise that dbtng will map it to ILIKE in postgres.
221
      if (isset($conditions['name'])) {
222
        $query->condition('u.name', $conditions['name'], 'LIKE');
223 224 225
        unset($conditions['name']);
      }
      if (isset($conditions['mail'])) {
226
        $query->condition('u.mail', $conditions['mail'], 'LIKE');
227 228 229 230 231
        unset($conditions['mail']);
      }
      foreach ($conditions as $field => $value) {
        $query->condition('u.' . $field, $value);
      }
232
    }
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    $result = $query->execute();

    $queried_users = array();
    // Build an array of user picture IDs so that these can be fetched later.
    $picture_fids = array();
    foreach ($result as $record) {
      $picture_fids[] = $record->picture;
      $queried_users[$record->uid] = drupal_unpack($record);
      $queried_users[$record->uid]->roles = array();
      if ($record->uid) {
        $queried_users[$record->uid]->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
      }
      else {
        $queried_users[$record->uid]->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
      }
248
    }
249

250 251 252 253 254 255
    if (!empty($queried_users)) {
      // 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
256

257 258 259 260 261 262 263 264 265 266 267 268 269
      // 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;
          }
        }
      }

270 271
      field_attach_load('user', $queried_users);

272 273 274 275 276 277
      // Invoke hook_user_load() on the users loaded from the database
      // and add them to the static cache.
      foreach (module_implements('user_load') as $module) {
        $function = $module . '_user_load';
        $function($queried_users);
      }
278

279

280 281 282 283

      $users = $users + $queried_users;
      $user_cache = $user_cache + $queried_users;
    }
284
  }
285 286 287 288 289 290 291 292 293 294

  // Ensure that the returned array is ordered the same as the original $uids
  // array if this was passed in and remove any invalid uids.
  if ($passed_uids) {
    // Remove any invalid uids from the array.
    $passed_uids = array_intersect_key($passed_uids, $users);
    foreach ($users as $user) {
      $passed_uids[$user->uid] = $user;
    }
    $users = $passed_uids;
Dries's avatar
 
Dries committed
295
  }
Dries's avatar
 
Dries committed
296

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
  return $users;
}


/**
 * 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
349 350
}

351
/**
352
 * Save changes to a user account or add a new user.
353 354
 *
 * @param $account
355 356
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
357
 *
358
 * @param $edit
359
 *   An array of fields and values to save. For example array('name'
360
 *   => 'My name'). Keys that do not belong to columns in the user-related
361 362 363
 *   tables are added to the a serialized array in the 'data' column
 *   and will be loaded in the $user->data array by user_load().
 *   Setting a field to NULL deletes it from the data column.
364 365 366
 *
 * @param $category
 *   (optional) The category for storing profile information in.
367 368
 *
 * @return
369
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
370
 */
371
function user_save($account, $edit = array(), $category = 'account') {
372
  $table = drupal_get_schema('users');
373 374
  $user_fields = $table['fields'];

375
  if (!empty($edit['pass'])) {
376
    // Allow alternate password hashing schemes.
377
    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
378
    $edit['pass'] = user_hash_password(trim($edit['pass']));
379
    // Abort if the hashing failed and returned FALSE.
380
    if (!$edit['pass']) {
381 382
      return FALSE;
    }
383 384 385
  }
  else {
    // Avoid overwriting an existing password with a blank password.
386
    unset($edit['pass']);
387 388
  }

Dries's avatar
 
Dries committed
389 390 391 392 393 394 395 396 397 398 399 400
  // 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;

401
  if (is_object($account) && $account->uid) {
402
    user_module_invoke('update', $edit, $account, $category);
403
    $data = unserialize(db_query('SELECT data FROM {users} WHERE uid = :uid', array(':uid' => $account->uid))->fetchField());
404 405
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
406
    if (empty($edit['access']) && empty($account->access) && user_access('administer users')) {
407
      $edit['access'] = REQUEST_TIME;
408
    }
409
    foreach ($edit as $key => $value) {
Dries's avatar
 
Dries committed
410
      // Form fields that don't pertain to the users, user_roles, or
411
      // Field API are automatically serialized into the users.data
Dries's avatar
 
Dries committed
412 413
      // column.
      if ($key != 'roles' && empty($user_fields[$key]) && empty($field_form[$key])) {
414 415
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
 
Dries committed
416
        }
417 418
        else {
          $data[$key] = $value;
Dries's avatar
 
Dries committed
419
        }
Dries's avatar
 
Dries committed
420 421 422
      }
    }

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439

    // 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) {
        $info = image_get_info($picture->filepath);
        $destination = file_create_path(variable_get('user_picture_path', 'pictures') . '/picture-' . $account->uid . '.' . $info['extension']);
        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;

440 441
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
442
    // Save changes to the user table.
443
    $success = drupal_write_record('users', $edit, 'uid');
444
    if (!$success) {
Dries's avatar
 
Dries committed
445 446 447 448
      // The query failed - better to abort the save than risk further
      // data loss.

      // TODO: Fields change: I think this is a bug.  If no columns in
449
      // the user table are changed, drupal_write_record returns
Dries's avatar
 
Dries committed
450
      // FALSE because rowCount() (rows changed) is 0.  However,
451
      // non-users data may have been changed, e.g. fields.
Dries's avatar
 
Dries committed
452
      // return FALSE;
453
    }
Dries's avatar
 
Dries committed
454

455
    // If the picture changed or was unset, remove the old one. This step needs
456
    // to occur after updating the {users} record so that user_file_references()
457 458 459 460 461
    // doesn't report it in use and block the deletion.
    if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) {
      file_delete($account->picture);
    }

462
    // Reload user roles if provided.
463
    if (isset($edit['roles']) && is_array($edit['roles'])) {
464
      db_delete('users_roles')->condition('uid', $account->uid)->execute();
Dries's avatar
 
Dries committed
465

466
      foreach (array_keys($edit['roles']) as $rid) {
467
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
468 469 470 471 472 473
          db_insert('users_roles')
            ->fields(array(
              'uid' => $account->uid,
              'rid' => $rid,
            ))
            ->execute();
474
        }
475
      }
Dries's avatar
 
Dries committed
476 477
    }

478
    // Delete a blocked user's sessions to kick them if they are online.
479
    if (isset($edit['status']) && $edit['status'] == 0) {
480
      drupal_session_destroy_uid($account->uid);
481 482
    }

483 484
    // If the password changed, delete all open sessions and recreate
    // the current one.
485
    if (!empty($edit['pass'])) {
486
      drupal_session_destroy_uid($account->uid);
487 488 489
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
490 491
    }

Dries's avatar
 
Dries committed
492
    // Save Field data.
493 494
    $object = (object) $edit;
    field_attach_update('user', $object);
Dries's avatar
 
Dries committed
495

496
    // Refresh user object.
497
    $user = user_load($account->uid, TRUE);
498 499

    // Send emails after we have the new user object.
500
    if (isset($edit['status']) && $edit['status'] != $account->status) {
501
      // The user's status is changing; conditionally send notification email.
502
      $op = $edit['status'] == 1 ? 'status_activated' : 'status_blocked';
503 504 505
      _user_mail_notify($op, $user);
    }

506
    user_module_invoke('after_update', $edit, $user, $category);
Dries's avatar
 
Dries committed
507 508
  }
  else {
509
    // Allow 'created' to be set by the caller.
510
    if (!isset($edit['created'])) {
511
      $edit['created'] = REQUEST_TIME;
512
    }
513 514
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
515
    if (empty($edit['access']) && user_access('administer users')) {
516
      $edit['access'] = REQUEST_TIME;
517
    }
518

519
    $success = drupal_write_record('users', $edit);
520 521 522 523 524
    if (!$success) {
      // On a failed INSERT some other existing user's uid may be returned.
      // We must abort to avoid overwriting their account.
      return FALSE;
    }
525

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

529 530
    $object = (object) $edit;
    field_attach_insert('user', $object);
Dries's avatar
 
Dries committed
531

532
    user_module_invoke('insert', $edit, $user, $category);
533

534 535
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
536
    $data = array();
537
    foreach ($edit as $key => $value) {
538
      // Form fields that don't pertain to the users, user_roles, or
539
      // Field API are automatically serialized into the user.data
Dries's avatar
 
Dries committed
540 541
      // column.
      if (($key != 'roles') && (empty($user_fields[$key]) && empty($field_form[$key])) && ($value !== NULL)) {
542 543 544
        $data[$key] = $value;
      }
    }
545 546
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
547
      drupal_write_record('users', $data_array, 'uid');
548
    }
549

550
    // Save user roles (delete just to be safe).
551
    if (isset($edit['roles']) && is_array($edit['roles'])) {
552
      db_delete('users_roles')->condition('uid', $edit['uid'])->execute();
553
      foreach (array_keys($edit['roles']) as $rid) {
554
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
555 556 557 558 559 560
          db_insert('users_roles')
            ->fields(array(
              'uid' => $edit['uid'],
              'rid' => $rid,
            ))
            ->execute();
561
        }
562 563 564
      }
    }

565
    // Build the finished user object.
566
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
 
Dries committed
567 568 569 570 571
  }

  return $user;
}

Dries's avatar
Dries committed
572 573 574
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
575
function user_validate_name($name) {
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
  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.');
  }
591 592 593 594 595 596 597 598
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
                   '\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
599
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
600 601 602
                   $name)) {
    return t('The username contains an illegal character.');
  }
603 604 605
  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
606 607 608
}

function user_validate_mail($mail) {
609 610 611
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
612
  if (!valid_email_address($mail)) {
613
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
614 615 616
  }
}

617
function user_validate_picture(&$form, &$form_state) {
618
  // If required, validate the uploaded picture.
619 620 621 622 623
  $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),
  );
624

625 626 627 628 629 630 631
  // 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
632 633 634
  }
}

Dries's avatar
Dries committed
635 636 637
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
638 639
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
640 641
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
642
  // of 'I', 1, and 'l'.
643
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
644

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

Dries's avatar
Dries committed
648 649
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
650

Dries's avatar
Dries committed
651
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
652 653 654 655
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
660 661
}

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
/**
 * Determine the permissions for one or more roles.
 *
 * @param $roles
 *   An array whose keys are the role IDs of interest, such as $user->roles.
 * @param $reset
 *   Optional parameter - if TRUE data in the static variable is rebuilt.
 *
 * @return
 *   An array indexed by role ID. Each value is an array whose keys are the
 *   permission strings for the given role ID.
 */
function user_role_permissions($roles = array(), $reset = FALSE) {
  static $stored_permissions = array();

  if ($reset) {
    // Clear the data cached in the static variable.
    $stored_permissions = array();
  }

  $role_permissions = $fetch = array();

  if ($roles) {
    foreach ($roles as $rid => $name) {
      if (isset($stored_permissions[$rid])) {
        $role_permissions[$rid] = $stored_permissions[$rid];
      }
      else {
        // Add this rid to the list of those needing to be fetched.
        $fetch[] = $rid;
        // Prepare in case no permissions are returned.
        $stored_permissions[$rid] = array();
      }
    }

    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.
700
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
701

702 703
      foreach ($result as $row) {
        $stored_permissions[$row->rid][$row->permission] = TRUE;
704 705 706 707 708 709 710 711 712 713 714
      }
      foreach ($fetch as $rid) {
        // For every rid, we know we at least assigned an empty array.
        $role_permissions[$rid] = $stored_permissions[$rid];
      }
    }
  }

  return $role_permissions;
}

Dries's avatar
Dries committed
715 716 717 718 719
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
720 721
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
722 723 724 725
 * @param $reset
 *   (optional) Resets the user's permissions cache, which will result in a
 *   recalculation of the user's permissions. This is necessary to support
 *   dynamically added user roles.
Dries's avatar
Dries committed
726 727
 *
 * @return
728
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
729 730 731 732 733
 *
 * 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.
 */
734
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
 
Dries committed
735
  global $user;
Dries's avatar
 
Dries committed
736
  static $perm = array();
Dries's avatar
 
Dries committed
737

738
  if ($reset) {
739
    $perm = array();
740 741
  }

742 743 744 745
  if (is_null($account)) {
    $account = $user;
  }

746
  // User #1 has all privileges:
747
  if ($account->uid == 1) {
748
    return TRUE;
Dries's avatar
 
Dries committed
749 750
  }

Dries's avatar
Dries committed
751 752
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
753
  if (!isset($perm[$account->uid])) {
754
    $role_permissions = user_role_permissions($account->roles, $reset);
Dries's avatar
 
Dries committed
755

756
    $perms = array();
757 758
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
 
Dries committed
759
    }
760
    $perm[$account->uid] = $perms;
Dries's avatar
 
Dries committed
761
  }
762

763
  return isset($perm[$account->uid][$string]);
Dries's avatar
 
Dries committed
764 765
}

766
/**
767
 * Checks for usernames blocked by user administration.
768
 *
769
 * @return boolean TRUE for blocked users, FALSE for active.
770 771
 */
function user_is_blocked($name) {
772
  $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject();
773

774
  return $deny;
775 776
}

Dries's avatar
Dries committed
777 778 779
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
780
function user_perm() {
781
   return array(
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
     '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.'),
     ),
798 799 800 801 802 803 804 805
     'cancel account' => array(
       'title' => t('Cancel account'),
       '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/user/settings'))),
     ),
     '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.'))),
     ),
806
   );
Dries's avatar
 
Dries committed
807 808
}

Dries's avatar
Dries committed
809 810 811 812 813
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
814 815 816
function user_file_download($filepath) {
  if (strpos($filepath, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info(file_create_path($filepath));
817
    return array('Content-Type' => $info['mime_type']);
Dries's avatar
 
Dries committed
818 819 820
  }
}

821 822 823 824 825
/**
 * Implementation of hook_file_references().
 */
function user_file_references($file) {
  // Determine if the file is used by this module.
826
  $count = db_query('SELECT COUNT(*) FROM {users} WHERE picture = :fid', array(':fid' => $file->fid))->fetchField();
827 828 829 830 831 832 833 834 835 836 837
  if ($count) {
    // Return the name of the module and how many references it has to the file.
    return array('user' => $count);
  }
}

/**
 * Implementation of hook_file_delete().
 */
function user_file_delete($file) {
  // Remove any references to the file.
838
  db_update('users')
839 840 841 842 843
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

Dries's avatar
Dries committed
844 845 846
/**
 * Implementation of hook_search().
 */
847
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
848 849
  switch ($op) {
    case 'name':
850
      if ($skip_access_check || user_access('access user profiles')) {
851
        return t('Users');
852
      }
853
    case 'search':
854 855 856 857
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
858 859
        $query = db_select('users');
        $query->fields('users', array('name', 'uid', 'mail'));
860 861
        if (user_access('administer users')) {
          // Administrators can also search in the otherwise private email field.
862 863 864
          $query->condition(db_or()->
                            where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"))->
                            where('LOWER(mail) LIKE LOWER(:mail)', array(':mail' => "%$keys%")));
865 866
        }
        else {
867 868 869 870 871 872 873
          $query->where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"));
        }
        $query = $query->extend('PagerDefault')
                       ->limit(2);
        $result = $query->execute();
        foreach ($result as $account) {
          $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
874 875
        }
        return $find;
876
      }
Dries's avatar
 
Dries committed
877 878 879
  }
}

Dries's avatar
Dries committed
880 881 882 883 884
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
885 886 887 888 889 890
    'user_profile_category' => array(
      '#theme_wrapper' => 'user_profile_category'
    ),
    'user_profile_item' => array(
      '#theme' => 'user_profile_item'
    ),
Dries's avatar
Dries committed
891 892 893
  );
}

Dries's avatar
Dries committed
894
/**
895
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
896
 */
897 898
function user_user_view(&$edit, &$account, $category = NULL) {
  $account->content['user_picture'] = array(
899
    '#markup' => theme('user_picture', $account),
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
    '#weight' => -10,
  );
  if (!isset($account->content['summary'])) {
    $account->content['summary'] = array();
  }
  $account->content['summary'] += array(
    '#type' => 'user_profile_category',
    '#attributes' => array('class' => 'user-member'),
    '#weight' => 5,
    '#title' => t('History'),
  );
  $account->content['summary']['member_for'] =  array(
    '#type' => 'user_profile_item',
    '#title' => t('Member for'),
    '#markup' => format_interval(REQUEST_TIME - $account->created),
  );
}

/**
 * Implementation of hook_user_form.
 */
function user_user_form(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
923
    $form_state = array();
924
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
925
  }
926
}
927

928
/**
929
 * Implementation of hook_user_validate().
930 931 932
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
933 934 935 936 937 938
    $uid = isset($account->uid) ? $account->uid : FALSE;
    // Validate the username when: new user account; or user is editing own account and can change username; or an admin user.
    if (!$uid || ($GLOBALS['user']->uid == $uid && user_access('change own username')) || user_access('administer users')) {
      if ($error = user_validate_name($edit['name'])) {
        form_set_error('name', $error);
      }
939
      elseif (db_query("SELECT COUNT(*) FROM {users} WHERE uid != :uid AND LOWER(name) = LOWER(:name)", array(':uid' => $uid, ':name' => $edit['name']))->fetchField() > 0) {
940 941 942 943
        form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name'])));
      }
    }

944
    // Validate the e-mail address, and check if it is taken by an existing user.
945 946 947
    if ($error = user_validate_mail($edit['mail'])) {
      form_set_error('mail', $error);
    }
948
    elseif (db_query("SELECT COUNT(*) FROM {users} WHERE uid != :uid AND LOWER(mail) = LOWER(:mail)", array(':uid' => $uid, ':mail' => $edit['mail']))->fetchField() > 0) {
949 950 951 952 953 954 955
      // Format error message dependent on whether the user is logged in or not.
      if ($GLOBALS['user']->uid) {
        form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $edit['mail'])));
      }
      else {
        form_set_error('mail', t('The e-mail address %email is already registered. <a href="@password">Have you forgotten your password?</a>', array('%email' => $edit['mail'], '@password' => url('user/password'))));
      }
956
    }
957
  }
958
}
959

960
/**
961
 * Implementation of hook_user_submit().
962 963 964
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
965 966 967
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
968
    // Delete picture if requested, and if no replacement picture was given.
969 970
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
971
    }
972 973 974 975
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

976 977 978
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
979
  }
980
}
981

982 983 984
/**
 * Implementation of hook_user_categories.
 */
985
function user_user_categories($edit, $account, $category = NULL) {
986
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
987 988
}

989 990
function user_login_block() {
  $form = array(
991
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
992
    '#id' => 'user-login-form',
993
    '#validate' => user_login_default_validators(),
994
    '#submit' => array('user_login_submit'),
995 996 997
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
998
    '#maxlength' => USERNAME_MAX_LENGTH,