<?php

/**

 * @file

 * Install, update and uninstall functions for the user module.

 */

/**

 * Implements hook_schema().

 */

function user_schema() {

  $schema['authmap'] = array(

    'description' => 'Stores distributed authentication mapping.',

    'fields' => array(

      'aid' => array(

        'description' => 'Primary Key: Unique authmap ID.',

        'type' => 'serial',

        'unsigned' => TRUE,

        'not null' => TRUE,

      ),

      'uid' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => "User's {users}.uid.",

      ),

      'authname' => array(

        'type' => 'varchar',

        'length' => 128,

        'not null' => TRUE,

        'default' => '',

        'description' => 'Unique authentication name.',

      ),

      'module' => array(

        'type' => 'varchar',

        'length' => 128,

        'not null' => TRUE,

        'default' => '',

        'description' => 'Module which is controlling the authentication.',

      ),

    ),

    'unique keys' => array(

      'authname' => array('authname'),

    ),

    'primary key' => array('aid'),

    'foreign keys' => array(

      'user' => array(

        'table' => 'users',

        'columns' => array('uid' => 'uid'),

      ),

    ),

    'indexes' => array(

      'uid_module' => array('uid', 'module'),

    ),

  );

  $schema['role_permission'] = array(

    'description' => 'Stores the permissions assigned to user roles.',

    'fields' => array(

      'rid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'description' => 'Foreign Key: {role}.rid.',

      ),

      'permission' => array(

        'type' => 'varchar',

        'length' => 128,

        'not null' => TRUE,

        'default' => '',

        'description' => 'A single permission granted to the role identified by rid.',

      ),

      'module' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => "The module declaring the permission.",

      ),

    ),

    'primary key' => array('rid', 'permission'),

    'indexes' => array(

      'permission' => array('permission'),

    ),

    'foreign keys' => array(

      'role' => array(

        'table' => 'role',

        'columns' => array('rid' => 'rid'),

      ),

    ),

  );

  $schema['role'] = array(

    'description' => 'Stores user roles.',

    'fields' => array(

      'rid' => array(

        'type' => 'serial',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'description' => 'Primary Key: Unique role ID.',

      ),

      'name' => array(

        'type' => 'varchar',

        'length' => 64,

        'not null' => TRUE,

        'default' => '',

        'description' => 'Unique role name.',

        'translatable' => TRUE,

      ),

      'weight' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => 'The weight of this role in listings and the user interface.',

      ),

    ),

    'unique keys' => array(

      'name' => array('name'),

    ),

    'primary key' => array('rid'),

    'indexes' => array(

      'name_weight' => array('name', 'weight'),

    ),

  );

  // The table name here is plural, despite Drupal table naming standards,

  // because "user" is a reserved word in many databases.

  $schema['users'] = array(

    'description' => 'Stores user data.',

    'fields' => array(

      'uid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'description' => 'Primary Key: Unique user ID.',

        'default' => 0,

      ),

      'name' => array(

        'type' => 'varchar',

        'length' => 60,

        'not null' => TRUE,

        'default' => '',

        'description' => 'Unique user name.',

      ),

      'pass' => array(

        'type' => 'varchar',

        'length' => 128,

        'not null' => TRUE,

        'default' => '',

        'description' => "User's password (hashed).",

      ),

      'mail' => array(

        'type' => 'varchar',

        'length' => 254,

        'not null' => FALSE,

        'default' => '',

        'description' => "User's e-mail address.",

      ),

      'theme' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => "User's default theme.",

      ),

      'signature' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => "User's signature.",

      ),

      'signature_format' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => FALSE,

        'description' => 'The {filter_format}.format of the signature.',

      ),

      'created' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => 'Timestamp for when user was created.',

      ),

      'access' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => 'Timestamp for previous time user accessed the site.',

      ),

      'login' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => "Timestamp for user's last login.",

      ),

      'status' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'size' => 'tiny',

        'description' => 'Whether the user is active(1) or blocked(0).',

      ),

      'timezone' => array(

        'type' => 'varchar',

        'length' => 32,

        'not null' => FALSE,

        'description' => "User's time zone.",

      ),

      'language' => array(

        'type' => 'varchar',

        'length' => 12,

        'not null' => TRUE,

        'default' => '',

        'description' => "User's default language.",

      ),

      'picture' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => "Foreign key: {file_managed}.fid of user's picture.",

      ),

      'init' => array(

        'type' => 'varchar',

        'length' => 254,

        'not null' => FALSE,

        'default' => '',

        'description' => 'E-mail address used for initial account creation.',

      ),

      'data' => array(

        'type' => 'blob',

        'not null' => FALSE,

        'size' => 'big',

        'serialize' => TRUE,

        'description' => 'A serialized array of name value pairs that are related to the user. Any form values posted during user edit are stored and are loaded into the $user object during user_load(). Use of this field is discouraged and it will likely disappear in a future version of Drupal.',

      ),

    ),

    'indexes' => array(

      'access' => array('access'),

      'created' => array('created'),

      'mail' => array('mail'),

      'picture' => array('picture'),

    ),

    'unique keys' => array(

      'name' => array('name'),

    ),

    'primary key' => array('uid'),

    'foreign keys' => array(

      'signature_format' => array(

        'table' => 'filter_format',

        'columns' => array('signature_format' => 'format'),

      ),

    ),

  );

  $schema['users_roles'] = array(

    'description' => 'Maps users to roles.',

    'fields' => array(

      'uid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

        'description' => 'Primary Key: {users}.uid for user.',

      ),

      'rid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

        'description' => 'Primary Key: {role}.rid for role.',

      ),

    ),

    'primary key' => array('uid', 'rid'),

    'indexes' => array(

      'rid' => array('rid'),

    ),

    'foreign keys' => array(

      'user' => array(

        'table' => 'users',

        'columns' => array('uid' => 'uid'),

      ),

      'role' => array(

        'table' => 'role',

        'columns' => array('rid' => 'rid'),

      ),

    ),

  );

  return $schema;

}

/**

 * Implements hook_install().

 */

function user_install() {

  // Insert a row for the anonymous user.

  db_insert('users')

    ->fields(array(

      'uid' => 0,

      'name' => '',

      'mail' => '',

    ))

    ->execute();

  // We need some placeholders here as name and mail are uniques and data is

  // presumed to be a serialized array. This will be changed by the settings

  // form in the installer.

  db_insert('users')

    ->fields(array(

      'uid' => 1,

      'name' => 'placeholder-for-uid-1',

      'mail' => 'placeholder-for-uid-1',

      'created' => REQUEST_TIME,

      'status' => 1,

      'data' => NULL,

    ))

    ->execute();

  // Built-in roles.

  $rid_anonymous = db_insert('role')

    ->fields(array('name' => 'anonymous user', 'weight' => 0))

    ->execute();

  $rid_authenticated = db_insert('role')

    ->fields(array('name' => 'authenticated user', 'weight' => 1))

    ->execute();

  // Sanity check to ensure the anonymous and authenticated role IDs are the

  // same as the drupal defined constants. In certain situations, this will

  // not be true.

  if ($rid_anonymous != DRUPAL_ANONYMOUS_RID) {

    db_update('role')

      ->fields(array('rid' => DRUPAL_ANONYMOUS_RID))

      ->condition('rid', $rid_anonymous)

      ->execute();

  }

  if ($rid_authenticated != DRUPAL_AUTHENTICATED_RID) {

    db_update('role')

      ->fields(array('rid' => DRUPAL_AUTHENTICATED_RID))

      ->condition('rid', $rid_authenticated)

      ->execute();

  }

}

/**

 * Implements hook_update_dependencies().

 */

function user_update_dependencies() {

  // user_update_7006() updates data in the {role_permission} table, so it must

  // run after system_update_7007(), which populates that table.

  $dependencies['user'][7006] = array(

    'system' => 7007,

  );

  // user_update_7010() needs to query the {filter_format} table to get a list

  // of existing text formats, so it must run after filter_update_7000(), which

  // creates that table.

  $dependencies['user'][7010] = array(

    'filter' => 7000,

  );

  // user_update_7012() uses the file API and inserts records into the

  // {file_managed} table, so it therefore must run after system_update_7061(),

  // which inserts files with specific IDs into the table and therefore relies

  // on the table being empty (otherwise it would accidentally overwrite

  // existing records).

  $dependencies['user'][7012] = array(

    'system' => 7061,

  );

  // user_update_7013() uses the file usage API, which relies on the

  // {file_usage} table, so it must run after system_update_7059(), which

  // creates that table.

  $dependencies['user'][7013] = array(

    'system' => 7059,

  );

  return $dependencies;

}

/**

 * Utility function: grant a set of permissions to a role during update.

 *

 * This function is valid for a database schema version 7000.

 *

 * @param $rid

 *   The role ID.

 * @param $permissions

 *   An array of permissions names.

 * @param $module

 *   The name of the module defining the permissions.

 * @ingroup update_api

 */

function _update_7000_user_role_grant_permissions($rid, array $permissions, $module) {

  // Grant new permissions for the role.

  foreach ($permissions as $name) {

    db_merge('role_permission')

      ->key(array(

        'rid' => $rid,

        'permission' => $name,

      ))

      ->fields(array(

        'module' => $module,

      ))

      ->execute();

  }

}

/**

 * @addtogroup updates-6.x-to-7.x

 * @{

 */

/**

 * Increase the length of the password field to accommodate better hashes.

 *

 * Also re-hashes all current passwords to improve security. This may be a

 * lengthy process, and is performed batch-wise.

 */

function user_update_7000(&$sandbox) {

  $sandbox['#finished'] = 0;

  // Lower than DRUPAL_HASH_COUNT to make the update run at a reasonable speed.

  $hash_count_log2 = 11;

  // Multi-part update.

  if (!isset($sandbox['user_from'])) {

    db_change_field('users', 'pass', 'pass', array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''));

    $sandbox['user_from'] = 0;

    $sandbox['user_count'] = db_query("SELECT COUNT(uid) FROM {users}")->fetchField();

  }

  else {

    require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');

    //  Hash again all current hashed passwords.

    $has_rows = FALSE;

    // Update this many per page load.

    $count = 1000;

    $result = db_query_range("SELECT uid, pass FROM {users} WHERE uid > 0 ORDER BY uid", $sandbox['user_from'], $count);

    foreach ($result as $account) {

      $has_rows = TRUE;

      // If the $account->pass value is not a MD5 hash (a 32 character

      // hexadecimal string) then skip it.

      if (!preg_match('/^[0-9a-f]{32}$/', $account->pass)) {

        continue;

      }

      $new_hash = user_hash_password($account->pass, $hash_count_log2);

      if ($new_hash) {

        // Indicate an updated password.

        $new_hash  = 'U' . $new_hash;

        db_update('users')

          ->fields(array('pass' => $new_hash))

          ->condition('uid', $account->uid)

          ->execute();

      }

    }

    $sandbox['#finished'] = $sandbox['user_from']/$sandbox['user_count'];

    $sandbox['user_from'] += $count;

    if (!$has_rows) {

      $sandbox['#finished'] = 1;

      return t('User passwords rehashed to improve security');

    }

  }

}

/**

 * Remove the 'threshold', 'mode' and 'sort' columns from the {users} table.

 *

 * These fields were previously used to store per-user comment settings.

 */

function user_update_7001() {

  db_drop_field('users', 'threshold');

  db_drop_field('users', 'mode');

  db_drop_field('users', 'sort');

}

/**

 * Convert user time zones from time zone offsets to time zone names.

 */

function user_update_7002(&$sandbox) {

  $sandbox['#finished'] = 0;

  // Multi-part update.

  if (!isset($sandbox['user_from'])) {

    db_change_field('users', 'timezone', 'timezone', array('type' => 'varchar', 'length' => 32, 'not null' => FALSE));

    $sandbox['user_from'] = 0;

    $sandbox['user_count'] = db_query("SELECT COUNT(uid) FROM {users}")->fetchField();

    $sandbox['user_not_migrated'] = 0;

  }

  else {

    $timezones = system_time_zones();

    // Update this many per page load.

    $count = 10000;

    $contributed_date_module = db_field_exists('users', 'timezone_name');

    $contributed_event_module = db_field_exists('users', 'timezone_id');

    $results = db_query_range("SELECT uid FROM {users} ORDER BY uid", $sandbox['user_from'], $count);

    foreach ($results as $account) {

      $timezone = NULL;

      // If the contributed Date module has created a users.timezone_name

      // column, use this data to set each user's time zone.

      if ($contributed_date_module) {

        $date_timezone = db_query("SELECT timezone_name FROM {users} WHERE uid = :uid", array(':uid' => $account->uid))->fetchField();

        if (isset($timezones[$date_timezone])) {

          $timezone = $date_timezone;

        }

      }

      // If the contributed Event module has stored user time zone information

      // use that information to update the user accounts.

      if (!$timezone && $contributed_event_module) {

        try {

          $event_timezone = db_query("SELECT t.name FROM {users} u LEFT JOIN {event_timezones} t ON u.timezone_id = t.timezone WHERE u.uid = :uid", array(':uid' => $account->uid))->fetchField();

          $event_timezone = str_replace(' ', '_', $event_timezone);

          if (isset($timezones[$event_timezone])) {

            $timezone = $event_timezone;

          }

        }

        catch (PDOException $e) {

          // Ignore error if event_timezones table does not exist or unexpected

          // schema found.

        }

      }

      if ($timezone) {

        db_update('users')

          ->fields(array('timezone' => $timezone))

          ->condition('uid', $account->uid)

          ->execute();

      }

      else {