user.module 121 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 29 30 31 32 33 34 35
/**
 * Implementation of hook_theme()
 */
function user_theme() {
  return array(
    'user_picture' => array(
      'arguments' => array('account' => NULL),
    ),
    'user_profile' => array(
36 37 38 39 40 41 42 43 44 45
      'arguments' => array('account' => NULL),
      'file' => 'user_profile',
    ),
    'user_profile_category' => array(
      'arguments' => array('element' => NULL),
      'file' => 'user_profile_category',
    ),
    'user_profile_item' => array(
      'arguments' => array('element' => NULL),
      'file' => 'user_profile_item',
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    ),
    'user_list' => array(
      'arguments' => array('users' => NULL, 'title' => NULL),
    ),
    'user_admin_perm' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_admin_new_role' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_admin_account' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_filter_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'user_filters' => array(
      'arguments' => array('form' => NULL),
    ),
65 66 67
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
68 69 70
  );
}

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

74
  if ($user = db_fetch_array($result)) {
Dries's avatar
 
Dries committed
75
    return user_load($user);
Dries's avatar
 
Dries committed
76 77 78 79 80 81
  }
  else {
    return 0;
  }
}

82
/**
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
 * Perform standard Drupal login operations for a user object.  The
 * user object must already be authenticated. This function verifies
 * that the user account is not blocked/denied and then performs the login,
 * updates the login timestamp in the database, invokes hook_user('login'),
 * regenerates the session, etc.
 *
 * @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.
 * @return boolean
 *    TRUE if the login succeeds, FALSE otherwise.
 */
function user_external_login($account, $edit = array()) {
98 99
  $form = drupal_get_form('user_login');

100 101 102 103 104
  $state['values'] = $edit;
  if (empty($state['values']['name'])) {
    $state['values']['name'] = $account->name;
  }

105 106 107 108 109 110 111 112 113 114
  user_login_name_validate($form, $state, (array)$account);
  if (form_get_errors()) {
    return FALSE;
  }
  global $user;
  $user = $account;
  user_login_submit($form, $state, (array)$account);
  return TRUE;
}

Dries's avatar
Dries committed
115 116 117 118 119
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
120
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
121 122
 *
 * @return
123
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
Dries's avatar
Dries committed
124
 */
Dries's avatar
 
Dries committed
125
function user_load($array = array()) {
Dries's avatar
Dries committed
126
  // Dynamically compose a SQL query:
127
  $query = array();
128
  $params = array();
129

130 131 132 133
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }

Dries's avatar
 
Dries committed
134
  foreach ($array as $key => $value) {
135 136
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
137
      $params[] = $value;
138
    }
139 140 141 142
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
 
Dries committed
143
    else {
144
      $query[]= "LOWER($key) = LOWER('%s')";
145
      $params[] = $value;
Dries's avatar
 
Dries committed
146 147
    }
  }
148
  $result = db_query('SELECT * FROM {users} u WHERE '. implode(' AND ', $query), $params);
Dries's avatar
 
Dries committed
149

150 151 152
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
Dries's avatar
 
Dries committed
153

154
    $user->roles = array();
155 156 157 158 159 160
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
161 162 163 164
    $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;
    }
165
    user_module_invoke('load', $array, $user);
166 167
  }
  else {
168
    $user = FALSE;
Dries's avatar
 
Dries committed
169
  }
Dries's avatar
 
Dries committed
170 171 172 173

  return $user;
}

174
/**
175
 * Save changes to a user account or add a new user.
176 177
 *
 * @param $account
178 179
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
180 181 182
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
183
 *   Setting a field to NULL deletes it from the data column.
184 185 186 187
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
188
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
189
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
190
  $user_fields = user_fields();
191
  if (is_object($account) && $account->uid) {
192
    user_module_invoke('update', $array, $account, $category);
193 194 195 196 197
    if (isset($array['status']) && $array['status'] != $account->status) {
      // The user's status is changing, conditionally send notification email.
      $op = $array['status'] == 1 ? 'status_activated' : 'status_blocked';
      _user_mail_notify($op, $account);
    }
198
    $query = '';
Dries's avatar
Dries committed
199
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
Dries's avatar
 
Dries committed
200
    foreach ($array as $key => $value) {
201
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
 
Dries committed
202 203
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
 
Dries committed
204
      }
205
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
206
        if (in_array($key, $user_fields)) {
207
          // Save standard fields
Dries's avatar
 
Dries committed
208 209
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
 
Dries committed
210
        }
Dries's avatar
 
Dries committed
211
        else if ($key != 'roles') {
212
          // Roles is a special case: it used below.
213
          if ($value === NULL) {
214 215 216 217 218
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
 
Dries committed
219
        }
Dries's avatar
 
Dries committed
220 221
      }
    }
222
    $query .= "data = '%s' ";
Dries's avatar
 
Dries committed
223
    $v[] = serialize($data);
Dries's avatar
 
Dries committed
224

225
    db_query("UPDATE {users} SET $query WHERE uid = %d", array_merge($v, array($account->uid)));
Dries's avatar
 
Dries committed
226

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

231
      foreach (array_keys($array['roles']) as $rid) {
232 233 234
        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);
        }
235
      }
Dries's avatar
 
Dries committed
236 237
    }

238
    // Delete a blocked user's sessions to kick them if they are online.
239
    if (isset($array['status']) && $array['status'] == 0) {
240
      sess_destroy_uid($account->uid);
241 242
    }

243 244 245 246 247 248 249
    // If the password changed, delete all open sessions and recreate
    // the current one.
    if (isset($array['pass'])) {
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

250
    // Refresh user object
Dries's avatar
 
Dries committed
251
    $user = user_load(array('uid' => $account->uid));
252
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
 
Dries committed
253 254
  }
  else {
255
    if (!isset($array['created'])) {    // Allow 'created' to be set by the caller
256 257 258
      $array['created'] = time();
    }

259 260 261
    // Note, we wait with saving the data column to prevent module-handled
    // fields from being saved there. We cannot invoke hook_user('insert') here
    // because we don't have a fully initialized user object yet.
Dries's avatar
 
Dries committed
262
    foreach ($array as $key => $value) {
263
      switch ($key) {
264 265 266
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
 
Dries committed
267
          $s[] = "'%s'";
Dries's avatar
Dries committed
268
          break;
269
        case 'mode':     case 'sort':
270 271 272 273 274 275 276 277 278 279 280 281 282
        case 'threshold':  case 'created':  case 'access':
        case 'login':      case 'status':
          $fields[] = $key;
          $values[] = $value;
          $s[] = "%d";
          break;
        default:
          if (substr($key, 0, 4) !== 'auth' && in_array($key, $user_fields)) {
            $fields[] = $key;
            $values[] = $value;
            $s[] = "'%s'";
          }
          break;
Dries's avatar
 
Dries committed
283 284
      }
    }
Dries's avatar
Dries committed
285
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
286
    $array['uid'] = db_last_insert_id('users', 'uid');
Dries's avatar
 
Dries committed
287

288 289
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
290

291 292 293 294 295
    user_module_invoke('insert', $array, $user, $category);

    // Build and save the serialized data field now
    $data = array();
    foreach ($array as $key => $value) {
296
      if ((substr($key, 0, 4) !== 'auth') && ($key != 'roles') && (!in_array($key, $user_fields)) && ($value !== NULL)) {
297 298 299 300 301
        $data[$key] = $value;
      }
    }
    db_query("UPDATE {users} SET data = '%s' WHERE uid = %d", serialize($data), $user->uid);

302
    // Save user roles (delete just to be safe).
303
    if (isset($roles) && is_array($array['roles'])) {
304 305 306 307 308
      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);
        }
309 310 311
      }
    }

312 313
    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
314 315
  }

316
  // Save distributed authentication mappings
317
  $authmaps = array();
Dries's avatar
 
Dries committed
318
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
319
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
 
Dries committed
320 321 322
      $authmaps[$key] = $value;
    }
  }
323
  if (sizeof($authmaps) > 0) {
Dries's avatar
 
Dries committed
324
    user_set_authmaps($user, $authmaps);
Dries's avatar
 
Dries committed
325 326 327 328 329
  }

  return $user;
}

Dries's avatar
Dries committed
330 331 332
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
333
function user_validate_name($name) {
334
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
335 336
  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.');
337
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
338
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
339 340 341 342 343 344 345
  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
346 347
                   '\x{FFF9}-\x{FFFD}'.      // Replacement characters
                   '\x{0}]/u',               // NULL byte
348 349 350
                   $name)) {
    return t('The username contains an illegal character.');
  }
351
  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.');
352
  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
353 354 355
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
356
  if (!$mail) return t('You must enter an e-mail address.');
357
  if (!valid_email_address($mail)) {
358
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
359 360 361
  }
}

362
function user_validate_picture(&$form, &$form_state) {
363
  // If required, validate the uploaded picture.
364 365 366 367 368 369 370 371 372
  $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)) {
    // The image was saved using file_save_upload() and was added to the
    // files table as a temorary file. We'll make a copy and let the garbage
    // collector delete the original upload.
373
    $info = image_get_info($file->filepath);
374 375
    $destination = variable_get('user_picture_path', 'pictures') .'/picture-'. $form['#uid'] .'.'. $info['extension'];
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
376
      $form_state['values']['picture'] = $file->filepath;
377
    }
378 379
    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'))));
380
    }
Dries's avatar
 
Dries committed
381 382 383
  }
}

Dries's avatar
Dries committed
384 385 386
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
387 388
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
389 390
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
391 392
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
393

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

Dries's avatar
Dries committed
397 398
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
399

Dries's avatar
Dries committed
400
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
401 402 403 404
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
409 410
}

Dries's avatar
Dries committed
411 412 413 414 415
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
416 417
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
418 419
 *
 * @return
420
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
421 422 423 424 425
 *
 * 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.
 */
Dries's avatar
 
Dries committed
426
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
427
  global $user;
Dries's avatar
 
Dries committed
428
  static $perm = array();
Dries's avatar
 
Dries committed
429

430 431 432 433
  if (is_null($account)) {
    $account = $user;
  }

434
  // User #1 has all privileges:
435
  if ($account->uid == 1) {
436
    return TRUE;
Dries's avatar
 
Dries committed
437 438
  }

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

Steven Wittens's avatar
Steven Wittens committed
444
    $perm[$account->uid] = '';
Dries's avatar
 
Dries committed
445
    while ($row = db_fetch_object($result)) {
446
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
447
    }
Dries's avatar
 
Dries committed
448
  }
449

450
  if (isset($perm[$account->uid])) {
451
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
452
  }
453

454
  return FALSE;
Dries's avatar
 
Dries committed
455 456
}

457 458 459
/**
 * Checks for usernames blocked by user administration
 *
460
 * @return boolean TRUE for blocked users, FALSE for active
461 462
 */
function user_is_blocked($name) {
463
  $deny  = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
464

465
  return $deny;
466 467
}

Dries's avatar
 
Dries committed
468 469
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
470

Dries's avatar
 
Dries committed
471
  if (!$fields) {
Dries's avatar
Dries committed
472
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
473 474 475
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
476 477
    else {
      // Make sure we return the default fields at least
478
      $fields = array('uid', 'name', 'pass', 'mail', 'picture', 'mode', 'sort', 'threshold', 'theme', 'signature', 'created', 'access', 'login', 'status', 'timezone', 'language', 'init', 'data');
Dries's avatar
 
Dries committed
479
    }
Dries's avatar
 
Dries committed
480
  }
Dries's avatar
 
Dries committed
481

Dries's avatar
 
Dries committed
482
  return $fields;
Dries's avatar
 
Dries committed
483 484
}

Dries's avatar
Dries committed
485 486 487
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
488
function user_perm() {
489
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
 
Dries committed
490 491
}

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

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

Dries's avatar
Dries committed
536 537 538
/**
 * Implementation of hook_user().
 */
539
function user_user($type, &$edit, &$account, $category = NULL) {
Dries's avatar
Dries committed
540
  if ($type == 'view') {
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
    $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'),
      '#weight' => -5,
      '#title' => t('History'),
    );
    $account->content['summary']['member_for'] =  array(
      '#type' => 'user_profile_item',
      '#title' => t('Member for'),
      '#value' => format_interval(time() - $account->created),
558
    );
Dries's avatar
Dries committed
559
  }
560
  if ($type == 'form' && $category == 'account') {
561 562
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
563 564 565
  }

  if ($type == 'validate' && $category == 'account') {
566
    return _user_edit_validate(arg(1), $edit);
567 568
  }

569 570 571 572
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

573
  if ($type == 'categories') {
574
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
575
  }
Dries's avatar
Dries committed
576 577
}

578 579
function user_login_block() {
  $form = array(
580
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
581
    '#id' => 'user-login-form',
582
    '#validate' => user_login_default_validators(),
583
    '#submit' => array('user_login_submit'),
584 585 586
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
587
    '#maxlength' => USERNAME_MAX_LENGTH,
588 589 590 591 592
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
593
    '#maxlength' => 60,
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
    '#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
609 610 611
/**
 * Implementation of hook_block().
 */
612
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
613 614
  global $user;

Dries's avatar
Dries committed
615 616 617 618 619
  if ($op == 'list') {
     $blocks[0]['info'] = t('User login');
     $blocks[1]['info'] = t('Navigation');
     $blocks[2]['info'] = t('Who\'s new');
     $blocks[3]['info'] = t('Who\'s online');
620

621
     return $blocks;
622
  }
623 624 625 626 627 628 629 630 631
  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;
  }
632 633
  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');
634 635
    $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.'));
636

637
    return $form;
638
  }
639 640 641
  else if ($op == 'save' && $delta == 2) {
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
642 643 644 645 646
  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
647 648
    $block = array();

Dries's avatar
 
Dries committed
649 650
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
651 652
        // 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
653

Dries's avatar
Dries committed
654
          $block['subject'] = t('User login');
655
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
 
Dries committed
656
        }
Dries's avatar
Dries committed
657
        return $block;
Dries's avatar
Dries committed
658

659
      case 1:
660
        if ($menu = menu_tree()) {
Dries's avatar
Dries committed
661
           $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
662
           $block['content'] = $menu;
Dries's avatar
 
Dries committed
663
        }
664
        return $block;
Dries's avatar
Dries committed
665

Dries's avatar
 
Dries committed
666
      case 2:
667
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
668
          // Retrieve a list of new users who have subsequently accessed the site successfully.
669
          $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));
670
          while ($account = db_fetch_object($result)) {
671
            $items[] = $account;
672
          }
Dries's avatar
Dries committed
673
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
674

Dries's avatar
Dries committed
675 676
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
677
        }
Dries's avatar
Dries committed
678 679
        return $block;

Dries's avatar
 
Dries committed
680
      case 3:
681
        if (user_access('access content')) {
682
          // Count users active within the defined period.
683
          $interval = time() - variable_get('user_block_seconds_online', 900);
684

685
          // Perform database queries to gather online user lists.  We use s.timestamp
686
          // rather than u.access because it is much faster.
687
          $anonymous_count = sess_count($interval);
688
          $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);
689
          $authenticated_count = db_num_rows($authenticated_users);
Dries's avatar
 
Dries committed
690

Dries's avatar
Dries committed
691
          // Format the output with proper grammar.
692 693
          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
694 695
          }
          else {
696
            $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
697 698
          }

699 700
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
701
          if ($authenticated_count && $max_users) {
702
            $items = array();
703

704
            while ($max_users-- && $account = db_fetch_object($authenticated_users)) {
705 706
              $items[] = $account;
            }
707

708 709
            $output .= theme('user_list', $items, t('Online users'));
          }
710

Dries's avatar
Dries committed
711 712
          $block['subject'] = t('Who\'s online');
          $block['content'] = $output;
Dries's avatar
 
Dries committed
713
        }
Dries's avatar
 
Dries committed
714
        return $block;
Dries's avatar
 
Dries committed
715 716
    }
  }
717 718
}

Dries's avatar
 
Dries committed
719 720
function theme_user_picture($account) {
  if (variable_get('user_pictures', 0)) {
721
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
 
Dries committed
722 723 724 725 726 727
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

728
    if (isset($picture)) {
729
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
730
      $picture = theme('image', $picture, $alt, $alt, '', FALSE);
731
      if (!empty($account->uid) && user_access('access user profiles')) {
732
        $picture = l($picture, "user/$account->uid", array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE));
Dries's avatar
 
Dries committed
733 734 735 736 737 738 739
      }

      return "<div class=\"picture\">$picture</div>";
    }
  }
}

740 741 742 743 744 745 746
/**
 * Make a list of users.
 * @param $items an array with user objects. Should contain at least the name and uid
 *
 * @ingroup themeable
 */
function theme_user_list($users, $title = NULL) {
747 748 749 750
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
751
  }
Dries's avatar
Dries committed
752
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
753 754
}

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
function user_is_anonymous() {
  return !$GLOBALS['user']->uid;
}

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

function user_register_access() {
  return !$GLOBALS['user']->uid && variable_get('user_register', 1);
}

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'))
    );
}

779
function user_edit_access($account) {
780
  return ($GLOBALS['user']->uid == $account->uid) || user_access('administer users');
781 782 783 784 785 786 787
}

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

Dries's avatar
 
Dries committed
788
/**
Dries's avatar
 
Dries committed
789
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
790
 */
791 792
function user_menu() {
  $items['user/autocomplete'] = array(
793
    'title' => 'User autocomplete',
794
    'page callback' => 'user_autocomplete',
795
    'access callback' => 'user_access',
796 797 798
    'access arguments' => array('access user profiles'),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
 
Dries committed
799

800
  // Registration and login pages.
801
  $items['user'] = array(
802
    'title' => 'Log in',
803 804 805
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_login'),
    'access callback' => 'user_is_anonymous',
806
    'type' => MENU_CALLBACK,
807 808 809
  );

  $items['user/login'] = array(
810
    'title' => 'Log in',
811 812
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
 
Dries committed
813

814
  $items['user/register'] = array(
815
    'title' => 'Create new account',
816 817 818 819 820 821 822
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_register'),
    'access callback' => 'user_register_access',
    'type' => MENU_LOCAL_TASK,
  );

  $items['user/password'] = array(
823
    'title' => 'Request new password',
824 825
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),
826
    'access callback' => 'user_is_anonymous',
827 828 829
    'type' => MENU_LOCAL_TASK,
  );
  $items['user/reset/%/%/%'] = array(
830
    'title' => 'Reset password',
831 832 833 834 835 836 837 838
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass_reset', 2, 3, 4),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
  );

  // Admin user pages
  $items['admin/user'] = array(
839 840
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
841 842 843
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
844 845
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
846 847
  );
  $items['admin/user/user'] = array(
848 849
    'title' => 'Users',
    'description' => 'List, add, and edit users.',
850 851 852 853
    'page callback' => 'user_admin',
    'page arguments' => array('list'),
    'access arguments' => array('administer users'));
  $items['admin/user/user/list'] = array(
854
    'title' => 'List',
855 856 857 858
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/user/create'] = array(
859
    'title' => 'Add user',
860 861 862 863
    'page arguments' => array('create'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/settings'] = array(
864 865
    'title' => 'User settings',
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, and user pictures.',
866 867 868 869 870 871
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_settings'),
  );

  // Admin access pages
  $items['admin/user/access'] = array(
872 873
    'title' => 'Access control',
    'description' => 'Determine access to features by selecting permissions for roles.',
874 875 876 877 878
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_perm'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles'] = array(
879 880
    'title' => 'Roles',
    'description' => 'List, edit, or add user roles.',
881 882 883 884 885
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_new_role'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles/edit'] = array(
886
    'title' => 'Edit role',
887 888 889 890
    'page arguments' => array('user_admin_role'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/rules'] = array(
891 892
    'title' => 'Access rules',
    'description' => 'List and create rules to disallow usernames, e-mail addresses, and IP addresses.',
893 894 895 896
    'page callback' => 'user_admin_access',
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/rules/list'] = array(
897
    'title' => 'List',
898 899 900 901
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/rules/add'] = array(
902
    'title' => 'Add rule',
903 904 905 906
    'page callback' => 'user_admin_access_add',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/rules/check'] = array(
907
    'title' => 'Check rules',