user.module 86 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
define('USERNAME_MAX_LENGTH', 60);
define('EMAIL_MAX_LENGTH', 64);

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

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

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

83
  if ($user = db_fetch_array($result)) {
Dries's avatar
   
Dries committed
84
    return user_load($user);
Dries's avatar
   
Dries committed
85
86
87
88
89
90
  }
  else {
    return 0;
  }
}

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

111
112
113
114
115
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

116
117
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
118
    // Invalid login.
119
120
    return FALSE;
  }
121

122
  // Valid login.
123
124
  global $user;
  $user = $account;
125
  user_authenticate_finalize($state['values']);
126
127
128
  return TRUE;
}

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

144
145
146
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }
147
148
149
  elseif (!is_array($array)) {
    return FALSE;
  }
150

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

167
  if ($user = db_fetch_object($result)) {
168
    $user = drupal_unpack($user);
Dries's avatar
   
Dries committed
169

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

  return $user;
}

190
/**
191
 * Save changes to a user account or add a new user.
192
193
 *
 * @param $account
194
195
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
196
197
198
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
199
 *   Setting a field to NULL deletes it from the data column.
200
201
202
203
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
204
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
205
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
206
  $user_fields = user_fields();
207
  if (is_object($account) && $account->uid) {
208
    user_module_invoke('update', $array, $account, $category);
209
    $query = '';
Dries's avatar
Dries committed
210
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
211
212
213
214
215
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
    if (empty($array['access']) && empty($account->access) && user_access('administer users')) {
      $array['access'] = time();
    }
Dries's avatar
   
Dries committed
216
    foreach ($array as $key => $value) {
217
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
   
Dries committed
218
219
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
   
Dries committed
220
      }
221
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
222
        if (in_array($key, $user_fields)) {
223
          // Save standard fields
Dries's avatar
   
Dries committed
224
225
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
   
Dries committed
226
        }
Dries's avatar
   
Dries committed
227
        else if ($key != 'roles') {
228
          // Roles is a special case: it used below.
229
          if ($value === NULL) {
230
231
232
233
234
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
   
Dries committed
235
        }
Dries's avatar
   
Dries committed
236
237
      }
    }
238
    $query .= "data = '%s' ";
Dries's avatar
   
Dries committed
239
    $v[] = serialize($data);
Dries's avatar
   
Dries committed
240

241
    db_query("UPDATE {users} SET $query WHERE uid = %d", array_merge($v, array($account->uid)));
Dries's avatar
   
Dries committed
242

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

247
      foreach (array_keys($array['roles']) as $rid) {
248
249
250
        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);
        }
251
      }
Dries's avatar
   
Dries committed
252
253
    }

254
    // Delete a blocked user's sessions to kick them if they are online.
255
    if (isset($array['status']) && $array['status'] == 0) {
256
      sess_destroy_uid($account->uid);
257
258
    }

259
260
    // If the password changed, delete all open sessions and recreate
    // the current one.
261
    if (!empty($array['pass'])) {
262
263
264
265
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

266
    // Refresh user object
Dries's avatar
   
Dries committed
267
    $user = user_load(array('uid' => $account->uid));
268
269
270
271
272
273
274
275

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

276
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
   
Dries committed
277
278
  }
  else {
279
    if (!isset($array['created'])) {    // Allow 'created' to be set by the caller
280
281
      $array['created'] = time();
    }
282
283
284
285
286
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
    if (empty($array['access']) && user_access('administer users')) {
      $array['access'] = time();
    }
287

288
289
290
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there. We cannot invoke hook_user('insert') here
    // because we don't have a fully initialized user object yet.
Dries's avatar
   
Dries committed
291
    foreach ($array as $key => $value) {
292
      switch ($key) {
293
294
295
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
   
Dries committed
296
          $s[] = "'%s'";
Dries's avatar
Dries committed
297
          break;
298
        case 'mode':       case 'sort':     case 'timezone':
299
300
301
302
303
304
305
306
307
308
309
310
311
        case 'threshold':  case 'created':  case 'access':
        case 'login':      case 'status':
          $fields[] = $key;
          $values[] = $value;
          $s[] = "%d";
          break;
        default:
          if (substr($key, 0, 4) !== 'auth' && in_array($key, $user_fields)) {
            $fields[] = $key;
            $values[] = $value;
            $s[] = "'%s'";
          }
          break;
Dries's avatar
   
Dries committed
312
313
      }
    }
Dries's avatar
Dries committed
314
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
315
    $array['uid'] = db_last_insert_id('users', 'uid');
Dries's avatar
   
Dries committed
316

317
318
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
319

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

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
325
      if ((substr($key, 0, 4) !== 'auth') && ($key != 'roles') && (!in_array($key, $user_fields)) && ($value !== NULL)) {
326
327
328
329
330
        $data[$key] = $value;
      }
    }
    db_query("UPDATE {users} SET data = '%s' WHERE uid = %d", serialize($data), $user->uid);

331
    // Save user roles (delete just to be safe).
332
    if (isset($array['roles']) && is_array($array['roles'])) {
333
334
335
336
337
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
      foreach (array_keys($array['roles']) as $rid) {
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
        }
338
339
340
      }
    }

341
342
    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
343
344
  }

345
  // Save distributed authentication mappings
346
  $authmaps = array();
Dries's avatar
   
Dries committed
347
  foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
348
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
   
Dries committed
349
350
351
      $authmaps[$key] = $value;
    }
  }
352
  if (sizeof($authmaps) > 0) {
Dries's avatar
   
Dries committed
353
    user_set_authmaps($user, $authmaps);
Dries's avatar
   
Dries committed
354
355
356
357
358
  }

  return $user;
}

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

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

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

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

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

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

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

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

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

  return $pass;
Dries's avatar
   
Dries committed
443
444
}

Dries's avatar
Dries committed
445
446
447
448
449
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
450
451
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
452
453
454
455
 * @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
456
457
 *
 * @return
458
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
459
460
461
462
463
 *
 * 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.
 */
464
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
   
Dries committed
465
  global $user;
Dries's avatar
   
Dries committed
466
  static $perm = array();
Dries's avatar
   
Dries committed
467

468
469
470
471
  if ($reset) {
    unset($perm);
  }

472
473
474
475
  if (is_null($account)) {
    $account = $user;
  }

476
  // User #1 has all privileges:
477
  if ($account->uid == 1) {
478
    return TRUE;
Dries's avatar
   
Dries committed
479
480
  }

Dries's avatar
Dries committed
481
482
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
483
  if (!isset($perm[$account->uid])) {
484
    $result = db_query("SELECT p.perm FROM {role} r INNER JOIN {permission} p ON p.rid = r.rid WHERE r.rid IN (". db_placeholders($account->roles) .")", array_keys($account->roles));
Dries's avatar
   
Dries committed
485

486
    $perms = array();
Dries's avatar
   
Dries committed
487
    while ($row = db_fetch_object($result)) {
488
      $perms += array_flip(explode(', ', $row->perm));
Dries's avatar
   
Dries committed
489
    }
490
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
491
  }
492

493
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
494
495
}

496
497
498
/**
 * Checks for usernames blocked by user administration
 *
499
 * @return boolean TRUE for blocked users, FALSE for active
500
501
 */
function user_is_blocked($name) {
502
  $deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
503

504
  return $deny;
505
506
}

Dries's avatar
   
Dries committed
507
508
function user_fields() {
  static $fields;
Dries's avatar
   
Dries committed
509

Dries's avatar
   
Dries committed
510
  if (!$fields) {
Dries's avatar
Dries committed
511
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
512
513
    if ($field = db_fetch_array($result)) {
      $fields = array_keys($field);
Kjartan's avatar
Kjartan committed
514
    }
Dries's avatar
   
Dries committed
515
516
    else {
      // Make sure we return the default fields at least
517
      $fields = array('uid', 'name', 'pass', 'mail', 'picture', 'mode', 'sort', 'threshold', 'theme', 'signature', 'created', 'access', 'login', 'status', 'timezone', 'language', 'init', 'data');
Dries's avatar
   
Dries committed
518
    }
Dries's avatar
   
Dries committed
519
  }
Dries's avatar
   
Dries committed
520

Dries's avatar
   
Dries committed
521
  return $fields;
Dries's avatar
   
Dries committed
522
523
}

Dries's avatar
Dries committed
524
525
526
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
527
function user_perm() {
528
  return array('administer permissions', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
   
Dries committed
529
530
}

Dries's avatar
Dries committed
531
532
533
534
535
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
   
Dries committed
536
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
537
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
538
539
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
   
Dries committed
540
541
542
  }
}

Dries's avatar
Dries committed
543
544
545
/**
 * Implementation of hook_search().
 */
546
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
547
548
  switch ($op) {
    case 'name':
549
      if ($skip_access_check || user_access('access user profiles')) {
550
        return t('Users');
551
      }
552
    case 'search':
553
554
555
556
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
557
558
559
560
        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)) {
561
            $find[] = array('title' => $account->name .' ('. $account->mail .')', 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
562
563
564
          }
        }
        else {
565
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
566
          while ($account = db_fetch_object($result)) {
567
            $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
568
          }
569
570
        }
        return $find;
571
      }
Dries's avatar
   
Dries committed
572
573
574
  }
}

Dries's avatar
Dries committed
575
576
577
578
579
580
581
582
583
584
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
585
586
587
/**
 * Implementation of hook_user().
 */
588
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
589
  if ($type == 'view') {
590
591
592
593
594
595
596
597
598
599
    $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'),
600
      '#weight' => 5,
601
602
603
604
605
606
      '#title' => t('History'),
    );
    $account->content['summary']['member_for'] =  array(
      '#type' => 'user_profile_item',
      '#title' => t('Member for'),
      '#value' => format_interval(time() - $account->created),
607
    );
Dries's avatar
Dries committed
608
  }
609
  if ($type == 'form' && $category == 'account') {
610
611
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
612
613
614
  }

  if ($type == 'validate' && $category == 'account') {
615
    return _user_edit_validate(arg(1), $edit);
616
617
  }

618
619
620
621
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

622
  if ($type == 'categories') {
623
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
624
  }
Dries's avatar
Dries committed
625
626
}

627
628
function user_login_block() {
  $form = array(
629
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
630
    '#id' => 'user-login-form',
631
    '#validate' => user_login_default_validators(),
632
    '#submit' => array('user_login_submit'),
633
634
635
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
636
    '#maxlength' => USERNAME_MAX_LENGTH,
637
638
639
640
641
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
642
    '#maxlength' => 60,
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
    $items[] = l(t('Create new account'), 'user/register', array('title' => t('Create a new user account.')));
  }
  $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
  $form['links'] = array('#value' => theme('item_list', $items));
  return $form;
}

Dries's avatar
Dries committed
658
659
660
/**
 * Implementation of hook_block().
 */
661
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
662
663
  global $user;

Dries's avatar
Dries committed
664
  if ($op == 'list') {
665
666
667
    $blocks[0]['info'] = t('User login');
    // Not worth caching.
    $blocks[0]['cache'] = BLOCK_NO_CACHE;
668

669
670
671
672
    $blocks[1]['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[1]['cache'] = BLOCK_NO_CACHE;
673

674
    $blocks[2]['info'] = t('Who\'s new');
675

676
677
678
679
    // Too dynamic to cache.
    $blocks[3]['info'] = t('Who\'s online');
    $blocks[3]['cache'] = BLOCK_NO_CACHE;
    return $blocks;
680
  }
681
682
683
684
685
686
687
688
689
  else if ($op == 'configure' && $delta == 2) {
    $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;
  }
690
691
  else if ($op == 'configure' && $delta == 3) {
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
692
693
    $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.'));
694

695
    return $form;
696
  }
697
698
699
  else if ($op == 'save' && $delta == 2) {
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
700
701
702
703
704
  else if ($op == 'save' && $delta == 3) {
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
  else if ($op == 'view') {
Dries's avatar
   
Dries committed
705
706
    $block = array();

Dries's avatar
   
Dries committed
707
708
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
709
710
        // 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
711

Dries's avatar
Dries committed
712
          $block['subject'] = t('User login');
713
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
   
Dries committed
714
        }
Dries's avatar
Dries committed
715
        return $block;
Dries's avatar
Dries committed
716

717
      case 1:
718
        if ($menu = menu_tree()) {
719
720
          $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
          $block['content'] = $menu;
Dries's avatar
   
Dries committed
721
        }
722
        return $block;
Dries's avatar
Dries committed
723

Dries's avatar
   
Dries committed
724
      case 2:
725
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
726
          // Retrieve a list of new users who have subsequently accessed the site successfully.
727
          $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));
728
          while ($account = db_fetch_object($result)) {
729
            $items[] = $account;
730
          }
Dries's avatar
Dries committed
731
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
732

Dries's avatar
Dries committed
733
734
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
735
        }
Dries's avatar
Dries committed
736
737
        return $block;

Dries's avatar
   
Dries committed
738
      case 3:
739
        if (user_access('access content')) {
740
          // Count users active within the defined period.
741
          $interval = time() - variable_get('user_block_seconds_online', 900);
742

743
          // Perform database queries to gather online user lists.  We use s.timestamp
744
          // rather than u.access because it is much faster.
745
          $anonymous_count = sess_count($interval);
746
          $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);
747
748
749
750
751
752
753
754
755
756
          $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
757

Dries's avatar
Dries committed
758
          // Format the output with proper grammar.
759
760
          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
761
762
          }
          else {
763
            $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
764
765
          }

766
767
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
768
          if ($authenticated_count && $max_users) {
769
770
            $output .= theme('user_list', $items, t('Online users'));
          }
771

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

780
781
782
783
784
785
786
787
788
789
/**
 * 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
790
  if (variable_get('user_pictures', 0)) {
791
    $account = $variables['account'];
792
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
   
Dries committed
793
794
795
796
797
798
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

799
    if (isset($picture)) {
800
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
801
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
802
      if (!empty($account->uid) && user_access('access user profiles')) {
803
804
        $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
805
806
807
808
809
      }
    }
  }
}

810
811
/**
 * Make a list of users.
812
813
814
815
816
 *
 * @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().
817
818
819
820
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
821
822
823
824
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
825
  }
Dries's avatar
Dries committed
826
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
827
828
}

829
function user_is_anonymous() {
830
831
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
832
833
834
835
836
837
838
}

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

function user_register_access() {
839
  return user_is_anonymous() && variable_get('user_register', 1);
840
841
842
843
844
845
846
847
848
849
850
851
852
853
}

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

854
function user_edit_access($account) {
855
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
856
857
858
859
860
861
862
}

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

Dries's avatar
   
Dries committed
863
/**
Dries's avatar
   
Dries committed
864
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
865
 */
866
867
function user_menu() {
  $items['user/autocomplete'] = array(
868
    'title' => 'User autocomplete',
869
    'page callback' => 'user_autocomplete',
870
    'access callback' => 'user_access',
871
872
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
873
    'file' => 'user.pages.inc',
874
  );
Dries's avatar
   
Dries committed
875

876
  // Registration and login pages.
877
  $items['user'] = array(
878
    'title' => 'User account',
879
880
    'page callback' => 'user_page',
    'access callback' => TRUE,
881
    'type' => MENU_CALLBACK,
882
    'file' => 'user.pages.inc',
883
884
885
  );

  $items['user/login'] = array(
886
    'title' => 'Log in',
887
    'access callback' => 'user_is_anonymous',
888
889
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
   
Dries committed
890

891
  $items['user/register'] = array(
892
    'title' => 'Create new account',
893
894
895
896
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
897
    'file' => 'user.pages.inc',
898
899
900
  );

  $items['user/password'] = array(
901
    'title' => 'Request new password',
902
903
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),
904
    'access callback' => 'user_is_anonymous',
905
    'type' => MENU_LOCAL_TASK,
906
    'file' => 'user.pages.inc',
907
908
  );
  $items['user/reset/%/%/%'] = array(
909
    'title' => 'Reset password',
910
911
912
913
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
914
    'file' => 'user.pages.inc',
915
916
917
918
  );

  // Admin user pages
  $items['admin/user'] = array(
919
920
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
921
922
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
923
    'access arguments' => array('access administration pages'),
Dries's avatar