3 * Helper class for making a copy of the database, mostly for unit testing.
5 * Copyright © 2010 Chad Horohoe <chad@anyonecanedit.org>
6 * http://www.mediawiki.org/
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
30 * Table prefix for cloning
33 private $newTablePrefix = '';
36 * Current table prefix
39 private $oldTablePrefix = '';
42 * List of tables to be cloned
45 private $tablesToClone = array();
48 * Should we DROP tables containing the new names?
51 private $dropCurrentTables = true;
54 * Whether to use temporary tables or not
57 private $useTemporaryTables = true;
62 * @param $db DatabaseBase A database subclass
63 * @param $tablesToClone Array An array of tables to clone, unprefixed
64 * @param $newTablePrefix String Prefix to assign to the tables
65 * @param $oldTablePrefix String Prefix on current tables, if not $wgDBprefix
66 * @param $dropCurrentTables bool
68 public function __construct( DatabaseBase
$db, array $tablesToClone,
69 $newTablePrefix, $oldTablePrefix = '', $dropCurrentTables = true )
72 $this->tablesToClone
= $tablesToClone;
73 $this->newTablePrefix
= $newTablePrefix;
74 $this->oldTablePrefix
= $oldTablePrefix ?
$oldTablePrefix : $this->db
->tablePrefix();
75 $this->dropCurrentTables
= $dropCurrentTables;
79 * Set whether to use temporary tables or not
80 * @param $u Bool Use temporary tables when cloning the structure
82 public function useTemporaryTables( $u = true ) {
83 $this->useTemporaryTables
= $u;
87 * Clone the table structure
89 public function cloneTableStructure() {
91 foreach( $this->tablesToClone
as $tbl ) {
92 # Clean up from previous aborted run. So that table escaping
93 # works correctly across DB engines, we need to change the pre-
94 # fix back and forth so tableName() works right.
96 self
::changePrefix( $this->oldTablePrefix
);
97 $oldTableName = $this->db
->tableName( $tbl, 'raw' );
99 self
::changePrefix( $this->newTablePrefix
);
100 $newTableName = $this->db
->tableName( $tbl, 'raw' );
102 if( $this->dropCurrentTables
&& !in_array( $this->db
->getType(), array( 'postgres', 'oracle' ) ) ) {
103 $this->db
->dropTable( $tbl, __METHOD__
);
104 wfDebug( __METHOD__
." dropping {$newTableName}\n", true);
105 //Dropping the oldTable because the prefix was changed
109 wfDebug( __METHOD__
." duplicating $oldTableName to $newTableName\n", true );
110 $this->db
->duplicateTableStructure( $oldTableName, $newTableName, $this->useTemporaryTables
);
117 * Change the prefix back to the original.
118 * @param $dropTables bool Optionally drop the tables we created
120 public function destroy( $dropTables = false ) {
122 self
::changePrefix( $this->newTablePrefix
);
123 foreach( $this->tablesToClone
as $tbl ) {
124 $this->db
->dropTable( $tbl );
127 self
::changePrefix( $this->oldTablePrefix
);
131 * Change the table prefix on all open DB connections/
136 public static function changePrefix( $prefix ) {
138 wfGetLBFactory()->forEachLB( array( 'CloneDatabase', 'changeLBPrefix' ), array( $prefix ) );
139 $wgDBprefix = $prefix;
143 * @param $lb LoadBalancer
147 public static function changeLBPrefix( $lb, $prefix ) {
148 $lb->forEachOpenConnection( array( 'CloneDatabase', 'changeDBPrefix' ), array( $prefix ) );
152 * @param $db DatabaseBase
156 public static function changeDBPrefix( $db, $prefix ) {
157 $db->tablePrefix( $prefix );