You are here

user.module in Drupal 5

Same filename and directory in other branches
  1. 6 modules/user/user.module
  2. 7 modules/user/user.module

Enables the user registration and login system.

File

modules/user/user.module
View source
<?php

/**
 * @file
 * Enables the user registration and login system.
 */
define('USERNAME_MAX_LENGTH', 60);
define('EMAIL_MAX_LENGTH', 64);

/**
 * Invokes hook_user() in every module.
 *
 * We cannot use module_invoke() for this, because the arguments need to
 * be passed by reference.
 */
function user_module_invoke($type, &$array, &$user, $category = NULL) {
  foreach (module_list() as $module) {
    $function = $module . '_user';
    if (function_exists($function)) {
      $function($type, $array, $user, $category);
    }
  }
}
function user_external_load($authname) {
  $result = db_query("SELECT uid FROM {authmap} WHERE authname = '%s'", $authname);
  if ($user = db_fetch_array($result)) {
    return user_load($user);
  }
  else {
    return 0;
  }
}

/**
 * Fetch a user object.
 *
 * @param $array
 *   An associative array of attributes to search for in selecting the
 *   user, such as user name or e-mail address.
 *
 * @return
 *   A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.
 */
function user_load($array = array()) {

  // Dynamically compose a SQL query:
  $query = array();
  $params = array();
  foreach ($array as $key => $value) {
    if ($key == 'uid' || $key == 'status') {
      $query[] = "{$key} = %d";
      $params[] = $value;
    }
    else {
      if ($key == 'pass') {
        $query[] = "pass = '%s'";
        $params[] = md5($value);
      }
      else {
        $query[] = "LOWER({$key}) = LOWER('%s')";
        $params[] = $value;
      }
    }
  }
  $result = db_query('SELECT * FROM {users} u WHERE ' . implode(' AND ', $query), $params);
  if (db_num_rows($result)) {
    $user = db_fetch_object($result);
    $user = drupal_unpack($user);
    $user->roles = array();
    if ($user->uid) {
      $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
    }
    else {
      $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
    }
    $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;
    }
    user_module_invoke('load', $array, $user);
  }
  else {
    $user = FALSE;
  }
  return $user;
}

/**
 * Save changes to a user account or add a new user.
 *
 * @param $account
 *   The $user object for the user to modify or add. If $user->uid is
 *   omitted, a new user will be added.
 *
 * @param $array
 *   An array of fields and values to save. For example array('name' => 'My name');
 *   Setting a field to NULL deletes it from the data column.
 *
 * @param $category
 *   (optional) The category for storing profile information in.
 */
function user_save($account, $array = array(), $category = 'account') {

  // Dynamically compose a SQL query:
  $user_fields = user_fields();
  if ($account->uid) {
    user_module_invoke('update', $array, $account, $category);
    $data = unserialize(db_result(db_query('SELECT data FROM {users} WHERE uid = %d', $account->uid)));

    // 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();
    }
    foreach ($array as $key => $value) {
      if ($key == 'pass' && !empty($value)) {
        $query .= "{$key} = '%s', ";
        $v[] = md5($value);
      }
      else {
        if (substr($key, 0, 4) !== 'auth' && $key != 'pass') {
          if (in_array($key, $user_fields)) {

            // Save standard fields
            $query .= "{$key} = '%s', ";
            $v[] = $value;
          }
          else {
            if ($key != 'roles') {

              // Roles is a special case: it used below.
              if ($value === NULL) {
                unset($data[$key]);
              }
              else {
                $data[$key] = $value;
              }
            }
          }
        }
      }
    }
    $query .= "data = '%s' ";
    $v[] = serialize($data);
    db_query("UPDATE {users} SET {$query} WHERE uid = %d", array_merge($v, array(
      $account->uid,
    )));

    // Reload user roles if provided
    if (is_array($array['roles'])) {
      db_query('DELETE FROM {users_roles} WHERE uid = %d', $account->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)', $account->uid, $rid);
        }
      }
    }

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

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

    // Refresh user object
    $user = user_load(array(
      'uid' => $account->uid,
    ));
    user_module_invoke('after_update', $array, $user, $category);
  }
  else {
    $array['uid'] = db_next_id('{users}_uid');
    if (!isset($array['created'])) {

      // Allow 'created' to be set by hook_auth
      $array['created'] = time();
    }

    // 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();
    }

    // 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.
    foreach ($array as $key => $value) {
      switch ($key) {
        case 'pass':
          $fields[] = $key;
          $values[] = md5($value);
          $s[] = "'%s'";
          break;
        case 'uid':
        case 'mode':
        case 'sort':
        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;
      }
    }
    db_query('INSERT INTO {users} (' . implode(', ', $fields) . ') VALUES (' . implode(', ', $s) . ')', $values);

    // Build the initial user object.
    $user = user_load(array(
      'uid' => $array['uid'],
    ));
    user_module_invoke('insert', $array, $user, $category);

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

    // Save user roles (delete just to be safe).
    if (is_array($array['roles'])) {
      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);
        }
      }
    }

    // Build the finished user object.
    $user = user_load(array(
      'uid' => $array['uid'],
    ));
  }

  // Save distributed authentication mappings
  $authmaps = array();
  foreach ($array as $key => $value) {
    if (substr($key, 0, 4) == 'auth') {
      $authmaps[$key] = $value;
    }
  }
  if (sizeof($authmaps) > 0) {
    user_set_authmaps($user, $authmaps);
  }
  return $user;
}

/**
 * Verify the syntax of the given name.
 */
function user_validate_name($name) {
  if (!strlen($name)) {
    return t('You must enter a username.');
  }
  if (substr($name, 0, 1) == ' ') {
    return t('The username cannot begin with a space.');
  }
  if (substr($name, -1) == ' ') {
    return t('The username cannot end with a space.');
  }
  if (strpos($name, '  ') !== FALSE) {
    return t('The username cannot contain multiple spaces in a row.');
  }
  if (ereg("", $name)) {
    return t('The username contains an illegal character.');
  }
  if (preg_match('/[\\x{80}-\\x{A0}' . '\\x{AD}' . '\\x{2000}-\\x{200F}' . '\\x{2028}-\\x{202F}' . '\\x{205F}-\\x{206F}' . '\\x{FEFF}' . '\\x{FF01}-\\x{FF60}' . '\\x{FFF9}-\\x{FFFD}' . '\\x{0}]/u', $name)) {
    return t('The username contains an illegal character.');
  }
  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.');
  }
  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,
    ));
  }
}
function user_validate_mail($mail) {
  if (!$mail) {
    return t('You must enter an e-mail address.');
  }
  if (!valid_email_address($mail)) {
    return t('The e-mail address %mail is not valid.', array(
      '%mail' => $mail,
    ));
  }
}
function user_validate_picture($file, &$edit, $user) {
  global $form_values;

  // Initialize the picture:
  $form_values['picture'] = $user->picture;

  // Check that uploaded file is an image, with a maximum file size
  // and maximum height/width.
  $info = image_get_info($file->filepath);
  list($maxwidth, $maxheight) = explode('x', variable_get('user_picture_dimensions', '85x85'));
  if (!$info || !$info['extension']) {
    form_set_error('picture_upload', t('The uploaded file was not an image.'));
  }
  else {
    if (image_get_toolkit()) {
      image_scale($file->filepath, $file->filepath, $maxwidth, $maxheight);
    }
    else {
      if (filesize($file->filepath) > variable_get('user_picture_file_size', '30') * 1000) {
        form_set_error('picture_upload', t('The uploaded image is too large; the maximum file size is %size kB.', array(
          '%size' => variable_get('user_picture_file_size', '30'),
        )));
      }
      else {
        if ($info['width'] > $maxwidth || $info['height'] > $maxheight) {
          form_set_error('picture_upload', t('The uploaded image is too large; the maximum dimensions are %dimensions pixels.', array(
            '%dimensions' => variable_get('user_picture_dimensions', '85x85'),
          )));
        }
      }
    }
  }
  if (!form_get_errors()) {
    if ($file = file_save_upload('picture_upload', variable_get('user_picture_path', 'pictures') . '/picture-' . $user->uid . '.' . $info['extension'], 1)) {
      $form_values['picture'] = $file->filepath;
    }
    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'),
      )));
    }
  }
}

/**
 * Generate a random alphanumeric password.
 */
function user_password($length = 10) {

  // This variable contains the list of allowable characters for the
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
  // of 'I', 1, and l.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';

  // Zero-based count of characters in the allowable list:
  $len = strlen($allowable_characters) - 1;

  // Declare the password as a blank string.
  $pass = '';

  // Loop the number of times specified by $length.
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
    $pass .= $allowable_characters[mt_rand(0, $len)];
  }
  return $pass;
}

/**
 * Determine whether the user has a given privilege.
 *
 * @param $string
 *   The permission, such as "administer nodes", being checked for.
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
 *
 * @return
 *   boolean TRUE if the current user has the requested permission.
 *
 * 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.
 */
function user_access($string, $account = NULL) {
  global $user;
  static $perm = array();
  if (is_null($account)) {
    $account = $user;
  }

  // User #1 has all privileges:
  if ($account->uid == 1) {
    return TRUE;
  }

  // To reduce the number of SQL queries, we cache the user's permissions
  // in a static variable.
  if (!isset($perm[$account->uid])) {
    $rids = array_keys($account->roles);
    $placeholders = implode(',', array_fill(0, count($rids), '%d'));
    $result = db_query("SELECT DISTINCT(p.perm) FROM {role} r INNER JOIN {permission} p ON p.rid = r.rid WHERE r.rid IN ({$placeholders})", $rids);
    $perm[$account->uid] = '';
    while ($row = db_fetch_object($result)) {
      $perm[$account->uid] .= "{$row->perm}, ";
    }
  }
  if (isset($perm[$account->uid])) {
    return strpos($perm[$account->uid], "{$string}, ") !== FALSE;
  }
  return FALSE;
}

/**
 * Checks for usernames blocked by user administration
 *
 * @return boolean TRUE for blocked users, FALSE for active
 */
function user_is_blocked($name) {
  $deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));
  return $deny;
}
function user_fields() {
  static $fields;
  if (!$fields) {
    $result = db_query('SELECT * FROM {users} WHERE uid = 1');
    if (db_num_rows($result)) {
      $fields = array_keys(db_fetch_array($result));
    }
    else {

      // Make sure we return the default fields at least
      $fields = array(
        'uid',
        'name',
        'pass',
        'mail',
        'picture',
        'mode',
        'sort',
        'threshold',
        'theme',
        'signature',
        'created',
        'access',
        'login',
        'status',
        'timezone',
        'language',
        'init',
        'data',
      );
    }
  }
  return $fields;
}

/**
 * Implementation of hook_perm().
 */
function user_perm() {
  return array(
    'administer access control',
    'administer users',
    'access user profiles',
    'change own username',
  );
}

/**
 * Implementation of hook_file_download().
 *
 * Ensure that user pictures (avatars) are always downloadable.
 */
function user_file_download($file) {
  if (strpos($file, variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
    $info = image_get_info(file_create_path($file));
    return array(
      'Content-type: ' . $info['mime_type'],
    );
  }
}

/**
 * Implementation of hook_search().
 */
function user_search($op = 'search', $keys = NULL) {
  switch ($op) {
    case 'name':
      if (user_access('access user profiles')) {
        return t('Users');
      }
    case 'search':
      if (user_access('access user profiles')) {
        $find = array();

        // Replace wildcards with MySQL/PostgreSQL wildcards.
        $keys = preg_replace('!\\*+!', '%', $keys);
        $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, NULL, NULL, TRUE),
          );
        }
        return $find;
      }
  }
}

/**
 * Implementation of hook_user().
 */
function user_user($type, &$edit, &$user, $category = NULL) {
  if ($type == 'view') {
    $items['history'] = array(
      'title' => t('Member for'),
      'value' => format_interval(time() - $user->created),
      'class' => 'member',
    );
    return array(
      t('History') => $items,
    );
  }
  if ($type == 'form' && $category == 'account') {
    return user_edit_form(arg(1), $edit);
  }
  if ($type == 'validate' && $category == 'account') {
    return _user_edit_validate(arg(1), $edit);
  }
  if ($type == 'submit' && $category == 'account') {
    return _user_edit_submit(arg(1), $edit);
  }
  if ($type == 'categories') {
    return array(
      array(
        'name' => 'account',
        'title' => t('Account settings'),
        'weight' => 1,
      ),
    );
  }
}
function user_login_block() {
  $form = array(
    '#action' => url($_GET['q'], drupal_get_destination()),
    '#id' => 'user-login-form',
    '#base' => 'user_login',
  );
  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#maxlength' => USERNAME_MAX_LENGTH,
    '#size' => 15,
    '#required' => TRUE,
  );
  $form['pass'] = array(
    '#type' => 'password',
    '#title' => t('Password'),
    '#maxlength' => 60,
    '#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;
}

/**
 * Implementation of hook_block().
 */
function user_block($op = 'list', $delta = 0, $edit = array()) {
  global $user;
  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');
    return $blocks;
  }
  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;
    }
    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');
        $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.'),
        );
        return $form;
      }
      else {
        if ($op == 'save' && $delta == 2) {
          variable_set('user_block_whois_new_count', $edit['user_block_whois_new_count']);
        }
        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') {
              $block = array();
              switch ($delta) {
                case 0:

                  // For usability's sake, avoid showing two login forms on one page.
                  if (!$user->uid && !(arg(0) == 'user' && !is_numeric(arg(1)))) {
                    $block['subject'] = t('User login');
                    $block['content'] = drupal_get_form('user_login_block');
                  }
                  return $block;
                case 1:
                  if ($menu = theme('menu_tree')) {
                    $block['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
                    $block['content'] = $menu;
                  }
                  return $block;
                case 2:
                  if (user_access('access content')) {

                    // Retrieve a list of new users who have subsequently accessed the site successfully.
                    $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));
                    while ($account = db_fetch_object($result)) {
                      $items[] = $account;
                    }
                    $output = theme('user_list', $items);
                    $block['subject'] = t('Who\'s new');
                    $block['content'] = $output;
                  }
                  return $block;
                case 3:
                  if (user_access('access content')) {

                    // Count users active within the defined period.
                    $interval = time() - variable_get('user_block_seconds_online', 900);

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

                    // Format the output with proper grammar.
                    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'),
                      ));
                    }
                    else {
                      $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'),
                      ));
                    }

                    // Display a list of currently online users.
                    $max_users = variable_get('user_block_max_list_count', 10);
                    if ($authenticated_count && $max_users) {
                      $items = array();
                      while ($max_users-- && ($account = db_fetch_object($authenticated_users))) {
                        $items[] = $account;
                      }
                      $output .= theme('user_list', $items, t('Online users'));
                    }
                    $block['subject'] = t('Who\'s online');
                    $block['content'] = $output;
                  }
                  return $block;
              }
            }
          }
        }
      }
    }
  }
}
function theme_user_picture($account) {
  if (variable_get('user_pictures', 0)) {
    if ($account->picture && file_exists($account->picture)) {
      $picture = file_create_url($account->picture);
    }
    else {
      if (variable_get('user_picture_default', '')) {
        $picture = variable_get('user_picture_default', '');
      }
    }
    if (isset($picture)) {
      $alt = t("@user's picture", array(
        '@user' => $account->name ? $account->name : variable_get('anonymous', t('Anonymous')),
      ));
      $picture = theme('image', $picture, $alt, $alt, '', FALSE);
      if (!empty($account->uid) && user_access('access user profiles')) {
        $picture = l($picture, "user/{$account->uid}", array(
          'title' => t('View user profile.'),
        ), NULL, NULL, FALSE, TRUE);
      }
      return "<div class=\"picture\">{$picture}</div>";
    }
  }
}

/**
 * Theme a user page
 * @param $account the user object
 * @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.
 *
 * @ingroup themeable
 */
function theme_user_profile($account, $fields) {
  $output = '<div class="profile">';
  $output .= theme('user_picture', $account);
  foreach ($fields as $category => $items) {
    if (strlen($category) > 0) {
      $output .= '<h2 class="title">' . check_plain($category) . '</h2>';
    }
    $output .= '<dl>';
    foreach ($items as $item) {
      if (isset($item['title'])) {
        $output .= '<dt class="' . $item['class'] . '">' . $item['title'] . '</dt>';
      }
      $output .= '<dd class="' . $item['class'] . '">' . $item['value'] . '</dd>';
    }
    $output .= '</dl>';
  }
  $output .= '</div>';
  return $output;
}

/**
 * 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) {
  if (!empty($users)) {
    foreach ($users as $user) {
      $items[] = theme('username', $user);
    }
  }
  return theme('item_list', $items, $title);
}

/**
 * Implementation of hook_menu().
 */
function user_menu($may_cache) {
  global $user;
  $items = array();
  $admin_access = user_access('administer users');
  $access_access = user_access('administer access control');
  $view_access = user_access('access user profiles');
  if ($may_cache) {
    $items[] = array(
      'path' => 'user',
      'title' => t('User account'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_login',
      ),
      'access' => !$user->uid,
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'user/autocomplete',
      'title' => t('User autocomplete'),
      'callback' => 'user_autocomplete',
      'access' => $view_access,
      'type' => MENU_CALLBACK,
    );

    // Registration and login pages.
    $items[] = array(
      'path' => 'user/login',
      'title' => t('Log in'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_login',
      ),
      'access' => !$user->uid,
      'type' => MENU_DEFAULT_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'user/register',
      'title' => t('Create new account'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_register',
      ),
      'access' => !$user->uid && variable_get('user_register', 1),
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'user/password',
      'title' => t('Request new password'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_pass',
      ),
      'access' => !$user->uid,
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'user/reset',
      'title' => t('Reset password'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_pass_reset',
      ),
      'access' => TRUE,
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'user/help',
      'title' => t('Help'),
      'callback' => 'user_help_page',
      'type' => MENU_CALLBACK,
    );

    // Admin user pages
    $items[] = array(
      'path' => 'admin/user',
      'title' => t('User management'),
      'description' => t('Manage your site\'s users, groups and access to site features.'),
      'position' => 'left',
      'callback' => 'system_admin_menu_block_page',
      'access' => user_access('administer site configuration'),
    );
    $items[] = array(
      'path' => 'admin/user/user',
      'title' => t('Users'),
      'description' => t('List, add, and edit users.'),
      'callback' => 'user_admin',
      'callback arguments' => array(
        'list',
      ),
      'access' => $admin_access,
    );
    $items[] = array(
      'path' => 'admin/user/user/list',
      'title' => t('List'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10,
    );
    $items[] = array(
      'path' => 'admin/user/user/create',
      'title' => t('Add user'),
      'callback' => 'user_admin',
      'callback arguments' => array(
        'create',
      ),
      'access' => $admin_access,
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'admin/user/settings',
      'title' => t('User settings'),
      'description' => t('Configure default behavior of users, including registration requirements, e-mails, and user pictures.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_admin_settings',
      ),
    );

    // Admin access pages
    $items[] = array(
      'path' => 'admin/user/access',
      'title' => t('Access control'),
      'description' => t('Determine access to features by selecting permissions for roles.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_admin_perm',
      ),
      'access' => $access_access,
    );
    $items[] = array(
      'path' => 'admin/user/roles',
      'title' => t('Roles'),
      'description' => t('List, edit, or add user roles.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_admin_new_role',
      ),
      'access' => $access_access,
      'type' => MENU_NORMAL_ITEM,
    );
    $items[] = array(
      'path' => 'admin/user/roles/edit',
      'title' => t('Edit role'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_admin_role',
      ),
      'access' => $access_access,
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'admin/user/rules',
      'title' => t('Access rules'),
      'description' => t('List and create rules to disallow usernames, e-mail addresses, and IP addresses.'),
      'callback' => 'user_admin_access',
      'access' => $access_access,
    );
    $items[] = array(
      'path' => 'admin/user/rules/list',
      'title' => t('List'),
      'access' => $access_access,
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10,
    );
    $items[] = array(
      'path' => 'admin/user/rules/add',
      'title' => t('Add rule'),
      'callback' => 'user_admin_access_add',
      'access' => $access_access,
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'admin/user/rules/check',
      'title' => t('Check rules'),
      'callback' => 'user_admin_access_check',
      'access' => $access_access,
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'admin/user/rules/edit',
      'title' => t('Edit rule'),
      'callback' => 'user_admin_access_edit',
      'access' => $access_access,
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'admin/user/rules/delete',
      'title' => t('Delete rule'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'user_admin_access_delete_confirm',
      ),
      'access' => $access_access,
      'type' => MENU_CALLBACK,
    );
    if (module_exists('search')) {
      $items[] = array(
        'path' => 'admin/user/search',
        'title' => t('Search users'),
        'description' => t('Search users by name.'),
        'callback' => 'user_admin',
        'callback arguments' => array(
          'search',
        ),
        'access' => $admin_access,
        'type' => MENU_NORMAL_ITEM,
      );
    }

    // Your personal page
    if ($user->uid) {
      $items[] = array(
        'path' => 'user/' . $user->uid,
        'title' => t('My account'),
        'callback' => 'user_view',
        'callback arguments' => array(
          arg(1),
        ),
        'access' => TRUE,
        'type' => MENU_DYNAMIC_ITEM,
      );
    }
    $items[] = array(
      'path' => 'logout',
      'title' => t('Log out'),
      'access' => $user->uid,
      'callback' => 'user_logout',
      'weight' => 10,
    );
  }
  else {

    // Add the CSS for this module. We put this in !$may_cache so it is only
    // added once per request.
    drupal_add_css(drupal_get_path('module', 'user') . '/user.css', 'module');
    if ($_GET['q'] == 'user' && $user->uid) {

      // We want to make the current user's profile accessible without knowing
      // their uid, so just linking to /user is enough.
      drupal_goto('user/' . $user->uid);
    }
    if (arg(0) == 'user' && is_numeric(arg(1)) && arg(1) > 0) {
      $account = user_load(array(
        'uid' => arg(1),
      ));
      if ($user !== FALSE) {

        // Always let a user view their own account
        $view_access |= $user->uid == arg(1);

        // Only admins can view blocked accounts
        $view_access &= $account->status || $admin_access;
        $items[] = array(
          'path' => 'user/' . arg(1),
          'title' => t('User'),
          'type' => MENU_CALLBACK,
          'callback' => 'user_view',
          'callback arguments' => array(
            arg(1),
          ),
          'access' => $view_access,
        );
        $items[] = array(
          'path' => 'user/' . arg(1) . '/view',
          'title' => t('View'),
          'access' => $view_access,
          'type' => MENU_DEFAULT_LOCAL_TASK,
          'weight' => -10,
        );
        $items[] = array(
          'path' => 'user/' . arg(1) . '/edit',
          'title' => t('Edit'),
          'callback' => 'drupal_get_form',
          'callback arguments' => array(
            'user_edit',
          ),
          'access' => $admin_access || $user->uid == arg(1),
          'type' => MENU_LOCAL_TASK,
        );
        $items[] = array(
          'path' => 'user/' . arg(1) . '/delete',
          'title' => t('Delete'),
          'callback' => 'user_edit',
          'access' => $admin_access,
          'type' => MENU_CALLBACK,
        );
        if (arg(2) == 'edit') {
          if (($categories = _user_categories($account)) && count($categories) > 1) {
            foreach ($categories as $key => $category) {
              $items[] = array(
                'path' => 'user/' . arg(1) . '/edit/' . $category['name'],
                'title' => $category['title'],
                'type' => $category['name'] == 'account' ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
                'weight' => $category['weight'],
                'access' => $admin_access || $user->uid == arg(1),
              );
            }
          }
        }
      }
    }
  }
  return $items;
}

/**
 * Accepts an user object, $account, or a DA name and returns an associative
 * array of modules and DA names. Called at external login.
 */
function user_get_authmaps($authname = NULL) {
  $result = db_query("SELECT authname, module FROM {authmap} WHERE authname = '%s'", $authname);
  if (db_num_rows($result) > 0) {
    while ($authmap = db_fetch_object($result)) {
      $authmaps[$authmap->module] = $authmap->authname;
    }
    return $authmaps;
  }
  else {
    return 0;
  }
}
function user_set_authmaps($account, $authmaps) {
  foreach ($authmaps as $key => $value) {
    $module = explode('_', $key, 2);
    if ($value) {
      db_query("UPDATE {authmap} SET authname = '%s' WHERE uid = %d AND module = '%s'", $value, $account->uid, $module[1]);
      if (!db_affected_rows()) {
        db_query("INSERT INTO {authmap} (authname, uid, module) VALUES ('%s', %d, '%s')", $value, $account->uid, $module[1]);
      }
    }
    else {
      db_query("DELETE FROM {authmap} WHERE uid = %d AND module = '%s'", $account->uid, $module[1]);
    }
  }
}
function user_auth_help_links() {
  $links = array();
  foreach (module_implements('auth') as $module) {
    $links[] = l(module_invoke($module, 'info', 'name'), 'user/help', array(), NULL, $module);
  }
  return $links;
}

/*** User features *********************************************************/
function user_login() {
  global $user;

  // If we are already logged on, go to the user page instead.
  if ($user->uid) {
    drupal_goto('user/' . $user->uid);
  }

  // Display login form:
  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#size' => 60,
    '#maxlength' => USERNAME_MAX_LENGTH,
    '#required' => TRUE,
    '#attributes' => array(
      'tabindex' => '1',
    ),
  );
  if (variable_get('drupal_authentication_service', FALSE) && count(user_auth_help_links()) > 0) {
    $form['name']['#description'] = t('Enter your @s username, or an ID from one of our affiliates: !a.', array(
      '@s' => variable_get('site_name', 'Drupal'),
      '!a' => implode(', ', user_auth_help_links()),
    ));
  }
  else {
    $form['name']['#description'] = t('Enter your @s username.', array(
      '@s' => variable_get('site_name', 'Drupal'),
    ));
  }
  $form['pass'] = array(
    '#type' => 'password',
    '#title' => t('Password'),
    '#description' => t('Enter the password that accompanies your username.'),
    '#required' => TRUE,
    '#attributes' => array(
      'tabindex' => '2',
    ),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Log in'),
    '#weight' => 2,
    '#attributes' => array(
      'tabindex' => '3',
    ),
  );
  return $form;
}
function user_login_validate($form_id, $form_values) {
  if ($form_values['name']) {
    if (user_is_blocked($form_values['name'])) {

      // blocked in user administration
      form_set_error('name', t('The username %name has not been activated or is blocked.', array(
        '%name' => $form_values['name'],
      )));
    }
    else {
      if (drupal_is_denied('user', $form_values['name'])) {

        // denied by access controls
        form_set_error('name', t('The name %name is a reserved username.', array(
          '%name' => $form_values['name'],
        )));
      }
      else {
        if ($form_values['pass']) {
          $user = user_authenticate($form_values['name'], trim($form_values['pass']));
          if (!$user->uid) {
            form_set_error('name', t('Sorry, unrecognized username or password. <a href="@password">Have you forgotten your password?</a>', array(
              '@password' => url('user/password'),
            )));
            watchdog('user', t('Login attempt failed for %user.', array(
              '%user' => $form_values['name'],
            )));
          }
        }
      }
    }
  }
}
function user_login_submit($form_id, $form_values) {
  global $user;
  if ($user->uid) {

    // To handle the edge case where this function is called during a
    // bootstrap, check for the existence of t().
    if (function_exists('t')) {
      $message = t('Session opened for %name.', array(
        '%name' => $user->name,
      ));
    }
    else {
      $message = "Session opened for " . check_plain($user->name);
    }
    watchdog('user', $message);

    // Update the user table timestamp noting user has logged in.
    db_query("UPDATE {users} SET login = %d WHERE uid = %d", time(), $user->uid);

    // Regenerate the session ID to prevent against session fixation attacks.
    sess_regenerate();
    user_module_invoke('login', $form_values, $user);
    return 'user/' . $user->uid;
  }
}
function user_authenticate($name, $pass) {
  global $user;

  // Try to log in the user locally. Don't set $user unless successful.
  if ($account = user_load(array(
    'name' => $name,
    'pass' => $pass,
    'status' => 1,
  ))) {

    // Check if the e-mail is denied by an access rule.
    // Doing this check here saves us a user_load() in user_login_validate()
    // and introduces less code change for a security fix.
    if (drupal_is_denied('mail', $account->mail)) {
      form_set_error('name', t('The name %name is registered using a reserved e-mail address and therefore could not be logged in.', array(
        '%name' => $account->name,
      )));
      return;
    }
    else {
      $user = $account;
      return $user;
    }
  }

  // Strip name and server from ID:
  $fullname = $name;
  if ($server = strrchr($name, '@')) {
    $name = substr($name, 0, strlen($name) - strlen($server));
    $server = substr($server, 1);
  }

  // When possible, determine corresponding external auth source. Invoke
  // source, and log in user if successful:
  if ($result = user_get_authmaps($fullname)) {
    if (module_invoke(key($result), 'auth', $name, $pass, $server)) {
      $user = user_external_load($fullname);
      watchdog('user', t('External load by %user using module %module.', array(
        '%user' => $fullname,
        '%module' => key($result),
      )));
    }
  }
  else {
    foreach (module_implements('auth') as $module) {
      if (module_invoke($module, 'auth', $name, $pass, $server)) {
        $registered_user = user_load(array(
          'name' => $fullname,
        ));
        if (!$registered_user->uid) {

          // Register this new user.
          $userinfo = array(
            'name' => $fullname,
            'pass' => user_password(),
            'init' => $fullname,
            'status' => 1,
            'access' => time(),
          );
          $userinfo["authname_{$module}"] = $fullname;
          $user = user_save('', $userinfo);
          watchdog('user', t('New external user: %user using module %module.', array(
            '%user' => $fullname,
            '%module' => $module,
          )), WATCHDOG_NOTICE, l(t('edit'), 'user/' . $user->uid . '/edit'));
          break;
        }
      }
    }
  }
  return $user;
}

/**
 * Menu callback; logs the current user out, and redirects to the home page.
 */
function user_logout() {
  global $user;
  watchdog('user', t('Session closed for %name.', array(
    '%name' => $user->name,
  )));

  // Destroy the current session:
  session_destroy();
  module_invoke_all('user', 'logout', NULL, $user);

  // Load the anonymous user
  $user = drupal_anonymous_user();
  drupal_goto();
}
function user_pass() {

  // Display form:
  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Username or e-mail address'),
    '#size' => 60,
    '#maxlength' => max(USERNAME_MAX_LENGTH, EMAIL_MAX_LENGTH),
    '#required' => TRUE,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('E-mail new password'),
    '#weight' => 2,
  );
  return $form;
}
function user_pass_validate($form_id, $form_values) {
  $name = $form_values['name'];

  // Blocked accounts cannot request a new password,
  // check provided username and email against access rules.
  if (drupal_is_denied('user', $name) || drupal_is_denied('mail', $name)) {
    form_set_error('name', t('%name is not allowed to request a new password.', array(
      '%name' => $name,
    )));
  }
  $account = user_load(array(
    'mail' => $name,
    'status' => 1,
  ));
  if (!$account) {
    $account = user_load(array(
      'name' => $name,
      'status' => 1,
    ));
  }
  if ($account->uid) {
    form_set_value(array(
      '#parents' => array(
        'account',
      ),
    ), $account);
  }
  else {
    form_set_error('name', t('Sorry, %name is not recognized as a user name or an email address.', array(
      '%name' => $name,
    )));
  }
}
function user_pass_submit($form_id, $form_values) {
  global $base_url;
  $account = $form_values['account'];
  $from = variable_get('site_mail', ini_get('sendmail_from'));

  // Mail one time login URL and instructions.
  $variables = array(
    '!username' => $account->name,
    '!site' => variable_get('site_name', 'Drupal'),
    '!login_url' => user_pass_reset_url($account),
    '!uri' => $base_url,
    '!uri_brief' => preg_replace('!^https?://!', '', $base_url),
    '!mailto' => $account->mail,
    '!date' => format_date(time()),
    '!login_uri' => url('user', NULL, NULL, TRUE),
    '!edit_uri' => url('user/' . $account->uid . '/edit', NULL, NULL, TRUE),
  );
  $subject = _user_mail_text('pass_subject', $variables);
  $body = _user_mail_text('pass_body', $variables);
  $mail_success = drupal_mail('user-pass', $account->mail, $subject, $body, $from);
  if ($mail_success) {
    watchdog('user', t('Password reset instructions mailed to %name at %email.', array(
      '%name' => $account->name,
      '%email' => $account->mail,
    )));
    drupal_set_message(t('Further instructions have been sent to your e-mail address.'));
  }
  else {
    watchdog('user', t('Error mailing password reset instructions to %name at %email.', array(
      '%name' => $account->name,
      '%email' => $account->mail,
    )), WATCHDOG_ERROR);
    drupal_set_message(t('Unable to send mail. Please contact the site admin.'));
  }
  return 'user';
}

/**
 * Menu callback; process one time login link and redirects to the user page on success.
 */
function user_pass_reset($uid, $timestamp, $hashed_pass, $action = NULL) {
  global $user;

  // Check if the user is already logged in. The back button is often the culprit here.
  if ($user->uid) {
    drupal_set_message(t('You have already used this one-time login link. It is not necessary to use this link to login anymore. You are already logged in.'));
    drupal_goto();
  }
  else {

    // Time out, in seconds, until login URL expires. 24 hours = 86400 seconds.
    $timeout = 86400;
    $current = time();

    // Some redundant checks for extra security ?
    if ($timestamp < $current && ($account = user_load(array(
      'uid' => $uid,
      'status' => 1,
    )))) {

      // Deny one-time login to blocked accounts.
      if (drupal_is_denied('user', $account->name) || drupal_is_denied('mail', $account->mail)) {
        drupal_set_message(t('You have tried to use a one-time login for an account which has been blocked.'), 'error');
        drupal_goto();
      }

      // No time out for first time login.
      if ($account->login && $current - $timestamp > $timeout) {
        drupal_set_message(t('You have tried to use a one-time login link that has expired. Please request a new one using the form below.'));
        drupal_goto('user/password');
      }
      else {
        if ($account->uid && $timestamp > $account->login && $timestamp < $current && $hashed_pass == user_pass_rehash($account->pass, $timestamp, $account->login)) {

          // First stage is a confirmation form, then login
          if ($action == 'login') {
            watchdog('user', t('User %name used one-time login link at time %timestamp.', array(
              '%name' => $account->name,
              '%timestamp' => $timestamp,
            )));

            // Update the user table noting user has logged in.
            // And this also makes this hashed password a one-time-only login.
            db_query("UPDATE {users} SET login = %d WHERE uid = %d", time(), $account->uid);

            // Now we can set the new user.
            $user = $account;

            // And proceed with normal login, going to user page.
            $edit = array();

            // Regenerate the session ID to prevent against session fixation attacks.
            sess_regenerate();
            user_module_invoke('login', $edit, $user);
            drupal_set_message(t('You have just used your one-time login link. It is no longer necessary to use this link to login. Please change your password.'));
            drupal_goto('user/' . $user->uid . '/edit');
          }
          else {
            $form['message'] = array(
              '#value' => t('<p>This is a one-time login for %user_name and will expire on %expiration_date</p><p>Click on this button to login to the site and change your password.</p>', array(
                '%user_name' => $account->name,
                '%expiration_date' => format_date($timestamp + $timeout),
              )),
            );
            $form['help'] = array(
              '#value' => '<p>' . t('This login can be used only once.') . '</p>',
            );
            $form['submit'] = array(
              '#type' => 'submit',
              '#value' => t('Log in'),
            );
            $form['#action'] = url("user/reset/{$uid}/{$timestamp}/{$hashed_pass}/login");
            return $form;
          }
        }
        else {
          drupal_set_message(t('You have tried to use a one-time login link which has either been used or is no longer valid. Please request a new one using the form below.'));
          drupal_goto('user/password');
        }
      }
    }
    else {

      // Deny access, no more clues.
      // Everything will be in the watchdog's URL for the administrator to check.
      drupal_access_denied();
    }
  }
}
function user_pass_reset_url($account) {
  $timestamp = time();
  return url("user/reset/{$account->uid}/{$timestamp}/" . user_pass_rehash($account->pass, $timestamp, $account->login), NULL, NULL, TRUE);
}
function user_pass_rehash($password, $timestamp, $login) {
  return md5($timestamp . $password . $login);
}
function user_register() {
  global $user;
  $admin = user_access('administer users');

  // If we aren't admin but already logged on, go to the user page instead.
  if (!$admin && $user->uid) {
    drupal_goto('user/' . $user->uid);
  }
  $form = array();

  // Display the registration form.
  if (!$admin) {
    $form['user_registration_help'] = array(
      '#value' => filter_xss_admin(variable_get('user_registration_help', '')),
    );
  }
  $affiliates = user_auth_help_links();
  if (!$admin && count($affiliates) > 0) {
    $affiliates = implode(', ', $affiliates);
    $form['affiliates'] = array(
      '#value' => '<p>' . t('Note: if you have an account with one of our affiliates (!s), you may <a href="@login_uri">login now</a> instead of registering.', array(
        '!s' => $affiliates,
        '@login_uri' => url('user'),
      )) . '</p>',
    );
  }

  // Merge in the default user edit fields.
  $form = array_merge($form, user_edit_form(NULL, NULL, TRUE));
  if ($admin) {
    $form['account']['notify'] = array(
      '#type' => 'checkbox',
      '#title' => t('Notify user of new account'),
    );

    // Redirect back to page which initiated the create request; usually admin/user/user/create
    $form['destination'] = array(
      '#type' => 'hidden',
      '#value' => $_GET['q'],
    );
  }

  // Create a dummy variable for pass-by-reference parameters.
  $null = NULL;
  $extra = _user_forms($null, NULL, NULL, 'register');

  // Remove form_group around default fields if there are no other groups.
  if (!$extra) {
    $form['name'] = $form['account']['name'];
    $form['mail'] = $form['account']['mail'];
    $form['pass'] = $form['account']['pass'];
    $form['status'] = $form['account']['status'];
    $form['roles'] = $form['account']['roles'];
    $form['notify'] = $form['account']['notify'];
    unset($form['account']);
  }
  else {
    $form = array_merge($form, $extra);
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Create new account'),
    '#weight' => 30,
  );
  return $form;
}
function user_register_validate($form_id, $form_values) {
  user_module_invoke('validate', $form_values, $form_values, 'account');
}
function user_register_submit($form_id, $form_values) {
  global $base_url;
  $admin = user_access('administer users');
  $mail = $form_values['mail'];
  $name = $form_values['name'];
  if (!variable_get('user_email_verification', TRUE) || $admin) {
    $pass = $form_values['pass'];
  }
  else {
    $pass = user_password();
  }
  $notify = $form_values['notify'];
  $from = variable_get('site_mail', ini_get('sendmail_from'));
  if (isset($form_values['roles'])) {
    $roles = array_filter($form_values['roles']);

    // Remove unset roles
  }
  if (!$admin && array_intersect(array_keys($form_values), array(
    'uid',
    'roles',
    'init',
    'session',
    'status',
  ))) {
    watchdog('security', t('Detected malicious attempt to alter protected user fields.'), WATCHDOG_WARNING);
    return 'user/register';
  }

  //the unset below is needed to prevent these form values from being saved as user data
  unset($form_values['form_token'], $form_values['submit'], $form_values['op'], $form_values['notify'], $form_values['form_id'], $form_values['affiliates'], $form_values['destination']);
  $merge_data = array(
    'pass' => $pass,
    'init' => $mail,
    'roles' => $roles,
  );
  if (!$admin) {

    // Set the user's status because it was not displayed in the form.
    $merge_data['status'] = variable_get('user_register', 1) == 1;
  }
  $account = user_save('', array_merge($form_values, $merge_data));
  watchdog('user', t('New user: %name %email.', array(
    '%name' => $name,
    '%email' => '<' . $mail . '>',
  )), WATCHDOG_NOTICE, l(t('edit'), 'user/' . $account->uid . '/edit'));
  $variables = array(
    '!username' => $name,
    '!site' => variable_get('site_name', 'Drupal'),
    '!password' => $pass,
    '!uri' => $base_url,
    '!uri_brief' => substr($base_url, strlen('http://')),
    '!mailto' => $mail,
    '!date' => format_date(time()),
    '!login_uri' => url('user', NULL, NULL, TRUE),
    '!edit_uri' => url('user/' . $account->uid . '/edit', NULL, NULL, TRUE),
    '!login_url' => user_pass_reset_url($account),
  );

  // The first user may login immediately, and receives a customized welcome e-mail.
  if ($account->uid == 1) {
    drupal_mail('user-register-admin', $mail, t('Drupal user account details for !s', array(
      '!s' => $name,
    )), strtr(t("!username,\n\nYou may now login to !uri using the following username and password:\n\n  username: !username\n  password: !password\n\n!edit_uri\n\n--drupal"), $variables), $from);
    drupal_set_message(t('<p>Welcome to Drupal. You are user #1, which gives you full and immediate access. All future registrants will receive their passwords via e-mail, so please make sure your website e-mail address is set properly under the general settings on the <a href="@settings">site information settings page</a>.</p><p> Your password is <strong>%pass</strong>. You may change your password below.</p>', array(
      '%pass' => $pass,
      '@settings' => url('admin/settings/site-information'),
    )));
    user_authenticate($account->name, trim($pass));
    return 'user/1/edit';
  }
  else {
    if ($admin && !$notify) {
      drupal_set_message(t('Created a new user account. No e-mail has been sent.'));
    }
    else {
      if (!variable_get('user_email_verification', TRUE) && $account->status && !$admin) {

        // No e-mail verification is required, create new user account, and login user immediately.
        $subject = _user_mail_text('welcome_subject', $variables);
        $body = _user_mail_text('welcome_body', $variables);
        drupal_mail('user-register-welcome', $mail, $subject, $body, $from);
        user_authenticate($account->name, trim($pass));
        $edit = array();
        user_module_invoke('login', $edit, $account);
        return '';
      }
      else {
        if ($account->status || $notify) {

          // Create new user account, no administrator approval required.
          $subject = $notify ? _user_mail_text('admin_subject', $variables) : _user_mail_text('welcome_subject', $variables);
          $body = $notify ? _user_mail_text('admin_body', $variables) : _user_mail_text('welcome_body', $variables);
          drupal_mail($notify ? 'user-register-notify' : 'user-register-welcome', $mail, $subject, $body, $from);
          if ($notify) {
            drupal_set_message(t('Password and further instructions have been e-mailed to the new user %user.', array(
              '%user' => $name,
            )));
          }
          else {
            drupal_set_message(t('Your password and further instructions have been sent to your e-mail address.'));
            return '';
          }
        }
        else {

          // Create new user account, administrator approval required.
          $subject = _user_mail_text('approval_subject', $variables);
          $body = _user_mail_text('approval_body', $variables);
          drupal_mail('user-register-approval-user', $mail, $subject, $body, $from);
          drupal_mail('user-register-approval-admin', $from, $subject, t("!username has applied for an account.\n\n!edit_uri", $variables), $from);
          drupal_set_message(t('Thank you for applying for an account. Your account is currently pending approval by the site administrator.<br />In the meantime, your password and further instructions have been sent to your e-mail address.'));
          return '';
        }
      }
    }
  }
}
function user_edit_form($uid, $edit, $register = FALSE) {
  $admin = user_access('administer users');

  // Account information:
  $form['account'] = array(
    '#type' => 'fieldset',
    '#title' => t('Account information'),
  );
  if (user_access('change own username') || $admin || $register) {
    $form['account']['name'] = array(
      '#type' => 'textfield',
      '#title' => t('Username'),
      '#default_value' => $edit['name'],
      '#maxlength' => USERNAME_MAX_LENGTH,
      '#description' => t('Your preferred username; punctuation is not allowed except for periods, hyphens, and underscores.'),
      '#required' => TRUE,
    );
  }
  $form['account']['mail'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail address'),
    '#default_value' => $edit['mail'],
    '#maxlength' => EMAIL_MAX_LENGTH,
    '#description' => t('A valid e-mail address. All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail.'),
    '#required' => TRUE,
  );
  if (!$register) {
    $form['account']['pass'] = array(
      '#type' => 'password_confirm',
      '#description' => t('To change the current user password, enter the new password in both fields.'),
      '#size' => 25,
    );
  }
  elseif (!variable_get('user_email_verification', TRUE) || $admin) {
    $form['account']['pass'] = array(
      '#type' => 'password_confirm',
      '#description' => t('Provide a password for the new account in both fields.'),
      '#required' => TRUE,
      '#size' => 25,
    );
  }
  if ($admin) {
    $form['account']['status'] = array(
      '#type' => 'radios',
      '#title' => t('Status'),
      '#default_value' => isset($edit['status']) ? $edit['status'] : 1,
      '#options' => array(
        t('Blocked'),
        t('Active'),
      ),
    );
  }
  if (user_access('administer access control')) {
    $roles = user_roles(1);
    unset($roles[DRUPAL_AUTHENTICATED_RID]);
    if ($roles) {
      $form['account']['roles'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Roles'),
        '#default_value' => array_keys((array) $edit['roles']),
        '#options' => $roles,
        '#description' => t('The user receives the combined permissions of the %au role, and all roles selected here.', array(
          '%au' => t('authenticated user'),
        )),
      );
    }
  }

  // Picture/avatar:
  if (variable_get('user_pictures', 0) && !$register) {
    $form['picture'] = array(
      '#type' => 'fieldset',
      '#title' => t('Picture'),
      '#weight' => 1,
    );
    $picture = theme('user_picture', (object) $edit);
    if ($picture) {
      $form['picture']['current_picture'] = array(
        '#value' => $picture,
      );
      $form['picture']['picture_delete'] = array(
        '#type' => 'checkbox',
        '#title' => t('Delete picture'),
        '#description' => t('Check this box to delete your current picture.'),
      );
    }
    else {
      $form['picture']['picture_delete'] = array(
        '#type' => 'hidden',
      );
    }
    $form['picture']['picture_upload'] = array(
      '#type' => 'file',
      '#title' => t('Upload picture'),
      '#size' => 48,
      '#description' => t('Your virtual face or picture. Maximum dimensions are %dimensions and the maximum size is %size kB.', array(
        '%dimensions' => variable_get('user_picture_dimensions', '85x85'),
        '%size' => variable_get('user_picture_file_size', '30'),
      )) . ' ' . variable_get('user_picture_guidelines', ''),
    );
  }
  return $form;
}
function _user_edit_validate($uid, &$edit) {
  $user = user_load(array(
    'uid' => $uid,
  ));

  // Validate the username:
  if (user_access('change own username') || user_access('administer users') || arg(1) == 'register') {
    if ($error = user_validate_name($edit['name'])) {
      form_set_error('name', $error);
    }
    else {
      if (db_num_rows(db_query("SELECT uid FROM {users} WHERE uid != %d AND LOWER(name) = LOWER('%s')", $uid, $edit['name'])) > 0) {
        form_set_error('name', t('The name %name is already taken.', array(
          '%name' => $edit['name'],
        )));
      }
      else {
        if (drupal_is_denied('user', $edit['name'])) {
          form_set_error('name', t('The name %name has been denied access.', array(
            '%name' => $edit['name'],
          )));
        }
      }
    }
  }

  // Validate the e-mail address:
  if ($error = user_validate_mail($edit['mail'])) {
    form_set_error('mail', $error);
  }
  else {
    if (db_num_rows(db_query("SELECT uid FROM {users} WHERE uid != %d AND LOWER(mail) = LOWER('%s')", $uid, $edit['mail'])) > 0) {
      form_set_error('mail', t('The e-mail address %email is already registered. <a href="@password">Have you forgotten your password?</a>', array(
        '%email' => $edit['mail'],
        '@password' => url('user/password'),
      )));
    }
    else {
      if (drupal_is_denied('mail', $edit['mail'])) {
        form_set_error('mail', t('The e-mail address %email has been denied access.', array(
          '%email' => $edit['mail'],
        )));
      }
    }
  }

  // If required, validate the uploaded picture.
  if ($file = file_check_upload('picture_upload')) {
    user_validate_picture($file, $edit, $user);
  }
}
function _user_edit_submit($uid, &$edit) {
  $user = user_load(array(
    'uid' => $uid,
  ));

  // Delete picture if requested, and if no replacement picture was given.
  if ($edit['picture_delete']) {
    if ($user->picture && file_exists($user->picture)) {
      file_delete($user->picture);
    }
    $edit['picture'] = '';
  }
  if (isset($edit['roles'])) {
    $edit['roles'] = array_filter($edit['roles']);
  }
}
function user_edit($category = 'account') {
  global $user;
  $account = user_load(array(
    'uid' => arg(1),
  ));
  if ($account === FALSE) {
    drupal_set_message(t('The account does not exist or has already been deleted.'));
    drupal_goto('admin/user/user');
  }
  $edit = $_POST['op'] ? $_POST : (array) $account;
  if (arg(2) == 'delete') {
    return drupal_get_form('user_confirm_delete', $account->name, $account->uid);
  }
  else {
    if ($_POST['op'] == t('Delete')) {
      if ($_REQUEST['destination']) {
        $destination = drupal_get_destination();
        unset($_REQUEST['destination']);
      }

      // Note: we redirect from user/uid/edit to user/uid/delete to make the tabs disappear.
      drupal_goto("user/{$account->uid}/delete", $destination);
    }
  }
  $form = _user_forms($edit, $account, $category);
  $form['_category'] = array(
    '#type' => 'value',
    '#value' => $category,
  );
  $form['_account'] = array(
    '#type' => 'value',
    '#value' => $account,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
    '#weight' => 30,
  );
  if (user_access('administer users')) {
    $form['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'),
      '#weight' => 31,
    );
  }
  $form['#attributes']['enctype'] = 'multipart/form-data';
  drupal_set_title(check_plain($account->name));
  return $form;
}
function user_confirm_delete($name, $uid) {
  $form['uid'] = array(
    '#type' => 'value',
    '#value' => $uid,
  );
  return confirm_form($form, t('Are you sure you want to delete the account %name?', array(
    '%name' => $name,
  )), 'user/' . $uid, t('All submissions made by this user will be attributed to the anonymous account. This action cannot be undone.'), t('Delete'), t('Cancel'));
}
function user_confirm_delete_submit($form_id, $form_values) {
  $account = user_load(array(
    'uid' => $form_values['uid'],
  ));
  user_delete((array) $account, $form_values['uid']);
  return 'admin/user/user';
}

/**
 * Delete a user.
 *
 * @param $edit An array of submitted form values.
 * @param $uid The user ID of the user to delete.
 */
function user_delete($edit, $uid) {
  $account = user_load(array(
    'uid' => $uid,
  ));
  sess_destroy_uid($uid);
  db_query('DELETE FROM {users} WHERE uid = %d', $uid);
  db_query('DELETE FROM {users_roles} WHERE uid = %d', $uid);
  db_query('DELETE FROM {authmap} WHERE uid = %d', $uid);
  $array = array(
    '%name' => $account->name,
    '%email' => '<' . $account->mail . '>',
  );
  watchdog('user', t('Deleted user: %name %email.', $array), WATCHDOG_NOTICE);
  drupal_set_message(t('%name has been deleted.', $array));
  module_invoke_all('user', 'delete', $edit, $account);
}
function user_edit_validate($form_id, $form_values) {
  user_module_invoke('validate', $form_values, $form_values['_account'], $form_values['_category']);

  // Validate input to ensure that non-privileged users can't alter protected data.
  if (!user_access('administer users') && array_intersect(array_keys($form_values), array(
    'uid',
    'init',
    'session',
  )) || !user_access('administer access control') && isset($form_values['roles'])) {
    $message = t('Detected malicious attempt to alter protected user fields.');
    watchdog('security', $message, WATCHDOG_WARNING);

    // set this to a value type field
    form_set_error('category', $message);
  }
}
function user_edit_submit($form_id, $form_values) {
  $account = $form_values['_account'];
  $category = $form_values['_category'];
  unset($form_values['_account'], $form_values['op'], $form_values['submit'], $form_values['delete'], $form_values['form_token'], $form_values['form_id'], $form_values['_category']);
  user_module_invoke('submit', $form_values, $account, $category);
  user_save($account, $form_values, $category);

  // Delete that user's menu cache:
  cache_clear_all($account->uid . ':', 'cache_menu', TRUE);

  // Clear the page cache because pages can contain usernames and/or profile information:
  cache_clear_all();
  drupal_set_message(t('The changes have been saved.'));
  return 'user/' . $account->uid;
}
function user_view($uid = 0) {
  global $user;
  $account = user_load(array(
    'uid' => $uid,
  ));
  if ($account === FALSE || $account->access == 0 && !user_access('administer users')) {
    return drupal_not_found();
  }

  // Retrieve and merge all profile fields:
  $fields = array();
  foreach (module_list() as $module) {
    if ($data = module_invoke($module, 'user', 'view', '', $account)) {
      foreach ($data as $category => $items) {
        foreach ($items as $key => $item) {
          $item['class'] = "{$module}-" . $item['class'];
          $fields[$category][$key] = $item;
        }
      }
    }
  }

  // Let modules change the returned fields - useful for personal privacy
  // controls. Since modules communicate changes by reference, we cannot use
  // module_invoke_all().
  foreach (module_implements('profile_alter') as $module) {
    $function = $module . '_profile_alter';
    $function($account, $fields);
  }
  drupal_set_title(check_plain($account->name));
  return theme('user_profile', $account, $fields);
}

/*** Administrative features ***********************************************/
function _user_mail_text($messageid, $variables = array()) {

  // Check if an admin setting overrides the default string.
  if ($admin_setting = variable_get('user_mail_' . $messageid, FALSE)) {
    return strtr($admin_setting, $variables);
  }
  else {
    switch ($messageid) {
      case 'welcome_subject':
        return t('Account details for !username at !site', $variables);
      case 'welcome_body':
        return t("!username,\n\nThank you for registering at !site. You may now log in to !login_uri using the following username and password:\n\nusername: !username\npassword: !password\n\nYou may also log in by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.\n\n\n--  !site team", $variables);
      case 'admin_subject':
        return t('An administrator created an account for you at !site', $variables);
      case 'admin_body':
        return t("!username,\n\nA site administrator at !site has created an account for you. You may now log in to !login_uri using the following username and password:\n\nusername: !username\npassword: !password\n\nYou may also log in by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.\n\n\n--  !site team", $variables);
      case 'approval_subject':
        return t('Account details for !username at !site (pending admin approval)', $variables);
      case 'approval_body':
        return t("!username,\n\nThank you for registering at !site. Your application for an account is currently pending approval. Once it has been granted, you may log in to !login_uri using the following username and password:\n\nusername: !username\npassword: !password\n\nYou may also log in by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once.\n\nAfter logging in, you may wish to change your password at !edit_uri\n\n\n--  !site team", $variables);
      case 'pass_subject':
        return t('Replacement login information for !username at !site', $variables);
      case 'pass_body':
        return t("!username,\n\nA request to reset the password for your account has been made at !site.\n\nYou may now log in to !uri_brief by clicking on this link or copying and pasting it in your browser:\n\n!login_url\n\nThis is a one-time login, so it can be used only once. It expires after one day and nothing will happen if it's not used.\n\nAfter logging in, you will be redirected to !edit_uri so you can change your password.", $variables);
    }
  }
}
function user_admin_check_user() {
  $form['user'] = array(
    '#type' => 'fieldset',
    '#title' => t('Username'),
  );
  $form['user']['test'] = array(
    '#type' => 'textfield',
    '#title' => '',
    '#description' => t('Enter a username to check if it will be denied or allowed.'),
    '#size' => 30,
    '#maxlength' => USERNAME_MAX_LENGTH,
  );
  $form['user']['type'] = array(
    '#type' => 'hidden',
    '#value' => 'user',
  );
  $form['user']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Check username'),
  );
  $form['#base'] = 'user_admin_access_check';
  return $form;
}
function user_admin_check_mail() {
  $form['mail'] = array(
    '#type' => 'fieldset',
    '#title' => t('E-mail'),
  );
  $form['mail']['test'] = array(
    '#type' => 'textfield',
    '#title' => '',
    '#description' => t('Enter an e-mail address to check if it will be denied or allowed.'),
    '#size' => 30,
    '#maxlength' => EMAIL_MAX_LENGTH,
  );
  $form['mail']['type'] = array(
    '#type' => 'hidden',
    '#value' => 'mail',
  );
  $form['mail']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Check e-mail'),
  );
  $form['#base'] = 'user_admin_access_check';
  return $form;
}
function user_admin_check_host() {
  $form['host'] = array(
    '#type' => 'fieldset',
    '#title' => t('Hostname'),
  );
  $form['host']['test'] = array(
    '#type' => 'textfield',
    '#title' => '',
    '#description' => t('Enter a hostname or IP address to check if it will be denied or allowed.'),
    '#size' => 30,
    '#maxlength' => 64,
  );
  $form['host']['type'] = array(
    '#type' => 'hidden',
    '#value' => 'host',
  );
  $form['host']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Check hostname'),
  );
  $form['#base'] = 'user_admin_access_check';
  return $form;
}

/**
 * Menu callback: check an access rule
 */
function user_admin_access_check() {
  $output = drupal_get_form('user_admin_check_user');
  $output .= drupal_get_form('user_admin_check_mail');
  $output .= drupal_get_form('user_admin_check_host');
  return $output;
}
function user_admin_access_check_validate($form_id, $form_values) {
  if (empty($form_values['test'])) {
    form_set_error($form_values['type'], t('No value entered. Please enter a test string and try again.'));
  }
}
function user_admin_access_check_submit($form_id, $form_values) {
  switch ($form_values['type']) {
    case 'user':
      if (drupal_is_denied('user', $form_values['test'])) {
        drupal_set_message(t('The username %name is not allowed.', array(
          '%name' => $form_values['test'],
        )));
      }
      else {
        drupal_set_message(t('The username %name is allowed.', array(
          '%name' => $form_values['test'],
        )));
      }
      break;
    case 'mail':
      if (drupal_is_denied('mail', $form_values['test'])) {
        drupal_set_message(t('The e-mail address %mail is not allowed.', array(
          '%mail' => $form_values['test'],
        )));
      }
      else {
        drupal_set_message(t('The e-mail address %mail is allowed.', array(
          '%mail' => $form_values['test'],
        )));
      }
      break;
    case 'host':
      if (drupal_is_denied('host', $form_values['test'])) {
        drupal_set_message(t('The hostname %host is not allowed.', array(
          '%host' => $form_values['test'],
        )));
      }
      else {
        drupal_set_message(t('The hostname %host is allowed.', array(
          '%host' => $form_values['test'],
        )));
      }
      break;
    default:
      break;
  }
}

/**
 * Menu callback: add an access rule
 */
function user_admin_access_add($mask = NULL, $type = NULL) {
  $edit = array();
  $edit['aid'] = 0;
  $edit['mask'] = $mask;
  $edit['type'] = $type;
  return drupal_get_form('user_admin_access_add_form', $edit, t('Add rule'));
}

/**
 * Menu callback: delete an access rule
 */
function user_admin_access_delete_confirm($aid = 0) {
  $access_types = array(
    'user' => t('username'),
    'mail' => t('e-mail'),
    'host' => t('host'),
  );
  $edit = db_fetch_object(db_query('SELECT aid, type, status, mask FROM {access} WHERE aid = %d', $aid));
  $form = array();
  $form['aid'] = array(
    '#type' => 'hidden',
    '#value' => $aid,
  );
  $output = confirm_form($form, t('Are you sure you want to delete the @type rule for %rule?', array(
    '@type' => $access_types[$edit->type],
    '%rule' => $edit->mask,
  )), 'admin/user/rules', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
  return $output;
}
function user_admin_access_delete_confirm_submit($form_id, $form_values) {
  db_query('DELETE FROM {access} WHERE aid = %d', $form_values['aid']);
  drupal_set_message(t('The access rule has been deleted.'));
  return 'admin/user/rules';
}

/**
 * Menu callback: edit an access rule
 */
function user_admin_access_edit($aid = 0) {
  $edit = db_fetch_array(db_query('SELECT aid, type, status, mask FROM {access} WHERE aid = %d', $aid));
  return drupal_get_form('user_admin_access_edit_form', $edit, t('Save rule'));
}
function user_admin_access_form($edit, $submit) {
  $form = array();
  $form['aid'] = array(
    '#type' => 'value',
    '#value' => $edit['aid'],
  );
  $form['status'] = array(
    '#type' => 'radios',
    '#title' => t('Access type'),
    '#default_value' => $edit['status'],
    '#options' => array(
      '1' => t('Allow'),
      '0' => t('Deny'),
    ),
  );
  $type_options = array(
    'user' => t('Username'),
    'mail' => t('E-mail'),
    'host' => t('Host'),
  );
  $form['type'] = array(
    '#type' => 'radios',
    '#title' => t('Rule type'),
    '#default_value' => isset($type_options[$edit['type']]) ? $edit['type'] : 'user',
    '#options' => $type_options,
  );
  $form['mask'] = array(
    '#type' => 'textfield',
    '#title' => t('Mask'),
    '#size' => 30,
    '#maxlength' => 64,
    '#default_value' => $edit['mask'],
    '#description' => '%: ' . t('Matches any number of characters, even zero characters') . '.<br />_: ' . t('Matches exactly one character.'),
    '#required' => TRUE,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => $submit,
  );
  $form['#base'] = 'user_admin_access_form';
  return $form;
}

/**
 * Submit callback for user_admin_access_form().
 */
function user_admin_access_form_submit($form_id, $form_values) {
  if ($form_values['aid']) {
    db_query("UPDATE {access} SET mask = '%s', type = '%s', status = '%s' WHERE aid = %d", $form_values['mask'], $form_values['type'], $form_values['status'], $form_values['aid']);
    drupal_set_message(t('The access rule has been saved.'));
  }
  else {
    db_query("INSERT INTO {access} (mask, type, status) VALUES ('%s', '%s', %d)", $form_values['mask'], $form_values['type'], $form_values['status']);
    drupal_set_message(t('The access rule has been added.'));
  }
  return 'admin/user/rules';
}

/**
 * Menu callback: list all access rules
 */
function user_admin_access() {
  $header = array(
    array(
      'data' => t('Access type'),
      'field' => 'status',
    ),
    array(
      'data' => t('Rule type'),
      'field' => 'type',
    ),
    array(
      'data' => t('Mask'),
      'field' => 'mask',
    ),
    array(
      'data' => t('Operations'),
      'colspan' => 2,
    ),
  );
  $result = db_query("SELECT aid, type, status, mask FROM {access}" . tablesort_sql($header));
  $access_types = array(
    'user' => t('username'),
    'mail' => t('e-mail'),
    'host' => t('host'),
  );
  $rows = array();
  while ($rule = db_fetch_object($result)) {
    $rows[] = array(
      $rule->status ? t('allow') : t('deny'),
      $access_types[$rule->type],
      $rule->mask,
      l(t('edit'), 'admin/user/rules/edit/' . $rule->aid),
      l(t('delete'), 'admin/user/rules/delete/' . $rule->aid),
    );
  }
  if (count($rows) == 0) {
    $rows[] = array(
      array(
        'data' => '<em>' . t('There are currently no access rules.') . '</em>',
        'colspan' => 5,
      ),
    );
  }
  $output .= theme('table', $header, $rows);
  return $output;
}

/**
 * Retrieve an array of roles matching specified conditions.
 *
 * @param $membersonly
 *   Set this to TRUE to exclude the 'anonymous' role.
 * @param $permission
 *   A string containing a permission. If set, only roles containing that permission are returned.
 *
 * @return
 *   An associative array with the role id as the key and the role name as value.
 */
function user_roles($membersonly = 0, $permission = 0) {
  $roles = array();
  if ($permission) {
    $result = db_query("SELECT r.* FROM {role} r INNER JOIN {permission} p ON r.rid = p.rid WHERE p.perm LIKE '%%%s%%' ORDER BY r.name", $permission);
  }
  else {
    $result = db_query('SELECT * FROM {role} ORDER BY name');
  }
  while ($role = db_fetch_object($result)) {
    if (!$membersonly || $membersonly && $role->rid != DRUPAL_ANONYMOUS_RID) {
      $roles[$role->rid] = $role->name;
    }
  }
  return $roles;
}

/**
 * Menu callback: administer permissions.
 */
function user_admin_perm($rid = NULL) {
  if (is_numeric($rid)) {
    $result = db_query('SELECT r.rid, p.perm FROM {role} r LEFT JOIN {permission} p ON r.rid = p.rid WHERE r.rid = %d', $rid);
  }
  else {
    $result = db_query('SELECT r.rid, p.perm FROM {role} r LEFT JOIN {permission} p ON r.rid = p.rid ORDER BY name');
  }

  // Compile role array:
  // Add a comma at the end so when searching for a permission, we can
  // always search for "$perm," to make sure we do not confuse
  // permissions that are substrings of each other.
  while ($role = db_fetch_object($result)) {
    $role_permissions[$role->rid] = $role->perm . ',';
  }
  if (is_numeric($rid)) {
    $result = db_query('SELECT rid, name FROM {role} r WHERE r.rid = %d ORDER BY name', $rid);
  }
  else {
    $result = db_query('SELECT rid, name FROM {role} ORDER BY name');
  }
  $role_names = array();
  while ($role = db_fetch_object($result)) {
    $role_names[$role->rid] = $role->name;
  }

  // Render role/permission overview:
  $options = array();
  foreach (module_list(FALSE, FALSE, TRUE) as $module) {
    if ($permissions = module_invoke($module, 'perm')) {
      $form['permission'][] = array(
        '#value' => $module,
      );
      asort($permissions);
      foreach ($permissions as $perm) {
        $options[$perm] = '';
        $form['permission'][$perm] = array(
          '#value' => t($perm),
        );
        foreach ($role_names as $rid => $name) {

          // Builds arrays for checked boxes for each role
          if (strpos($role_permissions[$rid], $perm . ',') !== FALSE) {
            $status[$rid][] = $perm;
          }
        }
      }
    }
  }

  // Have to build checkboxes here after checkbox arrays are built
  foreach ($role_names as $rid => $name) {
    $form['checkboxes'][$rid] = array(
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => $status[$rid],
    );
    $form['role_names'][$rid] = array(
      '#value' => $name,
      '#tree' => TRUE,
    );
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save permissions'),
  );
  return $form;
}
function theme_user_admin_perm($form) {
  foreach (element_children($form['permission']) as $key) {

    // Don't take form control structures
    if (is_array($form['permission'][$key])) {
      $row = array();

      // Module name
      if (is_numeric($key)) {
        $row[] = array(
          'data' => t('@module module', array(
            '@module' => drupal_render($form['permission'][$key]),
          )),
          'class' => 'module',
          'id' => 'module-' . $form['permission'][$key]['#value'],
          'colspan' => count($form['role_names']) + 1,
        );
      }
      else {
        $row[] = array(
          'data' => drupal_render($form['permission'][$key]),
          'class' => 'permission',
        );
        foreach (element_children($form['checkboxes']) as $rid) {
          if (is_array($form['checkboxes'][$rid])) {
            $row[] = array(
              'data' => drupal_render($form['checkboxes'][$rid][$key]),
              'align' => 'center',
              'title' => t($key),
            );
          }
        }
      }
      $rows[] = $row;
    }
  }
  $header[] = t('Permission');
  foreach (element_children($form['role_names']) as $rid) {
    if (is_array($form['role_names'][$rid])) {
      $header[] = drupal_render($form['role_names'][$rid]);
    }
  }
  $output = theme('table', $header, $rows, array(
    'id' => 'permissions',
  ));
  $output .= drupal_render($form);
  return $output;
}
function user_admin_perm_submit($form_id, $form_values) {

  // Save permissions:
  $result = db_query('SELECT * FROM {role}');
  while ($role = db_fetch_object($result)) {
    if (isset($form_values[$role->rid])) {

      // Delete, so if we clear every checkbox we reset that role;
      // otherwise permissions are active and denied everywhere.
      db_query('DELETE FROM {permission} WHERE rid = %d', $role->rid);
      $form_values[$role->rid] = array_filter($form_values[$role->rid]);
      if (count($form_values[$role->rid])) {
        db_query("INSERT INTO {permission} (rid, perm) VALUES (%d, '%s')", $role->rid, implode(', ', array_keys($form_values[$role->rid])));
      }
    }
  }
  drupal_set_message(t('The changes have been saved.'));

  // Clear the cached pages and menus:
  menu_rebuild();
}

/**
 * Menu callback: administer roles.
 */
function user_admin_role() {
  $id = arg(4);
  if ($id) {
    if (DRUPAL_ANONYMOUS_RID == $id || DRUPAL_AUTHENTICATED_RID == $id) {
      drupal_goto('admin/user/roles');
    }

    // Display the edit role form.
    $role = db_fetch_object(db_query('SELECT * FROM {role} WHERE rid = %d', $id));
    $form['name'] = array(
      '#type' => 'textfield',
      '#title' => t('Role name'),
      '#default_value' => $role->name,
      '#size' => 30,
      '#required' => TRUE,
      '#maxlength' => 64,
      '#description' => t('The name for this role. Example: "moderator", "editorial board", "site architect".'),
    );
    $form['rid'] = array(
      '#type' => 'value',
      '#value' => $id,
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save role'),
    );
    $form['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete role'),
    );
  }
  else {
    $form['name'] = array(
      '#type' => 'textfield',
      '#size' => 32,
      '#maxlength' => 64,
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Add role'),
    );
    $form['#base'] = 'user_admin_role';
  }
  return $form;
}
function user_admin_role_validate($form_id, $form_values) {
  if ($form_values['name']) {
    if ($form_values['op'] == t('Save role')) {
      if (db_result(db_query("SELECT COUNT(*) FROM {role} WHERE name = '%s' AND rid != %d", $form_values['name'], $form_values['rid']))) {
        form_set_error('name', t('The role name %name already exists. Please choose another role name.', array(
          '%name' => $form_values['name'],
        )));
      }
    }
    else {
      if ($form_values['op'] == t('Add role')) {
        if (db_result(db_query("SELECT COUNT(*) FROM {role} WHERE name = '%s'", $form_values['name']))) {
          form_set_error('name', t('The role name %name already exists. Please choose another role name.', array(
            '%name' => $form_values['name'],
          )));
        }
      }
    }
  }
  else {
    form_set_error('name', t('You must specify a valid role name.'));
  }
}
function user_admin_role_submit($form_id, $form_values) {
  if ($form_values['op'] == t('Save role')) {
    db_query("UPDATE {role} SET name = '%s' WHERE rid = %d", $form_values['name'], $form_values['rid']);
    drupal_set_message(t('The role has been renamed.'));
  }
  else {
    if ($form_values['op'] == t('Delete role')) {
      db_query('DELETE FROM {role} WHERE rid = %d', $form_values['rid']);
      db_query('DELETE FROM {permission} WHERE rid = %d', $form_values['rid']);

      // Update the users who have this role set:
      db_query('DELETE FROM {users_roles} WHERE rid = %d', $form_values['rid']);
      drupal_set_message(t('The role has been deleted.'));
    }
    else {
      if ($form_values['op'] == t('Add role')) {
        db_query("INSERT INTO {role} (name) VALUES ('%s')", $form_values['name']);
        drupal_set_message(t('The role has been added.'));
      }
    }
  }
  return 'admin/user/roles';
}
function theme_user_admin_new_role($form) {
  $header = array(
    t('Name'),
    array(
      'data' => t('Operations'),
      'colspan' => 2,
    ),
  );
  foreach (user_roles() as $rid => $name) {
    $edit_permissions = l(t('edit permissions'), 'admin/user/access/' . $rid);
    if (!in_array($rid, array(
      DRUPAL_ANONYMOUS_RID,
      DRUPAL_AUTHENTICATED_RID,
    ))) {
      $rows[] = array(
        $name,
        l(t('edit role'), 'admin/user/roles/edit/' . $rid),
        $edit_permissions,
      );
    }
    else {
      $rows[] = array(
        $name,
        t('locked'),
        $edit_permissions,
      );
    }
  }
  $rows[] = array(
    drupal_render($form['name']),
    array(
      'data' => drupal_render($form['submit']),
      colspan => 2,
    ),
  );
  $output = drupal_render($form);
  $output .= theme('table', $header, $rows);
  return $output;
}
function user_admin_account() {
  $filter = user_build_filter_query();
  $header = array(
    array(),
    array(
      'data' => t('Username'),
      'field' => 'u.name',
    ),
    array(
      'data' => t('Status'),
      'field' => 'u.status',
    ),
    t('Roles'),
    array(
      'data' => t('Member for'),
      'field' => 'u.created',
      'sort' => 'desc',
    ),
    array(
      'data' => t('Last access'),
      'field' => 'u.access',
    ),
    t('Operations'),
  );
  $sql = 'SELECT DISTINCT u.uid, u.name, u.status, u.created, u.access FROM {users} u LEFT JOIN {users_roles} ur ON u.uid = ur.uid ' . $filter['join'] . ' WHERE u.uid != 0 ' . $filter['where'];
  $sql .= tablesort_sql($header);
  $query_count = 'SELECT COUNT(DISTINCT u.uid) FROM {users} u LEFT JOIN {users_roles} ur ON u.uid = ur.uid ' . $filter['join'] . ' WHERE u.uid != 0 ' . $filter['where'];
  $result = pager_query($sql, 50, 0, $query_count, $filter['args']);
  $form['options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Update options'),
    '#prefix' => '<div class="container-inline">',
    '#suffix' => '</div>',
  );
  $options = array();
  foreach (module_invoke_all('user_operations') as $operation => $array) {
    $options[$operation] = $array['label'];
  }
  $form['options']['operation'] = array(
    '#type' => 'select',
    '#options' => $options,
    '#default_value' => 'unblock',
  );
  $form['options']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update'),
  );
  $destination = drupal_get_destination();
  $status = array(
    t('blocked'),
    t('active'),
  );
  $roles = user_roles(1);
  while ($account = db_fetch_object($result)) {
    $accounts[$account->uid] = '';
    $form['name'][$account->uid] = array(
      '#value' => theme('username', $account),
    );
    $form['status'][$account->uid] = array(
      '#value' => $status[$account->status],
    );
    $users_roles = array();
    $roles_result = db_query('SELECT rid FROM {users_roles} WHERE uid = %d', $account->uid);
    while ($user_role = db_fetch_object($roles_result)) {
      $users_roles[] = $roles[$user_role->rid];
    }
    asort($users_roles);
    $form['roles'][$account->uid][0] = array(
      '#value' => theme('item_list', $users_roles),
    );
    $form['member_for'][$account->uid] = array(
      '#value' => format_interval(time() - $account->created),
    );
    $form['last_access'][$account->uid] = array(
      '#value' => $account->access ? t('@time ago', array(
        '@time' => format_interval(time() - $account->access),
      )) : t('never'),
    );
    $form['operations'][$account->uid] = array(
      '#value' => l(t('edit'), "user/{$account->uid}/edit", array(), $destination),
    );
  }
  $form['accounts'] = array(
    '#type' => 'checkboxes',
    '#options' => $accounts,
  );
  $form['pager'] = array(
    '#value' => theme('pager', NULL, 50, 0),
  );
  return $form;
}

/**
 * Theme user administration overview.
 */
function theme_user_admin_account($form) {

  // Overview table:
  $header = array(
    theme('table_select_header_cell'),
    array(
      'data' => t('Username'),
      'field' => 'u.name',
    ),
    array(
      'data' => t('Status'),
      'field' => 'u.status',
    ),
    t('Roles'),
    array(
      'data' => t('Member for'),
      'field' => 'u.created',
      'sort' => 'desc',
    ),
    array(
      'data' => t('Last access'),
      'field' => 'u.access',
    ),
    t('Operations'),
  );
  $output = drupal_render($form['options']);
  if (isset($form['name']) && is_array($form['name'])) {
    foreach (element_children($form['name']) as $key) {
      $rows[] = array(
        drupal_render($form['accounts'][$key]),
        drupal_render($form['name'][$key]),
        drupal_render($form['status'][$key]),
        drupal_render($form['roles'][$key]),
        drupal_render($form['member_for'][$key]),
        drupal_render($form['last_access'][$key]),
        drupal_render($form['operations'][$key]),
      );
    }
  }
  else {
    $rows[] = array(
      array(
        'data' => t('No users available.'),
        'colspan' => '7',
      ),
    );
  }
  $output .= theme('table', $header, $rows);
  if ($form['pager']['#value']) {
    $output .= drupal_render($form['pager']);
  }
  $output .= drupal_render($form);
  return $output;
}

/**
 * Submit the user administration update form.
 */
function user_admin_account_submit($form_id, $form_values) {
  $operations = module_invoke_all('user_operations');
  $operation = $operations[$form_values['operation']];

  // Filter out unchecked accounts.
  $accounts = array_filter($form_values['accounts']);
  if ($function = $operation['callback']) {

    // Add in callback arguments if present.
    if (isset($operation['callback arguments'])) {
      $args = array_merge(array(
        $accounts,
      ), $operation['callback arguments']);
    }
    else {
      $args = array(
        $accounts,
      );
    }
    call_user_func_array($function, $args);
    cache_clear_all('*', 'cache_menu', TRUE);
    drupal_set_message(t('The update has been performed.'));
  }
}
function user_admin_account_validate($form_id, $form_values) {
  $form_values['accounts'] = array_filter($form_values['accounts']);
  if (count($form_values['accounts']) == 0) {
    form_set_error('', t('No users selected.'));
  }
}

/**
 * Implementation of hook_user_operations().
 */
function user_user_operations() {
  global $form_values;
  $operations = array(
    'unblock' => array(
      'label' => t('Unblock the selected users'),
      'callback' => 'user_user_operations_unblock',
    ),
    'block' => array(
      'label' => t('Block the selected users'),
      'callback' => 'user_user_operations_block',
    ),
    'delete' => array(
      'label' => t('Delete the selected users'),
    ),
  );
  if (user_access('administer access control')) {
    $roles = user_roles(1);
    unset($roles[DRUPAL_AUTHENTICATED_RID]);

    // Can't edit authenticated role.
    $add_roles = array();
    foreach ($roles as $key => $value) {
      $add_roles['add_role-' . $key] = $value;
    }
    $remove_roles = array();
    foreach ($roles as $key => $value) {
      $remove_roles['remove_role-' . $key] = $value;
    }
    if (count($roles)) {
      $role_operations = array(
        t('Add a role to the selected users') => array(
          'label' => $add_roles,
        ),
        t('Remove a role from the selected users') => array(
          'label' => $remove_roles,
        ),
      );
      $operations += $role_operations;
    }
  }

  // If the form has been posted, we need to insert the proper data for role editing if necessary.
  if ($form_values) {
    $operation_rid = explode('-', $form_values['operation']);
    $operation = $operation_rid[0];
    $rid = $operation_rid[1];
    if ($operation == 'add_role' || $operation == 'remove_role') {
      if (user_access('administer access control')) {
        $operations[$form_values['operation']] = array(
          'callback' => 'user_multiple_role_edit',
          'callback arguments' => array(
            $operation,
            $rid,
          ),
        );
      }
      else {
        watchdog('security', t('Detected malicious attempt to alter protected user fields.'), WATCHDOG_WARNING);
        return;
      }
    }
  }
  return $operations;
}

/**
 * Callback function for admin mass unblocking users.
 */
function user_user_operations_unblock($accounts) {
  foreach ($accounts as $uid) {
    $account = user_load(array(
      'uid' => (int) $uid,
    ));

    // Skip unblocking user if they are already unblocked.
    if ($account !== FALSE && $account->status == 0) {
      user_save($account, array(
        'status' => 1,
      ));
    }
  }
}

/**
 * Callback function for admin mass blocking users.
 */
function user_user_operations_block($accounts) {
  foreach ($accounts as $uid) {
    $account = user_load(array(
      'uid' => (int) $uid,
    ));

    // Skip blocking user if they are already blocked.
    if ($account !== FALSE && $account->status == 1) {
      user_save($account, array(
        'status' => 0,
      ));
    }
  }
}

/**
 * Callback function for admin mass adding/deleting a user role.
 */
function user_multiple_role_edit($accounts, $operation, $rid) {

  // The role name is not necessary as user_save() will reload the user
  // object, but some modules' hook_user() may look at this first.
  $role_name = db_result(db_query('SELECT name FROM {role} WHERE rid = %d', $rid));
  switch ($operation) {
    case 'add_role':
      foreach ($accounts as $uid) {
        $account = user_load(array(
          'uid' => (int) $uid,
        ));

        // Skip adding the role to the user if they already have it.
        if ($account !== FALSE && !isset($account->roles[$rid])) {
          $roles = $account->roles + array(
            $rid => $role_name,
          );
          user_save($account, array(
            'roles' => $roles,
          ));
        }
      }
      break;
    case 'remove_role':
      foreach ($accounts as $uid) {
        $account = user_load(array(
          'uid' => (int) $uid,
        ));

        // Skip removing the role from the user if they already don't have it.
        if ($account !== FALSE && isset($account->roles[$rid])) {
          $roles = array_diff($account->roles, array(
            $rid => $role_name,
          ));
          user_save($account, array(
            'roles' => $roles,
          ));
        }
      }
      break;
  }
}
function user_multiple_delete_confirm() {
  $edit = $_POST;
  $form['accounts'] = array(
    '#prefix' => '<ul>',
    '#suffix' => '</ul>',
    '#tree' => TRUE,
  );

  // array_filter returns only elements with TRUE values
  foreach (array_filter($edit['accounts']) as $uid => $value) {
    $user = db_result(db_query('SELECT name FROM {users} WHERE uid = %d', $uid));
    $form['accounts'][$uid] = array(
      '#type' => 'hidden',
      '#value' => $uid,
      '#prefix' => '<li>',
      '#suffix' => check_plain($user) . "</li>\n",
    );
  }
  $form['operation'] = array(
    '#type' => 'hidden',
    '#value' => 'delete',
  );
  return confirm_form($form, t('Are you sure you want to delete these users?'), 'admin/user/user', t('This action cannot be undone.'), t('Delete all'), t('Cancel'));
}
function user_multiple_delete_confirm_submit($form_id, $form_values) {
  if ($form_values['confirm']) {
    foreach ($form_values['accounts'] as $uid => $value) {
      user_delete($form_values, $uid);
    }
    drupal_set_message(t('The users have been deleted.'));
  }
  return 'admin/user/user';
}
function user_admin_settings() {

  // User registration settings.
  $form['registration'] = array(
    '#type' => 'fieldset',
    '#title' => t('User registration settings'),
  );
  $form['registration']['user_register'] = array(
    '#type' => 'radios',
    '#title' => t('Public registrations'),
    '#default_value' => variable_get('user_register', 1),
    '#options' => array(
      t('Only site administrators can create new user accounts.'),
      t('Visitors can create accounts and no administrator approval is required.'),
      t('Visitors can create accounts but administrator approval is required.'),
    ),
  );
  $form['registration']['user_email_verification'] = array(
    '#type' => 'checkbox',
    '#title' => t('Require e-mail verification when a visitor creates an account'),
    '#default_value' => variable_get('user_email_verification', TRUE),
    '#description' => t('If this box is checked, new users will be required to validate their e-mail address prior to logging into to the site, and will be assigned a system-generated password. With it unchecked, users will be logged in immediately upon registering, and may select their own passwords during registration.'),
  );
  $form['registration']['user_registration_help'] = array(
    '#type' => 'textarea',
    '#title' => t('User registration guidelines'),
    '#default_value' => variable_get('user_registration_help', ''),
    '#description' => t("This text is displayed at the top of the user registration form. It's useful for helping or instructing your users."),
  );

  // User e-mail settings.
  $form['email'] = array(
    '#type' => 'fieldset',
    '#title' => t('User e-mail settings'),
  );
  $form['email']['user_mail_welcome_subject'] = array(
    '#type' => 'textfield',
    '#title' => t('Subject of welcome e-mail'),
    '#default_value' => _user_mail_text('welcome_subject'),
    '#maxlength' => 180,
    '#description' => t('Customize the subject of your welcome e-mail, which is sent to new members upon registering.') . ' ' . t('Available variables are:') . ' !username, !site, !password, !uri, !uri_brief, !mailto, !date, !login_uri, !edit_uri, !login_url.',
  );
  $form['email']['user_mail_welcome_body'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of welcome e-mail'),
    '#default_value' => _user_mail_text('welcome_body'),
    '#rows' => 15,
    '#description' => t('Customize the body of the welcome e-mail, which is sent to new members upon registering.') . ' ' . t('Available variables are:') . ' !username, !site, !password, !uri, !uri_brief, !mailto, !login_uri, !edit_uri, !login_url.',
  );
  $form['email']['user_mail_admin_subject'] = array(
    '#type' => 'textfield',
    '#title' => t('Subject of welcome e-mail (user created by administrator)'),
    '#default_value' => _user_mail_text('admin_subject'),
    '#maxlength' => 180,
    '#description' => t('Customize the subject of your welcome e-mail, which is sent to new member accounts created by an administrator.') . ' ' . t('Available variables are:') . ' !username, !site, !password, !uri, !uri_brief, !mailto, !date, !login_uri, !edit_uri, !login_url.',
  );
  $form['email']['user_mail_admin_body'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of welcome e-mail (user created by administrator)'),
    '#default_value' => _user_mail_text('admin_body'),
    '#rows' => 15,
    '#description' => t('Customize the body of the welcome e-mail, which is sent to new member accounts created by an administrator.') . ' ' . t('Available variables are:') . ' !username, !site, !password, !uri, !uri_brief, !mailto, !login_uri, !edit_uri, !login_url.',
  );
  $form['email']['user_mail_approval_subject'] = array(
    '#type' => 'textfield',
    '#title' => t('Subject of welcome e-mail (awaiting admin approval)'),
    '#default_value' => _user_mail_text('approval_subject'),
    '#maxlength' => 180,
    '#description' => t('Customize the subject of your awaiting approval welcome e-mail, which is sent to new members upon registering.') . ' ' . t('Available variables are:') . ' !username, !site, !password, !uri, !uri_brief, !mailto, !date, !login_uri, !edit_uri, !login_url.',
  );
  $form['email']['user_mail_approval_body'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of welcome e-mail (awaiting admin approval)'),
    '#default_value' => _user_mail_text('approval_body'),
    '#rows' => 15,
    '#description' => t('Customize the body of the awaiting approval welcome e-mail, which is sent to new members upon registering.') . ' ' . t('Available variables are:') . ' !username, !site, !password, !uri, !uri_brief, !mailto, !login_uri, !edit_uri, !login_url.',
  );
  $form['email']['user_mail_pass_subject'] = array(
    '#type' => 'textfield',
    '#title' => t('Subject of password recovery e-mail'),
    '#default_value' => _user_mail_text('pass_subject'),
    '#maxlength' => 180,
    '#description' => t('Customize the subject of your forgotten password e-mail.') . ' ' . t('Available variables are:') . ' !username, !site, !login_url, !uri, !uri_brief, !mailto, !date, !login_uri, !edit_uri.',
  );
  $form['email']['user_mail_pass_body'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of password recovery e-mail'),
    '#default_value' => _user_mail_text('pass_body'),
    '#rows' => 15,
    '#description' => t('Customize the body of the forgotten password e-mail.') . ' ' . t('Available variables are:') . ' !username, !site, !login_url, !uri, !uri_brief, !mailto, !login_uri, !edit_uri.',
  );

  // If picture support is enabled, check whether the picture directory exists:
  if (variable_get('user_pictures', 0)) {
    $picture_path = file_create_path(variable_get('user_picture_path', 'pictures'));
    file_check_directory($picture_path, 1, 'user_picture_path');
  }
  $form['pictures'] = array(
    '#type' => 'fieldset',
    '#title' => t('Pictures'),
  );
  $form['pictures']['user_pictures'] = array(
    '#type' => 'radios',
    '#title' => t('Picture support'),
    '#default_value' => variable_get('user_pictures', 0),
    '#options' => array(
      t('Disabled'),
      t('Enabled'),
    ),
    '#description' => t('Enable picture support.'),
  );
  $form['pictures']['user_picture_path'] = array(
    '#type' => 'textfield',
    '#title' => t('Picture image path'),
    '#default_value' => variable_get('user_picture_path', 'pictures'),
    '#size' => 30,
    '#maxlength' => 255,
    '#description' => t('Subdirectory in the directory %dir where pictures will be stored.', array(
      '%dir' => file_directory_path() . '/',
    )),
  );
  $form['pictures']['user_picture_default'] = array(
    '#type' => 'textfield',
    '#title' => t('Default picture'),
    '#default_value' => variable_get('user_picture_default', ''),
    '#size' => 30,
    '#maxlength' => 255,
    '#description' => t('URL of picture to display for users with no custom picture selected. Leave blank for none.'),
  );
  $form['pictures']['user_picture_dimensions'] = array(
    '#type' => 'textfield',
    '#title' => t('Picture maximum dimensions'),
    '#default_value' => variable_get('user_picture_dimensions', '85x85'),
    '#size' => 15,
    '#maxlength' => 10,
    '#description' => t('Maximum dimensions for pictures, in pixels.'),
  );
  $form['pictures']['user_picture_file_size'] = array(
    '#type' => 'textfield',
    '#title' => t('Picture maximum file size'),
    '#default_value' => variable_get('user_picture_file_size', '30'),
    '#size' => 15,
    '#maxlength' => 10,
    '#description' => t('Maximum file size for pictures, in kB.'),
  );
  $form['pictures']['user_picture_guidelines'] = array(
    '#type' => 'textarea',
    '#title' => t('Picture guidelines'),
    '#default_value' => variable_get('user_picture_guidelines', ''),
    '#description' => t("This text is displayed at the picture upload form in addition to the default guidelines. It's useful for helping or instructing your users."),
  );
  return system_settings_form($form);
}
function user_admin($callback_arg = '') {
  $op = isset($_POST['op']) ? $_POST['op'] : $callback_arg;
  switch ($op) {
    case 'search':
    case t('Search'):
      $output = drupal_get_form('search_form', url('admin/user/search'), $_POST['keys'], 'user') . search_data($_POST['keys'], 'user');
      break;
    case t('Create new account'):
    case 'create':
      $output = drupal_get_form('user_register');
      break;
    default:
      if ($_POST['accounts'] && $_POST['operation'] == 'delete') {
        $output = drupal_get_form('user_multiple_delete_confirm');
      }
      else {
        $output = drupal_get_form('user_filter_form');
        $output .= drupal_get_form('user_admin_account');
      }
  }
  return $output;
}

/**
 * Implementation of hook_help().
 */
function user_help($section) {
  global $user;
  switch ($section) {
    case 'admin/help#user':
      $output = '<p>' . t('The user module allows users to register, login, and log out. Users benefit from being able to sign on because it associates content they create with their account and allows various permissions to be set for their roles. The user module supports user roles which can setup fine grained permissions allowing each role to do only what the administrator wants them to. Each user is assigned to one or more roles. By default there are two roles <em>anonymous</em> - a user who has not logged in, and <em>authenticated</em> a user who has signed up and who has been authorized.') . '</p>';
      $output .= '<p>' . t('Users can use their own name or handle and can fine tune some personal configuration settings through their individual my account page. Registered users need to authenticate by supplying either a local username and password, or a remote username and password such as DelphiForums ID, or one from a Drupal powered website. A visitor accessing your website is assigned an unique ID, the so-called session ID, which is stored in a cookie. For security\'s sake, the cookie does not contain personal information but acts as a key to retrieve the information stored on your server.') . '</p>';
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="@user">User page</a>.', array(
        '@user' => 'http://drupal.org/handbook/modules/user/',
      )) . '</p>';
      return $output;
    case 'admin/user/user':
      return '<p>' . t('Drupal allows users to register, login, log out, maintain user profiles, etc. Users of the site may not use their own names to post content until they have signed up for a user account.') . '</p>';
    case 'admin/user/user/create':
    case 'admin/user/user/account/create':
      return '<p>' . t('This web page allows the administrators to register new users by hand. Note that you cannot have a user where either the e-mail address or the username match another user in the system.') . '</p>';
    case 'admin/user/rules':
      return '<p>' . t('Set up username and e-mail address access rules for new <em>and</em> existing accounts (currently logged in accounts will not be logged out). If a username or e-mail address for an account matches any deny rule, but not an allow rule, then the account will not be allowed to be created or to log in. A host rule is effective for every page view, not just registrations.') . '</p>';
    case 'admin/user/access':
      return '<p>' . t('Permissions let you control what users can do on your site. Each user role (defined on the <a href="@role">user roles page</a>) has its own set of permissions. For example, you could give users classified as "Administrators" permission to "administer nodes" but deny this power to ordinary, "authenticated" users. You can use permissions to reveal new features to privileged users (those with subscriptions, for example). Permissions also allow trusted users to share the administrative burden of running a busy site.', array(
        '@role' => url('admin/user/roles'),
      )) . '</p>';
    case 'admin/user/roles':
      return t('<p>Roles allow you to fine tune the security and administration of Drupal. A role defines a group of users that have certain privileges as defined in <a href="@permissions">user permissions</a>. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the <em>role names</em> of the various roles. To delete a role choose "edit".</p><p>By default, Drupal comes with two user roles:</p>
      <ul>
      <li>Anonymous user: this role is used for users that don\'t have a user account or that are not authenticated.</li>
      <li>Authenticated user: this role is automatically granted to all logged in users.</li>
      </ul>', array(
        '@permissions' => url('admin/user/access'),
      ));
    case 'admin/user/search':
      return '<p>' . t('Enter a simple pattern ("*" may be used as a wildcard match) to search for a username. For example, one may search for "br" and Drupal might return "brian", "brad", and "brenda".') . '</p>';
    case 'user/help#user':
      $site = variable_get('site_name', 'Drupal');
      $affiliates = user_auth_help_links();
      if (count($affiliates)) {
        $affiliate_info = implode(', ', user_auth_help_links());
      }
      else {
        $affiliate_info = t('one of our affiliates');
      }
      $output = t('
      <h3>Distributed authentication<a id="da"></a></h3>
      <p>One of the more tedious moments in visiting a new website is filling out the registration form. Here at @site, you do not have to fill out a registration form if you are already a member of !affiliate-info. This capability is called <em>distributed authentication</em>, and <a href="@drupal">Drupal</a>, the software which powers @site, fully supports it.</p>
      <p>Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at @site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user \'Joe\' is already a registered member of <a href="@delphi-forums">Delphi Forums</a>. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with @site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the <em>remote.delphiforums.com</em> server behind the scenes (usually using <a href="@xml">XML-RPC</a>, <a href="@http-post">HTTP POST</a>, or <a href="@soap">SOAP</a>) and asks: "Is the password for user Joe correct?". If Delphi replies yes, then we create a new @site account for Joe and log him into it. Joe may keep on logging into @site in the same manner, and he will always be logged into the same account.</p>', array(
        '!affiliate-info' => $affiliate_info,
        '@site' => $site,
        '@drupal' => 'http://drupal.org',
        '@delphi-forums' => 'http://www.delphiforums.com',
        '@xml' => 'http://www.xmlrpc.com',
        '@http-post' => 'http://www.w3.org/Protocols/',
        '@soap' => 'http://www.soapware.org',
      ));
      foreach (module_list() as $module) {
        if (module_hook($module, 'auth')) {
          $output .= "<h4><a id=\"{$module}\"></a>" . module_invoke($module, 'info', 'name') . '</h4>';
          $output .= module_invoke($module, 'help', "user/help#{$module}");
        }
      }
      return $output;
  }
}

/**
 * Menu callback; Prints user-specific help information.
 */
function user_help_page() {
  return user_help('user/help#user');
}

/**
 * Retrieve a list of all user setting/information categories and sort them by weight.
 */
function _user_categories($account) {
  $categories = array();
  foreach (module_list() as $module) {
    if ($data = module_invoke($module, 'user', 'categories', NULL, $account, '')) {
      $categories = array_merge($data, $categories);
    }
  }
  usort($categories, '_user_sort');
  return $categories;
}
function _user_sort($a, $b) {
  $a = (array) $a + array(
    'weight' => 0,
    'title' => '',
  );
  $b = (array) $b + array(
    'weight' => 0,
    'title' => '',
  );
  return $a['weight'] < $b['weight'] ? -1 : ($a['weight'] > $b['weight'] ? 1 : ($a['title'] < $b['title'] ? -1 : 1));
}

/**
 * Retrieve a list of all form elements for the specified category.
 */
function _user_forms(&$edit, $account, $category, $hook = 'form') {
  $groups = array();
  foreach (module_list() as $module) {
    if ($data = module_invoke($module, 'user', $hook, $edit, $account, $category)) {
      $groups = array_merge_recursive($data, $groups);
    }
  }
  uasort($groups, '_user_sort');
  return empty($groups) ? FALSE : $groups;
}

/**
 * Retrieve a pipe delimited string of autocomplete suggestions for existing users
 */
function user_autocomplete($string = '') {
  $matches = array();
  if ($string) {
    $result = db_query_range("SELECT name FROM {users} WHERE LOWER(name) LIKE LOWER('%s%%')", $string, 0, 10);
    while ($user = db_fetch_object($result)) {
      $matches[$user->name] = check_plain($user->name);
    }
  }
  print drupal_to_js($matches);
  exit;
}

/**
 * List user administration filters that can be applied.
 */
function user_filters() {

  // Regular filters
  $filters = array();
  $roles = user_roles(1);
  unset($roles[DRUPAL_AUTHENTICATED_RID]);

  // Don't list authorized role.
  if (count($roles)) {
    $filters['role'] = array(
      'title' => t('role'),
      'where' => "ur.rid = %d",
      'options' => $roles,
    );
  }
  $options = array();
  $t_module = t('module');
  foreach (module_list() as $module) {
    if ($permissions = module_invoke($module, 'perm')) {
      asort($permissions);
      foreach ($permissions as $permission) {
        $options["{$module} {$t_module}"][$permission] = t($permission);
      }
    }
  }
  ksort($options);
  $filters['permission'] = array(
    'title' => t('permission'),
    'join' => 'LEFT JOIN {permission} p ON ur.rid = p.rid',
    'where' => " ((p.perm IS NOT NULL AND p.perm LIKE '%%%s%%') OR u.uid = 1) ",
    'options' => $options,
  );
  $filters['status'] = array(
    'title' => t('status'),
    'where' => 'u.status = %d',
    'options' => array(
      1 => t('active'),
      0 => t('blocked'),
    ),
  );
  return $filters;
}

/**
 * Build query for user administration filters based on session.
 */
function user_build_filter_query() {
  $filters = user_filters();

  // Build query
  $where = $args = $join = array();
  foreach ($_SESSION['user_overview_filter'] as $filter) {
    list($key, $value) = $filter;

    // This checks to see if this permission filter is an enabled permission for the authenticated role.
    // If so, then all users would be listed, and we can skip adding it to the filter query.
    if ($key == 'permission') {
      $account = new stdClass();
      $account->uid = 'user_filter';
      $account->roles = array(
        DRUPAL_AUTHENTICATED_RID => 1,
      );
      if (user_access($value, $account)) {
        continue;
      }
    }
    $where[] = $filters[$key]['where'];
    $args[] = $value;
    $join[] = $filters[$key]['join'];
  }
  $where = count($where) ? 'AND ' . implode(' AND ', $where) : '';
  $join = count($join) ? ' ' . implode(' ', array_unique($join)) : '';
  return array(
    'where' => $where,
    'join' => $join,
    'args' => $args,
  );
}

/**
 * Return form for user administration filters.
 */
function user_filter_form() {
  $session =& $_SESSION['user_overview_filter'];
  $session = is_array($session) ? $session : array();
  $filters = user_filters();
  $i = 0;
  $form['filters'] = array(
    '#type' => 'fieldset',
    '#title' => t('Show only users where'),
    '#theme' => 'user_filters',
  );
  foreach ($session as $filter) {
    list($type, $value) = $filter;

    // Merge an array of arrays into one if necessary.
    $options = $type == 'permission' ? call_user_func_array('array_merge', $filters[$type]['options']) : $filters[$type]['options'];
    $params = array(
      '%property' => $filters[$type]['title'],
      '%value' => $options[$value],
    );
    if ($i++ > 0) {
      $form['filters']['current'][] = array(
        '#value' => t('<em>and</em> where <strong>%property</strong> is <strong>%value</strong>', $params),
      );
    }
    else {
      $form['filters']['current'][] = array(
        '#value' => t('<strong>%property</strong> is <strong>%value</strong>', $params),
      );
    }
  }
  foreach ($filters as $key => $filter) {
    $names[$key] = $filter['title'];
    $form['filters']['status'][$key] = array(
      '#type' => 'select',
      '#options' => $filter['options'],
    );
  }
  $form['filters']['filter'] = array(
    '#type' => 'radios',
    '#options' => $names,
  );
  $form['filters']['buttons']['submit'] = array(
    '#type' => 'submit',
    '#value' => count($session) ? t('Refine') : t('Filter'),
  );
  if (count($session)) {
    $form['filters']['buttons']['undo'] = array(
      '#type' => 'submit',
      '#value' => t('Undo'),
    );
    $form['filters']['buttons']['reset'] = array(
      '#type' => 'submit',
      '#value' => t('Reset'),
    );
  }
  return $form;
}

/**
 * Theme user administration filter form.
 */
function theme_user_filter_form($form) {
  $output = '<div id="user-admin-filter">';
  $output .= drupal_render($form['filters']);
  $output .= '</div>';
  $output .= drupal_render($form);
  return $output;
}

/**
 * Theme user administration filter selector.
 */
function theme_user_filters($form) {
  $output = '<ul class="clear-block">';
  if (sizeof($form['current'])) {
    foreach (element_children($form['current']) as $key) {
      $output .= '<li>' . drupal_render($form['current'][$key]) . '</li>';
    }
  }
  $output .= '<li><dl class="multiselect">' . (sizeof($form['current']) ? '<dt><em>' . t('and') . '</em> ' . t('where') . '</dt>' : '') . '<dd class="a">';
  foreach (element_children($form['filter']) as $key) {
    $output .= drupal_render($form['filter'][$key]);
  }
  $output .= '</dd>';
  $output .= '<dt>' . t('is') . '</dt><dd class="b">';
  foreach (element_children($form['status']) as $key) {
    $output .= drupal_render($form['status'][$key]);
  }
  $output .= '</dd>';
  $output .= '</dl>';
  $output .= '<div class="container-inline" id="user-admin-buttons">' . drupal_render($form['buttons']) . '</div>';
  $output .= '</li></ul>';
  return $output;
}

/**
 * Process result from user administration filter form.
 */
function user_filter_form_submit($form_id, $form_values) {
  $op = $form_values['op'];
  $filters = user_filters();
  switch ($op) {
    case t('Filter'):
    case t('Refine'):
      if (isset($form_values['filter'])) {
        $filter = $form_values['filter'];

        // Merge an array of arrays into one if necessary.
        $options = $filter == 'permission' ? call_user_func_array('array_merge', $filters[$filter]['options']) : $filters[$filter]['options'];
        if (isset($options[$form_values[$filter]])) {
          $_SESSION['user_overview_filter'][] = array(
            $filter,
            $form_values[$filter],
          );
        }
      }
      break;
    case t('Undo'):
      array_pop($_SESSION['user_overview_filter']);
      break;
    case t('Reset'):
      $_SESSION['user_overview_filter'] = array();
      break;
    case t('Update'):
      return;
  }
  return 'admin/user/user';
}
function user_forms() {
  $forms['user_admin_access_add_form']['callback'] = 'user_admin_access_form';
  $forms['user_admin_access_edit_form']['callback'] = 'user_admin_access_form';
  $forms['user_admin_new_role']['callback'] = 'user_admin_role';
  return $forms;
}

Functions

Namesort descending Description
theme_user_admin_account Theme user administration overview.
theme_user_admin_new_role
theme_user_admin_perm
theme_user_filters Theme user administration filter selector.
theme_user_filter_form Theme user administration filter form.
theme_user_list Make a list of users.
theme_user_picture
theme_user_profile Theme a user page
user_access Determine whether the user has a given privilege.
user_admin
user_admin_access Menu callback: list all access rules
user_admin_access_add Menu callback: add an access rule
user_admin_access_check Menu callback: check an access rule
user_admin_access_check_submit
user_admin_access_check_validate
user_admin_access_delete_confirm Menu callback: delete an access rule
user_admin_access_delete_confirm_submit
user_admin_access_edit Menu callback: edit an access rule
user_admin_access_form
user_admin_access_form_submit Submit callback for user_admin_access_form().
user_admin_account
user_admin_account_submit Submit the user administration update form.
user_admin_account_validate
user_admin_check_host
user_admin_check_mail
user_admin_check_user
user_admin_perm Menu callback: administer permissions.
user_admin_perm_submit
user_admin_role Menu callback: administer roles.
user_admin_role_submit
user_admin_role_validate
user_admin_settings
user_authenticate
user_auth_help_links
user_autocomplete Retrieve a pipe delimited string of autocomplete suggestions for existing users
user_block Implementation of hook_block().
user_build_filter_query Build query for user administration filters based on session.
user_confirm_delete
user_confirm_delete_submit
user_delete Delete a user.
user_edit
user_edit_form
user_edit_submit
user_edit_validate
user_external_load
user_fields
user_file_download Implementation of hook_file_download().
user_filters List user administration filters that can be applied.
user_filter_form Return form for user administration filters.
user_filter_form_submit Process result from user administration filter form.
user_forms
user_get_authmaps Accepts an user object, $account, or a DA name and returns an associative array of modules and DA names. Called at external login.
user_help Implementation of hook_help().
user_help_page Menu callback; Prints user-specific help information.
user_is_blocked Checks for usernames blocked by user administration
user_load Fetch a user object.
user_login
user_login_block
user_login_submit
user_login_validate
user_logout Menu callback; logs the current user out, and redirects to the home page.
user_menu Implementation of hook_menu().
user_module_invoke Invokes hook_user() in every module.
user_multiple_delete_confirm
user_multiple_delete_confirm_submit
user_multiple_role_edit Callback function for admin mass adding/deleting a user role.
user_pass
user_password Generate a random alphanumeric password.
user_pass_rehash
user_pass_reset Menu callback; process one time login link and redirects to the user page on success.
user_pass_reset_url
user_pass_submit
user_pass_validate
user_perm Implementation of hook_perm().
user_register
user_register_submit
user_register_validate
user_roles Retrieve an array of roles matching specified conditions.
user_save Save changes to a user account or add a new user.
user_search Implementation of hook_search().
user_set_authmaps
user_user Implementation of hook_user().
user_user_operations Implementation of hook_user_operations().
user_user_operations_block Callback function for admin mass blocking users.
user_user_operations_unblock Callback function for admin mass unblocking users.
user_validate_mail
user_validate_name Verify the syntax of the given name.
user_validate_picture
user_view
_user_categories Retrieve a list of all user setting/information categories and sort them by weight.
_user_edit_submit
_user_edit_validate
_user_forms Retrieve a list of all form elements for the specified category.
_user_mail_text
_user_sort

Constants

Namesort descending Description
EMAIL_MAX_LENGTH
USERNAME_MAX_LENGTH @file Enables the user registration and login system.