user.module 84.7 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
  foreach (module_list() as $module) {
20
    $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
 * Implementation of hook_theme().
29
30
31
32
33
 */
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
 * that the user account is not blocked and then performs the login,
96
 * updates the login timestamp in the database, invokes hook_user('login'),
97
 * and regenerates the session.
98
99
100
101
102
103
 *
 * @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
  // Check if user is blocked.
117
118
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
119
    // Invalid login.
120
121
    return FALSE;
  }
122

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

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

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

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

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

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

  return $user;
}

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

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

230
  if (is_object($account) && $account->uid) {
231
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
Dries committed
232
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
233
234
235
236
237
    // 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
238
    foreach ($array as $key => $value) {
239
240
241
      // 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])) {
242
243
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
   
Dries committed
244
        }
245
246
        else {
          $data[$key] = $value;
Dries's avatar
   
Dries committed
247
        }
Dries's avatar
   
Dries committed
248
249
250
      }
    }

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

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

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

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

276
277
    // If the password changed, delete all open sessions and recreate
    // the current one.
278
    if (!empty($array['pass'])) {
279
280
281
282
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

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

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

293
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
   
Dries committed
294
295
  }
  else {
296
297
    // Allow 'created' to be set by the caller.
    if (!isset($array['created'])) {
298
299
      $array['created'] = time();
    }
300
301
302
303
304
    // 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();
    }
305

306
    $success = drupal_write_record('users', $array);
307
    if (!$success) {
308
309
      // On a failed INSERT some other existing user's uid may be returned.
      // We must abort to avoid overwriting their account.
310
311
      return FALSE;
    }
312

313
314
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
315

316
317
    user_module_invoke('insert', $array, $user, $category);

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

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
346
347
  }

  return $user;
}

Dries's avatar
Dries committed
348
349
350
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
351
function user_validate_name($name) {
352
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
353
354
  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.');
355
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
356
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
357
358
359
360
361
362
363
364
  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
365
                   '\x{0}]/u',               // NULL byte
366
367
368
                   $name)) {
    return t('The username contains an illegal character.');
  }
369
  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.');
370
  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
371
372
373
}

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

382
function user_validate_picture(&$form, &$form_state) {
383
  // If required, validate the uploaded picture.
384
385
386
387
388
389
  $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)) {
390
391
392
393
394
    // 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);
    }

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

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

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

Dries's avatar
Dries committed
422
423
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
424

Dries's avatar
Dries committed
425
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
426
427
428
429
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
434
435
}

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

459
460
461
462
  if ($reset) {
    unset($perm);
  }

463
464
465
466
  if (is_null($account)) {
    $account = $user;
  }

467
  // User #1 has all privileges:
468
  if ($account->uid == 1) {
469
    return TRUE;
Dries's avatar
   
Dries committed
470
471
  }

Dries's avatar
Dries committed
472
473
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
474
  if (!isset($perm[$account->uid])) {
475
    $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
476

477
    $perms = array();
Dries's avatar
   
Dries committed
478
    while ($row = db_fetch_object($result)) {
479
      $perms += array_flip(explode(', ', $row->perm));
Dries's avatar
   
Dries committed
480
    }
481
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
482
  }
483

484
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
485
486
}

487
/**
488
 * Checks for usernames blocked by user administration.
489
 *
490
 * @return boolean TRUE for blocked users, FALSE for active.
491
492
 */
function user_is_blocked($name) {
493
  $deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
494

495
  return $deny;
496
497
}

Dries's avatar
Dries committed
498
499
500
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
501
function user_perm() {
502
503
504
505
506
507
   return array(
     'administer permissions' => 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' => t('Manage or block users, and manage their role assignments.'),
     'access user profiles' => t('View profiles of users on the site, which may contain personal information.'),
     'change own username' => t('Select a different username.'),
   );
Dries's avatar
   
Dries committed
508
509
}

Dries's avatar
Dries committed
510
511
512
513
514
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
   
Dries committed
515
function user_file_download($file) {
516
  if (strpos($file, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
517
    $info = image_get_info(file_create_path($file));
518
    return array('Content-type: ' . $info['mime_type']);
Dries's avatar
   
Dries committed
519
520
521
  }
}

Dries's avatar
Dries committed
522
523
524
/**
 * Implementation of hook_search().
 */
525
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
526
527
  switch ($op) {
    case 'name':
528
      if ($skip_access_check || user_access('access user profiles')) {
529
        return t('Users');
530
      }
531
    case 'search':
532
533
534
535
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
536
537
538
539
        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)) {
540
            $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
541
542
543
          }
        }
        else {
544
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
545
          while ($account = db_fetch_object($result)) {
546
            $find[] = array('title' => $account->name, 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
547
          }
548
549
        }
        return $find;
550
      }
Dries's avatar
   
Dries committed
551
552
553
  }
}

Dries's avatar
Dries committed
554
555
556
557
558
559
560
561
562
563
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
564
565
566
/**
 * Implementation of hook_user().
 */
567
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
568
  if ($type == 'view') {
569
570
571
572
573
574
575
576
577
578
    $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'),
579
      '#weight' => 5,
580
581
582
583
584
585
      '#title' => t('History'),
    );
    $account->content['summary']['member_for'] =  array(
      '#type' => 'user_profile_item',
      '#title' => t('Member for'),
      '#value' => format_interval(time() - $account->created),
586
    );
Dries's avatar
Dries committed
587
  }
588
  if ($type == 'form' && $category == 'account') {
589
590
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
591
592
593
  }

  if ($type == 'validate' && $category == 'account') {
594
    return _user_edit_validate(arg(1), $edit);
595
596
  }

597
598
599
600
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

601
  if ($type == 'categories') {
602
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
603
  }
Dries's avatar
Dries committed
604
605
}

606
607
function user_login_block() {
  $form = array(
608
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
609
    '#id' => 'user-login-form',
610
    '#validate' => user_login_default_validators(),
611
    '#submit' => array('user_login_submit'),
612
613
614
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
615
    '#maxlength' => USERNAME_MAX_LENGTH,
616
617
618
619
620
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
621
    '#maxlength' => 60,
622
623
624
625
626
627
628
629
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
630
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
631
  }
632
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
633
634
635
636
  $form['links'] = array('#value' => theme('item_list', $items));
  return $form;
}

Dries's avatar
Dries committed
637
638
639
/**
 * Implementation of hook_block().
 */
640
function user_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
   
Dries committed
641
642
  global $user;

Dries's avatar
Dries committed
643
  if ($op == 'list') {
644
    $blocks['login']['info'] = t('User login');
645
    // Not worth caching.
646
    $blocks['login']['cache'] = BLOCK_NO_CACHE;
647

648
    $blocks['navigation']['info'] = t('Navigation');
649
650
    // Menu blocks can't be cached because each menu item can have
    // a custom access callback. menu.inc manages its own caching.
651
    $blocks['navigation']['cache'] = BLOCK_NO_CACHE;
652

653
    $blocks['new']['info'] = t('Who\'s new');
654

655
    // Too dynamic to cache.
656
657
    $blocks['online']['info'] = t('Who\'s online');
    $blocks['online']['cache'] = BLOCK_NO_CACHE;
658
    return $blocks;
659
  }
660
  else if ($op == 'configure' && $delta == 'new') {
661
662
663
664
665
666
667
668
    $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;
  }
669
  else if ($op == 'configure' && $delta == 'online') {
670
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
671
672
    $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.'));
673

674
    return $form;
675
  }
676
  else if ($op == 'save' && $delta == 'new') {
677
678
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
679
  else if ($op == 'save' && $delta == 'online') {
680
681
682
683
    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
684
685
    $block = array();

Dries's avatar
   
Dries committed
686
    switch ($delta) {
687
      case 'login':
Dries's avatar
Dries committed
688
689
        // 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
690

Dries's avatar
Dries committed
691
          $block['subject'] = t('User login');
692
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
   
Dries committed
693
        }
Dries's avatar
Dries committed
694
        return $block;
Dries's avatar
Dries committed
695

696
      case 'navigation':
697
        if ($menu = menu_tree()) {
698
699
          $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
          $block['content'] = $menu;
Dries's avatar
   
Dries committed
700
        }
701
        return $block;
Dries's avatar
Dries committed
702

703
      case 'new':
704
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
705
          // Retrieve a list of new users who have subsequently accessed the site successfully.
706
          $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));
707
          while ($account = db_fetch_object($result)) {
708
            $items[] = $account;
709
          }
Dries's avatar
Dries committed
710
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
711

Dries's avatar
Dries committed
712
713
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
714
        }
Dries's avatar
Dries committed
715
716
        return $block;

717
      case 'online':
718
        if (user_access('access content')) {
719
          // Count users active within the defined period.
720
          $interval = time() - variable_get('user_block_seconds_online', 900);
721

722
          // Perform database queries to gather online user lists.  We use s.timestamp
723
          // rather than u.access because it is much faster.
724
          $anonymous_count = sess_count($interval);
725
          $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);
726
727
728
729
730
731
732
733
734
735
          $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
736

Dries's avatar
Dries committed
737
          // Format the output with proper grammar.
738
739
          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
740
741
          }
          else {
742
            $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
743
744
          }

745
746
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
747
          if ($authenticated_count && $max_users) {
748
749
            $output .= theme('user_list', $items, t('Online users'));
          }
750

Dries's avatar
Dries committed
751
752
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
   
Dries committed
753
        }
Dries's avatar
   
Dries committed
754
        return $block;
Dries's avatar
   
Dries committed
755
756
    }
  }
757
758
}

759
760
761
762
763
764
765
766
767
768
/**
 * 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
769
  if (variable_get('user_pictures', 0)) {
770
    $account = $variables['account'];
771
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
   
Dries committed
772
773
774
775
776
777
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

778
    if (isset($picture)) {
779
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
780
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
781
      if (!empty($account->uid) && user_access('access user profiles')) {
782
783
        $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
784
785
786
787
788
      }
    }
  }
}

789
790
/**
 * Make a list of users.
791
792
793
794
795
 *
 * @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().
796
797
798
799
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
800
801
802
803
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
804
  }
Dries's avatar
Dries committed
805
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
806
807
}

808
function user_is_anonymous() {
809
810
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
811
812
813
814
815
816
817
}

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

function user_register_access() {
818
  return user_is_anonymous() && variable_get('user_register', 1);
819
820
821
822
823
824
825
826
827
828
829
830
831
832
}

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

833
834
835
/**
 * Access callback for user account editing.
 */
836
function user_edit_access($account) {
837
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
838
839
840
841
842
843
844
}

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

Dries's avatar
   
Dries committed
845
/**
Dries's avatar
   
Dries committed
846
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
847
 */
848
849
function user_menu() {
  $items['user/autocomplete'] = array(
850
    'title' => 'User autocomplete',
851
    'page callback' => 'user_autocomplete',
852
    'access callback' => 'user_access',
853
854
855
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
   
Dries committed
856

857
  // Registration and login pages.
858
  $items['user'] = array(
859
    'title' => 'User account',
860
861
    'page callback' => 'user_page',
    'access callback' => TRUE,
862
    'type' => MENU_CALLBACK,
863
864
865
  );

  $items['user/login'] = array(
866
    'title' => 'Log in',
867
    'access callback' => 'user_is_anonymous',
868
869
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
   
Dries committed
870

871
  $items['user/register'] = array(
872
    'title' => 'Create new account',
873
874
875
876
877
878
879
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
  );

  $items['user/password'] = array(
880
    'title' => 'Request new password',
881
882
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),
883
    'access callback' => 'user_is_anonymous',
884
885
886
    'type' => MENU_LOCAL_TASK,
  );
  $items['user/reset/%/%/%'] = array(
887
    'title' => 'Reset password',
888
889
890
891
892
893
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
  );

894
  // User administration pages.
895
  $items['admin/user'] = array(
896
897
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
898
899
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
900
    'access arguments' => array('access administration pages'),
901
902
  );
  $items['admin/user/user'] = array(
903
904
    'title' => 'Users',
    'description' => 'List, add, and edit users.',
905
906
    'page callback' => 'user_admin',
    'page arguments' => array('list'),
907
908
    'access arguments' => array('administer users'),
  );
909
  $items['admin/user/user/list'] = array(
910
    'title' => 'List',
911
912
913
914
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/user/create'] = array(
915