user.module 93.4 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
function user_external_load($authname) {
Dries's avatar
 
Dries committed
87
  $result = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
88

89
  if ($user = db_fetch_array($result)) {
Dries's avatar
 
Dries committed
90
    return user_load($user);
Dries's avatar
 
Dries committed
91 92
  }
  else {
93
    return FALSE;
Dries's avatar
 
Dries committed
94 95 96
  }
}

97
/**
98 99 100
 * Perform standard Drupal login operations for a user object.
 *
 * The user object must already be authenticated. This function verifies
101
 * that the user account is not blocked and then performs the login,
102
 * updates the login timestamp in the database, invokes hook_user('login'),
103
 * and regenerates the session.
104 105 106 107 108 109
 *
 * @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.
110
 *    This array is passed to hook_user op login.
111 112 113 114
 * @return boolean
 *    TRUE if the login succeeds, FALSE otherwise.
 */
function user_external_login($account, $edit = array()) {
115 116
  $form = drupal_get_form('user_login');

117 118 119 120 121
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

122
  // Check if user is blocked.
123 124
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
125
    // Invalid login.
126 127
    return FALSE;
  }
128

129
  // Valid login.
130 131
  global $user;
  $user = $account;
132
  user_authenticate_finalize($state['values']);
133 134 135
  return TRUE;
}

Dries's avatar
Dries committed
136 137 138 139 140
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
141
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
142
 *
143 144 145
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
Dries's avatar
Dries committed
146
 */
Dries's avatar
 
Dries committed
147
function user_load($array = array()) {
Dries's avatar
Dries committed
148
  // Dynamically compose a SQL query:
149
  $query = array();
150
  $params = array();
151

152 153 154
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }
155 156 157
  elseif (!is_array($array)) {
    return FALSE;
  }
158

Dries's avatar
 
Dries committed
159
  foreach ($array as $key => $value) {
160 161
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
162
      $params[] = $value;
163
    }
164
    elseif ($key == 'pass') {
165
      $query[] = "pass = '%s'";
166
      $params[] = $value;
167
    }
Dries's avatar
 
Dries committed
168
    else {
169
      $query[]= "LOWER($key) = LOWER('%s')";
170
      $params[] = $value;
Dries's avatar
 
Dries committed
171 172
    }
  }
173
  $result = db_query('SELECT * FROM {users} u WHERE ' . implode(' AND ', $query), $params);
Dries's avatar
 
Dries committed
174

175
  if ($user = db_fetch_object($result)) {
176
    $user = drupal_unpack($user);
Dries's avatar
 
Dries committed
177

178
    $user->roles = array();
179 180 181 182 183 184
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
185 186 187 188
    $result = db_query('SELECT r.rid, r.name FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d', $user->uid);
    while ($role = db_fetch_object($result)) {
      $user->roles[$role->rid] = $role->name;
    }
189
    user_module_invoke('load', $array, $user);
190 191
  }
  else {
192
    $user = FALSE;
Dries's avatar
 
Dries committed
193
  }
Dries's avatar
 
Dries committed
194 195 196 197

  return $user;
}

198
/**
199
 * Save changes to a user account or add a new user.
200 201
 *
 * @param $account
202 203
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
204
 *
205
 * @param $edit
206
 *   An array of fields and values to save. For example array('name'
207
 *   => 'My name'). Keys that do not belong to columns in the user-related
208 209 210
 *   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.
211 212 213
 *
 * @param $category
 *   (optional) The category for storing profile information in.
214 215
 *
 * @return
216
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
217
 */
218
function user_save($account, $edit = array(), $category = 'account') {
219 220 221
  $table = drupal_get_schema('users');
  $user_fields = $table['fields'];

222
  if (!empty($edit['pass'])) {
223
    // Allow alternate password hashing schemes.
224
    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
225
    $edit['pass'] = user_hash_password(trim($edit['pass']));
226
    // Abort if the hashing failed and returned FALSE.
227
    if (!$edit['pass']) {
228 229
      return FALSE;
    }
230 231 232
  }
  else {
    // Avoid overwriting an existing password with a blank password.
233
    unset($edit['pass']);
234 235
  }

236
  if (is_object($account) && $account->uid) {
237
    user_module_invoke('update', $edit, $account, $category);
Dries's avatar
Dries committed
238
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
239 240
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
241
    if (empty($edit['access']) && empty($account->access) && user_access('administer users')) {
242
      $edit['access'] = REQUEST_TIME;
243
    }
244
    foreach ($edit as $key => $value) {
245 246 247
      // Fields that don't pertain to the users or user_roles
      // automatically serialized into the users.data column.
      if ($key != 'roles' && empty($user_fields[$key])) {
248 249
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
 
Dries committed
250
        }
251 252
        else {
          $data[$key] = $value;
Dries's avatar
 
Dries committed
253
        }
Dries's avatar
 
Dries committed
254 255 256
      }
    }

257 258
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
259
    // Save changes to the users table.
260 261 262 263 264
    $success = drupal_write_record('users', $edit, 'uid');
    if (!$success) {
      // The query failed - better to abort the save than risk further data loss.
      return FALSE;
    }
Dries's avatar
 
Dries committed
265

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

270
      foreach (array_keys($edit['roles']) as $rid) {
271 272 273
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
        }
274
      }
Dries's avatar
 
Dries committed
275 276
    }

277
    // Delete a blocked user's sessions to kick them if they are online.
278
    if (isset($edit['status']) && $edit['status'] == 0) {
279
      drupal_session_destroy_uid($account->uid);
280 281
    }

282 283
    // If the password changed, delete all open sessions and recreate
    // the current one.
284
    if (!empty($edit['pass'])) {
285
      drupal_session_destroy_uid($account->uid);
286 287 288
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
289 290
    }

291
    // Refresh user object.
Dries's avatar
 
Dries committed
292
    $user = user_load(array('uid' => $account->uid));
293 294

    // Send emails after we have the new user object.
295
    if (isset($edit['status']) && $edit['status'] != $account->status) {
296
      // The user's status is changing; conditionally send notification email.
297
      $op = $edit['status'] == 1 ? 'status_activated' : 'status_blocked';
298 299 300
      _user_mail_notify($op, $user);
    }

301
    user_module_invoke('after_update', $edit, $user, $category);
Dries's avatar
 
Dries committed
302 303
  }
  else {
304
    // Allow 'created' to be set by the caller.
305
    if (!isset($edit['created'])) {
306
      $edit['created'] = REQUEST_TIME;
307
    }
308 309
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
310
    if (empty($edit['access']) && user_access('administer users')) {
311
      $edit['access'] = REQUEST_TIME;
312
    }
313

314 315 316 317 318 319
    $success = drupal_write_record('users', $edit);
    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;
    }
320

321
    // Build the initial user object.
322
    $user = user_load(array('uid' => $edit['uid']));
Dries's avatar
 
Dries committed
323

324
    user_module_invoke('insert', $edit, $user, $category);
325

326 327
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
328
    $data = array();
329
    foreach ($edit as $key => $value) {
330
      if (($key != 'roles') && (empty($user_fields[$key])) && ($value !== NULL)) {
331 332 333
        $data[$key] = $value;
      }
    }
334 335 336 337
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
      drupal_write_record('users', $data_array, 'uid');
    }
338

339
    // Save user roles (delete just to be safe).
340 341 342
    if (isset($edit['roles']) && is_array($edit['roles'])) {
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $edit['uid']);
      foreach (array_keys($edit['roles']) as $rid) {
343
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
344
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $edit['uid'], $rid);
345
        }
346 347 348
      }
    }

349
    // Build the finished user object.
350
    $user = user_load(array('uid' => $edit['uid']));
Dries's avatar
 
Dries committed
351 352 353 354 355
  }

  return $user;
}

Dries's avatar
Dries committed
356 357 358
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
359
function user_validate_name($name) {
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  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.');
  }
375 376 377 378 379 380 381 382
  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
383
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
384 385 386
                   $name)) {
    return t('The username contains an illegal character.');
  }
387 388 389
  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
390 391 392
}

function user_validate_mail($mail) {
393 394 395
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
396
  if (!valid_email_address($mail)) {
397
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
398 399 400
  }
}

401
function user_validate_picture(&$form, &$form_state) {
402
  // If required, validate the uploaded picture.
403 404 405 406 407 408
  $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),
  );
  if ($file = file_save_upload('picture_upload', $validators)) {
409 410
    // Remove the old picture.
    if (isset($form_state['values']['_account']->picture) && file_exists($form_state['values']['_account']->picture)) {
411
      file_unmanaged_delete($form_state['values']['_account']->picture);
412 413
    }

414
    // The image was saved using file_save_upload() and was added to the
Dries's avatar
Dries committed
415
    // files table as a temporary file. We'll make a copy and let the garbage
416
    // collector delete the original upload.
417
    $info = image_get_info($file->filepath);
418
    $destination = file_create_path(variable_get('user_picture_path', 'pictures') . '/picture-' . $form['#uid'] . '.' . $info['extension']);
419
    if ($filepath = file_unmanaged_copy($file->filepath, $destination, FILE_EXISTS_REPLACE)) {
420
      $form_state['values']['picture'] = $filepath;
421
    }
422 423
    else {
      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'))));
424
    }
Dries's avatar
 
Dries committed
425 426 427
  }
}

Dries's avatar
Dries committed
428 429 430
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
431 432
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
433 434
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
435
  // of 'I', 1, and 'l'.
436
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
437

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

Dries's avatar
Dries committed
441 442
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
443

Dries's avatar
Dries committed
444
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
445 446 447 448
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
453 454
}

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
/**
 * 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.
493
      $result = db_query("SELECT r.rid, p.permission FROM {role} r INNER JOIN {role_permission} p ON p.rid = r.rid WHERE r.rid IN (:fetch)", array(':fetch' => $fetch));
494 495 496 497 498 499 500 501 502 503 504 505 506 507

      while ($row = db_fetch_array($result)) {
        $stored_permissions[$row['rid']][$row['permission']] = TRUE;
      }
      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
508 509 510 511 512
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
513 514
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
515 516 517 518
 * @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
519 520
 *
 * @return
521
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
522 523 524 525 526
 *
 * 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.
 */
527
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
 
Dries committed
528
  global $user;
Dries's avatar
 
Dries committed
529
  static $perm = array();
Dries's avatar
 
Dries committed
530

531
  if ($reset) {
532
    $perm = array();
533 534
  }

535 536 537 538
  if (is_null($account)) {
    $account = $user;
  }

539
  // User #1 has all privileges:
540
  if ($account->uid == 1) {
541
    return TRUE;
Dries's avatar
 
Dries committed
542 543
  }

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

549
    $perms = array();
550 551
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
 
Dries committed
552
    }
553
    $perm[$account->uid] = $perms;
Dries's avatar
 
Dries committed
554
  }
555

556
  return isset($perm[$account->uid][$string]);
Dries's avatar
 
Dries committed
557 558
}

559
/**
560
 * Checks for usernames blocked by user administration.
561
 *
562
 * @return boolean TRUE for blocked users, FALSE for active.
563 564
 */
function user_is_blocked($name) {
565
  $deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
566

567
  return $deny;
568 569
}

Dries's avatar
Dries committed
570 571 572
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
573
function user_perm() {
574
   return array(
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
     '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.'),
     ),
591 592 593 594 595 596 597 598
     '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.'))),
     ),
599
   );
Dries's avatar
 
Dries committed
600 601
}

Dries's avatar
Dries committed
602 603 604 605 606
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
607
function user_file_download($file) {
608
  if (strpos($file, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
609
    $info = image_get_info(file_create_path($file));
610
    return array('Content-type: ' . $info['mime_type']);
Dries's avatar
 
Dries committed
611 612 613
  }
}

Dries's avatar
Dries committed
614 615 616
/**
 * Implementation of hook_search().
 */
617
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
618 619
  switch ($op) {
    case 'name':
620
      if ($skip_access_check || user_access('access user profiles')) {
621
        return t('Users');
622
      }
623
    case 'search':
624 625 626 627
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
628 629 630 631
        if (user_access('administer users')) {
          // Administrators can also search in the otherwise private email field.
          $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);
          while ($account = db_fetch_object($result)) {
632
            $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
633 634 635
          }
        }
        else {
636
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
637
          while ($account = db_fetch_object($result)) {
638
            $find[] = array('title' => $account->name, 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
639
          }
640 641
        }
        return $find;
642
      }
Dries's avatar
 
Dries committed
643 644 645
  }
}

Dries's avatar
Dries committed
646 647 648 649 650 651 652 653 654 655
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
656
/**
657
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
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
function user_user_view(&$edit, &$account, $category = NULL) {
  $account->content['user_picture'] = array(
    '#value' => theme('user_picture', $account),
    '#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') {
685
    $form_state = array();
686
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
687
  }
688
}
689

690 691 692 693 694
/**
 * Implementation of hook_user_validate.
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
695
    return _user_edit_validate($account, $edit);
696
  }
697
}
698

699 700 701 702 703
/**
 * Implementation of hook_user_submit.
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
704
    return _user_edit_submit($account, $edit);
705
  }
706
}
707

708 709 710 711
/**
 * Implementation of hook_user_categories.
 */
function user_user_categories(&$edit, &$account, $category = NULL) {
712
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
713 714
}

715 716
function user_login_block() {
  $form = array(
717
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
718
    '#id' => 'user-login-form',
719
    '#validate' => user_login_default_validators(),
720
    '#submit' => array('user_login_submit'),
721 722 723
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
724
    '#maxlength' => USERNAME_MAX_LENGTH,
725 726 727 728 729
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
730
    '#maxlength' => 60,
731 732 733 734 735 736 737 738
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
739
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
740
  }
741
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
742
  $form['links'] = array('#markup' => theme('item_list', $items));
743 744 745
  return $form;
}

Dries's avatar
Dries committed
746
/**
747
 * Implementation of hook_block_list().
Dries's avatar
Dries committed
748
 */
749
function user_block_list() {
Dries's avatar
 
Dries committed
750 751
  global $user;

752 753 754
  $blocks['login']['info'] = t('User login');
  // Not worth caching.
  $blocks['login']['cache'] = BLOCK_NO_CACHE;
755

756 757 758 759
  $blocks['navigation']['info'] = t('Navigation');
  // Menu blocks can't be cached because each menu item can have
  // a custom access callback. menu.inc manages its own caching.
  $blocks['navigation']['cache'] = BLOCK_NO_CACHE;
760

761
  $blocks['new']['info'] = t('Who\'s new');
762

763 764 765 766 767
  // Too dynamic to cache.
  $blocks['online']['info'] = t('Who\'s online');
  $blocks['online']['cache'] = BLOCK_NO_CACHE;
  return $blocks;
}
768

769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
/**
 * Implementation of hook_block_configure().
 */
function user_block_configure($delta = '') {
  global $user;

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

    case 'online':
      $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
      $form['user_block_seconds_online'] = array('#type' => 'select', '#title' => t('User activity'), '#default_value' => variable_get('user_block_seconds_online', 900), '#options' => $period, '#description' => t('A user is considered online for this long after they have last viewed a page.'));
      $form['user_block_max_list_count'] = array('#type' => 'select', '#title' => t('User list length'), '#default_value' => variable_get('user_block_max_list_count', 10), '#options' => drupal_map_assoc(array(0, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100)), '#description' => t('Maximum number of currently online users to display.'));
      return $form;
790
  }
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
}

/**
 * Implementation of hook_block_save().
 */
function user_block_save($delta = '', $edit = array()) {
  global $user;

  switch ($delta) {
    case 'new':
      variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
      break;

    case 'online':
      variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
      variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
      break;
808
  }
809
}
Dries's avatar
 
Dries committed
810

811 812 813 814 815
/**
 * Implementation of hook_block_view().
 */
function user_block_view($delta = '') {
  global $user;
Dries's avatar
 
Dries committed
816

817
  $block = array();
Dries's avatar
Dries committed
818

819 820 821 822
  switch ($delta) {
    case 'login':
      // For usability's sake, avoid showing two login forms on one page.
      if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
Dries's avatar
Dries committed
823

824 825 826 827
        $block['subject'] = t('User login');
        $block['content'] = drupal_get_form('user_login_block');
      }
      return $block;
Dries's avatar
 
Dries committed
828

829 830 831 832 833 834
    case 'navigation':
      if ($menu = menu_tree()) {
        $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
        $block['content'] = $menu;
      }
      return $block;
Dries's avatar
Dries committed
835

836 837 838 839 840
    case 'new':
      if (user_access('access content')) {
        // Retrieve a list of new users who have subsequently accessed the site successfully.
        $items = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', array(), 0, variable_get('user_block_whois_new_count', 5))->fetchAll();
        $output = theme('user_list', $items);
841

842 843 844 845
        $block['subject'] = t('Who\'s new');
        $block['content'] = $output;
      }
      return $block;
Dries's avatar
 
Dries committed
846

847 848 849 850
    case 'online':
      if (user_access('access content')) {
        // Count users active within the defined period.
        $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
Dries's avatar
 
Dries committed
851

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

857 858 859
        // Format the output with proper grammar.
        if ($anonymous_count == 1 && $authenticated_count == 1) {
          $output = t('There is currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests')));
Dries's avatar
 
Dries committed
860
        }
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
        else {
          $output = t('There are currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests')));
        }

        // Display a list of currently online users.
        $max_users = variable_get('user_block_max_list_count', 10);
        if ($authenticated_count && $max_users) {
          $items = db_query_range('SELECT u.uid, u.name, MAX(s.timestamp) AS max_timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.timestamp >= :interval AND s.uid > 0 GROUP BY u.uid, u.name ORDER BY max_timestamp DESC', array(':interval' => $interval), 0, $max_users)->fetchAll();
          $output .= theme('user_list', $items, t('Online users'));
        }

        $block['subject'] = t('Who\'s online');
        $block['content'] = $output;
      }
      return $block;
Dries's avatar
 
Dries committed
876
  }
877 878
}

879 880 881 882 883 884 885 886 887 888
/**
 * Process variables for user-picture.tpl.php.
 *
 * The $variables array contains the following arguments:
 * - $account
 *
 * @see user-picture.tpl.php
 */
function template_preprocess_user_picture(&$variables) {
  $variables['picture'] = '';
Dries's avatar
 
Dries committed
889
  if (variable_get('user_pictures', 0)) {
890
    $account = $variables['account'];
891
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
 
Dries committed
892 893
      $picture = file_create_url($account->picture);
    }
894
    elseif (variable_get('user_picture_default', '')) {
Dries's avatar
 
Dries committed
895 896 897
      $picture = variable_get('user_picture_default', '');
    }

898
    if (isset($picture)) {
899
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
900
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
901
      if (!empty($account->uid) && user_access('access user profiles')) {
902 903
        $attributes = array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE);
        $variables['picture'] = l($variables['picture'], "user/$account->uid", $attributes);
Dries's avatar
 
Dries committed
904 905 906 907 908
      }
    }
  }
}

909 910
/**
 * Make a list of users.
911 912 913 914 915
 *
 * @param $users
 *   An array with user objects. Should contain at least the name and uid.
 * @param $title
 *  (optional) Title to pass on to theme_item_list().