e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
102 lines
3.3 KiB
PHP
102 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Change the prefix of database tables.
|
|
* Run this script to after changing $wgDBprefix on a wiki.
|
|
* The wiki will have to get downtime to do this correctly.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Maintenance
|
|
*/
|
|
|
|
use MediaWiki\MainConfigNames;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Maintenance script that changes the prefix of database tables.
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
class RenameDbPrefix extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addOption( "old", "Old db prefix [0 for none]", true, true );
|
|
$this->addOption( "new", "New db prefix [0 for none]", true, true );
|
|
}
|
|
|
|
public function getDbType() {
|
|
return Maintenance::DB_ADMIN;
|
|
}
|
|
|
|
public function execute() {
|
|
$dbName = $this->getConfig()->get( MainConfigNames::DBname );
|
|
|
|
// Allow for no old prefix
|
|
if ( $this->getOption( 'old', 0 ) === '0' ) {
|
|
$old = '';
|
|
} else {
|
|
// Use nice safe, sensible, prefixes
|
|
preg_match( '/^[a-zA-Z]+_$/', $this->getOption( 'old' ), $m );
|
|
$old = $m[0] ?? false;
|
|
}
|
|
// Allow for no new prefix
|
|
if ( $this->getOption( 'new', 0 ) === '0' ) {
|
|
$new = '';
|
|
} else {
|
|
// Use nice safe, sensible, prefixes
|
|
preg_match( '/^[a-zA-Z]+_$/', $this->getOption( 'new' ), $m );
|
|
$new = $m[0] ?? false;
|
|
}
|
|
|
|
if ( $old === false || $new === false ) {
|
|
$this->fatalError( "Invalid prefix!" );
|
|
}
|
|
if ( $old === $new ) {
|
|
$this->output( "Same prefix. Nothing to rename!\n", true );
|
|
}
|
|
|
|
$this->output( "Renaming DB prefix for tables of $dbName from '$old' to '$new'\n" );
|
|
$count = 0;
|
|
|
|
$dbw = $this->getPrimaryDB();
|
|
$res = $dbw->query( "SHOW TABLES " . $dbw->buildLike( $old, $dbw->anyString() ), __METHOD__ );
|
|
foreach ( $res as $row ) {
|
|
// XXX: odd syntax. MySQL outputs an oddly cased "Tables of X"
|
|
// sort of message. Best not to try $row->x stuff...
|
|
$fields = get_object_vars( $row );
|
|
// Silly for loop over one field...
|
|
foreach ( $fields as $table ) {
|
|
// $old should be regexp safe ([a-zA-Z_])
|
|
$newTable = preg_replace( '/^' . $old . '/', $new, $table );
|
|
$this->output( "Renaming table $table to $newTable\n" );
|
|
$oldTableEnc = $dbw->addIdentifierQuotes( $table );
|
|
$newTableEnc = $dbw->addIdentifierQuotes( $newTable );
|
|
$dbw->query( "RENAME TABLE $oldTableEnc TO $newTableEnc", __METHOD__ );
|
|
}
|
|
$count++;
|
|
}
|
|
$this->output( "Done! [$count tables]\n" );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = RenameDbPrefix::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|