user.module 120 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
/**
 * Implementation of hook_theme()
 */
function user_theme() {
  return array(
    'user_picture' => array(
      'arguments' => array('account' => NULL),
    ),
    'user_profile' => array(
      'arguments' => array('account' => NULL, 'fields' => NULL),
    ),
    '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),
    ),
56 57 58
    'user_signature' => array(
      'arguments' => array('signature' => NULL),
    ),
59 60 61
  );
}

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

65
  if ($user = db_fetch_array($result)) {
Dries's avatar
 
Dries committed
66
    return user_load($user);
Dries's avatar
 
Dries committed
67 68 69 70 71 72
  }
  else {
    return 0;
  }
}

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
/**
* 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.
* @return boolean
*    TRUE if the login succeeds, FALSE otherwise.
*/
function user_external_login($account) {
  $form = drupal_get_form('user_login');

  $state = array();
  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
100 101 102 103 104
/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
105
 *   user, such as user name or e-mail address.
Dries's avatar
Dries committed
106 107
 *
 * @return
108
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
Dries's avatar
Dries committed
109
 */
Dries's avatar
 
Dries committed
110
function user_load($array = array()) {
Dries's avatar
Dries committed
111
  // Dynamically compose a SQL query:
112
  $query = array();
113
  $params = array();
114

115 116 117 118
  if (is_numeric($array)) {
    $array = array('uid' => $array);
  }

Dries's avatar
 
Dries committed
119
  foreach ($array as $key => $value) {
120 121
    if ($key == 'uid' || $key == 'status') {
      $query[] = "$key = %d";
122
      $params[] = $value;
123
    }
124 125 126 127
    else if ($key == 'pass') {
      $query[] = "pass = '%s'";
      $params[] = md5($value);
    }
Dries's avatar
 
Dries committed
128
    else {
129
      $query[]= "LOWER($key) = LOWER('%s')";
130
      $params[] = $value;
Dries's avatar
 
Dries committed
131 132
    }
  }
133
  $result = db_query('SELECT * FROM {users} u WHERE '. implode(' AND ', $query), $params);
Dries's avatar
 
Dries committed
134

135 136 137
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
Dries's avatar
 
Dries committed
138

139
    $user->roles = array();
140 141 142 143 144 145
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
146 147 148 149
    $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;
    }
150
    user_module_invoke('load', $array, $user);
151 152
  }
  else {
153
    $user = FALSE;
Dries's avatar
 
Dries committed
154
  }
Dries's avatar
 
Dries committed
155 156 157 158

  return $user;
}

159
/**
160
 * Save changes to a user account or add a new user.
161 162
 *
 * @param $account
163 164
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
165 166 167
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
168
 *   Setting a field to NULL deletes it from the data column.
169 170 171 172
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
173
function user_save($account, $array = array(), $category = 'account') {
Dries's avatar
Dries committed
174
  // Dynamically compose a SQL query:
Kjartan's avatar
Kjartan committed
175
  $user_fields = user_fields();
176
  if (is_object($account) && $account->uid) {
177
    user_module_invoke('update', $array, $account, $category);
178 179 180 181 182
    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);
    }
183
    $query = '';
Dries's avatar
Dries committed
184
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));
Dries's avatar
 
Dries committed
185
    foreach ($array as $key => $value) {
186
      if ($key == 'pass' && !empty($value)) {
Dries's avatar
 
Dries committed
187 188
        $query .= "$key = '%s', ";
        $v[] = md5($value);
Dries's avatar
 
Dries committed
189
      }
190
      else if ((substr($key, 0, 4) !== 'auth') && ($key != 'pass')) {
Kjartan's avatar
Kjartan committed
191
        if (in_array($key, $user_fields)) {
192
          // Save standard fields
Dries's avatar
 
Dries committed
193 194
          $query .= "$key = '%s', ";
          $v[] = $value;
Dries's avatar
 
Dries committed
195
        }
Dries's avatar
 
Dries committed
196
        else if ($key != 'roles') {
197
          // Roles is a special case: it used below.
198
          if ($value === NULL) {
199 200 201 202 203
            unset($data[$key]);
          }
          else {
            $data[$key] = $value;
          }
Dries's avatar
 
Dries committed
204
        }
Dries's avatar
 
Dries committed
205 206
      }
    }
207
    $query .= "data = '%s' ";
Dries's avatar
 
Dries committed
208
    $v[] = serialize($data);
Dries's avatar
 
Dries committed
209

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

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

216
      foreach (array_keys($array['roles']) as $rid) {
217 218 219
        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);
        }
220
      }
Dries's avatar
 
Dries committed
221 222
    }

223
    // Delete a blocked user's sessions to kick them if they are online.
224
    if (isset($array['status']) && $array['status'] == 0) {
225
      sess_destroy_uid($account->uid);
226 227
    }

228 229 230 231 232 233 234
    // If the password changed, delete all open sessions and recreate
    // the current one.
    if (isset($array['pass'])) {
      sess_destroy_uid($account->uid);
      sess_regenerate();
    }

235
    // Refresh user object
Dries's avatar
 
Dries committed
236
    $user = user_load(array('uid' => $account->uid));
237
    user_module_invoke('after_update', $array, $user, $category);
Dries's avatar
 
Dries committed
238 239
  }
  else {
240
    if (!isset($array['created'])) {    // Allow 'created' to be set by the caller
241 242 243
      $array['created'] = time();
    }

244 245 246
    // 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
247
    foreach ($array as $key => $value) {
248
      switch ($key) {
249 250 251
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
Dries's avatar
 
Dries committed
252
          $s[] = "'%s'";
Dries's avatar
Dries committed
253
          break;
254
        case 'mode':     case 'sort':
255 256 257 258 259 260 261 262 263 264 265 266 267
        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
268 269
      }
    }
Dries's avatar
Dries committed
270
    db_query('INSERT INTO {users} ('. implode(', ', $fields) .') VALUES ('. implode(', ', $s) .')', $values);
271
    $array['uid'] = db_last_insert_id('users', 'uid');
Dries's avatar
 
Dries committed
272

273 274
    // Build the initial user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
275

276 277 278 279 280
    user_module_invoke('insert', $array, $user, $category);

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

287
    // Save user roles (delete just to be safe).
288
    if (isset($roles) && is_array($array['roles'])) {
289 290 291 292 293
      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);
        }
294 295 296
      }
    }

297 298
    // Build the finished user object.
    $user = user_load(array('uid' => $array['uid']));
Dries's avatar
 
Dries committed
299 300
  }

301
  // Save distributed authentication mappings
302
  $authmaps = array();
Dries's avatar
 
Dries committed
303
  foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
304
    if (substr($key, 0, 4) == 'auth') {
Dries's avatar
 
Dries committed
305 306 307
      $authmaps[$key] = $value;
    }
  }
308
  if (sizeof($authmaps) > 0) {
Dries's avatar
 
Dries committed
309
    user_set_authmaps($user, $authmaps);
Dries's avatar
 
Dries committed
310 311 312 313 314
  }

  return $user;
}

Dries's avatar
Dries committed
315 316 317
/**
 * Verify the syntax of the given name.
 */
Dries's avatar
 
Dries committed
318
function user_validate_name($name) {
319
  if (!strlen($name)) return t('You must enter a username.');
Dries's avatar
Dries committed
320 321
  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.');
322
  if (strpos($name, '  ') !== FALSE) return t('The username cannot contain multiple spaces in a row.');
323
  if (ereg("[^\x80-\xF7 [:alnum:]@_.-]", $name)) return t('The username contains an illegal character.');
324 325 326 327 328 329 330
  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
331 332
                   '\x{FFF9}-\x{FFFD}'.      // Replacement characters
                   '\x{0}]/u',               // NULL byte
333 334 335
                   $name)) {
    return t('The username contains an illegal character.');
  }
336
  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.');
337
  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
338 339 340
}

function user_validate_mail($mail) {
Dries's avatar
Dries committed
341
  if (!$mail) return t('You must enter an e-mail address.');
342
  if (!valid_email_address($mail)) {
343
    return t('The e-mail address %mail is not valid.', array('%mail' => $mail));
Dries's avatar
 
Dries committed
344 345 346
  }
}

347
function user_validate_picture(&$form, &$form_state) {
348
  // If required, validate the uploaded picture.
349 350 351 352 353 354 355 356 357
  $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.
358
    $info = image_get_info($file->filepath);
359 360
    $destination = variable_get('user_picture_path', 'pictures') .'/picture-'. $form['#uid'] .'.'. $info['extension'];
    if (file_copy($file, $destination, FILE_EXISTS_REPLACE)) {
361
      $form_state['values']['picture'] = $file->filepath;
362
    }
363 364
    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'))));
365
    }
Dries's avatar
 
Dries committed
366 367 368
  }
}

Dries's avatar
Dries committed
369 370 371
/**
 * Generate a random alphanumeric password.
 */
Dries's avatar
 
Dries committed
372 373
function user_password($length = 10) {
  // This variable contains the list of allowable characters for the
374 375
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
376 377
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
Dries's avatar
Dries committed
378

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

Dries's avatar
Dries committed
382 383
  // Declare the password as a blank string.
  $pass = '';
Dries's avatar
 
Dries committed
384

Dries's avatar
Dries committed
385
  // Loop the number of times specified by $length.
Dries's avatar
 
Dries committed
386 387 388 389
  for ($i = 0; $i < $length; $i++) {

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

  return $pass;
Dries's avatar
 
Dries committed
394 395
}

Dries's avatar
Dries committed
396 397 398 399 400
/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
Dries's avatar
 
Dries committed
401 402
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
Dries's avatar
Dries committed
403 404
 *
 * @return
405
 *   boolean TRUE if the current user has the requested permission.
Dries's avatar
Dries committed
406 407 408 409 410
 *
 * 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
411
function user_access($string, $account = NULL) {
Dries's avatar
 
Dries committed
412
  global $user;
Dries's avatar
 
Dries committed
413
  static $perm = array();
Dries's avatar
 
Dries committed
414

415 416 417 418
  if (is_null($account)) {
    $account = $user;
  }

419
  // User #1 has all privileges:
420
  if ($account->uid == 1) {
421
    return TRUE;
Dries's avatar
 
Dries committed
422 423
  }

Dries's avatar
Dries committed
424 425
  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
426
  if (!isset($perm[$account->uid])) {
427
    $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
428

Steven Wittens's avatar
Steven Wittens committed
429
    $perm[$account->uid] = '';
Dries's avatar
 
Dries committed
430
    while ($row = db_fetch_object($result)) {
431
      $perm[$account->uid] .= "$row->perm, ";
Dries's avatar
 
Dries committed
432
    }
Dries's avatar
 
Dries committed
433
  }
434

435
  if (isset($perm[$account->uid])) {
436
    return strpos($perm[$account->uid], "$string, ") !== FALSE;
437
  }
438

439
  return FALSE;
Dries's avatar
 
Dries committed
440 441
}

442 443 444
/**
 * Checks for usernames blocked by user administration
 *
445
 * @return boolean TRUE for blocked users, FALSE for active
446 447
 */
function user_is_blocked($name) {
448
  $deny  = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
449

450
  return $deny;
451 452
}

Dries's avatar
 
Dries committed
453 454
function user_fields() {
  static $fields;
Dries's avatar
 
Dries committed
455

Dries's avatar
 
Dries committed
456
  if (!$fields) {
Dries's avatar
Dries committed
457
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
Kjartan's avatar
Kjartan committed
458 459 460
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
Dries's avatar
 
Dries committed
461 462
    else {
      // Make sure we return the default fields at least
463
      $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
464
    }
Dries's avatar
 
Dries committed
465
  }
Dries's avatar
 
Dries committed
466

Dries's avatar
 
Dries committed
467
  return $fields;
Dries's avatar
 
Dries committed
468 469
}

Dries's avatar
Dries committed
470 471 472
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
473
function user_perm() {
474
  return array('administer access control', 'administer users', 'access user profiles', 'change own username');
Dries's avatar
 
Dries committed
475 476
}

Dries's avatar
Dries committed
477 478 479 480 481
/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
Dries's avatar
 
Dries committed
482
function user_file_download($file) {
Steven Wittens's avatar
Steven Wittens committed
483
  if (strpos($file, variable_get('user_picture_path', 'pictures') .'/picture-') === 0) {
484 485
    $info = image_get_info(file_create_path($file));
    return array('Content-type: '. $info['mime_type']);
Dries's avatar
 
Dries committed
486 487 488
  }
}

Dries's avatar
Dries committed
489 490 491
/**
 * Implementation of hook_search().
 */
492
function user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE) {
493 494
  switch ($op) {
    case 'name':
495
      if ($skip_access_check || user_access('access user profiles')) {
496
        return t('Users');
497
      }
498
    case 'search':
499 500 501 502
      if (user_access('access user profiles')) {
        $find = array();
        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\*+!', '%', $keys);
503
        $result = pager_query("SELECT uid, name FROM {users} WHERE LOWER(name) LIKE LOWER('%%%s%%')", 15, 0, NULL, $keys);
504
        while ($account = db_fetch_object($result)) {
505
          $find[] = array('title' => $account->name, 'link' => url('user/'. $account->uid, array('absolute' => TRUE)));
506 507
        }
        return $find;
508
      }
Dries's avatar
 
Dries committed
509 510 511
  }
}

Dries's avatar
Dries committed
512 513 514
/**
 * Implementation of hook_user().
 */
515
function user_user($type, &$edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
516
  if ($type == 'view') {
517
    $items['history'] = array('title' => t('Member for'),
518 519 520 521 522
      'value' => format_interval(time() - $user->created),
      'class' => 'member',
    );

    return array(t('History') => $items);
Dries's avatar
Dries committed
523
  }
524
  if ($type == 'form' && $category == 'account') {
525 526
    $form_state = array();
    return user_edit_form($form_state, arg(1), $edit);
527 528 529
  }

  if ($type == 'validate' && $category == 'account') {
530
    return _user_edit_validate(arg(1), $edit);
531 532
  }

533 534 535 536
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }

537
  if ($type == 'categories') {
538
    return array(array('name' => 'account', 'title' => t('Account settings'), 'weight' => 1));
539
  }
Dries's avatar
Dries committed
540 541
}

542 543
function user_login_block() {
  $form = array(
544
    '#action' => url($_GET['q'], array('query' => drupal_get_destination())),
545
    '#id' => 'user-login-form',
546
    '#validate' => user_login_default_validators(),
547
    '#submit' => array('user_login_submit'),
548 549 550
  );
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Username'),
551
    '#maxlength' => USERNAME_MAX_LENGTH,
552 553 554 555 556
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array('#type' => 'password',
    '#title' => t('Password'),
557
    '#maxlength' => 60,
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    '#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
573 574 575
/**
 * Implementation of hook_block().
 */
576
function user_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
577 578
  global $user;

Dries's avatar
Dries committed
579 580 581 582 583
  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');
584

585
     return $blocks;
586
  }
587 588 589 590 591 592 593 594 595
  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;
  }
596 597
  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');
598 599
    $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.'));
600

601
    return $form;
602
  }
603 604 605
  else if ($op == 'save' && $delta == 2) {
    variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
  }
606 607 608 609 610
  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
611 612
    $block = array();

Dries's avatar
 
Dries committed
613 614
    switch ($delta) {
      case 0:
Dries's avatar
Dries committed
615 616
        // 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
617

Dries's avatar
Dries committed
618
          $block['subject'] = t('User login');
619
          $block['content'] = drupal_get_form('user_login_block');
Dries's avatar
 
Dries committed
620
        }
Dries's avatar
Dries committed
621
        return $block;
Dries's avatar
Dries committed
622

623
      case 1:
624
        if ($menu = menu_tree()) {
Dries's avatar
Dries committed
625
           $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
626
           $block['content'] = $menu;
Dries's avatar
 
Dries committed
627
        }
628
        return $block;
Dries's avatar
Dries committed
629

Dries's avatar
 
Dries committed
630
      case 2:
631
        if (user_access('access content')) {
Steven Wittens's avatar
Steven Wittens committed
632
          // Retrieve a list of new users who have subsequently accessed the site successfully.
633
          $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));
634
          while ($account = db_fetch_object($result)) {
635
            $items[] = $account;
636
          }
Dries's avatar
Dries committed
637
          $output = theme('user_list', $items);
Dries's avatar
 
Dries committed
638

Dries's avatar
Dries committed
639 640
          $block['subject'] = t('Who\'s new');
          $block['content'] = $output;
641
        }
Dries's avatar
Dries committed
642 643
        return $block;

Dries's avatar
 
Dries committed
644
      case 3:
645
        if (user_access('access content')) {
646
          // Count users active within the defined period.
647
          $interval = time() - variable_get('user_block_seconds_online', 900);
648

649
          // Perform database queries to gather online user lists.  We use s.timestamp
650
          // rather than u.access because it is much faster.
651
          $anonymous_count = sess_count($interval);
652
          $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);
653
          $authenticated_count = db_num_rows($authenticated_users);
Dries's avatar
 
Dries committed
654

Dries's avatar
Dries committed
655
          // Format the output with proper grammar.
656 657
          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
658 659
          }
          else {
660
            $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
661 662
          }

663 664
          // Display a list of currently online users.
          $max_users = variable_get('user_block_max_list_count', 10);
665
          if ($authenticated_count && $max_users) {
666
            $items = array();
667

668
            while ($max_users-- && $account = db_fetch_object($authenticated_users)) {
669 670
              $items[] = $account;
            }
671

672 673
            $output .= theme('user_list', $items, t('Online users'));
          }
674

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

Dries's avatar
 
Dries committed
683 684
function theme_user_picture($account) {
  if (variable_get('user_pictures', 0)) {
685
    if (!empty($account->picture) && file_exists($account->picture)) {
Dries's avatar
 
Dries committed
686 687 688 689 690 691
      $picture = file_create_url($account->picture);
    }
    else if (variable_get('user_picture_default', '')) {
      $picture = variable_get('user_picture_default', '');
    }

692
    if (isset($picture)) {
693
      $alt = t("@user's picture", array('@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous'))));
694
      $picture = theme('image', $picture, $alt, $alt, '', FALSE);
695
      if (!empty($account->uid) && user_access('access user profiles')) {
696
        $picture = l($picture, "user/$account->uid", array('attributes' => array('title' => t('View user profile.')), 'html' => TRUE));
Dries's avatar
 
Dries committed
697 698 699 700 701 702 703
      }

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

704 705 706
/**
 * Theme a user page
 * @param $account the user object
707 708 709 710 711
 * @param $fields a multidimensional array for the fields, in the form of array (
 *   'category1' => array(item_array1, item_array2), 'category2' => array(item_array3,
 *    .. etc.). Item arrays are formatted as array(array('title' => 'item title',
 * 'value' => 'item value', 'class' => 'class-name'), ... etc.). Module names are incorporated
 * into the CSS class.
712 713 714
 *
 * @ingroup themeable
 */
Dries's avatar
Dries committed
715
function theme_user_profile($account, $fields) {
716
  $output = '<div class="profile">';
Dries's avatar
 
Dries committed
717
  $output .= theme('user_picture', $account);
718
  foreach ($fields as $category => $items) {
719
    if (strlen($category) > 0) {
720
      $output .= '<h2 class="title">'. $category .'</h2>';
721
    }
722 723
    $output .= '<dl>';
    foreach ($items as $item) {
724
      if (isset($item['title'])) {
725
        $output .= '<dt class="'. $item['class'] .'">'. $item['title'] .'</dt>';
726 727
      }
      $output .= '<dd class="'. $item['class'] .'">'. $item['value'] .'</dd>';
728 729
    }
    $output .= '</dl>';
Dries's avatar
Dries committed
730
  }
731
  $output .= '</div>';
Dries's avatar
 
Dries committed
732 733 734 735

  return $output;
}

736 737 738 739 740 741 742
/**
 * 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) {
743 744 745 746
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
747
  }
Dries's avatar
Dries committed
748
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
749 750
}

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
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'))
    );
}

775
function user_edit_access($account) {
776
  return ($GLOBALS['user']->uid == $account->uid) || user_access('administer users');
777 778 779 780 781 782 783
}

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

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

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

  $items['user/login'] = array(
806
    'title' => 'Log in',
807 808
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
 
Dries committed
809

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

  $items['user/password'] = array(
819
    'title' => 'Request new password',
820 821
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_pass'),
822
    'access callback' => 'user_is_anonymous',
823 824 825
    'type' => MENU_LOCAL_TASK,
  );
  $items['user/reset/%/%/%'] = array(
826
    'title' => 'Reset password',
827 828 829 830 831 832 833 834
    '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(
835 836
    'title' => 'User management',
    'description' => "Manage your site's users, groups and access to site features.",
837 838 839
    'position' => 'left',
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
840 841
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
842 843
  );
  $items['admin/user/user'] = array(
844 845
    'title' => 'Users',
    'description' => 'List, add, and edit users.',
846 847 848 849
    'page callback' => 'user_admin',
    'page arguments' => array('list'),
    'access arguments' => array('administer users'));
  $items['admin/user/user/list'] = array(
850
    'title' => 'List',
851 852 853 854
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/user/user/create'] = array(
855
    'title' => 'Add user',
856 857 858 859
    'page arguments' => array('create'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/user/settings'] = array(
860 861
    'title' => 'User settings',
    'description' => 'Configure default behavior of users, including registration requirements, e-mails, and user pictures.',
862 863 864 865 866 867
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_settings'),
  );

  // Admin access pages
  $items['admin/user/access'] = array(
868 869
    'title' => 'Access control',
    'description' => 'Determine access to features by selecting permissions for roles.',
870 871 872 873 874
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_perm'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles'] = array(
875 876
    'title' => 'Roles',
    'description' => 'List, edit, or add user roles.',
877 878 879 880 881
    'page callback' => 'drupal_get_form',
    'page arguments' => array('user_admin_new_role'),
    'access arguments' => array('administer access control'),
  );
  $items['admin/user/roles/edit'] = array(
882
    'title' => 'Edit role',
883 884 885 886
    'page arguments' => array('user_admin_role'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/rules'] = array(
887 888
    'title' => 'Access rules',
    'description' => 'List and create rules to disallow usernames, e-mail addresses, and IP addresses.',
Dries's avatar