[ticket/17525] Avoid more index name duplication

Many more tables have indexes with the same names which can cause issues
on SQLite/Postgres. Also, add an option for migrations to rename indexes.

PHPBB-17525
This commit is contained in:
rxu 2025-06-17 00:46:17 +07:00
parent 0e0214a71d
commit 7b0b95250c
No known key found for this signature in database
GPG key ID: 955F0567380E586A
5 changed files with 143 additions and 19 deletions

View file

@ -27,14 +27,74 @@ class rename_auth_role_id_index extends migration
public function update_schema()
{
return [
'drop_keys' => [
$this->table_prefix . 'acl_users' => [
'auth_role_id',
'rename_index' => [
$this->table_prefix . 'acl_groups' => [
'auth_role_id' => 'aclgrps_auth_role_id',
'group_id' => 'aclgrps_group_id',
],
],
'add_index' => [
$this->table_prefix . 'acl_users' => [
'usr_auth_role_id' => ['auth_role_id'],
'auth_role_id' => 'aclusrs_auth_role_id',
'user_id' => 'aclusrs_user_id',
],
$this->table_prefix . 'attachments' => [
'poster_id' => 'attchmnts_poster_id',
'topic_id' => 'attchmnts_topic_id',
],
$this->table_prefix . 'forums_watch' => [
'forum_id' => 'frmswtch_forum_id',
'user_id' => 'frmswtch_user_id',
],
$this->table_prefix . 'log' => [
'forum_id' => 'log_forum_id',
'topic_id' => 'log_topic_id',
'user_id' => 'log_user_id',
],
$this->table_prefix . 'login_attempts' => [
'user_id' => 'lgnatmpts_user_id',
],
$this->table_prefix . 'moderator_cache' => [
'forum_id' => 'mdrtrcch_forum_id',
],
$this->table_prefix . 'oauth_states' => [
'user_id' => 'oauthsts_user_id',
],
$this->table_prefix . 'oauth_tokens' => [
'user_id' => 'oauthtkns_user_id',
],
$this->table_prefix . 'poll_options' => [
'topic_id' => 'pllopts_topic_id',
],
$this->table_prefix . 'poll_votes' => [
'topic_id' => 'pllvts_topic_id',
],
$this->table_prefix . 'posts' => [
'forum_id' => 'psts_forum_id',
'poster_id' => 'psts_poster_id',
'topic_id' => 'psts_topic_id',
],
$this->table_prefix . 'privmsgs_folder' => [
'user_id' => 'pmfldr_user_id',
],
$this->table_prefix . 'privmsgs_rules' => [
'user_id' => 'pmrls_user_id',
],
$this->table_prefix . 'topics' => [
'forum_id' => 'tpcs_forum_id',
],
$this->table_prefix . 'topics_track' => [
'forum_id' => 'tpcstrk_forum_id',
'topic_id' => 'tpcstrk_topic_id',
],
$this->table_prefix . 'topics_watch' => [
'topic_id' => 'tpcswtch_topic_id',
'user_id' => 'tpcswtch_user_id',
],
$this->table_prefix . 'user_group' => [
'group_id' => 'usrgrp_group_id',
'user_id' => 'usrgrp_user_id',
],
$this->table_prefix . 'user_notifications' => [
'user_id' => 'usrntf_user_id',
],
],
];
@ -42,17 +102,11 @@ class rename_auth_role_id_index extends migration
public function revert_schema()
{
return [
'drop_keys' => [
$this->table_prefix . 'acl_users' => [
'usr_auth_role_id',
],
],
'add_index' => [
$this->table_prefix . 'acl_users' => [
'auth_role_id' => ['auth_role_id'],
],
],
];
$schema = $this->update_schema();
array_walk($schema['rename_index'], function (&$index_data, $table_name) {
$index_data = array_flip($index_data);
});
return $schema;
}
}

View file

@ -42,6 +42,7 @@ class helper
'add_primary_keys' => 2, // perform_schema_changes only uses one level, but second is in the function
'add_unique_index' => 2,
'add_index' => 2,
'rename_index' => 1,
);
foreach ($nested_level as $change_type => $data_depth)

View file

@ -187,6 +187,7 @@ class schema_generator
'add_index' => 'KEYS',
'add_unique_index' => 'KEYS',
'drop_keys' => 'KEYS',
'rename_index' => 'KEYS',
];
$schema_changes = $migration->update_schema();
@ -206,6 +207,7 @@ class schema_generator
{
case 'add':
case 'change':
case 'rename':
$action = function(&$value, $changes, $value_transform = null) {
self::set_all($value, $changes, $value_transform);
};
@ -347,7 +349,7 @@ class schema_generator
*/
private static function get_value_transform(string $change_type, string $schema_type) : Closure|null
{
if ($change_type !== 'add')
if (!in_array($change_type, ['add', 'rename']))
{
return null;
}
@ -355,6 +357,23 @@ class schema_generator
switch ($schema_type)
{
case 'index':
if ($change_type == 'rename')
{
return function(&$value, $key, $change) {
if (isset($value[$key]))
{
$data_backup = $value[$key];
unset($value[$key]);
$value[$change] = $data_backup;
unset($data_backup);
}
else
{
return null;
}
};
}
return function(&$value, $key, $change) {
$value[$key] = ['INDEX', $change];
};

View file

@ -330,6 +330,19 @@ class doctrine implements tools_interface
);
}
/**
* {@inheritDoc}
*/
public function sql_rename_index(string $table_name, string $index_name_old, string $index_name_new)
{
return $this->alter_schema(
function (Schema $schema) use ($table_name, $index_name_old, $index_name_new): void
{
$this->schema_rename_index($schema, $table_name, $index_name_old, $index_name_new);
}
);
}
/**
* {@inheritDoc}
*/
@ -545,6 +558,11 @@ class doctrine implements tools_interface
'use_key' => true,
'per_table' => true,
],
'rename_index' => [
'method' => 'schema_rename_index',
'use_key' => true,
'per_table' => true,
],
];
foreach ($mapping as $action => $params)
@ -831,6 +849,27 @@ class doctrine implements tools_interface
$table->addIndex($columns, $index_name);
}
/**
* @param Schema $schema
* @param string $table_name
* @param string $index_name_old
* @param string $index_name_new
* @param bool $safe_check
*
* @throws SchemaException
*/
protected function schema_rename_index(Schema $schema, string $table_name, string $index_name_old, string $index_name_new, bool $safe_check = false): void
{
$table = $schema->getTable($table_name);
if ($safe_check && !$table->hasIndex($index_name_old))
{
return;
}
$table->renameIndex($index_name_old, $index_name_new);
}
/**
* @param Schema $schema
* @param string $table_name

View file

@ -165,6 +165,17 @@ interface tools_interface
*/
public function sql_create_index(string $table_name, string $index_name, $column);
/**
* Rename index
*
* @param string $table_name Table to modify
* @param string $index_name_old Name of the index to rename
* @param string $index_name_new New name of the index being renamed
*
* @return bool|string[] True if the statements have been executed
*/
public function sql_rename_index(string $table_name, string $index_name_old, string $index_name_new);
/**
* Drop Index
*