user.module 86.9 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_' . $type;
28
    if (function_exists($function)) {
29
      $function($array, $user, $category);
30
    }
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
    elseif ($key == 'pass') {
166
      $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 $edit
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, $edit = array(), $category = 'account') {
220
221
222
  $table = drupal_get_schema('users');
  $user_fields = $table['fields'];

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

237
  if (is_object($account) && $account->uid) {
238
    user_module_invoke('update', $edit, $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
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
242
    if (empty($edit['access']) && empty($account->access) && user_access('administer users')) {
243
      $edit['access'] = REQUEST_TIME;
244
    }
245
    foreach ($edit 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
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
260
    // Save changes to the users table.
261
    $success = drupal_write_record('users', $edit, '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($edit['roles']) && is_array($edit['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($edit['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($edit['status']) && $edit['status'] == 0) {
280
      drupal_session_destroy_uid($account->uid);
281
282
    }

283
284
    // If the password changed, delete all open sessions and recreate
    // the current one.
285
    if (!empty($edit['pass'])) {
286
287
      drupal_session_destroy_uid($account->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
    $success = drupal_write_record('users', $edit);
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
    // 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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
/**
 * 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
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
531
532
533
  if ($reset) {
    unset($perm);
  }

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
677
    $form_state = array();
    return user_edit_form($form_state, arg(1), $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(arg(1), $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
696
    return _user_edit_submit(arg(1), $edit);
  }
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
739
/**
 * Implementation of hook_block().
 */
740
function user_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
   
Dries committed
741
742
  global $user;

Dries's avatar
Dries committed
743
  if ($op == 'list') {
744
    $blocks['login']['info'] = t('User login');
745
    // Not worth caching.
746
    $blocks['login']['cache'] = BLOCK_NO_CACHE;
747

748
    $blocks['navigation']['info'] = t('Navigation');
749
750
    // Menu blocks can't be cached because each menu item can have
    // a custom access callback. menu.inc manages its own caching.
751
    $blocks['navigation']['cache'] = BLOCK_NO_CACHE;
752

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

755
    // Too dynamic to cache.
756
757
    $blocks['online']['info'] = t('Who\'s online');
    $blocks['online']['cache'] = BLOCK_NO_CACHE;
758
    return $blocks;
759
  }
760
  elseif ($op == 'configure' && $delta == 'new') {
761
762
763
764
765
766
767
768
    $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;
  }
769
  elseif ($op == 'configure' && $delta == 'online') {
770
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
771
772
    $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.'));
773

774
    return $form;
775
  }
776
  elseif ($op == 'save' && $delta == 'new') {
777
778
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
779
  elseif ($op == 'save' && $delta == 'online') {
780
781
782
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
783
  elseif ($op == 'view') {
Dries's avatar
   
Dries committed
784
785
    $block = array();

Dries's avatar
   
Dries committed
786
    switch ($delta) {
787
      case 'login':
Dries's avatar
Dries committed
788
789
        // 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
790

Dries's avatar
Dries committed
791
          $block['subject'] = t('User login');
792
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
   
Dries committed
793
        }
Dries's avatar
Dries committed
794
        return $block;
Dries's avatar
Dries committed
795

796
      case 'navigation':
797
        if ($menu = menu_tree()) {
798
799
          $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
          $block['content'] = $menu;
Dries's avatar
   
Dries committed
800
        }
801
        return $block;
Dries's avatar
Dries committed
802

803
      case 'new':
804
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
805
          // Retrieve a list of new users who have subsequently accessed the site successfully.
806
          $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));
807
          while ($account = db_fetch_object($result)) {
808
            $items[] = $account;
809
          }
Dries's avatar
Dries committed
810
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
811

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

817
      case 'online':
818
        if (user_access('access content')) {
819
          // Count users active within the defined period.
820
          $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
821

822
          // Perform database queries to gather online user lists.  We use s.timestamp
823
          // rather than u.access because it is much faster.
824
          $anonymous_count = drupal_session_count($interval);
825
          $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);
826
827
828
829
830
831
832
833
834
835
          $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
836

Dries's avatar
Dries committed
837
          // Format the output with proper grammar.
838
839
          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
840
841
          }
          else {
842
            $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
843
844
          }

845
846
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
847
          if ($authenticated_count && $max_users) {
848
849
            $output .= theme('user_list', $items, t('Online users'));
          }
850

Dries's avatar
Dries committed
851
852
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
   
Dries committed
853
        }
Dries's avatar
   
Dries committed
854
        return $block;
Dries's avatar
   
Dries committed
855
856
    }
  }
857
858
}

859
860
861
862
863
864
865
866
867
868
/**
 * 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
869
  if (variable_get('user_pictures', 0)) {
870
    $account = $variables['account'];
871
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
   
Dries committed
872
873
      $picture = file_create_url($account->picture);
    }
874
    elseif (variable_get('user_picture_default', '')) {
Dries's avatar
   
Dries committed
875
876
877
      $picture = variable_get('user_picture_default', '');
    }

878
    if (isset($picture)) {
879
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
880
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
881
      if (!empty($account->uid) && user_access('access user profiles')) {
882
883
        $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
884
885
886
887
888
      }
    }
  }
}

889
890
/**
 * Make a list of users.
891
892
893
894
895
 *
 * @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().
896
897
898
899
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
900
901
902
903
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
904
  }
Dries's avatar
Dries committed
905
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
906
907
}

908
function user_is_anonymous() {
909
910
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
911
912
913
914
915
916
917
}

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

function user_register_access() {
918
  return user_is_anonymous() && variable_get('user_register', 1);
919
920
921
922
923
924
925
926
927
928
929
930
931
932
}

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'))
    );
}

933
934
935
/**
 * Access callback for user account editing.
 */