renameDbPrefix.php

Go to the documentation of this file.

<?php
use MediaWiki\MainConfigNames;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
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