user.module 108 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, &$edit, $account, $category = NULL) {
27
  foreach (module_implements('user_' . $type) as $module) {
28
    $function = $module . '_user_' . $type;
29
    $function($edit, $account, $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
    ),
    'user_list' => array(
      'arguments' => array('users' => NULL, 'title' => NULL),
    ),
60
    'user_admin_permissions' => array(
61
      '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
 */
function user_fieldable_info() {
  $return = array(
    'user' => array(
92
93
94
95
96
97
98
99
100
101
102
103
104
      'label' => t('User'),
      'object keys' => array(
        'id' => 'uid',
      ),
      'bundles' => array(
        'user' => array(
          'label' => t('User'),
          'admin' => array(
            'path' => 'admin/settings/user',
            'access arguments' => array('administer users'),
          ),
        ),
      ),
Dries's avatar
   
Dries committed
105
106
107
108
109
110
    ),
  );
  return $return;
}

/**
111
 * Implement hook_field_build_modes().
Dries's avatar
   
Dries committed
112
113
114
115
116
117
118
119
120
121
122
 */
function user_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'user') {
    $modes = array(
      'full' => t('User account'),
    );
  }
  return $modes;
}

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/**
 * Implement hook_field_extra_fields().
 */
function user_field_extra_fields($bundle) {
  $extra = array();

  if ($bundle == 'user') {
    $extra['account'] = array(
      'label' => 'User name and password',
      'description' => t('User module account form elements'),
      'weight' => -10,
    );
    $extra['timezone'] = array(
      'label' => 'Timezone',
      'description' => t('User module timezone form element.'),
      'weight' => 6,
    );
    $extra['summary'] = array(
      'label' => 'History',
      'description' => t('User module history view element.'),
      'weight' => 5,
    );
  }

  return $extra;
}

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

153
154
  if ($uid) {
    return user_load($uid);
Dries's avatar
   
Dries committed
155
156
  }
  else {
157
    return FALSE;
Dries's avatar
   
Dries committed
158
159
160
  }
}

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

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
  $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
204
205
206
    }
  }

207
208
209
210
  // 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
211

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

249
250
251
252
253
254
    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
255

256
257
258
259
260
261
262
263
264
265
266
267
268
      // 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;
          }
        }
      }

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

271
272
273
274
275
276
      // 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);
      }
277

278

279
280
281
282

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

  // 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
294
  }
Dries's avatar
   
Dries committed
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
341
342
343
344
345
346
347
  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
348
349
}

350
/**
351
 * Save changes to a user account or add a new user.
352
353
 *
 * @param $account
354
 *   (optional) The user object to modify or add. If you want to modify
355
356
 *   an existing user account, you will need to ensure that (a) $account
 *   is an object, and (b) you have set $account->uid to the numeric
357
358
 *   user ID of the user account you wish to modify. If you
 *   want to create a new user account, you can set $account->is_new to
359
 *   TRUE or omit the $account->uid field.
360
 * @param $edit
361
 *   An array of fields and values to save. For example array('name'
362
 *   => 'My name'). Keys that do not belong to columns in the user-related
363
364
 *   tables are added to the a serialized array in the 'data' column
 *   and will be loaded in the $user->data array by user_load().
365
366
 *   Setting a field to NULL deletes it from the data column, if you are
 *   modifying an existing user account.
367
368
 * @param $category
 *   (optional) The category for storing profile information in.
369
370
 *
 * @return
371
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
372
 */
373
function user_save($account, $edit = array(), $category = 'account') {
374
  $table = drupal_get_schema('users');
375
376
  $user_fields = $table['fields'];

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

Dries's avatar
   
Dries committed
391
392
393
394
395
396
397
398
399
400
401
402
  // 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;

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

428
429
430
431
432
433
    // 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) {
434
435
436
437
438
439
440
        $info = image_get_info($picture->uri);
        $picture_directory =  variable_get('file_default_scheme', 'public') . '://' . variable_get('user_picture_path', 'pictures');
        
        // Prepare the pictures directory.
        file_prepare_directory($picture_directory, FILE_CREATE_DIRECTORY);
        $destination = file_stream_wrapper_uri_normalize($picture_directory . '/picture-' . $account->uid . '.' . $info['extension']);

441
442
443
444
445
446
447
448
        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;

449
    $edit['data'] = $data;
450
    // Do not allow 'uid' to be changed.
451
    $edit['uid'] = $account->uid;
452
    // Save changes to the user table.
453
    $success = drupal_write_record('users', $edit, 'uid');
454
    if (!$success) {
Dries's avatar
   
Dries committed
455
456
457
458
      // 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
459
      // the user table are changed, drupal_write_record returns
Dries's avatar
   
Dries committed
460
      // FALSE because rowCount() (rows changed) is 0.  However,
461
      // non-users data may have been changed, e.g. fields.
Dries's avatar
   
Dries committed
462
      // return FALSE;
463
    }
Dries's avatar
   
Dries committed
464

465
    // If the picture changed or was unset, remove the old one. This step needs
466
    // to occur after updating the {users} record so that user_file_references()
467
468
469
470
471
    // doesn't report it in use and block the deletion.
    if (!empty($account->picture->fid) && ($edit['picture'] != $account->picture->fid)) {
      file_delete($account->picture);
    }

472
    // Reload user roles if provided.
473
    if (isset($edit['roles']) && is_array($edit['roles'])) {
474
475
476
      db_delete('users_roles')
        ->condition('uid', $account->uid)
        ->execute();
Dries's avatar
   
Dries committed
477

478
      $query = db_insert('users_roles')->fields(array('uid', 'rid'));
479
      foreach (array_keys($edit['roles']) as $rid) {
480
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
481
482
483
484
          $query->values(array(
            'uid' => $account->uid,
            'rid' => $rid,
          ));
485
        }
486
      }
487
      $query->execute();
Dries's avatar
   
Dries committed
488
489
    }

490
    // Delete a blocked user's sessions to kick them if they are online.
491
    if (isset($edit['status']) && $edit['status'] == 0) {
492
      drupal_session_destroy_uid($account->uid);
493
494
    }

495
496
    // If the password changed, delete all open sessions and recreate
    // the current one.
497
    if (!empty($edit['pass'])) {
498
      drupal_session_destroy_uid($account->uid);
499
500
501
      if ($account->uid == $GLOBALS['user']->uid) {
        drupal_session_regenerate();
      }
502
503
    }

Dries's avatar
   
Dries committed
504
    // Save Field data.
505
506
    $object = (object) $edit;
    field_attach_update('user', $object);
Dries's avatar
   
Dries committed
507

508
    // Refresh user object.
509
    $user = user_load($account->uid, TRUE);
510
511

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

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

531
    $edit['mail'] = trim($edit['mail']);
532
    $success = drupal_write_record('users', $edit);
533
534
535
536
537
    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;
    }
538

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

542
543
    $object = (object) $edit;
    field_attach_insert('user', $object);
Dries's avatar
   
Dries committed
544

545
    user_module_invoke('insert', $edit, $user, $category);
546

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

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

580
    // Build the finished user object.
581
    $user = user_load($edit['uid'], TRUE);
Dries's avatar
   
Dries committed
582
583
584
585
586
  }

  return $user;
}

Dries's avatar
Dries committed
587
588
589
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
   
Dries committed
590
function user_validate_name($name) {
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
  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.');
  }
606
  if (preg_match('/[\x{80}-\x{A0}' .         // Non-printable ISO-8859-1 + NBSP
607
608
609
610
611
612
613
614
615
                  '\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)) {
616
617
    return t('The username contains an illegal character.');
  }
618
619
620
  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
621
622
623
}

function user_validate_mail($mail) {
624
  $mail = trim($mail);
625
626
627
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
628
  if (!valid_email_address($mail)) {
629
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
   
Dries committed
630
631
632
  }
}

633
function user_validate_picture(&$form, &$form_state) {
634
  // If required, validate the uploaded picture.
635
636
637
638
639
  $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),
  );
640

641
642
643
644
645
646
647
  // 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
648
649
650
  }
}

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

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

Dries's avatar
Dries committed
664
665
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
   
Dries committed
666

Dries's avatar
Dries committed
667
  // Loop the number of times specified by $length.
Dries's avatar
   
Dries committed
668
669
670
671
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
   
Dries committed
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
709
710
711
712
713
714
715
/**
 * 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.
716
      $result = db_query("SELECT rid, permission FROM {role_permission} WHERE rid IN (:fetch)", array(':fetch' => $fetch));
717

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

754
  if ($reset) {
755
    $perm = array();
756
757
  }

758
  if (!isset($account)) {
759
760
761
    $account = $user;
  }

762
  // User #1 has all privileges:
763
  if ($account->uid == 1) {
764
    return TRUE;
Dries's avatar
   
Dries committed
765
766
  }

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

772
    $perms = array();
773
774
    foreach ($role_permissions as $one_role) {
      $perms += $one_role;
Dries's avatar
   
Dries committed
775
    }
776
    $perm[$account->uid] = $perms;
Dries's avatar
   
Dries committed
777
  }
778

779
  return isset($perm[$account->uid][$string]);
Dries's avatar
   
Dries committed
780
781
}

782
/**
783
 * Checks for usernames blocked by user administration.
784
 *
785
 * @return boolean TRUE for blocked users, FALSE for active.
786
787
 */
function user_is_blocked($name) {
788
  $deny = db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER(:name)", array(':name' => $name))->fetchObject();
789

790
  return $deny;
791
792
}

Dries's avatar
Dries committed
793
/**
794
 * Implement hook_permission().
Dries's avatar
Dries committed
795
 */
796
function user_permission() {
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'),
816
      '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'))),
817
818
819
820
821
822
    ),
    '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
823
824
}

Dries's avatar
Dries committed
825
/**
826
 * Implement hook_file_download().
Dries's avatar
Dries committed
827
828
829
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
830
function user_file_download($filepath) {
831
832
  if (strpos(file_uri_target($filepath), variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info($filepath);
833
    return array('Content-Type' => $info['mime_type']);
Dries's avatar
   
Dries committed
834
835
836
  }
}

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

/**
850
 * Implement hook_file_delete().
851
852
853
 */
function user_file_delete($file) {
  // Remove any references to the file.
854
  db_update('users')
855
856
857
858
859
    ->fields(array('picture' => 0))
    ->condition('picture', $file->fid)
    ->execute();
}

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

Dries's avatar
Dries committed
896
/**
897
 * Implement hook_elements().
Dries's avatar
Dries committed
898
899
900
 */
function user_elements() {
  return array(
901
    'user_profile_category' => array(
902
      '#theme_wrappers' => array('user_profile_category')
903
904
905
906
    ),
    'user_profile_item' => array(
      '#theme' => 'user_profile_item'
    ),
Dries's avatar
Dries committed
907
908
909
  );
}

Dries's avatar
Dries committed
910
/**
911
 * Implement hook_user_view().
Dries's avatar
Dries committed
912
 */
913
function user_user_view($account) {
914
  $account->content['user_picture'] = array(
915
    '#markup' => theme('user_picture', $account),
916
917
918
919
920
921
922
923
924
925
926
    '#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'),
  );
927
  $account->content['summary']['member_for'] = array(
928
929
930
931
932
933
934
    '#type' => 'user_profile_item',
    '#title' => t('Member for'),
    '#markup' => format_interval(REQUEST_TIME - $account->created),
  );
}

/**
935
 * Implement hook_user_form.
936
 */
937
function user_user_form(&$edit, $account, $category) {
938
  if ($category == 'account') {
939
    $form_state = array();
940
    return user_edit_form($form_state, (isset($account->uid) ? $account->uid : FALSE), $edit);
941
  }
942
}
943

944
/**
945
 * Implement hook_user_validate().
946
 */
947
function user_user_validate(&$edit, $account, $category) {
948
  if ($category == 'account') {
949
950
951
952
953
954
    $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);
      }
955
      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()) {
956
957
958
959
        form_set_error('name', t('The name %name is already taken.', array('%name' => $edit['name'])));
      }
    }

960
    // Validate the e-mail address, and check if it is taken by an existing user.
961
962
963
    if ($error = user_validate_mail($edit['mail'])) {
      form_set_error('mail', $error);
    }
964
    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()) {
965
966
967
968
969
970
971
      // 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'))));
      }
972
    }
973
974
975
976
977
978
979
980
981

    // 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'])));
      }
    }
982
  }
983
}
984

985
/**
986
 * Implement hook_user_submit().
987
 */
988
function user_user_submit(&$edit, $account, $category) {
989
  if ($category == 'account') {
990
991
992
    if (!empty($edit['picture_upload'])) {
      $edit['picture'] = $edit['picture_upload'];
    }
993
    // Delete picture if requested, and if no replacement picture was given.
994
995
    elseif (!empty($edit['picture_delete'])) {
      $edit['picture'] = NULL;
996
    }
997
998
999
1000
    // Remove these values so they don't end up serialized in the data field.
    $edit['picture_upload'] = NULL;
    $edit['picture_delete'] = NULL;

1001
1002
1003
    if (isset($edit['roles'])) {
      $edit['roles'] = array_filter($edit['roles']);
    }
1004
  }
1005
}
1006

1007
/**
1008
 * Implement hook_user_categories().
1009
 */
1010
1011
1012
1013
1014
1015
function user_user_categories() {
  return array(array(
    'name' => 'account',
    'title' => t('Account settings'),
    'weight' => 1,
  ));
Dries's avatar
Dries committed
1016
1017
}

1018
1019
function user_login_block() {
  $form = array(
1020
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
1021
    '#id' => 'user-login-form',
1022
    '#validate' => user_login_default_validators(),
1023
    '#submit' => array('user_login_submit'),
1024
1025
1026
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
1027
    '#maxlength' => USERNAME_MAX_LENGTH,
1028
1029
1030
1031
1032
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
1033
    '#maxlength' => 60,
1034
1035
1036
1037
1038
1039
1040
1041
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
1042
    $items[] = l(t('Create new account'), 'user/register', array(