user.module 86.4 KB
Newer Older
Dries's avatar
   
Dries committed
1
2
3
<?php
// $Id$

Dries's avatar
   
Dries committed
4
5
6
7
8
/**
 * @file
 * Enables the user registration and login system.
 */

9
10
11
/**
 * Maximum length of username text field.
 */
12
define('USERNAME_MAX_LENGTH', 60);
13
14
15
16

/**
 * Maximum length of user e-mail text field.
 */
17
18
define('EMAIL_MAX_LENGTH', 64);

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

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

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

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

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

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

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

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

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

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

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

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

177
    $user->roles = array();
178
179
180
181
182
183
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
184
185
186
187
    $result = db_query('SELECT r.rid, r.name FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d', $user->uid);
    while ($role = db_fetch_object($result)) {
      $user->roles[$role->rid] = $role->name;
    }
188
    user_module_invoke('load', $array, $user);
189
190
  }
  else {
191
    $user = FALSE;
Dries's avatar
   
Dries committed
192
  }
Dries's avatar
   
Dries committed
193
194
195
196

  return $user;
}

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

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

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

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

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

269
      foreach (array_keys($edit['roles']) as $rid) {
270
271
272
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
        }
273
      }
Dries's avatar
   
Dries committed
274
275
    }

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

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

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

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

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

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

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

321
    user_module_invoke('insert', $edit, $user, $category);
322

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

336
    // Save user roles (delete just to be safe).
337
338
339
    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) {
340
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
341
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $edit['uid'], $rid);
342
        }
343
344
345
      }
    }

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

  return $user;
}

Dries's avatar
Dries committed
353
354
355
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
356
function user_validate_name($name) {
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
  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.');
  }
372
373
374
375
376
377
378
379
  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
380
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
381
382
383
                   $name)) {
    return t('The username contains an illegal character.');
  }
384
385
386
  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
387
388
389
}

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

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

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

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

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

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

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

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

  return $pass;
Dries's avatar
   
Dries committed
450
451
}

452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
/**
 * 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
505
506
507
508
509
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
510
511
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
512
513
514
515
 * @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
516
517
 *
 * @return
518
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
519
520
521
522
523
 *
 * 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.
 */
524
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
   
Dries committed
525
  global $user;
Dries's avatar
   
Dries committed
526
  static $perm = array();
Dries's avatar
   
Dries committed
527

528
  if ($reset) {
529
    $perm = array();
530
531
  }

532
533
534
535
  if (is_null($account)) {
    $account = $user;
  }

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

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

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

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

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

564
  return $deny;
565
566
}

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

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

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

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

Dries's avatar
Dries committed
645
/**
646
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
647
 */
648
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
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') {
674
675
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
676
  }
677
}
678

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

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

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

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

Dries's avatar
Dries committed
735
736
737
/**
 * Implementation of hook_block().
 */
738
function user_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
   
Dries committed
739
740
  global $user;

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

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

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

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

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

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

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

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

801
      case 'new':
802
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
803
          // Retrieve a list of new users who have subsequently accessed the site successfully.
804
          $items = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', array(), 0, variable_get('user_block_whois_new_count', 5))->fetchAll();
Dries's avatar
Dries committed
805
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
806

Dries's avatar
Dries committed
807
808
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
809
        }
Dries's avatar
Dries committed
810
811
        return $block;

812
      case 'online':
813
        if (user_access('access content')) {
814
          // Count users active within the defined period.
815
          $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
816

817
          // Perform database queries to gather online user lists.  We use s.timestamp
818
          // rather than u.access because it is much faster.
819
          $anonymous_count = drupal_session_count($interval);
820
          $authenticated_count = db_query("SELECT COUNT(DISTINCT s.uid) FROM {sessions} s WHERE s.timestamp >= :timestamp AND s.uid > 0", array(':timestamp' => $interval))->fetchField();
Dries's avatar
   
Dries committed
821

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

830
831
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
832
          if ($authenticated_count && $max_users) {
833
            $items = db_query_range('SELECT u.uid, u.name, MAX(s.timestamp) AS max_timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.timestamp >= :interval AND s.uid > 0 GROUP BY u.uid, u.name ORDER BY max_timestamp DESC', array(':interval' => $interval), 0, $max_users)->fetchAll();
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
   
Dries committed
933
 */