user.module 130 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
40
41
    ),
    'user_profile_category' => array(
      'arguments' => array('element' => NULL),
42
      'template' => 'user-profile-category',
43
44
45
    ),
    'user_profile_item' => array(
      'arguments' => array('element' => NULL),
46
      'template' => 'user-profile-item',
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    ),
    'user_list' => array(
      'arguments' => array('users' => NULL, 'title' => NULL),
    ),
    'user_admin_perm' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_admin_new_role' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_admin_account' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_filter_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_filters' => array(
      'arguments' => array('form' => NULL),
    ),
66
67
68
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
69
70
71
  );
}

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

75
  if ($user = db_fetch_array($result)) {
Dries's avatar
   
Dries committed
76
    return user_load($user);
Dries's avatar
   
Dries committed
77
78
79
80
81
82
  }
  else {
    return 0;
  }
}

83
/**
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 * Perform standard Drupal login operations for a user object.  The
 * user object must already be authenticated. This function verifies
 * 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.
 * @return boolean
 *    TRUE if the login succeeds, FALSE otherwise.
 */
function user_external_login($account, $edit = array()) {
99
100
  $form = drupal_get_form('user_login');

101
102
103
104
105
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

106
107
108
109
110
111
112
113
114
115
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
    return FALSE;
  }
  global $user;
  $user = $account;
  user_login_submit($form, $state, (array)$account);
  return TRUE;
}

Dries's avatar
Dries committed
116
117
118
119
120
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
121
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
122
123
 *
 * @return
124
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
Dries's avatar
Dries committed
125
 */
Dries's avatar
   
Dries committed
126
function user_load($array = array()) {
Dries's avatar
Dries committed
127
  // Dynamically compose a SQL query:
128
  $query = array();
129
  $params = array();
130

131
132
133
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }
134
135
136
  elseif (!is_array($array)) {
    return FALSE;
  }
137

Dries's avatar
   
Dries committed
138
  foreach ($array as $key => $value) {
139
140
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
141
      $params[] = $value;
142
    }
143
144
145
146
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
   
Dries committed
147
    else {
148
      $query[]= "LOWER($key) = LOWER('%s')";
149
      $params[] = $value;
Dries's avatar
   
Dries committed
150
151
    }
  }
152
  $result = db_query('SELECT * FROM {users} u WHERE '. implode(' AND ', $query), $params);
Dries's avatar
   
Dries committed
153

154
  if ($user = db_fetch_object($result)) {
155
    $user = drupal_unpack($user);
Dries's avatar
   
Dries committed
156

157
    $user->roles = array();
158
159
160
161
162
163
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
164
165
166
167
    $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;
    }
168
    user_module_invoke('load', $array, $user);
169
170
  }
  else {
171
    $user = FALSE;
Dries's avatar
   
Dries committed
172
  }
Dries's avatar
   
Dries committed
173
174
175
176

  return $user;
}

177
/**
178
 * Save changes to a user account or add a new user.
179
180
 *
 * @param $account
181
182
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
183
184
185
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
186
 *   Setting a field to NULL deletes it from the data column.
187
188
189
190
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
191
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
192
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
193
  $user_fields = user_fields();
194
  if (is_object($account) && $account->uid) {
195
    user_module_invoke('update', $array, $account, $category);
196
197
198
199
200
    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, $account);
    }
201
    $query = '';
Dries's avatar
Dries committed
202
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
Dries's avatar
   
Dries committed
203
    foreach ($array as $key => $value) {
204
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
   
Dries committed
205
206
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
   
Dries committed
207
      }
208
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
209
        if (in_array($key, $user_fields)) {
210
          // Save standard fields
Dries's avatar
   
Dries committed
211
212
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
   
Dries committed
213
        }
Dries's avatar
   
Dries committed
214
        else if ($key != 'roles') {
215
          // Roles is a special case: it used below.
216
          if ($value === NULL) {
217
218
219
220
221
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
   
Dries committed
222
        }
Dries's avatar
   
Dries committed
223
224
      }
    }
225
    $query .= "data = '%s' ";
Dries's avatar
   
Dries committed
226
    $v[] = serialize($data);
Dries's avatar
   
Dries committed
227

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

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

234
      foreach (array_keys($array['roles']) as $rid) {
235
236
237
        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);
        }
238
      }
Dries's avatar
   
Dries committed
239
240
    }

241
    // Delete a blocked user's sessions to kick them if they are online.
242
    if (isset($array['status']) && $array['status'] == 0) {
243
      sess_destroy_uid($account->uid);
244
245
    }

246
247
    // If the password changed, delete all open sessions and recreate
    // the current one.
248
    if (!empty($array['pass'])) {
249
250
251
252
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

253
    // Refresh user object
Dries's avatar
   
Dries committed
254
    $user = user_load(array('uid' => $account->uid));
255
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
   
Dries committed
256
257
  }
  else {
258
    if (!isset($array['created'])) {    // Allow 'created' to be set by the caller
259
260
261
      $array['created'] = time();
    }

262
263
264
    // 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
265
    foreach ($array as $key => $value) {
266
      switch ($key) {
267
268
269
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
   
Dries committed
270
          $s[] = "'%s'";
Dries's avatar
Dries committed
271
          break;
272
        case 'mode':       case 'sort':     case 'timezone':
273
274
275
276
277
278
279
280
281
282
283
284
285
        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
286
287
      }
    }
Dries's avatar
Dries committed
288
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
289
    $array['uid'] = db_last_insert_id('users', 'uid');
Dries's avatar
   
Dries committed
290

291
292
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
293

294
295
296
297
298
    user_module_invoke('insert', $array, $user, $category);

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

305
    // Save user roles (delete just to be safe).
306
    if (isset($array['roles']) && is_array($array['roles'])) {
307
308
309
310
311
      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);
        }
312
313
314
      }
    }

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

319
  // Save distributed authentication mappings
320
  $authmaps = array();
Dries's avatar
   
Dries committed
321
  foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
322
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
   
Dries committed
323
324
325
      $authmaps[$key] = $value;
    }
  }
326
  if (sizeof($authmaps) > 0) {
Dries's avatar
   
Dries committed
327
    user_set_authmaps($user, $authmaps);
Dries's avatar
   
Dries committed
328
329
330
331
332
  }

  return $user;
}

Dries's avatar
Dries committed
333
334
335
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
336
function user_validate_name($name) {
337
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
338
339
  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.');
340
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
341
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
342
343
344
345
346
347
348
  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
349
350
                   '\x{FFF9}-\x{FFFD}'.      // Replacement characters
                   '\x{0}]/u',               // NULL byte
351
352
353
                   $name)) {
    return t('The username contains an illegal character.');
  }
354
  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.');
355
  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
356
357
358
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
359
  if (!$mail) return t('You must enter an e-mail address.');
360
  if (!valid_email_address($mail)) {
361
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
   
Dries committed
362
363
364
  }
}

365
function user_validate_picture(&$form, &$form_state) {
366
  // If required, validate the uploaded picture.
367
368
369
370
371
372
373
  $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)) {
    // The image was saved using file_save_upload() and was added to the
Dries's avatar
Dries committed
374
    // files table as a temporary file. We'll make a copy and let the garbage
375
    // collector delete the original upload.
376
    $info = image_get_info($file->filepath);
377
378
    $destination = variable_get('user_picture_path', 'pictures') .'/picture-'. $form['#uid'] .'.'. $info['extension'];
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
379
      $form_state['values']['picture'] = $file->filepath;
380
    }
381
382
    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'))));
383
    }
Dries's avatar
   
Dries committed
384
385
386
  }
}

Dries's avatar
Dries committed
387
388
389
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
   
Dries committed
390
391
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
392
393
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
394
395
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
396

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

Dries's avatar
Dries committed
400
401
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
402

Dries's avatar
Dries committed
403
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
404
405
406
407
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
412
413
}

Dries's avatar
Dries committed
414
415
416
417
418
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
419
420
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
421
422
 *
 * @return
423
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
424
425
426
427
428
 *
 * 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.
 */
Dries's avatar
   
Dries committed
429
function user_access($string, $account = NULL) {
Dries's avatar
   
Dries committed
430
  global $user;
Dries's avatar
   
Dries committed
431
  static $perm = array();
Dries's avatar
   
Dries committed
432

433
434
435
436
  if (is_null($account)) {
    $account = $user;
  }

437
  // User #1 has all privileges:
438
  if ($account->uid == 1) {
439
    return TRUE;
Dries's avatar
   
Dries committed
440
441
  }

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

Steven Wittens's avatar
Steven Wittens committed
447
    $perm[$account->uid] = '';
Dries's avatar
   
Dries committed
448
    while ($row = db_fetch_object($result)) {
449
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
   
Dries committed
450
    }
Dries's avatar
   
Dries committed
451
  }
452

453
  if (isset($perm[$account->uid])) {
454
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
455
  }
456

457
  return FALSE;
Dries's avatar
   
Dries committed
458
459
}

460
461
462
/**
 * Checks for usernames blocked by user administration
 *
463
 * @return boolean TRUE for blocked users, FALSE for active
464
465
 */
function user_is_blocked($name) {
466
  $deny  = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
467

468
  return $deny;
469
470
}

Dries's avatar
   
Dries committed
471
472
function user_fields() {
  static $fields;
Dries's avatar
   
Dries committed
473

Dries's avatar
   
Dries committed
474
  if (!$fields) {
Dries's avatar
Dries committed
475
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
476
477
    if ($field = db_fetch_array($result)) {
      $fields = array_keys($field);
Kjartan's avatar
Kjartan committed
478
    }
Dries's avatar
   
Dries committed
479
480
    else {
      // Make sure we return the default fields at least
481
      $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
482
    }
Dries's avatar
   
Dries committed
483
  }
Dries's avatar
   
Dries committed
484

Dries's avatar
   
Dries committed
485
  return $fields;
Dries's avatar
   
Dries committed
486
487
}

Dries's avatar
Dries committed
488
489
490
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
491
function user_perm() {
492
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
   
Dries committed
493
494
}

Dries's avatar
Dries committed
495
496
497
498
499
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
   
Dries committed
500
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
501
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
502
503
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
   
Dries committed
504
505
506
  }
}

Dries's avatar
Dries committed
507
508
509
/**
 * Implementation of hook_search().
 */
510
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
511
512
  switch ($op) {
    case 'name':
513
      if ($skip_access_check || user_access('access user profiles')) {
514
        return t('Users');
515
      }
516
    case 'search':
517
518
519
520
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
521
522
523
524
        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)) {
525
            $find[] = array('title' => $account->name .' ('. $account->mail .')', 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
526
527
528
          }
        }
        else {
529
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
530
          while ($account = db_fetch_object($result)) {
531
            $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
532
          }
533
534
        }
        return $find;
535
      }
Dries's avatar
   
Dries committed
536
537
538
  }
}

Dries's avatar
Dries committed
539
540
541
542
543
544
545
546
547
548
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
549
550
551
/**
 * Implementation of hook_user().
 */
552
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
553
  if ($type == 'view') {
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
    $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'),
      '#value' => format_interval(time() - $account->created),
571
    );
Dries's avatar
Dries committed
572
  }
573
  if ($type == 'form' && $category == 'account') {
574
575
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
576
577
578
  }

  if ($type == 'validate' && $category == 'account') {
579
    return _user_edit_validate(arg(1), $edit);
580
581
  }

582
583
584
585
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

586
  if ($type == 'categories') {
587
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
588
  }
Dries's avatar
Dries committed
589
590
}

591
592
function user_login_block() {
  $form = array(
593
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
594
    '#id' => 'user-login-form',
595
    '#validate' => user_login_default_validators(),
596
    '#submit' => array('user_login_submit'),
597
598
599
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
600
    '#maxlength' => USERNAME_MAX_LENGTH,
601
602
603
604
605
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
606
    '#maxlength' => 60,
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
    '#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
622
623
624
/**
 * Implementation of hook_block().
 */
625
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
626
627
  global $user;

Dries's avatar
Dries committed
628
629
  if ($op == 'list') {
     $blocks[0]['info'] = t('User login');
630
631
632
     // Not worth caching.
     $blocks[0]['cache'] = BLOCK_NO_CACHE;

Dries's avatar
Dries committed
633
     $blocks[1]['info'] = t('Navigation');
634
635
636
637
      // 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;

Dries's avatar
Dries committed
638
     $blocks[2]['info'] = t('Who\'s new');
639

640
641
642
     // Too dynamic to cache.
     $blocks[3]['info'] = t('Who\'s online');
     $blocks[3]['cache'] = BLOCK_NO_CACHE;
643
     return $blocks;
644
  }
645
646
647
648
649
650
651
652
653
  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;
  }
654
655
  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');
656
657
    $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.'));
658

659
    return $form;
660
  }
661
662
663
  else if ($op == 'save' && $delta == 2) {
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
664
665
666
667
668
  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
669
670
    $block = array();

Dries's avatar
   
Dries committed
671
672
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
673
674
        // 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
675

Dries's avatar
Dries committed
676
          $block['subject'] = t('User login');
677
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
   
Dries committed
678
        }
Dries's avatar
Dries committed
679
        return $block;
Dries's avatar
Dries committed
680

681
      case 1:
682
        if ($menu = menu_tree()) {
Dries's avatar
Dries committed
683
           $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
684
           $block['content'] = $menu;
Dries's avatar
   
Dries committed
685
        }
686
        return $block;
Dries's avatar
Dries committed
687

Dries's avatar
   
Dries committed
688
      case 2:
689
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
690
          // Retrieve a list of new users who have subsequently accessed the site successfully.
691
          $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));
692
          while ($account = db_fetch_object($result)) {
693
            $items[] = $account;
694
          }
Dries's avatar
Dries committed
695
          $output = theme('user_list', $items);
Dries's avatar
   
Dries committed
696

Dries's avatar
Dries committed
697
698
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
699
        }
Dries's avatar
Dries committed
700
701
        return $block;

Dries's avatar
   
Dries committed
702
      case 3:
703
        if (user_access('access content')) {
704
          // Count users active within the defined period.
705
          $interval = time() - variable_get('user_block_seconds_online', 900);
706

707
          // Perform database queries to gather online user lists.  We use s.timestamp
708
          // rather than u.access because it is much faster.
709
          $anonymous_count = sess_count($interval);
710
          $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);
711
712
713
714
715
716
717
718
719
720
          $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
721

Dries's avatar
Dries committed
722
          // Format the output with proper grammar.
723
724
          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
725
726
          }
          else {
727
            $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
728
729
          }

730
731
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
732
          if ($authenticated_count && $max_users) {
733
734
            $output .= theme('user_list', $items, t('Online users'));
          }
735

Dries's avatar
Dries committed
736
737
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
   
Dries committed
738
        }
Dries's avatar
   
Dries committed
739
        return $block;
Dries's avatar
   
Dries committed
740
741
    }
  }
742
743
}

744
745
746
747
748
749
750
751
752
753
/**
 * 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
754
  if (variable_get('user_pictures', 0)) {
755
    $account = $variables['account'];
756
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
   
Dries committed
757
758
759
760
761
762
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

763
    if (isset($picture)) {
764
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
765
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
766
      if (!empty($account->uid) && user_access('access user profiles')) {
767
768
        $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
769
770
771
772
773
      }
    }
  }
}

774
775
/**
 * Make a list of users.
776
777
778
779
780
 *
 * @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().
781
782
783
784
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
785
786
787
788
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
789
  }
Dries's avatar
Dries committed
790
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
791
792
}

793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
/**
 * Process variables for user-profile.tpl.php.
 *
 * The $variables array contains the following arguments:
 * - $account
 *
 * @see user-picture.tpl.php
 */
function template_preprocess_user_profile(&$variables) {
  $variables['profile'] = array();
  // Provide keyed variables so themers can print each section independantly.
  foreach (element_children($variables['account']->content) as $key) {
    $variables['profile'][$key] = drupal_render($variables['account']->content[$key]);
  }
  // Collect all profiles to make it easier to print all items at once.
  $variables['user_profile'] = implode($variables['profile']);
}

/**
 * Process variables for user-profile-item.tpl.php.
 *
 * The $variables array contains the following arguments:
 * - $element
 *
 * @see user-profile-item.tpl.php
 */
function template_preprocess_user_profile_item(&$variables) {
  $variables['title'] = $variables['element']['#title'];
  $variables['value'] = $variables['element']['#value'];
  $variables['attributes'] = '';
  if (isset($variables['element']['#attributes'])) {
    $variables['attributes'] = drupal_attributes($variables['element']['#attributes']);
  }
}

/**
 * Process variables for user-profile-category.tpl.php.
 *
 * The $variables array contains the following arguments:
 * - $element
 *
 * @see user-profile-category.tpl.php
 */
function template_preprocess_user_profile_category(&$variables) {
  $variables['title'] = $variables['element']['#title'];
  $variables['profile_items'] = $variables['element']['#children'];
  $variables['attributes'] = '';
  if (isset($variables['element']['#attributes'])) {
    $variables['attributes'] = drupal_attributes($variables['element']['#attributes']);
  }
}

845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
function user_is_anonymous() {
  return !$GLOBALS['user']->uid;
}

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

function user_register_access() {
  return !$GLOBALS['user']->uid && variable_get('user_register', 1);
}

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

869
function user_edit_access($account) {
870
  return ($GLOBALS['user']->uid == $account->uid) || user_access('administer users');
871
872
873
874
875
876
877
}

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

Dries's avatar
   
Dries committed
878
/**
Dries's avatar
   
Dries committed
879
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
880
 */
881
882
function user_menu() {
  $items['user/autocomplete'] = array(
883
    'title' => 'User autocomplete',
884
    'page callback' => 'user_autocomplete',
885
    'access callback' => 'user_access',
886
887
888
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
   
Dries committed
889

890
  // Registration and login pages.
891
  $items['user'] = array(
892
    'title' => 'Log in',
893
894
    'page callback' => 'user_page',
    'access callback' => TRUE,
895
    'type' => MENU_CALLBACK,
896
897
898
  );

  $items['user/login'] = array(
899
    'title' => 'Log in',
900
901
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
   
Dries committed
902

903
  $items['user/register'] = array(
904
    'title' => 'Create new account',
905
906
907
908
909
910
911
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
  );

  $items['user/password'] = array(
912
    'title' => 'Request new password',
913
914
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),
915
    'access callback' => 'user_is_anonymous',
916
917
918
    'type' => MENU_LOCAL_TASK,
  );
  $items['user/reset/%/%/%'] = array(
919
    'title' => 'Reset password',
920
921
922
923
924
925
926
927
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
  );

  // Admin user pages
  $items['admin/user'] = array(
928
929
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
930
931
932
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
933
934
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
935
936
  );
  $items['admin/user/user'] = array(
937
938
    'title' => 'Users',
    'description' => 'List, add, and edit users.',
939
940
941
942
    'page callback' => 'user_admin',
    'page arguments' => array('list'),
    'access arguments' => array('administer users'));
  $items['admin/user/user/list'] = array(
943
    'title' => 'List',
944
945
946
947
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/user/create'] = array(
948
    'title' => 'Add user',
949
950
951
952
    'page arguments' => array('create'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/settings'] = array(
953
954
    'title' => 'User settings',
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, and user pictures.',
955
956
957
958
959
960
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_settings'),
  );

  // Admin access pages
  $items['admin/user/access'] = array(
961
962
    'title' => 'Access control',
    'description' => 'Determine access to features by selecting permissions for roles.',
963
964
965
966
967
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_perm'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles'] = array(
968
969
    'title' => 'Roles',
    'description' => 'List, edit, or add user roles.',
970
971
972
973
974
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_new_role'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles/edit'] = array(
975
    'title' => 'Edit role',
976
977
978
979
    'page arguments' => array('user_admin_role'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/rules'] = array(
980
981
    'title' => 'Access rules',
    'description' => 'List and create rules to disallow usernames, e-mail addresses, and IP addresses.',
982
983
984
985
    'page callback' => 'user_admin_access',
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/rules/list'] = array(
986
    'title' => 'List',
987
988
989
990
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/rules/add'] = array(
991
    'title' => 'Add rule',
992
993
994
995
    'page callback' => 'user_admin_access_add',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/rules/check'] = array(
996
    'title' => 'Check rules',
997
998
999
1000
    'page callback' => 'user_admin_access_check',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/rules/edit'] = array(
1001
    'title' => 'Edit rule',