MediaWiki  1.34.0
renameDbPrefix.php
Go to the documentation of this file.
1 <?php
26 require_once __DIR__ . '/Maintenance.php';
27 
33 class RenameDbPrefix extends Maintenance {
34  public function __construct() {
35  parent::__construct();
36  $this->addOption( "old", "Old db prefix [0 for none]", true, true );
37  $this->addOption( "new", "New db prefix [0 for none]", true, true );
38  }
39 
40  public function getDbType() {
41  return Maintenance::DB_ADMIN;
42  }
43 
44  public function execute() {
45  global $wgDBname;
46 
47  // Allow for no old prefix
48  if ( $this->getOption( 'old', 0 ) === '0' ) {
49  $old = '';
50  } else {
51  // Use nice safe, sane, prefixes
52  preg_match( '/^[a-zA-Z]+_$/', $this->getOption( 'old' ), $m );
53  $old = $m[0] ?? false;
54  }
55  // Allow for no new prefix
56  if ( $this->getOption( 'new', 0 ) === '0' ) {
57  $new = '';
58  } else {
59  // Use nice safe, sane, prefixes
60  preg_match( '/^[a-zA-Z]+_$/', $this->getOption( 'new' ), $m );
61  $new = $m[0] ?? false;
62  }
63 
64  if ( $old === false || $new === false ) {
65  $this->fatalError( "Invalid prefix!" );
66  }
67  if ( $old === $new ) {
68  $this->output( "Same prefix. Nothing to rename!\n", true );
69  }
70 
71  $this->output( "Renaming DB prefix for tables of $wgDBname from '$old' to '$new'\n" );
72  $count = 0;
73 
74  $dbw = $this->getDB( DB_MASTER );
75  $res = $dbw->query( "SHOW TABLES " . $dbw->buildLike( $old, $dbw->anyString() ) );
76  foreach ( $res as $row ) {
77  // XXX: odd syntax. MySQL outputs an oddly cased "Tables of X"
78  // sort of message. Best not to try $row->x stuff...
79  $fields = get_object_vars( $row );
80  // Silly for loop over one field...
81  foreach ( $fields as $table ) {
82  // $old should be regexp safe ([a-zA-Z_])
83  $newTable = preg_replace( '/^' . $old . '/', $new, $table );
84  $this->output( "Renaming table $table to $newTable\n" );
85  $oldTableEnc = $dbw->addIdentifierQuotes( $table );
86  $newTableEnc = $dbw->addIdentifierQuotes( $newTable );
87  $dbw->query( "RENAME TABLE $oldTableEnc TO $newTableEnc" );
88  }
89  $count++;
90  }
91  $this->output( "Done! [$count tables]\n" );
92  }
93 }
94 
95 $maintClass = RenameDbPrefix::class;
96 require_once RUN_MAINTENANCE_IF_MAIN;
RUN_MAINTENANCE_IF_MAIN
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
RenameDbPrefix\execute
execute()
Do the actual work.
Definition: renameDbPrefix.php:44
$maintClass
$maintClass
Definition: renameDbPrefix.php:95
$wgDBname
$wgDBname
Current wiki database name.
Definition: DefaultSettings.php:1893
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:504
RenameDbPrefix\__construct
__construct()
Default constructor.
Definition: renameDbPrefix.php:34
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:82
$res
$res
Definition: testCompression.php:52
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:267
RenameDbPrefix\getDbType
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
Definition: renameDbPrefix.php:40
DB_MASTER
const DB_MASTER
Definition: defines.php:26
Maintenance\DB_ADMIN
const DB_ADMIN
Definition: Maintenance.php:89
RenameDbPrefix
Maintenance script that changes the prefix of database tables.
Definition: renameDbPrefix.php:33
Maintenance\getDB
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1396
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:302
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:453