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

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

9
10
11
define('USERNAME_MAX_LENGTH', 60);
define('EMAIL_MAX_LENGTH', 64);

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

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

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

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

91
/**
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 * 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()) {
107
108
  $form = drupal_get_form('user_login');

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

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

139
140
141
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }
142
143
144
  elseif (!is_array($array)) {
    return FALSE;
  }
145

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

162
  if ($user = db_fetch_object($result)) {
163
    $user = drupal_unpack($user);
Dries's avatar
   
Dries committed
164

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

  return $user;
}

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

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

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

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

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

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

256
    // Refresh user object
Dries's avatar
   
Dries committed
257
    $user = user_load(array('uid' => $account->uid));
258
259
260
261
262
263
264
265

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

266
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
   
Dries committed
267
268
  }
  else {
269
    if (!isset($array['created'])) {    // Allow 'created' to be set by the caller
270
271
272
      $array['created'] = time();
    }

273
274
275
    // 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
276
    foreach ($array as $key => $value) {
277
      switch ($key) {
278
279
280
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
   
Dries committed
281
          $s[] = "'%s'";
Dries's avatar
Dries committed
282
          break;
283
        case 'mode':       case 'sort':     case 'timezone':
284
285
286
287
288
289
290
291
292
293
294
295
296
        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
297
298
      }
    }
Dries's avatar
Dries committed
299
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
300
    $array['uid'] = db_last_insert_id('users', 'uid');
Dries's avatar
   
Dries committed
301

302
303
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
304

305
306
307
308
309
    user_module_invoke('insert', $array, $user, $category);

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

316
    // Save user roles (delete just to be safe).
317
    if (isset($array['roles']) && is_array($array['roles'])) {
318
319
320
321
322
      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);
        }
323
324
325
      }
    }

326
327
    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
   
Dries committed
328
329
  }

330
  // Save distributed authentication mappings
331
  $authmaps = array();
Dries's avatar
   
Dries committed
332
  foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
333
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
   
Dries committed
334
335
336
      $authmaps[$key] = $value;
    }
  }
337
  if (sizeof($authmaps) > 0) {
Dries's avatar
   
Dries committed
338
    user_set_authmaps($user, $authmaps);
Dries's avatar
   
Dries committed
339
340
341
342
343
  }

  return $user;
}

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

function user_validate_mail($mail) {
Dries's avatar
Dries committed
370
  if (!$mail) return t('You must enter an e-mail address.');
371
  if (!valid_email_address($mail)) {
372
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
   
Dries committed
373
374
375
  }
}

376
function user_validate_picture(&$form, &$form_state) {
377
  // If required, validate the uploaded picture.
378
379
380
381
382
383
384
  $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
385
    // files table as a temporary file. We'll make a copy and let the garbage
386
    // collector delete the original upload.
387
    $info = image_get_info($file->filepath);
388
389
    $destination = variable_get('user_picture_path', 'pictures') .'/picture-'. $form['#uid'] .'.'. $info['extension'];
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
390
      $form_state['values']['picture'] = $file->filepath;
391
    }
392
393
    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'))));
394
    }
Dries's avatar
   
Dries committed
395
396
397
  }
}

Dries's avatar
Dries committed
398
399
400
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
   
Dries committed
401
402
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
403
404
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
405
406
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
407

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

Dries's avatar
Dries committed
411
412
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
413

Dries's avatar
Dries committed
414
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
415
416
417
418
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
423
424
}

Dries's avatar
Dries committed
425
426
427
428
429
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
430
431
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
432
433
434
435
 * @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
436
437
 *
 * @return
438
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
439
440
441
442
443
 *
 * 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.
 */
444
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
   
Dries committed
445
  global $user;
Dries's avatar
   
Dries committed
446
  static $perm = array();
Dries's avatar
   
Dries committed
447

448
449
450
451
  if ($reset) {
    unset($perm);
  }

452
453
454
455
  if (is_null($account)) {
    $account = $user;
  }

456
  // User #1 has all privileges:
457
  if ($account->uid == 1) {
458
    return TRUE;
Dries's avatar
   
Dries committed
459
460
  }

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

466
    $perms = array();
Dries's avatar
   
Dries committed
467
    while ($row = db_fetch_object($result)) {
468
      $perms += array_flip(explode(', ', $row->perm));
Dries's avatar
   
Dries committed
469
    }
470
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
471
  }
472

473
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
474
475
}

476
477
478
/**
 * Checks for usernames blocked by user administration
 *
479
 * @return boolean TRUE for blocked users, FALSE for active
480
481
 */
function user_is_blocked($name) {
482
  $deny  = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
483

484
  return $deny;
485
486
}

Dries's avatar
   
Dries committed
487
488
function user_fields() {
  static $fields;
Dries's avatar
   
Dries committed
489

Dries's avatar
   
Dries committed
490
  if (!$fields) {
Dries's avatar
Dries committed
491
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
492
493
    if ($field = db_fetch_array($result)) {
      $fields = array_keys($field);
Kjartan's avatar
Kjartan committed
494
    }
Dries's avatar
   
Dries committed
495
496
    else {
      // Make sure we return the default fields at least
497
      $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
498
    }
Dries's avatar
   
Dries committed
499
  }
Dries's avatar
   
Dries committed
500

Dries's avatar
   
Dries committed
501
  return $fields;
Dries's avatar
   
Dries committed
502
503
}

Dries's avatar
Dries committed
504
505
506
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
507
function user_perm() {
508
  return array('administer permissions', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
   
Dries committed
509
510
}

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

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

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

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

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

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

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

607
608
function user_login_block() {
  $form = array(
609
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
610
    '#id' => 'user-login-form',
611
    '#validate' => user_login_default_validators(),
612
    '#submit' => array('user_login_submit'),
613
614
615
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
616
    '#maxlength' => USERNAME_MAX_LENGTH,
617
618
619
620
621
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
622
    '#maxlength' => 60,
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
    '#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
638
639
640
/**
 * Implementation of hook_block().
 */
641
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
642
643
  global $user;

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

Dries's avatar
Dries committed
649
     $blocks[1]['info'] = t('Navigation');
650
651
652
653
      // 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
654
     $blocks[2]['info'] = t('Who\'s new');
655

656
657
658
     // Too dynamic to cache.
     $blocks[3]['info'] = t('Who\'s online');
     $blocks[3]['cache'] = BLOCK_NO_CACHE;
659
     return $blocks;
660
  }
661
662
663
664
665
666
667
668
669
  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;
  }
670
671
  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');
672
673
    $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.'));
674

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

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

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

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

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

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

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

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

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

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

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

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

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

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

833
function user_edit_access($account) {
834
  return ($GLOBALS['user']->uid == $account->uid) || user_access('administer users');
835
836
837
838
839
840
841
}

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

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

855
  // Registration and login pages.
856
  $items['user'] = array(
857
    'title' => 'Log in',
858
859
    'page callback' => 'user_page',
    'access callback' => TRUE,
860
    'type' => MENU_CALLBACK,
861
    'file' => 'user.pages.inc',
862
863
864
  );

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

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

  $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
    'type' => MENU_LOCAL_TASK,
885
    'file' => 'user.pages.inc',
886
887
  );
  $items['user/reset/%/%/%'] = array(
888
    'title' => 'Reset password',
889
890
891
892
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
893
    'file' => 'user.pages.inc',
894
895
896
897
  );

  // Admin user pages
  $items['admin/user'] = array(
898
899
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
900
901
902
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
903
904
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
905
906
  );
  $items['admin/user/user'] = array(
907
908
    'title' => 'Users',
    'description' => 'List, add, and edit users.',
909
910
    'page callback' => 'user_admin',
    'page arguments' => array('list'),
911
912
913
    'access arguments' => array('administer users'),
    'file' => 'user.admin.inc',
  );
914
  $items['admin/user/user/list'] = array(
915
    'title' => 'List',
916
917
918
919
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/user/create'] = array(
920
    'title' => 'Add user',
921
922
    'page arguments' => array('create'),
    'type' => MENU_LOCAL_TASK,
923
    'file' => 'user.admin.inc',
924
925
  );
  $items['admin/user/settings'] = array(
926
927
    'title' => 'User settings',
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, and user pictures.',
928
929
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_settings'),
930
    'file' => 'user.admin.inc',
931
932
933
  );

  // Admin access pages
934
935
  $items['admin/user/permissions'] = array(
    'title' => 'Permissions',