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
 * Implement 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
 * Implement hook_fieldable_info().
Dries's avatar
   
Dries committed
88
89
90
91
92
93
94
95
96
97
98
99
 */
function user_fieldable_info() {
  $return = array(
    'user' => array(
      'name' => t('User'),
      'id key' => 'uid',
    ),
  );
  return $return;
}

/**
100
 * Implement hook_field_build_modes().
Dries's avatar
   
Dries committed
101
102
103
104
105
106
107
108
109
110
111
 */
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
  }
}

Dries's avatar
Dries committed
123
/**
124
 * Load multiple users based on certain conditions.
Dries's avatar
Dries committed
125
 *
126
127
128
 * 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
129
 *
130
131
132
133
134
135
136
137
 * @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.
138
 * @return
139
140
141
142
143
 *   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
144
 */
145
146
147
148
function user_load_multiple($uids = array(), $conditions = array(), $reset = FALSE) {
  static $user_cache = array();
  if ($reset) {
    $user_cache = array();
149
  }
150

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
  $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
166
167
168
    }
  }

169
170
171
172
  // 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
173

174
175
176
    // If the $uids array is populated, add those to the query.
    if ($uids) {
      $query->condition('u.uid', $uids, 'IN');
177
    }
178
179
    // If the conditions array is populated, add those to the query.
    if ($conditions) {
180
181
      // TODO D7: Using LIKE() to get a case insensitive comparison because Crell
      // and chx promise that dbtng will map it to ILIKE in postgres.
182
      if (isset($conditions['name'])) {
183
        $query->condition('u.name', $conditions['name'], 'LIKE');
184
185
186
        unset($conditions['name']);
      }
      if (isset($conditions['mail'])) {
187
        $query->condition('u.mail', $conditions['mail'], 'LIKE');
188
189
190
191
192
        unset($conditions['mail']);
      }
      foreach ($conditions as $field => $value) {
        $query->condition('u.' . $field, $value);
      }
193
    }
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
    $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';
      }
209
    }
210

211
212
213
214
215
216
    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
217

218
219
220
221
222
223
224
225
226
227
228
229
230
      // 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;
          }
        }
      }

231
232
      field_attach_load('user', $queried_users);

233
234
235
236
237
238
      // 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);
      }
239

240

241
242
243
244

      $users = $users + $queried_users;
      $user_cache = $user_cache + $queried_users;
    }
245
  }
246
247
248
249
250
251
252
253
254
255

  // 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
256
  }
Dries's avatar
   
Dries committed
257

258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
  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
310
311
}

312
/**
313
 * Save changes to a user account or add a new user.
314
315
 *
 * @param $account
316
 *   The $user object for the user to modify or add. If $user->uid is
317
 *   omitted (or $user->is_new == TRUE), a new user will be added.
318
 *
319
 * @param $edit
320
 *   An array of fields and values to save. For example array('name'
321
 *   => 'My name'). Keys that do not belong to columns in the user-related
322
323
324
 *   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.
325
326
327
 *
 * @param $category
 *   (optional) The category for storing profile information in.
328
329
 *
 * @return
330
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
331
 */
332
function user_save($account, $edit = array(), $category = 'account') {
333
  $table = drupal_get_schema('users');
334
335
  $user_fields = $table['fields'];

336
  if (!empty($edit['pass'])) {
337
    // Allow alternate password hashing schemes.
338
    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
339
    $edit['pass'] = user_hash_password(trim($edit['pass']));
340
    // Abort if the hashing failed and returned FALSE.
341
    if (!$edit['pass']) {
342
343
      return FALSE;
    }
344
345
346
  }
  else {
    // Avoid overwriting an existing password with a blank password.
347
    unset($edit['pass']);
348
349
  }

Dries's avatar
   
Dries committed
350
351
352
353
354
355
356
357
358
359
360
361
  // 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;

362
  if (!isset($account->is_new)) {
363
    $account->is_new = empty($account->uid);
364
365
  }
  if (is_object($account) && !$account->is_new) {
366
    user_module_invoke('update', $edit, $account, $category);
367
    $data = unserialize(db_query('SELECT data FROM {users} WHERE uid = :uid', array(':uid' => $account->uid))->fetchField());
368
369
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
370
    if (empty($edit['access']) && empty($account->access) && user_access('administer users')) {
371
      $edit['access'] = REQUEST_TIME;
372
    }
373
    foreach ($edit as $key => $value) {
Dries's avatar
   
Dries committed
374
      // Form fields that don't pertain to the users, user_roles, or
375
      // Field API are automatically serialized into the users.data
Dries's avatar
   
Dries committed
376
      // column.
377
      if (!in_array($key, array('roles', 'is_new')) && empty($user_fields[$key]) && empty($field_form[$key])) {
378
379
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
   
Dries committed
380
        }
381
382
        else {
          $data[$key] = $value;
Dries's avatar
   
Dries committed
383
        }
Dries's avatar
   
Dries committed
384
385
386
      }
    }

387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403

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

404
405
    $edit['data'] = $data;
    $edit['uid'] = $account->uid;
406
    // Save changes to the user table.
407
    $success = drupal_write_record('users', $edit, 'uid');
408
    if (!$success) {
Dries's avatar
   
Dries committed
409
410
411
412
      // 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
413
      // the user table are changed, drupal_write_record returns
Dries's avatar
   
Dries committed
414
      // FALSE because rowCount() (rows changed) is 0.  However,
415
      // non-users data may have been changed, e.g. fields.
Dries's avatar
   
Dries committed
416
      // return FALSE;
417
    }
Dries's avatar
   
Dries committed
418

419
    // If the picture changed or was unset, remove the old one. This step needs
420
    // to occur after updating the {users} record so that user_file_references()
421
422
423
424
425
    // doesn't report it in use and block the deletion.
    if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) {
      file_delete($account->picture);
    }

426
    // Reload user roles if provided.
427
    if (isset($edit['roles']) && is_array($edit['roles'])) {
428
429
430
      db_delete('users_roles')
        ->condition('uid', $account->uid)
        ->execute();
Dries's avatar
   
Dries committed
431

432
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
433
      foreach (array_keys($edit['roles']) as $rid) {
434
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
435
436
437
438
          $query->values(array(
            'uid' => $account->uid,
            'rid' => $rid,
          ));
439
        }
440
      }
441
      $query->execute();
Dries's avatar
   
Dries committed
442
443
    }

444
    // Delete a blocked user's sessions to kick them if they are online.
445
    if (isset($edit['status']) && $edit['status'] == 0) {
446
      drupal_session_destroy_uid($account->uid);
447
448
    }

449
450
    // If the password changed, delete all open sessions and recreate
    // the current one.
451
    if (!empty($edit['pass'])) {
452
      drupal_session_destroy_uid($account->uid);
453
454
455
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
456
457
    }

Dries's avatar
   
Dries committed
458
    // Save Field data.
459
460
    $object = (object) $edit;
    field_attach_update('user', $object);
Dries's avatar
   
Dries committed
461

462
    // Refresh user object.
463
    $user = user_load($account->uid, TRUE);
464
465

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

472
    user_module_invoke('after_update', $edit, $user, $category);
Dries's avatar
   
Dries committed
473
474
  }
  else {
475
    // Allow 'created' to be set by the caller.
476
    if (!isset($edit['created'])) {
477
      $edit['created'] = REQUEST_TIME;
478
    }
479
480
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
481
    if (empty($edit['access']) && user_access('administer users')) {
482
      $edit['access'] = REQUEST_TIME;
483
    }
484

485
    $edit['mail'] = trim($edit['mail']);
486
    $success = drupal_write_record('users', $edit);
487
488
489
490
491
    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;
    }
492

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

496
497
    $object = (object) $edit;
    field_attach_insert('user', $object);
Dries's avatar
   
Dries committed
498

499
    user_module_invoke('insert', $edit, $user, $category);
500

501
502
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
503
    $data = array();
504
    foreach ($edit as $key => $value) {
505
      // Form fields that don't pertain to the users, user_roles, or
506
      // Field API are automatically serialized into the user.data
Dries's avatar
   
Dries committed
507
      // column.
508
      if ((!in_array($key, array('roles', 'is_new'))) && (empty($user_fields[$key]) && empty($field_form[$key])) && ($value !== NULL)) {
509
510
511
        $data[$key] = $value;
      }
    }
512
513
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
514
      drupal_write_record('users', $data_array, 'uid');
515
    }
516

517
    // Save user roles (delete just to be safe).
518
    if (isset($edit['roles']) && is_array($edit['roles'])) {
519
520
521
522
      db_delete('users_roles')
        ->condition('uid', $edit['uid'])
        ->execute();
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
523
      foreach (array_keys($edit['roles']) as $rid) {
524
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
525
526
527
528
          $query->values(array(
            'uid' => $edit['uid'],
            'rid' => $rid,
          ));
529
        }
530
      }
531
      $query->execute();
532
533
    }

534
    // Build the finished user object.
535
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
   
Dries committed
536
537
538
539
540
  }

  return $user;
}

Dries's avatar
Dries committed
541
542
543
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
544
function user_validate_name($name) {
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
  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.');
  }
560
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
561
562
563
564
565
566
567
568
569
                  '\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)) {
570
571
    return t('The username contains an illegal character.');
  }
572
573
574
  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
575
576
577
}

function user_validate_mail($mail) {
578
  $mail = trim($mail);
579
580
581
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
582
  if (!valid_email_address($mail)) {
583
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
   
Dries committed
584
585
586
  }
}

587
function user_validate_picture(&$form, &$form_state) {
588
  // If required, validate the uploaded picture.
589
590
591
592
593
  $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),
  );
594

595
596
597
598
599
600
601
  // 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
602
603
604
  }
}

Dries's avatar
Dries committed
605
606
607
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
   
Dries committed
608
609
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
610
611
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
612
  // of 'I', 1, and 'l'.
613
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
614

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

Dries's avatar
Dries committed
618
619
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
620

Dries's avatar
Dries committed
621
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
622
623
624
625
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
630
631
}

632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
/**
 * 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.
670
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
671

672
673
      foreach ($result as $row) {
        $stored_permissions[$row->rid][$row->permission] = TRUE;
674
675
676
677
678
679
680
681
682
683
684
      }
      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
685
686
687
688
689
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
   
Dries committed
690
691
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
692
693
694
695
 * @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
696
697
 *
 * @return
698
 *   Boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
699
700
701
702
703
 *
 * 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.
 */
704
function user_access($string, $account = NULL, $reset = FALSE) {
Dries's avatar
   
Dries committed
705
  global $user;
Dries's avatar
   
Dries committed
706
  static $perm = array();
Dries's avatar
   
Dries committed
707

708
  if ($reset) {
709
    $perm = array();
710
711
  }

712
713
714
715
  if (is_null($account)) {
    $account = $user;
  }

716
  // User #1 has all privileges:
717
  if ($account->uid == 1) {
718
    return TRUE;
Dries's avatar
   
Dries committed
719
720
  }

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

726
    $perms = array();
727
728
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
   
Dries committed
729
    }
730
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
731
  }
732

733
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
734
735
}

736
/**
737
 * Checks for usernames blocked by user administration.
738
 *
739
 * @return boolean TRUE for blocked users, FALSE for active.
740
741
 */
function user_is_blocked($name) {
742
  $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject();
743

744
  return $deny;
745
746
}

Dries's avatar
Dries committed
747
/**
748
 * Implement hook_permission().
Dries's avatar
Dries committed
749
 */
750
function user_permission() {
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
  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'),
770
      '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/settings/user'))),
771
772
773
774
775
776
    ),
    '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
777
778
}

Dries's avatar
Dries committed
779
/**
780
 * Implement hook_file_download().
Dries's avatar
Dries committed
781
782
783
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
784
785
786
function user_file_download($filepath) {
  if (strpos($filepath, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info(file_create_path($filepath));
787
    return array('Content-Type' => $info['mime_type']);
Dries's avatar
   
Dries committed
788
789
790
  }
}

791
/**
792
 * Implement hook_file_references().
793
794
795
 */
function user_file_references($file) {
  // Determine if the file is used by this module.
796
797
  $file_used = (bool) db_query_range('SELECT 1 FROM {users} WHERE picture = :fid', array(':fid' => $file->fid), 0, 1)->fetchField();
  if ($file_used) {
798
799
800
801
802
803
    // Return the name of the module and how many references it has to the file.
    return array('user' => $count);
  }
}

/**
804
 * Implement hook_file_delete().
805
806
807
 */
function user_file_delete($file) {
  // Remove any references to the file.
808
  db_update('users')
809
810
811
812
813
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

Dries's avatar
Dries committed
814
/**
815
 * Implement hook_search().
Dries's avatar
Dries committed
816
 */
817
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
818
819
  switch ($op) {
    case 'name':
820
      if ($skip_access_check || user_access('access user profiles')) {
821
        return t('Users');
822
      }
823
    case 'search':
824
825
826
827
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
828
        $query = db_select('users')->extend('PagerDefault');
829
        $query->fields('users', array('name', 'uid', 'mail'));
830
831
        if (user_access('administer users')) {
          // Administrators can also search in the otherwise private email field.
832
          $query->condition(db_or()->
833
834
            where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"))->
            where('LOWER(mail) LIKE LOWER(:mail)', array(':mail' => "%$keys%")));
835
836
        }
        else {
837
838
          $query->where('LOWER(name) LIKE LOWER(:name)', array(':name' => "%$keys%"));
        }
839
840
841
        $result = $query
          ->limit(15)
          ->execute();
842
843
        foreach ($result as $account) {
          $find[] = array('title' => $account->name . ' (' . $account->mail . ')', 'link' => url('user/' . $account->uid, array('absolute' => TRUE)));
844
845
        }
        return $find;
846
      }
Dries's avatar
   
Dries committed
847
848
849
  }
}

Dries's avatar
Dries committed
850
/**
851
 * Implement hook_elements().
Dries's avatar
Dries committed
852
853
854
 */
function user_elements() {
  return array(
855
856
857
858
859
860
    'user_profile_category' => array(
      '#theme_wrapper' => 'user_profile_category'
    ),
    'user_profile_item' => array(
      '#theme' => 'user_profile_item'
    ),
Dries's avatar
Dries committed
861
862
863
  );
}

Dries's avatar
Dries committed
864
/**
865
 * Implement hook_user_view().
Dries's avatar
Dries committed
866
 */
867
868
function user_user_view(&$edit, &$account, $category = NULL) {
  $account->content['user_picture'] = array(
869
    '#markup' => theme('user_picture', $account),
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
    '#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),
  );
}

/**
889
 * Implement hook_user_form.
890
891
892
 */
function user_user_form(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
893
    $form_state = array();
894
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
895
  }
896
}
897

898
/**
899
 * Implement hook_user_validate().
900
901
902
 */
function user_user_validate(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
903
904
905
906
907
908
    $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);
      }
909
      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()) {
910
911
912
913
        form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name'])));
      }
    }

914
    // Validate the e-mail address, and check if it is taken by an existing user.
915
916
917
    if ($error = user_validate_mail($edit['mail'])) {
      form_set_error('mail', $error);
    }
918
    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()) {
919
920
921
922
923
924
925
      // 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'))));
      }
926
    }
927
928
929
930
931
932
933
934
935

    // 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'])));
      }
    }
936
  }
937
}
938

939
/**
940
 * Implement hook_user_submit().
941
942
943
 */
function user_user_submit(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
944
945
946
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
947
    // Delete picture if requested, and if no replacement picture was given.
948
949
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
950
    }
951
952
953
954
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

955
956
957
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
958
  }
959
}
960

961
/**
962
 * Implement hook_user_categories().
963
 */
964
965
966
967
968
969
function user_user_categories() {
  return array(array(
    'name' => 'account',
    'title' => t('Account settings'),
    'weight' => 1,
  ));
Dries's avatar
Dries committed
970
971
}

972
973
function user_login_block() {
  $form = array(
974
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
975
    '#id' => 'user-login-form',
976
    '#validate' => user_login_default_validators(),
977
    '#submit' => array('user_login_submit'),
978
979
980
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
981
    '#maxlength' => USERNAME_MAX_LENGTH,
982
983
984
985
986
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
987
    '#maxlength' => 60,
988
989
990
991
992
993
994
995
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
996
    $items[] = l(t('Create new account'), 'user/register', array('attributes' => array('title' => t('Create a new user account.'))));
997
  }
998
  $items[] = l(t('Request new password'), 'user/password', array('attributes' => array('title' => t('Request new password via e-mail.'))));
999
  $form['links'] = array('#markup' => theme('item_list', $items));
1000
1001
1002
  return $form;
}

Dries's avatar
Dries committed
1003
/**
1004
 * Implement hook_block_list().
Dries's avatar
Dries committed
1005
 */
1006
function user_block_list() {
Dries's avatar
   
Dries committed
1007
1008
  global $user;

1009
1010
1011
  $blocks['login']['info'] = t('User login');
  // Not worth caching.
  $blocks['login']['cache'] = BLOCK_NO_CACHE;
1012

1013
  $blocks['new']['info'] = t('Who\'s new');
1014

1015
1016
1017
1018
1019
  // Too dynamic to cache.
  $blocks['online']['info'] = t('Who\'s online');
  $blocks['online']['cache'] = BLOCK_NO_CACHE;
  return $blocks;
}
1020

1021
/**
1022
 * Implement hook_block_configure().
1023
1024
1025
1026
 */
function user_block_configure($delta = '') {
  global $user;

1027
  switch ($delta) {
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
    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.'));