MediaWiki  1.27.2
CloneDatabase.php
Go to the documentation of this file.
1 <?php
29  private $newTablePrefix = '';
30 
32  private $oldTablePrefix = '';
33 
35  private $tablesToClone = [];
36 
38  private $dropCurrentTables = true;
39 
41  private $useTemporaryTables = true;
42 
54  ) {
55  $this->db = $db;
56  $this->tablesToClone = $tablesToClone;
57  $this->newTablePrefix = $newTablePrefix;
58  $this->oldTablePrefix = $oldTablePrefix ? $oldTablePrefix : $this->db->tablePrefix();
59  $this->dropCurrentTables = $dropCurrentTables;
60  }
61 
66  public function useTemporaryTables( $u = true ) {
67  $this->useTemporaryTables = $u;
68  }
69 
73  public function cloneTableStructure() {
75  foreach ( $this->tablesToClone as $tbl ) {
76  if ( $wgSharedDB && in_array( $tbl, $wgSharedTables, true ) ) {
77  // Shared tables don't work properly when cloning due to
78  // how prefixes are handled (bug 65654)
79  throw new MWException( "Cannot clone shared table $tbl." );
80  }
81  # Clean up from previous aborted run. So that table escaping
82  # works correctly across DB engines, we need to change the pre-
83  # fix back and forth so tableName() works right.
84 
85  self::changePrefix( $this->oldTablePrefix );
86  $oldTableName = $this->db->tableName( $tbl, 'raw' );
87 
88  self::changePrefix( $this->newTablePrefix );
89  $newTableName = $this->db->tableName( $tbl, 'raw' );
90 
91  if ( $this->dropCurrentTables
92  && !in_array( $this->db->getType(), [ 'postgres', 'oracle' ] )
93  ) {
94  if ( $oldTableName === $newTableName ) {
95  // Last ditch check to avoid data loss
96  throw new MWException( "Not dropping new table, as '$newTableName'"
97  . " is name of both the old and the new table." );
98  }
99  $this->db->dropTable( $tbl, __METHOD__ );
100  wfDebug( __METHOD__ . " dropping {$newTableName}\n" );
101  // Dropping the oldTable because the prefix was changed
102  }
103 
104  # Create new table
105  wfDebug( __METHOD__ . " duplicating $oldTableName to $newTableName\n" );
106  $this->db->duplicateTableStructure( $oldTableName, $newTableName, $this->useTemporaryTables );
107  }
108  }
109 
114  public function destroy( $dropTables = false ) {
115  if ( $dropTables ) {
116  self::changePrefix( $this->newTablePrefix );
117  foreach ( $this->tablesToClone as $tbl ) {
118  $this->db->dropTable( $tbl );
119  }
120  }
121  self::changePrefix( $this->oldTablePrefix );
122  }
123 
130  public static function changePrefix( $prefix ) {
132  wfGetLBFactory()->forEachLB( [ 'CloneDatabase', 'changeLBPrefix' ], [ $prefix ] );
133  $wgDBprefix = $prefix;
134  }
135 
141  public static function changeLBPrefix( $lb, $prefix ) {
142  $lb->forEachOpenConnection( [ 'CloneDatabase', 'changeDBPrefix' ], [ $prefix ] );
143  }
144 
150  public static function changeDBPrefix( $db, $prefix ) {
151  $db->tablePrefix( $prefix );
152  }
153 }
string $newTablePrefix
Table prefix for cloning.
the array() calling protocol came about after MediaWiki 1.4rc1.
static changeLBPrefix($lb, $prefix)
destroy($dropTables=false)
Change the prefix back to the original.
$wgSharedTables
static changePrefix($prefix)
Change the table prefix on all open DB connections/.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
bool $dropCurrentTables
Should we DROP tables containing the new names?
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
cloneTableStructure()
Clone the table structure.
string $oldTablePrefix
Current table prefix.
$wgSharedDB
Shared database for multiple wikis.
bool $useTemporaryTables
Whether to use temporary tables or not.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Database abstraction object.
Definition: Database.php:32
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
wfGetLBFactory()
Get the load balancer factory object.
$wgDBprefix
Table name prefix.
static changeDBPrefix($db, $prefix)
__construct(DatabaseBase $db, array $tablesToClone, $newTablePrefix, $oldTablePrefix= '', $dropCurrentTables=true)
Constructor.
array $tablesToClone
List of tables to be cloned.
useTemporaryTables($u=true)
Set whether to use temporary tables or not.