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

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

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

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

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

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

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

91
/**
92 93 94
 * Perform standard Drupal login operations for a user object.
 *
 * The user object must already be authenticated. This function verifies
95 96
 * that the user account is not blocked/denied and then performs the login,
 * updates the login timestamp in the database, invokes hook_user('login'),
97
 * and regenerates the session.
98 99 100 101 102 103
 *
 * @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.
104
 *    This array is passed to hook_user op login.
105 106 107 108
 * @return boolean
 *    TRUE if the login succeeds, FALSE otherwise.
 */
function user_external_login($account, $edit = array()) {
109 110
  $form = drupal_get_form('user_login');

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

116
  // Check if user is blocked or denied by access rules.
117 118
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
119
    // Invalid login.
120 121
    return FALSE;
  }
122

123
  // Valid login.
124 125
  global $user;
  $user = $account;
126
  user_authenticate_finalize($state['values']);
127 128 129
  return TRUE;
}

Dries's avatar
Dries committed
130 131 132 133 134
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
135
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
136 137
 *
 * @return
138 139
 *   A fully-loaded $user object upon successful user load or FALSE if user
 *   cannot be loaded.
Dries's avatar
Dries committed
140
 */
Dries's avatar
 
Dries committed
141
function user_load($array = array()) {
Dries's avatar
Dries committed
142
  // Dynamically compose a SQL query:
143
  $query = array();
144
  $params = array();
145

146 147 148
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }
149 150 151
  elseif (!is_array($array)) {
    return FALSE;
  }
152

Dries's avatar
 
Dries committed
153
  foreach ($array as $key => $value) {
154 155
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
156
      $params[] = $value;
157
    }
158 159 160 161
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
 
Dries committed
162
    else {
163
      $query[]= "LOWER($key) = LOWER('%s')";
164
      $params[] = $value;
Dries's avatar
 
Dries committed
165 166
    }
  }
167
  $result = db_query('SELECT * FROM {users} u WHERE '. implode(' AND ', $query), $params);
Dries's avatar
 
Dries committed
168

169
  if ($user = db_fetch_object($result)) {
170
    $user = drupal_unpack($user);
Dries's avatar
 
Dries committed
171

172
    $user->roles = array();
173 174 175 176 177 178
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
179 180 181 182
    $result = db_query('SELECT r.rid, r.name FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d', $user->uid);
    while ($role = db_fetch_object($result)) {
      $user->roles[$role->rid] = $role->name;
    }
183
    user_module_invoke('load', $array, $user);
184 185
  }
  else {
186
    $user = FALSE;
Dries's avatar
 
Dries committed
187
  }
Dries's avatar
 
Dries committed
188 189 190 191

  return $user;
}

192
/**
193
 * Save changes to a user account or add a new user.
194 195
 *
 * @param $account
196 197
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
198 199
 *
 * @param $array
200 201 202 203 204
 *   An array of fields and values to save. For example array('name'
 *   => 'My name').  Keys that do not belong to columns in the user-related
 *   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.
205 206 207
 *
 * @param $category
 *   (optional) The category for storing profile information in.
208 209 210
 *
 * @return
 *   A fully-loaded $user object upon successful save or FALSE if the save failed.
211
 */
212
function user_save($account, $array = array(), $category = 'account') {
213 214 215 216 217 218 219 220 221 222 223
  $table = drupal_get_schema('users');
  $user_fields = $table['fields'];

  if (!empty($array['pass'])) {
    $array['pass'] = md5($array['pass']);
  }
  else {
    // Avoid overwriting an existing password with a blank password.
    unset($array['pass']);
  }

224
  if (is_object($account) && $account->uid) {
225
    user_module_invoke('update', $array, $account, $category);
Dries's avatar
Dries committed
226
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
227 228 229 230 231
    // Consider users edited by an administrator as logged in, if they haven't
    // already, so anonymous users can view the profile (if allowed).
    if (empty($array['access']) && empty($account->access) && user_access('administer users')) {
      $array['access'] = time();
    }
Dries's avatar
 
Dries committed
232
    foreach ($array as $key => $value) {
233 234 235
      // Fields that don't pertain to the users or user_roles
      // automatically serialized into the users.data column.
      if ($key != 'roles' && empty($user_fields[$key])) {
236 237
        if ($value === NULL) {
          unset($data[$key]);
Dries's avatar
 
Dries committed
238
        }
239 240
        else {
          $data[$key] = $value;
Dries's avatar
 
Dries committed
241
        }
Dries's avatar
 
Dries committed
242 243 244
      }
    }

245 246 247 248
    $array['data'] = $data;
    $array['uid'] = $account->uid;
    // Save changes to the users table.
    $success = drupal_write_record('users', $array, 'uid');
249 250 251 252
    if (!$success) {
      // The query failed - better to abort the save than risk further data loss.
      return FALSE;
    }
Dries's avatar
 
Dries committed
253

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

258
      foreach (array_keys($array['roles']) as $rid) {
259 260 261
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $account->uid, $rid);
        }
262
      }
Dries's avatar
 
Dries committed
263 264
    }

265
    // Delete a blocked user's sessions to kick them if they are online.
266
    if (isset($array['status']) && $array['status'] == 0) {
267
      sess_destroy_uid($account->uid);
268 269
    }

270 271
    // If the password changed, delete all open sessions and recreate
    // the current one.
272
    if (!empty($array['pass'])) {
273 274 275 276
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

277
    // Refresh user object.
Dries's avatar
 
Dries committed
278
    $user = user_load(array('uid' => $account->uid));
279 280 281

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

287
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
 
Dries committed
288 289
  }
  else {
290 291
    // Allow 'created' to be set by the caller.
    if (!isset($array['created'])) {
292 293
      $array['created'] = time();
    }
294 295 296 297 298
    // Consider users created by an administrator as already logged in, so
    // anonymous users can view the profile (if allowed).
    if (empty($array['access']) && user_access('administer users')) {
      $array['access'] = time();
    }
299

300
    $success = drupal_write_record('users', $array);
301
    if (!$success) {
302 303
      // On a failed INSERT some other existing user's uid may be returned.
      // We must abort to avoid overwriting their account.
304 305
      return FALSE;
    }
306

307 308
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
309

310 311
    user_module_invoke('insert', $array, $user, $category);

312 313
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there.
314 315
    $data = array();
    foreach ($array as $key => $value) {
316
      if (($key != 'roles') && (empty($user_fields[$key])) && ($value !== NULL)) {
317 318 319
        $data[$key] = $value;
      }
    }
320 321 322 323
    if (!empty($data)) {
      $data_array = array('uid' => $user->uid, 'data' => $data);
      drupal_write_record('users', $data_array, 'uid');
    }
324

325
    // Save user roles (delete just to be safe).
326
    if (isset($array['roles']) && is_array($array['roles'])) {
327 328 329 330 331
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $array['uid']);
      foreach (array_keys($array['roles']) as $rid) {
        if (!in_array($rid, array(DRUPAL_ANONYMOUS_RID, DRUPAL_AUTHENTICATED_RID))) {
          db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $array['uid'], $rid);
        }
332 333 334
      }
    }

335 336
    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
337 338 339 340 341
  }

  return $user;
}

Dries's avatar
Dries committed
342 343 344
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
345
function user_validate_name($name) {
346
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
347 348
  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.');
349
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
350
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
351 352 353 354 355 356 357
  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
358 359
                   '\x{FFF9}-\x{FFFD}'.      // Replacement characters
                   '\x{0}]/u',               // NULL byte
360 361 362
                   $name)) {
    return t('The username contains an illegal character.');
  }
363
  if (strpos($name, '@') !== FALSE && !eregi('@([0-9a-z](-?[0-9a-z])*.)+[a-z]{2}([zmuvtg]|fo|me)?$', $name)) return t('The username is not a valid authentication ID.');
364
  if (strlen($name) > USERNAME_MAX_LENGTH) return t('The username %name is too long: it must be %max characters or less.', array('%name' => $name, '%max' => USERNAME_MAX_LENGTH));
Dries's avatar
 
Dries committed
365 366 367
}

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

374
function user_validate_picture(&$form, &$form_state) {
375
  // If required, validate the uploaded picture.
376 377 378 379 380 381
  $validators = array(
    'file_validate_is_image' => array(),
    'file_validate_image_resolution' => array(variable_get('user_picture_dimensions', '85x85')),
    'file_validate_size' => array(variable_get('user_picture_file_size', '30') * 1024),
  );
  if ($file = file_save_upload('picture_upload', $validators)) {
382 383 384 385 386
    // Remove the old picture.
    if (isset($form_state['values']['_account']->picture) && file_exists($form_state['values']['_account']->picture)) {
      file_delete($form_state['values']['_account']->picture);
    }

387
    // The image was saved using file_save_upload() and was added to the
Dries's avatar
Dries committed
388
    // files table as a temporary file. We'll make a copy and let the garbage
389
    // collector delete the original upload.
390
    $info = image_get_info($file->filepath);
391 392
    $destination = variable_get('user_picture_path', 'pictures') .'/picture-'. $form['#uid'] .'.'. $info['extension'];
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
393
      $form_state['values']['picture'] = $file->filepath;
394
    }
395 396
    else {
      form_set_error('picture_upload', t("Failed to upload the picture image; the %directory directory doesn't exist or is not writable.", array('%directory' => variable_get('user_picture_path', 'pictures'))));
397
    }
Dries's avatar
 
Dries committed
398 399 400
  }
}

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

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

Dries's avatar
Dries committed
414 415
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
416

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

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

  return $pass;
Dries's avatar
 
Dries committed
426 427
}

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

451 452 453 454
  if ($reset) {
    unset($perm);
  }

455 456 457 458
  if (is_null($account)) {
    $account = $user;
  }

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

Dries's avatar
Dries committed
464 465
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
466
  if (!isset($perm[$account->uid])) {
467
    $result = db_query("SELECT p.perm FROM {role} r INNER JOIN {permission} p ON p.rid = r.rid WHERE r.rid IN (". db_placeholders($account->roles) .")", array_keys($account->roles));
Dries's avatar
 
Dries committed
468

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

476
  return isset($perm[$account->uid][$string]);
Dries's avatar
 
Dries committed
477 478
}

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

487
  return $deny;
488 489
}

Dries's avatar
Dries committed
490 491 492
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
493
function user_perm() {
494
  return array('administer permissions', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
 
Dries committed
495 496
}

Dries's avatar
Dries committed
497 498 499 500 501
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
502
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
503
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
504 505
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
506 507 508
  }
}

Dries's avatar
Dries committed
509 510 511
/**
 * Implementation of hook_search().
 */
512
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
513 514
  switch ($op) {
    case 'name':
515
      if ($skip_access_check || user_access('access user profiles')) {
516
        return t('Users');
517
      }
518
    case 'search':
519 520 521 522
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
523 524 525 526
        if (user_access('administer users')) {
          // Administrators can also search in the otherwise private email field.
          $result = pager_query("SELECT name, uid, mail FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%') OR LOWER(mail) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys, $keys);
          while ($account = db_fetch_object($result)) {
527
            $find[] = array('title' => $account->name .' ('. $account->mail .')', 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
528 529 530
          }
        }
        else {
531
          $result = pager_query("SELECT name, uid FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
532
          while ($account = db_fetch_object($result)) {
533
            $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
534
          }
535 536
        }
        return $find;
537
      }
Dries's avatar
 
Dries committed
538 539 540
  }
}

Dries's avatar
Dries committed
541 542 543 544 545 546 547 548 549 550
/**
 * Implementation of hook_elements().
 */
function user_elements() {
  return array(
    'user_profile_category' => array(),
    'user_profile_item' => array(),
  );
}

Dries's avatar
Dries committed
551 552 553
/**
 * Implementation of hook_user().
 */
554
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
555
  if ($type == 'view') {
556 557 558 559 560 561 562 563 564 565
    $account->content['user_picture'] = array(
      '#value' => theme('user_picture', $account),
      '#weight' => -10,
    );
    if (!isset($account->content['summary'])) {
      $account->content['summary'] = array();
    }
    $account->content['summary'] += array(
      '#type' => 'user_profile_category',
      '#attributes' => array('class' => 'user-member'),
566
      '#weight' => 5,
567 568 569 570 571 572
      '#title' => t('History'),
    );
    $account->content['summary']['member_for'] =  array(
      '#type' => 'user_profile_item',
      '#title' => t('Member for'),
      '#value' => format_interval(time() - $account->created),
573
    );
Dries's avatar
Dries committed
574
  }
575
  if ($type == 'form' && $category == 'account') {
576 577
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
578 579 580
  }

  if ($type == 'validate' && $category == 'account') {
581
    return _user_edit_validate(arg(1), $edit);
582 583
  }

584 585 586 587
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

588
  if ($type == 'categories') {
589
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
590
  }
Dries's avatar
Dries committed
591 592
}

593 594
function user_login_block() {
  $form = array(
595
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
596
    '#id' => 'user-login-form',
597
    '#validate' => user_login_default_validators(),
598
    '#submit' => array('user_login_submit'),
599 600 601
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
602
    '#maxlength' => USERNAME_MAX_LENGTH,
603 604 605 606 607
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
608
    '#maxlength' => 60,
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Log in'),
  );
  $items = array();
  if (variable_get('user_register', 1)) {
    $items[] = l(t('Create new account'), 'user/register', array('title' => t('Create a new user account.')));
  }
  $items[] = l(t('Request new password'), 'user/password', array('title' => t('Request new password via e-mail.')));
  $form['links'] = array('#value' => theme('item_list', $items));
  return $form;
}

Dries's avatar
Dries committed
624 625 626
/**
 * Implementation of hook_block().
 */
627
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
628 629
  global $user;

Dries's avatar
Dries committed
630
  if ($op == 'list') {
631 632 633
    $blocks[0]['info'] = t('User login');
    // Not worth caching.
    $blocks[0]['cache'] = BLOCK_NO_CACHE;
634

635 636 637 638
    $blocks[1]['info'] = t('Navigation');
    // Menu blocks can't be cached because each menu item can have
    // a custom access callback. menu.inc manages its own caching.
    $blocks[1]['cache'] = BLOCK_NO_CACHE;
639

640
    $blocks[2]['info'] = t('Who\'s new');
641

642 643 644 645
    // Too dynamic to cache.
    $blocks[3]['info'] = t('Who\'s online');
    $blocks[3]['cache'] = BLOCK_NO_CACHE;
    return $blocks;
646
  }
647 648 649 650 651 652 653 654 655
  else if ($op == 'configure' && $delta == 2) {
    $form['user_block_whois_new_count'] = array(
      '#type' => 'select',
      '#title' => t('Number of users to display'),
      '#default_value' => variable_get('user_block_whois_new_count', 5),
      '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
    );
    return $form;
  }
656 657
  else if ($op == 'configure' && $delta == 3) {
    $period = drupal_map_assoc(array(30, 60, 120, 180, 300, 600, 900, 1800, 2700, 3600, 5400, 7200, 10800, 21600, 43200, 86400), 'format_interval');
658 659
    $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.'));
660

661
    return $form;
662
  }
663 664 665
  else if ($op == 'save' && $delta == 2) {
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
666 667 668 669 670
  else if ($op == 'save' && $delta == 3) {
    variable_set('user_block_seconds_online', $edit['user_block_seconds_online']);
    variable_set('user_block_max_list_count', $edit['user_block_max_list_count']);
  }
  else if ($op == 'view') {
Dries's avatar
 
Dries committed
671 672
    $block = array();

Dries's avatar
 
Dries committed
673 674
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
675 676
        // For usability's sake, avoid showing two login forms on one page.
        if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
Dries's avatar
 
Dries committed
677

Dries's avatar
Dries committed
678
          $block['subject'] = t('User login');
679
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
 
Dries committed
680
        }
Dries's avatar
Dries committed
681
        return $block;
Dries's avatar
Dries committed
682

683
      case 1:
684
        if ($menu = menu_tree()) {
685 686
          $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
          $block['content'] = $menu;
Dries's avatar
 
Dries committed
687
        }
688
        return $block;
Dries's avatar
Dries committed
689

Dries's avatar
 
Dries committed
690
      case 2:
691
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
692
          // Retrieve a list of new users who have subsequently accessed the site successfully.
693
          $result = db_query_range('SELECT uid, name FROM {users} WHERE status != 0 AND access != 0 ORDER BY created DESC', 0, variable_get('user_block_whois_new_count', 5));
694
          while ($account = db_fetch_object($result)) {
695
            $items[] = $account;
696
          }
Dries's avatar
Dries committed
697
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
698

Dries's avatar
Dries committed
699 700
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
701
        }
Dries's avatar
Dries committed
702 703
        return $block;

Dries's avatar
 
Dries committed
704
      case 3:
705
        if (user_access('access content')) {
706
          // Count users active within the defined period.
707
          $interval = time() - variable_get('user_block_seconds_online', 900);
708

709
          // Perform database queries to gather online user lists.  We use s.timestamp
710
          // rather than u.access because it is much faster.
711
          $anonymous_count = sess_count($interval);
712
          $authenticated_users = db_query('SELECT DISTINCT u.uid, u.name, s.timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.timestamp >= %d AND s.uid > 0 ORDER BY s.timestamp DESC', $interval);
713 714 715 716 717 718 719 720 721 722
          $authenticated_count = 0;
          $max_users = variable_get('user_block_max_list_count', 10);
          $items = array();
          while ($account = db_fetch_object($authenticated_users)) {
            if ($max_users > 0) {
              $items[] = $account;
              $max_users--;
            }
            $authenticated_count++;
          }
Dries's avatar
 
Dries committed
723

Dries's avatar
Dries committed
724
          // Format the output with proper grammar.
725 726
          if ($anonymous_count == 1 && $authenticated_count == 1) {
            $output = t('There is currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests')));
Dries's avatar
 
Dries committed
727 728
          }
          else {
729
            $output = t('There are currently %members and %visitors online.', array('%members' => format_plural($authenticated_count, '1 user', '@count users'), '%visitors' => format_plural($anonymous_count, '1 guest', '@count guests')));
Dries's avatar
 
Dries committed
730 731
          }

732 733
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
734
          if ($authenticated_count && $max_users) {
735 736
            $output .= theme('user_list', $items, t('Online users'));
          }
737

Dries's avatar
Dries committed
738 739
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
740
        }
Dries's avatar
 
Dries committed
741
        return $block;
Dries's avatar
 
Dries committed
742 743
    }
  }
744 745
}

746 747 748 749 750 751 752 753 754 755
/**
 * Process variables for user-picture.tpl.php.
 *
 * The $variables array contains the following arguments:
 * - $account
 *
 * @see user-picture.tpl.php
 */
function template_preprocess_user_picture(&$variables) {
  $variables['picture'] = '';
Dries's avatar
 
Dries committed
756
  if (variable_get('user_pictures', 0)) {
757
    $account = $variables['account'];
758
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
 
Dries committed
759 760 761 762 763 764
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

765
    if (isset($picture)) {
766
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
767
      $variables['picture'] = theme('image', $picture, $alt, $alt, '', FALSE);
768
      if (!empty($account->uid) && user_access('access user profiles')) {
769 770
        $attributes = array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE);
        $variables['picture'] = l($variables['picture'], "user/$account->uid", $attributes);
Dries's avatar
 
Dries committed
771 772 773 774 775
      }
    }
  }
}

776 777
/**
 * Make a list of users.
778 779 780 781 782
 *
 * @param $users
 *   An array with user objects. Should contain at least the name and uid.
 * @param $title
 *  (optional) Title to pass on to theme_item_list().
783 784 785 786
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
787 788 789 790
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
791
  }
Dries's avatar
Dries committed
792
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
793 794
}

795
function user_is_anonymous() {
796 797
  // Menu administrators can see items for anonymous when administering.
  return !$GLOBALS['user']->uid || !empty($GLOBALS['menu_admin']);
798 799 800 801 802 803 804
}

function user_is_logged_in() {
  return (bool)$GLOBALS['user']->uid;
}

function user_register_access() {
805
  return user_is_anonymous() && variable_get('user_register', 1);
806 807 808 809 810 811 812 813 814 815 816 817 818 819
}

function user_view_access($account) {
  return $account && $account->uid &&
    (
      // Always let users view their own profile.
      ($GLOBALS['user']->uid == $account->uid) ||
      // Administrators can view all accounts.
      user_access('administer users') ||
      // The user is not blocked and logged in at least once.
      ($account->access && $account->status && user_access('access user profiles'))
    );
}

820
function user_edit_access($account) {
821
  return (($GLOBALS['user']->uid == $account->uid) || user_access('administer users')) && $account->uid > 0;
822 823 824 825 826 827 828
}

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

Dries's avatar
 
Dries committed
829
/**
Dries's avatar
 
Dries committed
830
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
831
 */
832 833
function user_menu() {
  $items['user/autocomplete'] = array(
834
    'title' => 'User autocomplete',
835
    'page callback' => 'user_autocomplete',
836
    'access callback' => 'user_access',
837 838
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
839
    'file' => 'user.pages.inc',
840
  );
Dries's avatar
 
Dries committed
841

842
  // Registration and login pages.
843
  $items['user'] = array(
844
    'title' => 'User account',
845 846
    'page callback' => 'user_page',
    'access callback' => TRUE,
847
    'type' => MENU_CALLBACK,
848
    'file' => 'user.pages.inc',
849 850 851
  );

  $items['user/login'] = array(
852
    'title' => 'Log in',
853
    'access callback' => 'user_is_anonymous',
854 855
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
 
Dries committed
856

857
  $items['user/register'] = array(
858
    'title' => 'Create new account',
859 860 861 862
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
863
    'file' => 'user.pages.inc',
864 865 866
  );

  $items['user/password'] = array(
867
    'title' => 'Request new password',
868 869
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),