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('account' => 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) {
Dries's avatar
 
Dries committed
113
  $result = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
114

115
  if ($user = db_fetch_array($result)) {
Dries's avatar
 
Dries committed
116
    return user_load($user);
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 219 220 221 222 223 224 225 226 227 228 229 230 231
    // If the conditions array is populated, add those to the query.
    if ($conditions) {
      // TODO D7: Using LIKE() to get a case insensitive comparison because Crell
      // and chx promise that dbtng will map it to ILIKE in postgres.
      if (isset($conditions['name'])) {
        $query->condition('u.name', $conditions['name'], 'LIKE');
        unset($conditions['name']);
      }
      if (isset($conditions['mail'])) {
        $query->condition('u.mail', $conditions['mail'], 'LIKE');
        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 270 271 272 273 274 275
      // 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;
          }
        }
      }

      // 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);
      }
276

277 278 279 280 281 282
      // TODO D7 : not sure the 3rd param ($types) is needed.
      field_attach_load('user', $queried_users);

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

  // 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
294
  }
Dries's avatar
 
Dries committed
295

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
  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
348 349
}

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

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

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

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

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

    // 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;

439 440
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
441
    // Save changes to the user table.
442
    $success = drupal_write_record('users', $edit, 'uid');
443
    if (!$success) {
Dries's avatar
 
Dries committed
444 445 446 447
      // 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
448
      // the user table are changed, drupal_write_record returns
Dries's avatar
 
Dries committed
449
      // FALSE because rowCount() (rows changed) is 0.  However,
450
      // non-users data may have been changed, e.g. fields.
Dries's avatar
 
Dries committed
451
      // return FALSE;
452
    }
Dries's avatar
 
Dries committed
453

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

461
    // Reload user roles if provided.
462
    if (isset($edit['roles']) && is_array($edit['roles'])) {
463
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $account->uid);
Dries's avatar
 
Dries committed
464

465
      foreach (array_keys($edit['roles']) as $rid) {
466
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
467
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
468
        }
469
      }
Dries's avatar
 
Dries committed
470 471
    }

472
    // Delete a blocked user's sessions to kick them if they are online.
473
    if (isset($edit['status']) && $edit['status'] == 0) {
474
      drupal_session_destroy_uid($account->uid);
475 476
    }

477 478
    // If the password changed, delete all open sessions and recreate
    // the current one.
479
    if (!empty($edit['pass'])) {
480
      drupal_session_destroy_uid($account->uid);
481 482 483
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
484 485
    }

Dries's avatar
 
Dries committed
486 487 488 489
    // Save Field data.
    $obj = (object) $edit;
    field_attach_update('user', $obj);

490
    // Refresh user object.
491
    $user = user_load($account->uid, TRUE);
492 493

    // Send emails after we have the new user object.
494
    if (isset($edit['status']) && $edit['status'] != $account->status) {
495
      // The user's status is changing; conditionally send notification email.
496
      $op = $edit['status'] == 1 ? 'status_activated' : 'status_blocked';
497 498 499
      _user_mail_notify($op, $user);
    }

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

513
    $success = drupal_write_record('users', $edit);
514 515 516 517 518
    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;
    }
519

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

Dries's avatar
 
Dries committed
523 524 525
    $obj = (object) $edit;
    field_attach_insert('user', $obj);

526
    user_module_invoke('insert', $edit, $user, $category);
527

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

544
    // Save user roles (delete just to be safe).
545
    if (isset($edit['roles']) && is_array($edit['roles'])) {
546
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $edit['uid']);
547
      foreach (array_keys($edit['roles']) as $rid) {
548
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
549
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $edit['uid'], $rid);
550
        }
551 552 553
      }
    }

554
    // Build the finished user object.
555
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
 
Dries committed
556 557 558 559 560
  }

  return $user;
}

Dries's avatar
Dries committed
561 562 563
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
564
function user_validate_name($name) {
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
  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.');
  }
580 581 582 583 584 585 586 587
  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
588
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
589 590 591
                   $name)) {
    return t('The username contains an illegal character.');
  }
592 593 594
  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
595 596 597
}

function user_validate_mail($mail) {
598 599 600
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
601
  if (!valid_email_address($mail)) {
602
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
603 604 605
  }
}

606
function user_validate_picture(&$form, &$form_state) {
607
  // If required, validate the uploaded picture.
608 609 610 611 612
  $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),
  );
613

614 615 616 617 618 619 620
  // 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
621 622 623
  }
}

Dries's avatar
Dries committed
624 625 626
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
627 628
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
629 630
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
631
  // of 'I', 1, and 'l'.
632
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
633

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

Dries's avatar
Dries committed
637 638
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
639

Dries's avatar
Dries committed
640
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
641 642 643 644
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
649 650
}

651 652 653 654 655 656 657 658 659 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
/**
 * 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.
689
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
690

691 692
      foreach ($result as $row) {
        $stored_permissions[$row->rid][$row->permission] = TRUE;
693 694 695 696 697 698 699 700 701 702 703
      }
      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
704 705 706 707 708
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
709 710
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
711 712 713 714
 * @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
715 716
 *
 * @return
717
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
718 719 720 721 722
 *
 * 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.
 */
723
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
 
Dries committed
724
  global $user;
Dries's avatar
 
Dries committed
725
  static $perm = array();
Dries's avatar
 
Dries committed
726

727
  if ($reset) {
728
    $perm = array();
729 730
  }

731 732 733 734
  if (is_null($account)) {
    $account = $user;
  }

735
  // User #1 has all privileges:
736
  if ($account->uid == 1) {
737
    return TRUE;
Dries's avatar
 
Dries committed
738 739
  }

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

745
    $perms = array();
746 747
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
 
Dries committed
748
    }
749
    $perm[$account->uid] = $perms;
Dries's avatar
 
Dries committed
750
  }
751

752
  return isset($perm[$account->uid][$string]);
Dries's avatar
 
Dries committed
753 754
}

755
/**
756
 * Checks for usernames blocked by user administration.
757
 *
758
 * @return boolean TRUE for blocked users, FALSE for active.
759 760
 */
function user_is_blocked($name) {
761
  $deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
762

763
  return $deny;
764 765
}

Dries's avatar
Dries committed
766 767 768
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
769
function user_perm() {
770
   return array(
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
     '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.'),
     ),
787 788 789 790 791 792 793 794
     '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.'))),
     ),
795
   );
Dries's avatar
 
Dries committed
796 797
}

Dries's avatar
Dries committed
798 799 800 801 802
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
803 804 805
function user_file_download($filepath) {
  if (strpos($filepath, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info(file_create_path($filepath));
806
    return array('Content-type: ' . $info['mime_type']);
Dries's avatar
 
Dries committed
807 808 809
  }
}

810 811 812 813 814
/**
 * Implementation of hook_file_references().
 */
function user_file_references($file) {
  // Determine if the file is used by this module.
815
  $count = db_query('SELECT COUNT(*) FROM {users} WHERE picture = :fid', array(':fid' => $file->fid))->fetchField();
816 817 818 819 820 821 822 823 824 825 826
  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.
827
  db_update('users')
828 829 830 831 832
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

Dries's avatar
Dries committed
833 834 835
/**
 * Implementation of hook_search().
 */
836
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
837 838
  switch ($op) {
    case 'name':
839
      if ($skip_access_check || user_access('access user profiles')) {
840
        return t('Users');
841
      }
842
    case 'search':
843 844 845 846
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
847 848
        if (user_access('administer users')) {
          // Administrators can also search in the otherwise private email field.
849
          $result = pager_query("SELECT name, uid, mail FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%') OR LOWER(mail) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys, $keys);
850
          while ($account = db_fetch_object($result)) {
851
            $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
852 853 854
          }
        }
        else {
855
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
856
          while ($account = db_fetch_object($result)) {
857
            $find[] = array('title' => $account->name, 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
858
          }
859 860
        }
        return $find;
861
      }
Dries's avatar
 
Dries committed
862 863 864
  }
}

Dries's avatar
Dries committed
865 866 867 868 869
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
870 871 872 873 874 875
    'user_profile_category' => array(
      '#theme_wrapper' => 'user_profile_category'
    ),
    'user_profile_item' => array(
      '#theme' => 'user_profile_item'
    ),
Dries's avatar
Dries committed
876 877 878
  );
}

Dries's avatar
Dries committed
879
/**
880
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
881
 */
882 883
function user_user_view(&$edit, &$account, $category = NULL) {
  $account->content['user_picture'] = array(
884
    '#markup' => theme('user_picture', $account),
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
    '#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') {
908
    $form_state = array();
909
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
910
  }
911
}
912

913
/**
914
 * Implementation of hook_user_validate().
915 916 917
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
918 919 920 921 922 923
    $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);
      }
924
      elseif (db_result(db_query("SELECT COUNT(*) FROM {users} WHERE uid != %d AND LOWER(name) = LOWER('%s')", $uid, $edit['name'])) > 0) {
925 926 927 928
        form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name'])));
      }
    }

929
    // Validate the e-mail address, and check if it is taken by an existing user.
930 931 932
    if ($error = user_validate_mail($edit['mail'])) {
      form_set_error('mail', $error);
    }
933
    elseif (db_result(db_query("SELECT COUNT(*) FROM {users} WHERE uid != %d AND LOWER(mail) = LOWER('%s')", $uid, $edit['mail'])) > 0) {
934 935 936 937 938 939 940
      // 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'))));
      }
941
    }
942
  }
943
}
944

945
/**
946
 * Implementation of hook_user_submit().
947 948 949
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
950 951 952
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
953
    // Delete picture if requested, and if no replacement picture was given.
954 955
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
956
    }
957 958 959 960
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

961 962 963
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
964
  }
965
}
966

967 968 969
/**
 * Implementation of hook_user_categories.
 */
970
function user_user_categories($edit, $account, $category = NULL) {
971
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
972 973
}

974 975
function user_login_block() {
  $form = array(
976
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
977
    '#id' => 'user-login-form',
978
    '#validate' => user_login_default_validators(),
979
    '#submit' => array('user_login_submit'),
980 981 982
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
983
    '#maxlength' => USERNAME_MAX_LENGTH,
984 985 986 987 988
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
989
    '#maxlength' => 60,
990 991 992 993 994 995 996 997
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
998
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
999
  }
1000
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));