masquerade.install in Masquerade 6

masquerade.install

Install, uninstall and update hooks for the Masquarade module.

File

masquerade.install

<?php

/**
 * @file masquerade.install
 *
 * Install, uninstall and update hooks for the Masquarade module.
 */

/**
 * Implementation of hook_schema().
 *
 * @return array
 */
function masquerade_schema() {
  return array(
    'masquerade' => array(
      'description' => "Each masquerading user has their session recorded into the masquerade table. Each record represents a masquerading user.",
      'fields' => array(
        'sid' => array(
          'description' => "The current session for this masquerading user corresponding to their {sessions}.sid.",
          'type' => 'varchar',
          'length' => '64',
          'not null' => TRUE,
          'default' => '',
        ),
        'uid_from' => array(
          'description' => 'The {users}.uid corresponding to a session.',
          'type' => 'int',
          'not null' => TRUE,
          'default' => 0,
          'disp-width' => '10',
        ),
        'uid_as' => array(
          'description' => 'The {users}.uid this session is masquerading as.',
          'type' => 'int',
          'not null' => TRUE,
          'default' => 0,
          'disp-width' => '10',
        ),
      ),
      'indexes' => array(
        'sid' => array(
          'sid',
          'uid_from',
        ),
        'sid_2' => array(
          'sid',
          'uid_as',
        ),
      ),
    ),
    'masquerade_users' => array(
      'description' => 'Per-user permission table granting permissions to switch as a specific user.',
      'fields' => array(
        'uid_from' => array(
          'description' => 'The {users}.uid that can masquerade as {masquerade_users}.uid_to.',
          'type' => 'int',
          'not null' => true,
          'default' => 0,
          'disp-width' => 10,
        ),
        'uid_to' => array(
          'description' => 'The {users}.uid that {masquerade_users}.uid_from can masquerade as.',
          'type' => 'int',
          'not null' => true,
          'default' => 0,
          'disp-width' => 10,
        ),
      ),
      'primary key' => array(
        'uid_from',
        'uid_to',
      ),
    ),
  );
}

/**
 * Implementation of hook_install().
 */
function masquerade_install() {
  drupal_install_schema('masquerade');
  db_query("UPDATE {system} SET weight = -10 WHERE name = 'masquerade'");
}

/**
 * Implementation of hook_uninstall().
 */
function masquerade_uninstall() {
  drupal_uninstall_schema('masquerade');
  variable_del('masquerade_test_user');
  variable_del('masquerade_admin_roles');
  variable_del('masquerade_quick_switches');
}

/**
 * Implementation of hook_update_N().
 *
 * Update for http://drupal.org/node/281468
 * Adding support for multiple quick links in the Masquerade block.
 */
function masquerade_update_5000() {

  // If test user was previously configured, add that as the first quick switch user.
  $masquerade_test_user = variable_get('masquerade_test_user', '');
  $masquerade_test_uid = db_result(db_query("SELECT uid FROM {users} WHERE name = '%s'", $masquerade_test_user));
  if ($masquerade_test_uid) {
    variable_set('masquerade_quick_switches', array(
      $masquerade_test_uid => $masquerade_test_uid,
    ));
  }
  return array();
}

/**
 * Implementation of hook_update_N().
 */
function masquerade_update_6001() {
  variable_set('masquerade_quick_switches', implode(',', variable_get('masquerade_quick_switches', array())));
  return array();
}

/**
 * Make the sid column match the length of the core sessions table (64 characters).
 */
function masquerade_update_6002() {
  $ret = array();
  db_drop_index($ret, 'masquerade', 'sid');
  db_drop_index($ret, 'masquerade', 'sid_2');
  db_change_field($ret, 'masquerade', 'sid', 'sid', array(
    'type' => 'varchar',
    'length' => '64',
    'not null' => TRUE,
    'default' => '',
  ));
  db_add_index($ret, 'masquerade', 'sid', array(
    'sid',
    'uid_from',
  ));
  db_add_index($ret, 'masquerade', 'sid_2', array(
    'sid',
    'uid_as',
  ));
  return $ret;
}

/**
 * Change masquerade_quick_switches variable to store a serialized array of
 * user ID's. Reverts update 6001.
 */
function masquerade_update_6003() {
  $users = variable_get('masquerade_quick_switches', NULL);
  if (!empty($users)) {
    $user_ids = drupal_explode_tags($users);
    if (!empty($user_ids)) {
      variable_set('masquerade_quick_switches', $user_ids);
    }
  }
  else {
    variable_del('masquerade_quick_switches');
  }
  return array();
}

/**
 * Set the weight of the masquerade module to -10, but only if it hasn't
 * previously been changed.
 */
function masquerade_update_6004() {
  $ret = array();
  $ret[] = update_sql("UPDATE {system} SET weight = -10 WHERE name = 'masquerade' AND weight = 0");
  return $ret;
}

/**
 * Add a table storing specific user pairings a user can masquerade as.
 */
function masquerade_update_6005() {
  $ret = array();
  $schema = array(
    'masquerade_users' => array(
      'fields' => array(
        'uid_from' => array(
          'type' => 'int',
          'not null' => true,
          'default' => 0,
          'disp-width' => 10,
        ),
        'uid_to' => array(
          'type' => 'int',
          'not null' => true,
          'default' => 0,
          'disp-width' => 10,
        ),
      ),
      'primary key' => array(
        'uid_from',
        'uid_to',
      ),
    ),
  );
  db_create_table($ret, 'masquerade_users', $schema['masquerade_users']);
  return $ret;
}

/**
 * Update masquerade block caching.
 */
function masquerade_update_6006() {
  $ret = array();
  $ret[] = update_sql("UPDATE {blocks} SET cache = -1 WHERE module = 'masquerade'");
  return $ret;
}

Functions

Name	Description
masquerade_install	Implementation of hook_install().
masquerade_schema	Implementation of hook_schema().
masquerade_uninstall	Implementation of hook_uninstall().
masquerade_update_5000	Implementation of hook_update_N().
masquerade_update_6001	Implementation of hook_update_N().
masquerade_update_6002	Make the sid column match the length of the core sessions table (64 characters).
masquerade_update_6003	Change masquerade_quick_switches variable to store a serialized array of user ID's. Reverts update 6001.
masquerade_update_6004	Set the weight of the masquerade module to -10, but only if it hasn't previously been changed.
masquerade_update_6005	Add a table storing specific user pairings a user can masquerade as.
masquerade_update_6006	Update masquerade block caching.