user.module 102 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
46
47
    ),
    'user_profile_category' => array(
      'arguments' => array('element' => NULL),
48
      'template' => 'user-profile-category',
49
50
51
    ),
    'user_profile_item' => array(
      'arguments' => array('element' => NULL),
52
      'template' => 'user-profile-item',
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
    ),
    '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),
    ),
72
73
74
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
75
76
77
  );
}

Dries's avatar
   
Dries committed
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * 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
104
function user_external_load($authname) {
105
  $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField();
Dries's avatar
   
Dries committed
106

107
108
  if ($uid) {
    return user_load($uid);
Dries's avatar
   
Dries committed
109
110
  }
  else {
111
    return FALSE;
Dries's avatar
   
Dries committed
112
113
114
  }
}

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

135
136
137
138
139
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

140
  // Check if user is blocked.
141
142
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
143
    // Invalid login.
144
145
    return FALSE;
  }
146

147
  // Valid login.
148
149
  global $user;
  $user = $account;
150
  user_authenticate_finalize($state['values']);
151
152
153
  return TRUE;
}

Dries's avatar
Dries committed
154
/**
155
 * Load multiple users based on certain conditions.
Dries's avatar
Dries committed
156
 *
157
158
159
 * 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
160
 *
161
162
163
164
165
166
167
168
 * @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.
169
 * @return
170
171
172
173
174
 *   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
175
 */
176
177
178
179
function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
  static $user_cache = array();
  if ($reset) {
    $user_cache = array();
180
  }
181

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
  $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
197
198
199
    }
  }

200
201
202
203
  // 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
204

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

242
243
244
245
246
247
    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
248

249
250
251
252
253
254
255
256
257
258
259
260
261
      // 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;
          }
        }
      }

262
263
      field_attach_load('user', $queried_users);

264
265
266
267
268
269
      // 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);
      }
270

271

272
273
274
275

      $users = $users + $queried_users;
      $user_cache = $user_cache + $queried_users;
    }
276
  }
277
278
279
280
281
282
283
284
285
286

  // 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
287
  }
Dries's avatar
   
Dries committed
288

289
290
291
292
293
294
295
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
  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
341
342
}

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

367
  if (!empty($edit['pass'])) {
368
    // Allow alternate password hashing schemes.
369
    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
370
    $edit['pass'] = user_hash_password(trim($edit['pass']));
371
    // Abort if the hashing failed and returned FALSE.
372
    if (!$edit['pass']) {
373
374
      return FALSE;
    }
375
376
377
  }
  else {
    // Avoid overwriting an existing password with a blank password.
378
    unset($edit['pass']);
379
380
  }

Dries's avatar
   
Dries committed
381
382
383
384
385
386
387
388
389
390
391
392
  // 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;

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

418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434

    // 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;

435
436
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
437
    // Save changes to the user table.
438
    $success = drupal_write_record('users', $edit, 'uid');
439
    if (!$success) {
Dries's avatar
   
Dries committed
440
441
442
443
      // 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
444
      // the user table are changed, drupal_write_record returns
Dries's avatar
   
Dries committed
445
      // FALSE because rowCount() (rows changed) is 0.  However,
446
      // non-users data may have been changed, e.g. fields.
Dries's avatar
   
Dries committed
447
      // return FALSE;
448
    }
Dries's avatar
   
Dries committed
449

450
    // If the picture changed or was unset, remove the old one. This step needs
451
    // to occur after updating the {users} record so that user_file_references()
452
453
454
455
456
    // doesn't report it in use and block the deletion.
    if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) {
      file_delete($account->picture);
    }

457
    // Reload user roles if provided.
458
    if (isset($edit['roles']) && is_array($edit['roles'])) {
459
460
461
      db_delete('users_roles')
        ->condition('uid', $account->uid)
        ->execute();
Dries's avatar
   
Dries committed
462

463
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
464
      foreach (array_keys($edit['roles']) as $rid) {
465
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
466
467
468
469
          $query->values(array(
            'uid' => $account->uid,
            'rid' => $rid,
          ));
470
        }
471
      }
472
      $query->execute();
Dries's avatar
   
Dries committed
473
474
    }

475
    // Delete a blocked user's sessions to kick them if they are online.
476
    if (isset($edit['status']) && $edit['status'] == 0) {
477
      drupal_session_destroy_uid($account->uid);
478
479
    }

480
481
    // If the password changed, delete all open sessions and recreate
    // the current one.
482
    if (!empty($edit['pass'])) {
483
      drupal_session_destroy_uid($account->uid);
484
485
486
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
487
488
    }

Dries's avatar
   
Dries committed
489
    // Save Field data.
490
491
    $object = (object) $edit;
    field_attach_update('user', $object);
Dries's avatar
   
Dries committed
492

493
    // Refresh user object.
494
    $user = user_load($account->uid, TRUE);
495
496

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

503
    user_module_invoke('after_update', $edit, $user, $category);
Dries's avatar
   
Dries committed
504
505
  }
  else {
506
    // Allow 'created' to be set by the caller.
507
    if (!isset($edit['created'])) {
508
      $edit['created'] = REQUEST_TIME;
509
    }
510
511
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
512
    if (empty($edit['access']) && user_access('administer users')) {
513
      $edit['access'] = REQUEST_TIME;
514
    }
515

516
    $success = drupal_write_record('users', $edit);
517
518
519
520
521
    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;
    }
522

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

526
527
    $object = (object) $edit;
    field_attach_insert('user', $object);
Dries's avatar
   
Dries committed
528

529
    user_module_invoke('insert', $edit, $user, $category);
530

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

547
    // Save user roles (delete just to be safe).
548
    if (isset($edit['roles']) && is_array($edit['roles'])) {
549
550
551
552
      db_delete('users_roles')
        ->condition('uid', $edit['uid'])
        ->execute();
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
553
      foreach (array_keys($edit['roles']) as $rid) {
554
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
555
556
557
558
          $query->values(array(
            'uid' => $edit['uid'],
            'rid' => $rid,
          ));
559
        }
560
      }
561
      $query->execute();
562
563
    }

564
    // Build the finished user object.
565
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
   
Dries committed
566
567
568
569
570
  }

  return $user;
}

Dries's avatar
Dries committed
571
572
573
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
574
function user_validate_name($name) {
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
  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.');
  }
590
591
592
593
594
595
596
597
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
                   '\x{AD}' .                // Soft-hyphen
                   '\x{2000}-\x{200F}' .     // Various space characters
                   '\x{2028}-\x{202F}' .     // Bidirectional text overrides
                   '\x{205F}-\x{206F}' .     // Various text hinting characters
                   '\x{FEFF}' .              // Byte order mark
                   '\x{FF01}-\x{FF60}' .     // Full-width latin
                   '\x{FFF9}-\x{FFFD}' .     // Replacement characters
598
                   '\x{0}-\x{1F}]/u',        // NULL byte and control characters
599
600
601
                   $name)) {
    return t('The username contains an illegal character.');
  }
602
603
604
  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
605
606
607
}

function user_validate_mail($mail) {
608
609
610
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
611
  if (!valid_email_address($mail)) {
612
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
   
Dries committed
613
614
615
  }
}

616
function user_validate_picture(&$form, &$form_state) {
617
  // If required, validate the uploaded picture.
618
619
620
621
622
  $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),
  );
623

624
625
626
627
628
629
630
  // 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
631
632
633
  }
}

Dries's avatar
Dries committed
634
635
636
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
   
Dries committed
637
638
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
639
640
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
641
  // of 'I', 1, and 'l'.
642
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
643

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

Dries's avatar
Dries committed
647
648
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
649

Dries's avatar
Dries committed
650
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
651
652
653
654
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
659
660
}

661
662
663
664
665
666
667
668
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
/**
 * 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.
699
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
700

701
702
      foreach ($result as $row) {
        $stored_permissions[$row->rid][$row->permission] = TRUE;
703
704
705
706
707
708
709
710
711
712
713
      }
      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
714
715
716
717
718
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
719
720
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
721
722
723
724
 * @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
725
726
 *
 * @return
727
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
728
729
730
731
732
 *
 * 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.
 */
733
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
   
Dries committed
734
  global $user;
Dries's avatar
   
Dries committed
735
  static $perm = array();
Dries's avatar
   
Dries committed
736

737
  if ($reset) {
738
    $perm = array();
739
740
  }

741
742
743
744
  if (is_null($account)) {
    $account = $user;
  }

745
  // User #1 has all privileges:
746
  if ($account->uid == 1) {
747
    return TRUE;
Dries's avatar
   
Dries committed
748
749
  }

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

755
    $perms = array();
756
757
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
   
Dries committed
758
    }
759
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
760
  }
761

762
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
763
764
}

765
/**
766
 * Checks for usernames blocked by user administration.
767
 *
768
 * @return boolean TRUE for blocked users, FALSE for active.
769
770
 */
function user_is_blocked($name) {
771
  $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject();
772

773
  return $deny;
774
775
}

Dries's avatar
Dries committed
776
777
778
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
779
function user_perm() {
780
   return array(
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
     '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.'),
     ),
797
798
799
800
801
802
803
804
     '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.'))),
     ),
805
   );
Dries's avatar
   
Dries committed
806
807
}

Dries's avatar
Dries committed
808
809
810
811
812
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
813
814
815
function user_file_download($filepath) {
  if (strpos($filepath, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info(file_create_path($filepath));
816
    return array('Content-Type' => $info['mime_type']);
Dries's avatar
   
Dries committed
817
818
819
  }
}

820
821
822
823
824
/**
 * Implementation of hook_file_references().
 */
function user_file_references($file) {
  // Determine if the file is used by this module.
825
826
  $file_used = (bool) db_query_range('SELECT 1 FROM {users} WHERE picture = :fid', array(':fid' => $file->fid), 0, 1)->fetchField();
  if ($file_used) {
827
828
829
830
831
832
833
834
835
836
    // 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.
837
  db_update('users')
838
839
840
841
842
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

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

Dries's avatar
Dries committed
879
880
881
882
883
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
884
885
886
887
888
889
    'user_profile_category' => array(
      '#theme_wrapper' => 'user_profile_category'
    ),
    'user_profile_item' => array(
      '#theme' => 'user_profile_item'
    ),
Dries's avatar
Dries committed
890
891
892
  );
}

Dries's avatar
Dries committed
893
/**
894
 * Implementation of hook_user_view().
Dries's avatar
Dries committed
895
 */
896
897
function user_user_view(&$edit, &$account, $category = NULL) {
  $account->content['user_picture'] = array(
898
    '#markup' => theme('user_picture', $account),
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
    '#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') {
922
    $form_state = array();
923
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
924
  }
925
}
926

927
/**
928
 * Implementation of hook_user_validate().
929
930
931
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
932
933
934
935
936
937
    $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);
      }
938
      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()) {
939
940
941
942
        form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name'])));
      }
    }

943
    // Validate the e-mail address, and check if it is taken by an existing user.
944
945
946
    if ($error = user_validate_mail($edit['mail'])) {
      form_set_error('mail', $error);
    }
947
    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()) {
948
949
950
951
952
953
954
      // 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'))));
      }
955
    }
956
957
958
959
960
961
962
963
964

    // 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'])));
      }
    }
965
  }
966
}
967

968
/**
969
 * Implementation of hook_user_submit().
970
971
972
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
973
974
975
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
976
    // Delete picture if requested, and if no replacement picture was given.
977
978
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
979
    }
980
981
982
983
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

984
985
986
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
987
  }
988
}
989

990
991
992
/**
 * Implementation of hook_user_categories.
 */
993
function user_user_categories($edit, $account, $category = NULL) {
994
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
Dries's avatar
Dries committed
995
996
}

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

Dries's avatar
Dries committed
1028
/**
1029
 * Implementation of hook_block_list().
Dries's avatar
Dries committed
1030
 */
1031
function user_block_list() {
Dries's avatar
   
Dries committed
1032
1033
  global $user;

1034
1035
1036
  $blocks['login']['info'] = t('User login');
  // Not worth caching.
  $blocks['login']['cache'] = BLOCK_NO_CACHE;
1037

1038
  $blocks['new']['info'] = t('Who\'s new');
1039

1040
1041
1042
1043
1044
  // Too dynamic to cache.
  $blocks['online']['info'] = t('Who\'s online');
  $blocks['online']['cache'] = BLOCK_NO_CACHE;
  return $blocks;
}
1045

1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
/**
 * Implementation of hook_block_configure().
 */
function user_block_configure($delta = '') {
  global $user;

  switch($delta) {
    case 'new':
      $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;

    case 'online':
      $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
      $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.'));
1066
      $form['user_block_cache'] = array('#markup' => '<p>If page caching is disabled, the block shows the number of anonymous and authenticated users, respectively. If page caching is enabled, only the number of authenticated users is displayed.</p>');
1067
      return $form;
1068
  }
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
}

/**
 * Implementation of hook_block_save().
 */
function user_block_save($delta = '', $edit = array()) {
  global $user;

  switch ($delta) {
    case 'new':
      variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
      break;

    case 'online':
      variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
      variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
      break;
1086
  }
1087
}
Dries's avatar
   
Dries committed
1088

1089
1090
1091
1092
1093
/**
 * Implementation of hook_block_view().
 */
function user_block_view($delta = '') {
  global $user;