user.module 86.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);

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

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

Dries's avatar
 
Dries committed
87
function user_external_load($authname) {
Dries's avatar
 
Dries committed
88
  $result = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
Dries's avatar
 
Dries committed
89

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

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

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

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

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

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

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

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

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

179
    $user->roles = array();
180 181 182 183 184 185
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
186 187 188 189
    $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;
    }
190
    user_module_invoke('load', $array, $user);
191 192
  }
  else {
193
    $user = FALSE;
Dries's avatar
 
Dries committed
194
  }
Dries's avatar
 
Dries committed
195 196 197 198

  return $user;
}

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

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

237
  if (is_object($account) && $account->uid) {
238
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
Dries committed
239
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
240 241 242 243 244
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
    if (empty($array['access']) && empty($account->access) && user_access('administer users')) {
      $array['access'] = time();
    }
Dries's avatar
 
Dries committed
245
    foreach ($array as $key => $value) {
246 247 248
      // 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])) {
249 250
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
 
Dries committed
251
        }
252 253
        else {
          $data[$key] = $value;
Dries's avatar
 
Dries committed
254
        }
Dries's avatar
 
Dries committed
255 256 257
      }
    }

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

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

271
      foreach (array_keys($array['roles']) as $rid) {
272 273 274
        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);
        }
275
      }
Dries's avatar
 
Dries committed
276 277
    }

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

283 284
    // If the password changed, delete all open sessions and recreate
    // the current one.
285
    if (!empty($array['pass'])) {
286 287 288 289
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

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

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

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

313
    $success = drupal_write_record('users', $array);
314
    if (!$success) {
315 316
      // On a failed INSERT some other existing user's uid may be returned.
      // We must abort to avoid overwriting their account.
317 318
      return FALSE;
    }
319

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

323 324
    user_module_invoke('insert', $array, $user, $category);

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

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

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

  return $user;
}

Dries's avatar
Dries committed
355 356 357
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
358
function user_validate_name($name) {
359
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
360 361
  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.');
362
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
363
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
364 365 366 367 368 369 370 371
  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
372
                   '\x{0}]/u',               // NULL byte
373 374 375
                   $name)) {
    return t('The username contains an illegal character.');
  }
376
  if (strpos($name, '@') !== FALSE && !eregi('@([0-9a-z](-?[0-9a-z])*.)+[a-z]{2}([zmuvtg]|fo|me)?$', $name)) return t('The username is not a valid authentication ID.');
377
  if (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
378 379 380
}

function user_validate_mail($mail) {
381 382 383
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
384
  if (!valid_email_address($mail)) {
385
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
386 387 388
  }
}

389
function user_validate_picture(&$form, &$form_state) {
390
  // If required, validate the uploaded picture.
391 392 393 394 395 396
  $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)) {
397 398 399 400 401
    // Remove the old picture.
    if (isset($form_state['values']['_account']->picture) && file_exists($form_state['values']['_account']->picture)) {
      file_delete($form_state['values']['_account']->picture);
    }

402
    // The image was saved using file_save_upload() and was added to the
Dries's avatar
Dries committed
403
    // files table as a temporary file. We'll make a copy and let the garbage
404
    // collector delete the original upload.
405
    $info = image_get_info($file->filepath);
406
    $destination = variable_get('user_picture_path', 'pictures') . '/picture-' . $form['#uid'] . '.' . $info['extension'];
407
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
408
      $form_state['values']['picture'] = $file->filepath;
409
    }
410 411
    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'))));
412
    }
Dries's avatar
 
Dries committed
413 414 415
  }
}

Dries's avatar
Dries committed
416 417 418
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
419 420
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
421 422
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
423
  // of 'I', 1, and 'l'.
424
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
425

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

Dries's avatar
Dries committed
429 430
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
431

Dries's avatar
Dries committed
432
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
433 434 435 436
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
441 442
}

443 444 445 446 447 448 449 450 451 452 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 493 494 495
/**
 * 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.
      $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 (" . db_placeholders($fetch) . ")", $fetch);

      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
496 497 498 499 500
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
501 502
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
503 504 505 506
 * @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
507 508
 *
 * @return
509
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
510 511 512 513 514
 *
 * 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.
 */
515
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
 
Dries committed
516
  global $user;
Dries's avatar
 
Dries committed
517
  static $perm = array();
Dries's avatar
 
Dries committed
518

519 520 521 522
  if ($reset) {
    unset($perm);
  }

523 524 525 526
  if (is_null($account)) {
    $account = $user;
  }

527
  // User #1 has all privileges:
528
  if ($account->uid == 1) {
529
    return TRUE;
Dries's avatar
 
Dries committed
530 531
  }

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

537
    $perms = array();
538 539
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
 
Dries committed
540
    }
541
    $perm[$account->uid] = $perms;
Dries's avatar
 
Dries committed
542
  }
543

544
  return isset($perm[$account->uid][$string]);
Dries's avatar
 
Dries committed
545 546
}

547
/**
548
 * Checks for usernames blocked by user administration.
549
 *
550
 * @return boolean TRUE for blocked users, FALSE for active.
551 552
 */
function user_is_blocked($name) {
553
  $deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
554

555
  return $deny;
556 557
}

Dries's avatar
Dries committed
558 559 560
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
561
function user_perm() {
562 563 564 565 566 567
   return array(
     'administer permissions' => 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' => t('Manage or block users, and manage their role assignments.'),
     'access user profiles' => t('View profiles of users on the site, which may contain personal information.'),
     'change own username' => t('Select a different username.'),
   );
Dries's avatar
 
Dries committed
568 569
}

Dries's avatar
Dries committed
570 571 572 573 574
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
575
function user_file_download($file) {
576
  if (strpos($file, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
577
    $info = image_get_info(file_create_path($file));
578
    return array('Content-type: ' . $info['mime_type']);
Dries's avatar
 
Dries committed
579 580 581
  }
}

Dries's avatar
Dries committed
582 583 584
/**
 * Implementation of hook_search().
 */
585
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
586 587
  switch ($op) {
    case 'name':
588
      if ($skip_access_check || user_access('access user profiles')) {
589
        return t('Users');
590
      }
591
    case 'search':
592 593 594 595
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
596 597 598 599
        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)) {
600
            $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
601 602 603
          }
        }
        else {
604
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
605
          while ($account = db_fetch_object($result)) {
606
            $find[] = array('title' => $account->name, 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
607
          }
608 609
        }
        return $find;
610
      }
Dries's avatar
 
Dries committed
611 612 613
  }
}

Dries's avatar
Dries committed
614 615 616 617 618 619 620 621 622 623
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
624 625 626
/**
 * Implementation of hook_user().
 */
627
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
628
  if ($type == 'view') {
629 630 631 632 633 634 635 636 637 638
    $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'),
639
      '#weight' => 5,
640 641 642 643 644 645
      '#title' => t('History'),
    );
    $account->content['summary']['member_for'] =  array(
      '#type' => 'user_profile_item',
      '#title' => t('Member for'),
      '#value' => format_interval(time() - $account->created),
646
    );
Dries's avatar
Dries committed
647
  }
648
  if ($type == 'form' && $category == 'account') {
649 650
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
651 652 653
  }

  if ($type == 'validate' && $category == 'account') {
654
    return _user_edit_validate(arg(1), $edit);
655 656
  }

657 658 659 660
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

661
  if ($type == 'categories') {
662
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
663
  }
Dries's avatar
Dries committed
664 665
}

666 667
function user_login_block() {
  $form = array(
668
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
669
    '#id' => 'user-login-form',
670
    '#validate' => user_login_default_validators(),
671
    '#submit' => array('user_login_submit'),
672 673 674
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
675
    '#maxlength' => USERNAME_MAX_LENGTH,
676 677 678 679 680
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
681
    '#maxlength' => 60,
682 683 684 685 686 687 688 689
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
690
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
691
  }
692
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
693 694 695 696
  $form['links'] = array('#value' => theme('item_list', $items));
  return $form;
}

Dries's avatar
Dries committed
697 698 699
/**
 * Implementation of hook_block().
 */
700
function user_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
 
Dries committed
701 702
  global $user;

Dries's avatar
Dries committed
703
  if ($op == 'list') {
704
    $blocks['login']['info'] = t('User login');
705
    // Not worth caching.
706
    $blocks['login']['cache'] = BLOCK_NO_CACHE;
707

708
    $blocks['navigation']['info'] = t('Navigation');
709 710
    // Menu blocks can't be cached because each menu item can have
    // a custom access callback. menu.inc manages its own caching.
711
    $blocks['navigation']['cache'] = BLOCK_NO_CACHE;
712

713
    $blocks['new']['info'] = t('Who\'s new');
714

715
    // Too dynamic to cache.
716 717
    $blocks['online']['info'] = t('Who\'s online');
    $blocks['online']['cache'] = BLOCK_NO_CACHE;
718
    return $blocks;
719
  }
720
  else if ($op == 'configure' && $delta == 'new') {
721 722 723 724 725 726 727 728
    $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;
  }
729
  else if ($op == 'configure' && $delta == 'online') {
730
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
731 732
    $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.'));
733

734
    return $form;
735
  }
736
  else if ($op == 'save' && $delta == 'new') {
737 738
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
739
  else if ($op == 'save' && $delta == 'online') {
740 741 742 743
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
  else if ($op == 'view') {
Dries's avatar
 
Dries committed
744 745
    $block = array();

Dries's avatar
 
Dries committed
746
    switch ($delta) {
747
      case 'login':
Dries's avatar
Dries committed
748 749
        // 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
750

Dries's avatar
Dries committed
751
          $block['subject'] = t('User login');
752
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
 
Dries committed
753
        }
Dries's avatar
Dries committed
754
        return $block;
Dries's avatar
Dries committed
755

756
      case 'navigation':
757
        if ($menu = menu_tree()) {
758 759
          $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
          $block['content'] = $menu;
Dries's avatar
 
Dries committed
760
        }
761
        return $block;
Dries's avatar
Dries committed
762

763
      case 'new':
764
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
765
          // Retrieve a list of new users who have subsequently accessed the site successfully.
766
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', 0, variable_get('user_block_whois_new_count', 5));
767
          while ($account = db_fetch_object($result)) {
768
            $items[] = $account;
769
          }
Dries's avatar
Dries committed
770
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
771

Dries's avatar
Dries committed
772 773
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
774
        }
Dries's avatar
Dries committed
775 776
        return $block;

777
      case 'online':
778
        if (user_access('access content')) {
779
          // Count users active within the defined period.
780
          $interval = time() - variable_get('user_block_seconds_online', 900);
781

782
          // Perform database queries to gather online user lists.  We use s.timestamp
783
          // rather than u.access because it is much faster.
784
          $anonymous_count = sess_count($interval);
785
          $authenticated_users = db_query('SELECT DISTINCT u.uid, u.name, s.timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.timestamp >= %d AND s.uid > 0 ORDER BY s.timestamp DESC', $interval);
786 787 788 789 790 791 792 793 794 795
          $authenticated_count = 0;
          $max_users = variable_get('user_block_max_list_count', 10);
          $items = array();
          while ($account = db_fetch_object($authenticated_users)) {
            if ($max_users > 0) {
              $items[] = $account;
              $max_users--;
            }
            $authenticated_count++;
          }
Dries's avatar
 
Dries committed
796

Dries's avatar
Dries committed
797
          // Format the output with proper grammar.
798 799
          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
800 801
          }
          else {
802
            $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')));
Dries's avatar
 
Dries committed
803 804
          }

805 806
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
807
          if ($authenticated_count && $max_users) {
808 809
            $output .= theme('user_list', $items, t('Online users'));
          }
810

Dries's avatar
Dries committed
811 812
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
813
        }
Dries's avatar
 
Dries committed
814
        return $block;
Dries's avatar
 
Dries committed
815 816
    }
  }
817 818
}

819 820 821 822 823 824 825 826 827 828
/**
 * 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
829
  if (variable_get('user_pictures', 0)) {
830
    $account = $variables['account'];
831
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
 
Dries committed
832 833 834 835 836 837
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

838
    if (isset($picture)) {
839
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
840
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
841
      if (!empty($account->uid) && user_access('access user profiles')) {
842 843
        $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
844 845 846 847 848
      }
    }
  }
}

849 850
/**
 * Make a list of users.
851 852 853 854 855
 *
 * @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().
856 857 858 859
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
860 861 862 863
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
864
  }
Dries's avatar
Dries committed
865
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
866 867
}

868
function user_is_anonymous() {
869 870
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
871 872 873 874 875 876 877
}

function user_is_logged_in() {
  return (bool)$GLOBALS['user']->uid;
}

function user_register_access() {
878
  return user_is_anonymous() && variable_get('user_register', 1);
879 880 881 882 883 884 885 886 887 888 889 890