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

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

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

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

19

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

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

Dries's avatar
   
Dries committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/**
 * Implementation of hook_fieldable_info().
 */
function user_fieldable_info() {
  $return = array(
    'user' => array(
      'name' => t('User'),
      'id key' => 'uid',
    ),
  );
  return $return;
}

/**
 * Implementation of hook_field_build_modes().
 */
function user_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'user') {
    $modes = array(
      'full' => t('User account'),
    );
  }
  return $modes;
}

Dries's avatar
   
Dries committed
112
function user_external_load($authname) {
113
  $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField();
Dries's avatar
   
Dries committed
114

115
116
  if ($uid) {
    return user_load($uid);
Dries's avatar
   
Dries committed
117
118
  }
  else {
119
    return FALSE;
Dries's avatar
   
Dries committed
120
121
122
  }
}

123
/**
124
125
126
 * Perform standard Drupal login operations for a user object.
 *
 * The user object must already be authenticated. This function verifies
127
 * that the user account is not blocked and then performs the login,
128
 * updates the login timestamp in the database, invokes hook_user('login'),
129
 * and regenerates the session.
130
131
132
133
134
135
 *
 * @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.
136
 *    This array is passed to hook_user op login.
137
138
139
140
 * @return boolean
 *    TRUE if the login succeeds, FALSE otherwise.
 */
function user_external_login($account, $edit = array()) {
141
  $form = drupal_render(drupal_get_form('user_login'));
142

143
144
145
146
147
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

148
  // Check if user is blocked.
149
150
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
151
    // Invalid login.
152
153
    return FALSE;
  }
154

155
  // Valid login.
156
157
  global $user;
  $user = $account;
158
  user_authenticate_finalize($state['values']);
159
160
161
  return TRUE;
}

Dries's avatar
Dries committed
162
/**
163
 * Load multiple users based on certain conditions.
Dries's avatar
Dries committed
164
 *
165
166
167
 * This function should be used whenever you need to load more than one user
 * from the database. Users are loaded into memory and will not require
 * database access if loaded again during the same page request.
Dries's avatar
Dries committed
168
 *
169
170
171
172
173
174
175
176
 * @param $uids
 *   An array of user IDs.
 * @param $conditions
 *   An array of conditions to match against the {users} table. These
 *   should be supplied in the form array('field_name' => 'field_value').
 * @param $reset
 *   A boolean indicating that the internal cache should be reset. Use this if
 *   loading a user object which has been altered during the page request.
177
 * @return
178
179
180
181
182
 *   An array of user objects, indexed by uid.
 *
 * @see user_load()
 * @see user_load_by_mail()
 * @see user_load_by_name()
Dries's avatar
Dries committed
183
 */
184
185
186
187
function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
  static $user_cache = array();
  if ($reset) {
    $user_cache = array();
188
  }
189

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
  $users = array();

  // Create a new variable which is either a prepared version of the $uids
  // array for later comparison with the user cache, or FALSE if no $uids were
  // passed. The $uids array is reduced as items are loaded from cache, and we
  // need to know if it's empty for this reason to avoid querying the database
  // when all requested users are loaded from cache.
  $passed_uids = !empty($uids) ? array_flip($uids) : FALSE;

  // Load any available users from the internal cache.
  if ($user_cache) {
    if ($uids && !$conditions) {
      $users += array_intersect_key($user_cache, $passed_uids);
      // If any users were loaded, remove them from the $uids still to load.
      $uids = array_keys(array_diff_key($passed_uids, $users));
Dries's avatar
   
Dries committed
205
206
207
    }
  }

208
209
210
211
  // Load any remaining users from the database, this is necessary if we have
  // $uids still to load, or if $conditions was passed without $uids.
  if ($uids || ($conditions && !$passed_uids)) {
    $query = db_select('users', 'u')->fields('u');
Dries's avatar
   
Dries committed
212

213
214
215
    // If the $uids array is populated, add those to the query.
    if ($uids) {
      $query->condition('u.uid', $uids, 'IN');
216
    }
217
218
    // If the conditions array is populated, add those to the query.
    if ($conditions) {
219
220
      // TODO D7: Using LIKE() to get a case insensitive comparison because Crell
      // and chx promise that dbtng will map it to ILIKE in postgres.
221
      if (isset($conditions['name'])) {
222
        $query->condition('u.name', $conditions['name'], 'LIKE');
223
224
225
        unset($conditions['name']);
      }
      if (isset($conditions['mail'])) {
226
        $query->condition('u.mail', $conditions['mail'], 'LIKE');
227
228
229
230
231
        unset($conditions['mail']);
      }
      foreach ($conditions as $field => $value) {
        $query->condition('u.' . $field, $value);
      }
232
    }
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
    $result = $query->execute();

    $queried_users = array();
    // Build an array of user picture IDs so that these can be fetched later.
    $picture_fids = array();
    foreach ($result as $record) {
      $picture_fids[] = $record->picture;
      $queried_users[$record->uid] = drupal_unpack($record);
      $queried_users[$record->uid]->roles = array();
      if ($record->uid) {
        $queried_users[$record->uid]->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
      }
      else {
        $queried_users[$record->uid]->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
      }
248
    }
249

250
251
252
253
254
255
    if (!empty($queried_users)) {
      // Add any additional roles from the database.
      $result = db_query('SELECT r.rid, r.name, ur.uid FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid IN (:uids)', array(':uids' => array_keys($queried_users)));
      foreach ($result as $record) {
        $queried_users[$record->uid]->roles[$record->rid] = $record->name;
      }
Dries's avatar
   
Dries committed
256

257
258
259
260
261
262
263
264
265
266
267
268
269
      // Add the full file objects for user pictures if enabled.
      if (!empty($picture_fids) && variable_get('user_pictures', 1) == 1) {
        $pictures = file_load_multiple($picture_fids);
        foreach ($queried_users as $account) {
          if (!empty($account->picture) && isset($pictures[$account->picture])) {
            $account->picture = $pictures[$account->picture];
          }
          else {
            $account->picture = NULL;
          }
        }
      }

270
271
      field_attach_load('user', $queried_users);

272
273
274
275
276
277
      // Invoke hook_user_load() on the users loaded from the database
      // and add them to the static cache.
      foreach (module_implements('user_load') as $module) {
        $function = $module . '_user_load';
        $function($queried_users);
      }
278

279

280
281
282
283

      $users = $users + $queried_users;
      $user_cache = $user_cache + $queried_users;
    }
284
  }
285
286
287
288
289
290
291
292
293
294

  // Ensure that the returned array is ordered the same as the original $uids
  // array if this was passed in and remove any invalid uids.
  if ($passed_uids) {
    // Remove any invalid uids from the array.
    $passed_uids = array_intersect_key($passed_uids, $users);
    foreach ($users as $user) {
      $passed_uids[$user->uid] = $user;
    }
    $users = $passed_uids;
Dries's avatar
   
Dries committed
295
  }
Dries's avatar
   
Dries committed
296

297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
  return $users;
}


/**
 * Fetch a user object.
 *
 * @param $uid
 *   Integer specifying the user id.
 * @param $reset
 *   A boolean indicating that the internal cache should be reset.
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load($uid, $reset = FALSE) {
  $users = user_load_multiple(array($uid), array(), $reset);
  return reset($users);
}

/**
 * Fetch a user object by email address.
 *
 * @param $mail
 *   String with the account's e-mail address.
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load_by_mail($mail) {
  $users = user_load_multiple(array(), array('mail' => $mail));
  return reset($users);
}

/**
 * Fetch a user object by account name.
 *
 * @param $name
 *   String with the account's user name.
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
 *
 * @see user_load_multiple()
 */
function user_load_by_name($name) {
  $users = user_load_multiple(array(), array('name' => $name));
  return reset($users);
Dries's avatar
   
Dries committed
349
350
}

351
/**
352
 * Save changes to a user account or add a new user.
353
354
 *
 * @param $account
355
 *   The $user object for the user to modify or add. If $user->uid is
356
 *   omitted (or $user->is_new == TRUE), a new user will be added.
357
 *
358
 * @param $edit
359
 *   An array of fields and values to save. For example array('name'
360
 *   => 'My name'). Keys that do not belong to columns in the user-related
361
362
363
 *   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.
364
365
366
 *
 * @param $category
 *   (optional) The category for storing profile information in.
367
368
 *
 * @return
369
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
370
 */
371
function user_save($account, $edit = array(), $category = 'account') {
372
  $table = drupal_get_schema('users');
373
374
  $user_fields = $table['fields'];

375
  if (!empty($edit['pass'])) {
376
    // Allow alternate password hashing schemes.
377
    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
378
    $edit['pass'] = user_hash_password(trim($edit['pass']));
379
    // Abort if the hashing failed and returned FALSE.
380
    if (!$edit['pass']) {
381
382
      return FALSE;
    }
383
384
385
  }
  else {
    // Avoid overwriting an existing password with a blank password.
386
    unset($edit['pass']);
387
388
  }

Dries's avatar
   
Dries committed
389
390
391
392
393
394
395
396
397
398
399
400
  // Get the fields form so we can recognize the fields in the $edit
  // form that should not go into the serialized data array.
  $field_form = array();
  $field_form_state = array();
  $edit = (object) $edit;
  field_attach_form('user', $edit, $field_form, $field_form_state);

  // Presave fields.
  field_attach_presave('user', $edit);

  $edit = (array) $edit;

401
  if (!isset($account->is_new)) {
402
    $account->is_new = empty($account->uid);
403
404
  }
  if (is_object($account) && !$account->is_new) {
405
    user_module_invoke('update', $edit, $account, $category);
406
    $data = unserialize(db_query('SELECT data FROM {users} WHERE uid = :uid', array(':uid' => $account->uid))->fetchField());
407
408
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
409
    if (empty($edit['access']) && empty($account->access) && user_access('administer users')) {
410
      $edit['access'] = REQUEST_TIME;
411
    }
412
    foreach ($edit as $key => $value) {
Dries's avatar
   
Dries committed
413
      // Form fields that don't pertain to the users, user_roles, or
414
      // Field API are automatically serialized into the users.data
Dries's avatar
   
Dries committed
415
      // column.
416
      if (!in_array($key, array('roles', 'is_new')) && empty($user_fields[$key]) && empty($field_form[$key])) {
417
418
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
   
Dries committed
419
        }
420
421
        else {
          $data[$key] = $value;
Dries's avatar
   
Dries committed
422
        }
Dries's avatar
   
Dries committed
423
424
425
      }
    }

426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

    // Process picture uploads.
    if (!empty($edit['picture']->fid)) {
      $picture = $edit['picture'];
      // If the picture is a temporary file move it to its final location and
      // make it permanent.
      if (($picture->status & FILE_STATUS_PERMANENT) == 0) {
        $info = image_get_info($picture->filepath);
        $destination = file_create_path(variable_get('user_picture_path', 'pictures') . '/picture-' . $account->uid . '.' . $info['extension']);
        if ($picture = file_move($picture, $destination, FILE_EXISTS_REPLACE)) {
          $picture->status |= FILE_STATUS_PERMANENT;
          $edit['picture'] = file_save($picture);
        }
      }
    }
    $edit['picture'] = empty($edit['picture']->fid) ? 0 : $edit['picture']->fid;

443
444
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
445
    // Save changes to the user table.
446
    $success = drupal_write_record('users', $edit, 'uid');
447
    if (!$success) {
Dries's avatar
   
Dries committed
448
449
450
451
      // The query failed - better to abort the save than risk further
      // data loss.

      // TODO: Fields change: I think this is a bug.  If no columns in
452
      // the user table are changed, drupal_write_record returns
Dries's avatar
   
Dries committed
453
      // FALSE because rowCount() (rows changed) is 0.  However,
454
      // non-users data may have been changed, e.g. fields.
Dries's avatar
   
Dries committed
455
      // return FALSE;
456
    }
Dries's avatar
   
Dries committed
457

458
    // If the picture changed or was unset, remove the old one. This step needs
459
    // to occur after updating the {users} record so that user_file_references()
460
461
462
463
464
    // doesn't report it in use and block the deletion.
    if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) {
      file_delete($account->picture);
    }

465
    // Reload user roles if provided.
466
    if (isset($edit['roles']) && is_array($edit['roles'])) {
467
468
469
      db_delete('users_roles')
        ->condition('uid', $account->uid)
        ->execute();
Dries's avatar
   
Dries committed
470

471
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
472
      foreach (array_keys($edit['roles']) as $rid) {
473
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
474
475
476
477
          $query->values(array(
            'uid' => $account->uid,
            'rid' => $rid,
          ));
478
        }
479
      }
480
      $query->execute();
Dries's avatar
   
Dries committed
481
482
    }

483
    // Delete a blocked user's sessions to kick them if they are online.
484
    if (isset($edit['status']) && $edit['status'] == 0) {
485
      drupal_session_destroy_uid($account->uid);
486
487
    }

488
489
    // If the password changed, delete all open sessions and recreate
    // the current one.
490
    if (!empty($edit['pass'])) {
491
      drupal_session_destroy_uid($account->uid);
492
493
494
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
495
496
    }

Dries's avatar
   
Dries committed
497
    // Save Field data.
498
499
    $object = (object) $edit;
    field_attach_update('user', $object);
Dries's avatar
   
Dries committed
500

501
    // Refresh user object.
502
    $user = user_load($account->uid, TRUE);
503
504

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

511
    user_module_invoke('after_update', $edit, $user, $category);
Dries's avatar
   
Dries committed
512
513
  }
  else {
514
    // Allow 'created' to be set by the caller.
515
    if (!isset($edit['created'])) {
516
      $edit['created'] = REQUEST_TIME;
517
    }
518
519
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
520
    if (empty($edit['access']) && user_access('administer users')) {
521
      $edit['access'] = REQUEST_TIME;
522
    }
523

524
    $edit['mail'] = trim($edit['mail']);
525
    $success = drupal_write_record('users', $edit);
526
527
528
529
530
    if (!$success) {
      // On a failed INSERT some other existing user's uid may be returned.
      // We must abort to avoid overwriting their account.
      return FALSE;
    }
531

532
    // Build the initial user object.
533
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
   
Dries committed
534

535
536
    $object = (object) $edit;
    field_attach_insert('user', $object);
Dries's avatar
   
Dries committed
537

538
    user_module_invoke('insert', $edit, $user, $category);
539

540
541
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
542
    $data = array();
543
    foreach ($edit as $key => $value) {
544
      // Form fields that don't pertain to the users, user_roles, or
545
      // Field API are automatically serialized into the user.data
Dries's avatar
   
Dries committed
546
      // column.
547
      if ((!in_array($key, array('roles', 'is_new'))) && (empty($user_fields[$key]) && empty($field_form[$key])) && ($value !== NULL)) {
548
549
550
        $data[$key] = $value;
      }
    }
551
552
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
553
      drupal_write_record('users', $data_array, 'uid');
554
    }
555

556
    // Save user roles (delete just to be safe).
557
    if (isset($edit['roles']) && is_array($edit['roles'])) {
558
559
560
561
      db_delete('users_roles')
        ->condition('uid', $edit['uid'])
        ->execute();
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
562
      foreach (array_keys($edit['roles']) as $rid) {
563
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
564
565
566
567
          $query->values(array(
            'uid' => $edit['uid'],
            'rid' => $rid,
          ));
568
        }
569
      }
570
      $query->execute();
571
572
    }

573
    // Build the finished user object.
574
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
   
Dries committed
575
576
577
578
579
  }

  return $user;
}

Dries's avatar
Dries committed
580
581
582
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
583
function user_validate_name($name) {
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
  if (!$name) {
    return t('You must enter a username.');
  }
  if (substr($name, 0, 1) == ' ') {
    return t('The username cannot begin with a space.');
  }
  if (substr($name, -1) == ' ') {
    return t('The username cannot end with a space.');
  }
  if (strpos($name, '  ') !== FALSE) {
    return t('The username cannot contain multiple spaces in a row.');
  }
  if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)) {
    return t('The username contains an illegal character.');
  }
599
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
600
601
602
603
604
605
606
607
608
                  '\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
                  '\x{0}-\x{1F}]/u',        // NULL byte and control characters
                  $name)) {
609
610
    return t('The username contains an illegal character.');
  }
611
612
613
  if (drupal_strlen($name) > USERNAME_MAX_LENGTH) {
    return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
  }
Dries's avatar
   
Dries committed
614
615
616
}

function user_validate_mail($mail) {
617
  $mail = trim($mail);
618
619
620
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
621
  if (!valid_email_address($mail)) {
622
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
   
Dries committed
623
624
625
  }
}

626
function user_validate_picture(&$form, &$form_state) {
627
  // If required, validate the uploaded picture.
628
629
630
631
632
  $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),
  );
633

634
635
636
637
638
639
640
  // Save the file as a temporary file.
  $file = file_save_upload('picture_upload', $validators);
  if ($file === FALSE) {
    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'))));
  }
  elseif ($file !== NULL) {
    $form_state['values']['picture_upload'] = $file;
Dries's avatar
   
Dries committed
641
642
643
  }
}

Dries's avatar
Dries committed
644
645
646
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
   
Dries committed
647
648
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
649
650
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
651
  // of 'I', 1, and 'l'.
652
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
653

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

Dries's avatar
Dries committed
657
658
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
659

Dries's avatar
Dries committed
660
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
661
662
663
664
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
669
670
}

671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
/**
 * Determine the permissions for one or more roles.
 *
 * @param $roles
 *   An array whose keys are the role IDs of interest, such as $user->roles.
 * @param $reset
 *   Optional parameter - if TRUE data in the static variable is rebuilt.
 *
 * @return
 *   An array indexed by role ID. Each value is an array whose keys are the
 *   permission strings for the given role ID.
 */
function user_role_permissions($roles = array(), $reset = FALSE) {
  static $stored_permissions = array();

  if ($reset) {
    // Clear the data cached in the static variable.
    $stored_permissions = array();
  }

  $role_permissions = $fetch = array();

  if ($roles) {
    foreach ($roles as $rid => $name) {
      if (isset($stored_permissions[$rid])) {
        $role_permissions[$rid] = $stored_permissions[$rid];
      }
      else {
        // Add this rid to the list of those needing to be fetched.
        $fetch[] = $rid;
        // Prepare in case no permissions are returned.
        $stored_permissions[$rid] = array();
      }
    }

    if ($fetch) {
      // Get from the database permissions that were not in the static variable.
      // Only role IDs with at least one permission assigned will return rows.
709
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
710

711
712
      foreach ($result as $row) {
        $stored_permissions[$row->rid][$row->permission] = TRUE;
713
714
715
716
717
718
719
720
721
722
723
      }
      foreach ($fetch as $rid) {
        // For every rid, we know we at least assigned an empty array.
        $role_permissions[$rid] = $stored_permissions[$rid];
      }
    }
  }

  return $role_permissions;
}

Dries's avatar
Dries committed
724
725
726
727
728
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
729
730
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
731
732
733
734
 * @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
735
736
 *
 * @return
737
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
738
739
740
741
742
 *
 * 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.
 */
743
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
   
Dries committed
744
  global $user;
Dries's avatar
   
Dries committed
745
  static $perm = array();
Dries's avatar
   
Dries committed
746

747
  if ($reset) {
748
    $perm = array();
749
750
  }

751
752
753
754
  if (is_null($account)) {
    $account = $user;
  }

755
  // User #1 has all privileges:
756
  if ($account->uid == 1) {
757
    return TRUE;
Dries's avatar
   
Dries committed
758
759
  }

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

765
    $perms = array();
766
767
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
   
Dries committed
768
    }
769
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
770
  }
771

772
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
773
774
}

775
/**
776
 * Checks for usernames blocked by user administration.
777
 *
778
 * @return boolean TRUE for blocked users, FALSE for active.
779
780
 */
function user_is_blocked($name) {
781
  $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject();
782

783
  return $deny;
784
785
}

Dries's avatar
Dries committed
786
787
788
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
789
function user_perm() {
790
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
  return array(
    'administer permissions' =>  array(
      'title' => t('Administer permissions'),
      'description' => t('Manage the permissions assigned to user roles. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))),
    ),
    'administer users' => array(
      'title' => t('Administer users'),
      'description' => t('Manage or block users, and manage their role assignments.'),
    ),
    'access user profiles' => array(
      'title' => t('Access user profiles'),
      'description' => t('View profiles of users on the site, which may contain personal information.'),
    ),
    'change own username' => array(
      'title' => t('Change own username'),
      'description' => t('Select a different username.'),
    ),
    'cancel account' => array(
      'title' => t('Cancel account'),
      'description' => t('Remove or disable own user account and unpublish, anonymize, or remove own submissions depending on the configured <a href="@user-settings-url">user settings</a>.', array('@user-settings-url' => url('admin/user/settings'))),
    ),
    'select account cancellation method' => array(
      'title' => t('Select method for cancelling own account'),
      'description' => t('Select the method for cancelling own user account. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))),
    ),
  );
Dries's avatar
   
Dries committed
816
817
}

Dries's avatar
Dries committed
818
819
820
821
822
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
823
824
825
function user_file_download($filepath) {
  if (strpos($filepath, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info(file_create_path($filepath));
826
    return array('Content-Type' => $info['mime_type']);
Dries's avatar
   
Dries committed
827
828
829
  }
}

830
831
832
833
834
/**
 * Implementation of hook_file_references().
 */
function user_file_references($file) {
  // Determine if the file is used by this module.
835
836
  $file_used = (bool) db_query_range('SELECT 1 FROM {users} WHERE picture = :fid', array(':fid' => $file->fid), 0, 1)->fetchField();
  if ($file_used) {
837
838
839
840
841
842
843
844
845
846
    // Return the name of the module and how many references it has to the file.
    return array('user' => $count);
  }
}

/**
 * Implementation of hook_file_delete().
 */
function user_file_delete($file) {
  // Remove any references to the file.
847
  db_update('users')
848
849
850
851
852
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

Dries's avatar
Dries committed
853
854
855
/**
 * Implementation of hook_search().
 */
856
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
857
858
  switch ($op) {
    case 'name':
859
      if ($skip_access_check || user_access('access user profiles')) {
860
        return t('Users');
861
      }
862
    case 'search':
863
864
865
866
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
867
        $query = db_select('users')->extend('PagerDefault');
868
        $query->fields('users', array('name', 'uid', 'mail'));
869
870
        if (user_access('administer users')) {
          // Administrators can also search in the otherwise private email field.
871
          $query->condition(db_or()->
872
873
            where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"))->
            where('LOWER(mail) LIKE LOWER(:mail)', array(':mail' => "%$keys%")));
874
875
        }
        else {
876
877
          $query->where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"));
        }
878
879
880
        $result = $query
          ->limit(15)
          ->execute();
881
882
        foreach ($result as $account) {
          $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
883
884
        }
        return $find;
885
      }
Dries's avatar
   
Dries committed
886
887
888
  }
}

Dries's avatar
Dries committed
889
890
891
892
893
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
894
895
896
897
898
899
    'user_profile_category' => array(
      '#theme_wrapper' => 'user_profile_category'
    ),
    'user_profile_item' => array(
      '#theme' => 'user_profile_item'
    ),
Dries's avatar
Dries committed
900
901
902
  );
}

Dries's avatar
Dries committed
903
/**
904
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
905
 */
906
907
function user_user_view(&$edit, &$account, $category = NULL) {
  $account->content['user_picture'] = array(
908
    '#markup' => theme('user_picture', $account),
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
    '#weight' => -10,
  );
  if (!isset($account->content['summary'])) {
    $account->content['summary'] = array();
  }
  $account->content['summary'] += array(
    '#type' => 'user_profile_category',
    '#attributes' => array('class' => 'user-member'),
    '#weight' => 5,
    '#title' => t('History'),
  );
  $account->content['summary']['member_for'] =  array(
    '#type' => 'user_profile_item',
    '#title' => t('Member for'),
    '#markup' => format_interval(REQUEST_TIME - $account->created),
  );
}

/**
 * Implementation of hook_user_form.
 */
function user_user_form(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
932
    $form_state = array();
933
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
934
  }
935
}
936

937
/**
938
 * Implementation of hook_user_validate().
939
940
941
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
942
943
944
945
946
947
    $uid = isset($account->uid) ? $account->uid : FALSE;
    // Validate the username when: new user account; or user is editing own account and can change username; or an admin user.
    if (!$uid || ($GLOBALS['user']->uid == $uid && user_access('change own username')) || user_access('administer users')) {
      if ($error = user_validate_name($edit['name'])) {
        form_set_error('name', $error);
      }
948
      elseif ((bool) db_query_range("SELECT 1 FROM {users} WHERE uid <> :uid AND LOWER(name) = LOWER(:name)", array(':uid' => $uid, ':name' => $edit['name']), 0, 1)->fetchField()) {
949
950
951
952
        form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name'])));
      }
    }

953
    // Validate the e-mail address, and check if it is taken by an existing user.
954
955
956
    if ($error = user_validate_mail($edit['mail'])) {
      form_set_error('mail', $error);
    }
957
    elseif ((bool) db_query_range("SELECT 1 FROM {users} WHERE uid <> :uid AND LOWER(mail) = LOWER(:mail)", array(':uid' => $uid, ':mail' => $edit['mail']), 0, 1)->fetchField()) {
958
959
960
961
962
963
964
      // Format error message dependent on whether the user is logged in or not.
      if ($GLOBALS['user']->uid) {
        form_set_error('mail', t('The e-mail address %email is already taken.', array('%email' => $edit['mail'])));
      }
      else {
        form_set_error('mail', t('The e-mail address %email is already registered. <a href="@password">Have you forgotten your password?</a>', array('%email' => $edit['mail'], '@password' => url('user/password'))));
      }
965
    }
966
967
968
969
970
971
972
973
974

    // Make sure the signature isn't longer than the size of the database field.
    // Signatures are disabled by default, so make sure it exists first.
    if (isset($edit['signature'])) {
      $user_schema = drupal_get_schema('users');
      if (strlen($edit['signature']) > $user_schema['fields']['signature']['length']) {
        form_set_error('signature', t('The signature is too long: it must be %max characters or less.', array('%max' => $user_schema['fields']['signature']['length'])));
      }
    }
975
  }
976
}
977

978
/**
979
 * Implementation of hook_user_submit().
980
981
982
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
983
984
985
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
986
    // Delete picture if requested, and if no replacement picture was given.
987
988
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
989
    }
990
991
992
993
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

994
995
996
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
997
  }
998
}
999

1000
1001
1002
/**
 * Implementation of hook_user_categories.
 */
1003
function user_user_categories($edit, $account, $category = NULL) {
1004
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
1005
1006
}

1007
1008
function user_login_block() {
  $form = array(
1009
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
1010
    '#id' => 'user-login-form',
1011
    '#validate' => user_login_default_validators(),
1012
    '#submit' => array('user_login_submit'),
1013
1014
1015
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
1016
    '#maxlength' => USERNAME_MAX_LENGTH,
1017
1018
1019
1020
1021
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
1022
    '#maxlength' => 60,
1023
1024
1025
1026
1027
1028
1029
1030
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
1031
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
1032
  }
1033
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
1034
  $form['links'] = array('#markup' => theme('item_list', $items));
1035
1036
1037
  return $form;
}

Dries's avatar
Dries committed
1038
/**
1039
 * Implementation of hook_block_list().
Dries's avatar
Dries committed
1040
 */
1041
function user_block_list() {
Dries's avatar
   
Dries committed
1042
1043
  global $user;

1044
1045
1046
  $blocks['login']['info'] = t('User login');
  // Not worth caching.
  $blocks['login']['cache'] = BLOCK_NO_CACHE;
1047

1048
  $blocks['new']['info'] = t('Who\'s new');
1049

1050
1051
1052
1053
1054
  // Too dynamic to cache.
  $blocks['online']['info'] = t('Who\'s online');
  $blocks['online']['cache'] = BLOCK_NO_CACHE;
  return $blocks;
}
1055

1056
1057
1058
1059
1060
1061
/**
 * Implementation of hook_block_configure().
 */
function user_block_configure($delta = '') {
  global $user;

1062
  switch ($delta) {
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
    case 'new':