user.module 86.1 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
 *
 */
Dries's avatar
   
Dries committed
143
function user_load($array = array()) {
Dries's avatar
Dries committed
144
  // Dynamically compose a SQL query:
145
  $query = array();
146
  $params = array();
147

148
149
150
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }
151
152
153
  elseif (!is_array($array)) {
    return FALSE;
  }
154

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

171
  if ($user = db_fetch_object($result)) {
172
    $user = drupal_unpack($user);
Dries's avatar
   
Dries committed
173

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

  return $user;
}

194
/**
195
 * Save changes to a user account or add a new user.
196
197
 *
 * @param $account
198
199
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
200
 *
201
 * @param $edit
202
203
204
205
206
 *   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.
207
208
209
 *
 * @param $category
 *   (optional) The category for storing profile information in.
210
211
 *
 * @return
212
 *   A fully-loaded $user object.
213
 */
214
function user_save($account, $edit = array(), $category = 'account') {
215
216
217
  $table = drupal_get_schema('users');
  $user_fields = $table['fields'];

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

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

253
254
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
255
    // Save changes to the users table.
256
    drupal_write_record('users', $edit, 'uid');
Dries's avatar
   
Dries committed
257

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

262
      foreach (array_keys($edit['roles']) as $rid) {
263
264
265
        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);
        }
266
      }
Dries's avatar
   
Dries committed
267
268
    }

269
    // Delete a blocked user's sessions to kick them if they are online.
270
    if (isset($edit['status']) && $edit['status'] == 0) {
271
      drupal_session_destroy_uid($account->uid);
272
273
    }

274
275
    // If the password changed, delete all open sessions and recreate
    // the current one.
276
    if (!empty($edit['pass'])) {
277
278
      drupal_session_destroy_uid($account->uid);
      drupal_session_regenerate();
279
280
    }

281
    // Refresh user object.
Dries's avatar
   
Dries committed
282
    $user = user_load(array('uid' => $account->uid));
283
284

    // Send emails after we have the new user object.
285
    if (isset($edit['status']) && $edit['status'] != $account->status) {
286
      // The user's status is changing; conditionally send notification email.
287
      $op = $edit['status'] == 1 ? 'status_activated' : 'status_blocked';
288
289
290
      _user_mail_notify($op, $user);
    }

291
    user_module_invoke('after_update', $edit, $user, $category);
Dries's avatar
   
Dries committed
292
293
  }
  else {
294
    // Allow 'created' to be set by the caller.
295
    if (!isset($edit['created'])) {
296
      $edit['created'] = REQUEST_TIME;
297
    }
298
299
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
300
    if (empty($edit['access']) && user_access('administer users')) {
301
      $edit['access'] = REQUEST_TIME;
302
    }
303

304
    drupal_write_record('users', $edit);
305

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

309
    user_module_invoke('insert', $edit, $user, $category);
310

311
312
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
313
    $data = array();
314
    foreach ($edit as $key => $value) {
315
      if (($key != 'roles') && (empty($user_fields[$key])) && ($value !== NULL)) {
316
317
318
        $data[$key] = $value;
      }
    }
319
320
321
322
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
      drupal_write_record('users', $data_array, 'uid');
    }
323

324
    // Save user roles (delete just to be safe).
325
326
327
    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) {
328
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
329
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $edit['uid'], $rid);
330
        }
331
332
333
      }
    }

334
    // Build the finished user object.
335
    $user = user_load(array('uid' => $edit['uid']));
Dries's avatar
   
Dries committed
336
337
338
339
340
  }

  return $user;
}

Dries's avatar
Dries committed
341
342
343
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
344
function user_validate_name($name) {
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
  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.');
  }
360
361
362
363
364
365
366
367
  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
368
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
369
370
371
                   $name)) {
    return t('The username contains an illegal character.');
  }
372
373
374
  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
375
376
377
}

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

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

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

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

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

Dries's avatar
Dries committed
426
427
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
428

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

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

  return $pass;
Dries's avatar
   
Dries committed
438
439
}

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

516
  if ($reset) {
517
    $perm = array();
518
519
  }

520
521
522
523
  if (is_null($account)) {
    $account = $user;
  }

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

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

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

541
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
542
543
}

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

552
  return $deny;
553
554
}

Dries's avatar
Dries committed
555
556
557
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
558
function user_perm() {
559
   return array(
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
     '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.'),
     ),
576
   );
Dries's avatar
   
Dries committed
577
578
}

Dries's avatar
Dries committed
579
580
581
582
583
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
   
Dries committed
584
function user_file_download($file) {
585
  if (strpos($file, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
586
    $info = image_get_info(file_create_path($file));
587
    return array('Content-type: ' . $info['mime_type']);
Dries's avatar
   
Dries committed
588
589
590
  }
}

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

Dries's avatar
Dries committed
623
624
625
626
627
628
629
630
631
632
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
633
/**
634
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
635
 */
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
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') {
662
663
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
664
  }
665
}
666

667
668
669
670
671
/**
 * Implementation of hook_user_validate.
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
672
    return _user_edit_validate(arg(1), $edit);
673
  }
674
}
675

676
677
678
679
680
/**
 * Implementation of hook_user_submit.
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
681
682
    return _user_edit_submit(arg(1), $edit);
  }
683
}
684

685
686
687
688
/**
 * Implementation of hook_user_categories.
 */
function user_user_categories(&$edit, &$account, $category = NULL) {
689
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
690
691
}

692
693
function user_login_block() {
  $form = array(
694
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
695
    '#id' => 'user-login-form',
696
    '#validate' => user_login_default_validators(),
697
    '#submit' => array('user_login_submit'),
698
699
700
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
701
    '#maxlength' => USERNAME_MAX_LENGTH,
702
703
704
705
706
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
707
    '#maxlength' => 60,
708
709
710
711
712
713
714
715
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
716
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
717
  }
718
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
719
  $form['links'] = array('#markup' => theme('item_list', $items));
720
721
722
  return $form;
}

Dries's avatar
Dries committed
723
724
725
/**
 * Implementation of hook_block().
 */
726
function user_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
   
Dries committed
727
728
  global $user;

Dries's avatar
Dries committed
729
  if ($op == 'list') {
730
    $blocks['login']['info'] = t('User login');
731
    // Not worth caching.
732
    $blocks['login']['cache'] = BLOCK_NO_CACHE;
733

734
    $blocks['navigation']['info'] = t('Navigation');
735
736
    // Menu blocks can't be cached because each menu item can have
    // a custom access callback. menu.inc manages its own caching.
737
    $blocks['navigation']['cache'] = BLOCK_NO_CACHE;
738

739
    $blocks['new']['info'] = t('Who\'s new');
740

741
    // Too dynamic to cache.
742
743
    $blocks['online']['info'] = t('Who\'s online');
    $blocks['online']['cache'] = BLOCK_NO_CACHE;
744
    return $blocks;
745
  }
746
  elseif ($op == 'configure' && $delta == 'new') {
747
748
749
750
751
752
753
754
    $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;
  }
755
  elseif ($op == 'configure' && $delta == 'online') {
756
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
757
758
    $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.'));
759

760
    return $form;
761
  }
762
  elseif ($op == 'save' && $delta == 'new') {
763
764
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
765
  elseif ($op == 'save' && $delta == 'online') {
766
767
768
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
769
  elseif ($op == 'view') {
Dries's avatar
   
Dries committed
770
771
    $block = array();

Dries's avatar
   
Dries committed
772
    switch ($delta) {
773
      case 'login':
Dries's avatar
Dries committed
774
775
        // 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
776

Dries's avatar
Dries committed
777
          $block['subject'] = t('User login');
778
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
   
Dries committed
779
        }
Dries's avatar
Dries committed
780
        return $block;
Dries's avatar
Dries committed
781

782
      case 'navigation':
783
        if ($menu = menu_tree()) {
784
785
          $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
          $block['content'] = $menu;
Dries's avatar
   
Dries committed
786
        }
787
        return $block;
Dries's avatar
Dries committed
788

789
      case 'new':
790
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
791
          // Retrieve a list of new users who have subsequently accessed the site successfully.
792
          $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));
793
          while ($account = db_fetch_object($result)) {
794
            $items[] = $account;
795
          }
Dries's avatar
Dries committed
796
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
797

Dries's avatar
Dries committed
798
799
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
800
        }
Dries's avatar
Dries committed
801
802
        return $block;

803
      case 'online':
804
        if (user_access('access content')) {
805
          // Count users active within the defined period.
806
          $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
807

808
          // Perform database queries to gather online user lists.  We use s.timestamp
809
          // rather than u.access because it is much faster.
810
          $anonymous_count = drupal_session_count($interval);
811
          $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);
812
813
814
815
816
817
818
819
820
821
          $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
822

Dries's avatar
Dries committed
823
          // Format the output with proper grammar.
824
825
          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
826
827
          }
          else {
828
            $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
829
830
          }

831
832
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
833
          if ($authenticated_count && $max_users) {
834
835
            $output .= theme('user_list', $items, t('Online users'));
          }
836

Dries's avatar
Dries committed
837
838
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
   
Dries committed
839
        }
Dries's avatar
   
Dries committed
840
        return $block;
Dries's avatar
   
Dries committed
841
842
    }
  }
843
844
}

845
846
847
848
849
850
851
852
853
854
/**
 * 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
855
  if (variable_get('user_pictures', 0)) {
856
    $account = $variables['account'];
857
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
   
Dries committed
858
859
      $picture = file_create_url($account->picture);
    }
860
    elseif (variable_get('user_picture_default', '')) {
Dries's avatar
   
Dries committed
861
862
863
      $picture = variable_get('user_picture_default', '');
    }

864
    if (isset($picture)) {
865
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
866
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
867
      if (!empty($account->uid) && user_access('access user profiles')) {
868
869
        $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
870
871
872
873
874
      }
    }
  }
}

875
876
/**
 * Make a list of users.
877
878
879
880
881
 *
 * @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().
882
883
884
885
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
886
887
888
889
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
890
  }
Dries's avatar
Dries committed
891
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
892
893
}

894
function user_is_anonymous() {
895
896
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
897
898
899
900
901
902
903
}

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

function user_register_access() {
904
  return user_is_anonymous() && variable_get('user_register', 1);
905
906
907
908
909
910
911
912
913
914
915
916
917
918
}

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

919
920
921
/**
 * Access callback for user account editing.
 */
922
function user_edit_access($account) {
923
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
924
925
926
927
928
929
930
}

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

Dries's avatar
   
Dries committed
931
/**
Dries's avatar
   
Dries committed
932
 * Implementation of hook_menu().
Dries's avatar