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

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

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

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

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

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

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

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

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

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

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

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

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

  return $user;
}

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

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

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

256
257
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
258
    // Save changes to the users table.
259
260
261
262
263
    $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
264

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

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

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

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

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

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

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

313
314
315
316
317
318
    $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;
    }
319

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

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

325
326
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
327
    $data = array();
328
    foreach ($edit 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
340
341
    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) {
342
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
343
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $edit['uid'], $rid);
344
        }
345
346
347
      }
    }

348
    // Build the finished user object.
349
    $user = user_load(array('uid' => $edit['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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
  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.');
  }
374
375
376
377
378
379
380
381
  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
382
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
383
384
385
                   $name)) {
    return t('The username contains an illegal character.');
  }
386
387
388
  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
389
390
391
}

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

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

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

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

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

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

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

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

  return $pass;
Dries's avatar
   
Dries committed
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
/**
 * 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.
492
      $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));
493
494
495
496
497
498
499
500
501
502
503
504
505
506

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

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

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

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

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

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

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

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

566
  return $deny;
567
568
}

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

Dries's avatar
Dries committed
593
594
595
596
597
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
   
Dries committed
598
function user_file_download($file) {
599
  if (strpos($file, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
600
    $info = image_get_info(file_create_path($file));
601
    return array('Content-type: ' . $info['mime_type']);
Dries's avatar
   
Dries committed
602
603
604
  }
}

Dries's avatar
Dries committed
605
606
607
/**
 * Implementation of hook_search().
 */
608
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
609
610
  switch ($op) {
    case 'name':
611
      if ($skip_access_check || user_access('access user profiles')) {
612
        return t('Users');
613
      }
614
    case 'search':
615
616
617
618
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
619
620
621
622
        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)) {
623
            $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
624
625
626
          }
        }
        else {
627
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
628
          while ($account = db_fetch_object($result)) {
629
            $find[] = array('title' => $account->name, 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
630
          }
631
632
        }
        return $find;
633
      }
Dries's avatar
   
Dries committed
634
635
636
  }
}

Dries's avatar
Dries committed
637
638
639
640
641
642
643
644
645
646
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
647
/**
648
 * Implementation of hook_user_view().
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
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') {
676
    $form_state = array();
677
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
678
  }
679
}
680

681
682
683
684
685
/**
 * Implementation of hook_user_validate.
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
686
    return _user_edit_validate($account, $edit);
687
  }
688
}
689

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

699
700
701
702
/**
 * Implementation of hook_user_categories.
 */
function user_user_categories(&$edit, &$account, $category = NULL) {
703
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
704
705
}

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

Dries's avatar
Dries committed
737
/**
738
 * Implementation of hook_block_list().
Dries's avatar
Dries committed
739
 */
740
function user_block_list() {
Dries's avatar
   
Dries committed
741
742
  global $user;

743
744
745
  $blocks['login']['info'] = t('User login');
  // Not worth caching.
  $blocks['login']['cache'] = BLOCK_NO_CACHE;
746

747
748
749
750
  $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;
751

752
  $blocks['new']['info'] = t('Who\'s new');
753

754
755
756
757
758
  // Too dynamic to cache.
  $blocks['online']['info'] = t('Who\'s online');
  $blocks['online']['cache'] = BLOCK_NO_CACHE;
  return $blocks;
}
759

760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
/**
 * 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;
781
  }
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
}

/**
 * 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;
799
  }
800
}
Dries's avatar
   
Dries committed
801

802
803
804
805
806
/**
 * Implementation of hook_block_view().
 */
function user_block_view($delta = '') {
  global $user;
Dries's avatar
   
Dries committed
807

808
  $block = array();
Dries's avatar
Dries committed
809

810
811
812
813
  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
814

815
816
817
818
        $block['subject'] = t('User login');
        $block['content'] = drupal_get_form('user_login_block');
      }
      return $block;
Dries's avatar
   
Dries committed
819

820
821
822
823
824
825
    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
826

827
828
829
830
831
    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);
832

833
834
835
836
        $block['subject'] = t('Who\'s new');
        $block['content'] = $output;
      }
      return $block;
Dries's avatar
   
Dries committed
837

838
839
840
841
    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
842

843
        // Perform database queries to gather online user lists. We use s.timestamp
844
845
846
        // 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();
847

848
849
850
        // 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
851
        }
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
        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
867
  }
868
869
}

870
871
872
873
874
875
876
877
878
879
/**
 * 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
880
  if (variable_get('user_pictures', 0)) {
881
    $account = $variables['account'];
882
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
   
Dries committed
883
884
      $picture = file_create_url($account->picture);
    }
885
    elseif (variable_get('user_picture_default', '')) {
Dries's avatar
   
Dries committed
886
887
888
      $picture = variable_get('user_picture_default', '');
    }

889
    if (isset($picture)) {
890
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
891
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
892
      if (!empty($account->uid) && user_access('access user profiles')) {
893
894
        $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
895
896
897
898
899
      }
    }
  }
}

900
901
/**
 * Make a list of users.
902
903
904
905
906
 *
 * @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().
907
908
909
910
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
911
912
913
914
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
915
  }
Dries's avatar
Dries committed
916
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
917
918
}

919
function user_is_anonymous() {
920
921
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
922
923
924
925
926
927
928
}

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

function user_register_access() {
929
  return user_is_anonymous() && variable_get('user_register', 1);
930
931
932
933
934
935
936
937
938
939
940
941
942
943
}

function user_view_access($account) {
  return $account && $account->uid &&
    (
      // Always let users view their own profile.
      ($GLOBALS['user']->uid == $account->uid) ||
      // Administrators can view all accounts.
      user_access('administer users') ||
      // The user is not blocked and logged in at least once.
      ($account->access && $account->status && user_access('access user profiles'))
    );
}

944
945
946
/**
 * Access callback for user account editing.
 */
947
function user_edit_access($account) {
948
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
949
950
951
952
953
954
955
}

function user_load_self($arg) {
  $arg[1] = user_load($GLOBALS['user']->uid);
  return $arg;
}

Dries's avatar
   
Dries committed
956
/**
Dries's avatar
   
Dries committed
957
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
958
 */
959
960
function user_menu() {
  $items['user/autocomplete'] = array(
961
    'title' => 'User autocomplete',
962
    'page callback' => 'user_autocomplete',
963
    'access callback' => 'user_access',
964
965
966
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
   
Dries committed
967

968
  // Registration and login pages.
969
  $items['user'] = array(
970
    'title' => 'User account',
971
972
    'page callback' => 'user_page',
    'access callback' => TRUE,
973
    'type' => MENU_CALLBACK,
974
975
976
  );

  $items['user/login'] = array(
977
    'title' => 'Log in',
978
    'access callback' => 'user_is_anonymous',
979
980
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
   
Dries committed
981

982
  $items['user/register'] = array(
983
    'title' => 'Create new account',
984
985
986
987
988
989
990
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
  );

  $items['user/password'] = array(
Dries's avatar