404 lines
11 KiB
Plaintext
404 lines
11 KiB
Plaintext
<?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'),
|
|
),
|
|
),
|
|
);
|
|
|
|
$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' => 'roles',
|
|
'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.',
|
|
),
|
|
'langcode' => array(
|
|
'type' => 'varchar',
|
|
'length' => 12,
|
|
'not null' => TRUE,
|
|
'default' => '',
|
|
'description' => "The {language}.langcode of the user's profile.",
|
|
),
|
|
'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.",
|
|
),
|
|
'preferred_langcode' => array(
|
|
'type' => 'varchar',
|
|
'length' => 12,
|
|
'not null' => TRUE,
|
|
'default' => '',
|
|
'description' => 'The {language}.langcode that the user prefers for receiving emails and viewing the site.',
|
|
),
|
|
'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' => 'roles',
|
|
'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();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @addtogroup updates-7.x-to-8.x
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* The 'Member for' extra field has moved one level up in the array.
|
|
*/
|
|
function user_update_8000() {
|
|
$settings = field_bundle_settings('user', 'user');
|
|
if (isset($settings['extra_fields']['display']['summary'])) {
|
|
$settings['extra_fields']['display']['member_for'] = $settings['extra_fields']['display']['summary'];
|
|
unset($settings['extra_fields']['display']['summary']);
|
|
field_bundle_settings('user', 'user', $settings);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Splits {users}.language field to langcode and preferred_langcode.
|
|
*
|
|
* @see http://drupal.org/node/1454538
|
|
*/
|
|
function user_update_8001() {
|
|
// The former language field is the language preference of the user. Rename
|
|
// this to preferred_langcode in order to distinguish it from the langcode
|
|
// field common to all entity types, used for identifying the language of the
|
|
// entity itself.
|
|
$preferred_langcode_field = array(
|
|
'type' => 'varchar',
|
|
'length' => 12,
|
|
'not null' => TRUE,
|
|
'default' => '',
|
|
'description' => 'The {language}.langcode that the user prefers for receiving emails and viewing the site.',
|
|
);
|
|
db_change_field('users', 'language', 'preferred_langcode', $preferred_langcode_field);
|
|
|
|
// Add the langcode field.
|
|
$langcode_field = array(
|
|
'type' => 'varchar',
|
|
'length' => 12,
|
|
'not null' => TRUE,
|
|
'default' => '',
|
|
'description' => "The {language}.langcode of the user's profile.",
|
|
);
|
|
db_add_field('users', 'langcode', $langcode_field);
|
|
|
|
// Since distinguishing the language of the user entity from the user's
|
|
// preferred language is a new feature in Drupal 8, assume that for updated
|
|
// sites, existing user entities are in the user's preferred language.
|
|
db_update('users')->expression('langcode', 'preferred_langcode')->execute();
|
|
}
|
|
|
|
/**
|
|
* @} End of "addtogroup updates-7.x-to-8.x"
|
|
*/
|