MediaWiki  REL1_31
CloneDatabase.php
Go to the documentation of this file.
1 <?php
25 
28  private $newTablePrefix = '';
29 
31  private $oldTablePrefix = '';
32 
34  private $tablesToClone = [];
35 
37  private $dropCurrentTables = true;
38 
40  private $useTemporaryTables = true;
41 
43  private $db;
44 
54  ) {
55  $this->db = $db;
56  $this->tablesToClone = $tablesToClone;
57  $this->newTablePrefix = $newTablePrefix;
58  $this->oldTablePrefix = $oldTablePrefix !== null ? $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 (T67654)
79  throw new RuntimeException( "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  // Postgres: Temp tables are automatically deleted upon end of session
92  // Same Temp table name hides existing table for current session
93  if ( $this->dropCurrentTables
94  && !in_array( $this->db->getType(), [ 'oracle' ] )
95  ) {
96  if ( $oldTableName === $newTableName ) {
97  // Last ditch check to avoid data loss
98  throw new LogicException( "Not dropping new table, as '$newTableName'"
99  . " is name of both the old and the new table." );
100  }
101  $this->db->dropTable( $tbl, __METHOD__ );
102  wfDebug( __METHOD__ . " dropping {$newTableName}\n" );
103  // Dropping the oldTable because the prefix was changed
104  }
105 
106  # Create new table
107  wfDebug( __METHOD__ . " duplicating $oldTableName to $newTableName\n" );
108  $this->db->duplicateTableStructure(
109  $oldTableName, $newTableName, $this->useTemporaryTables );
110  }
111  }
112 
117  public function destroy( $dropTables = false ) {
118  if ( $dropTables ) {
119  self::changePrefix( $this->newTablePrefix );
120  foreach ( $this->tablesToClone as $tbl ) {
121  $this->db->dropTable( $tbl );
122  }
123  }
124  self::changePrefix( $this->oldTablePrefix );
125  }
126 
133  public static function changePrefix( $prefix ) {
135 
136  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
137  $lbFactory->setDomainPrefix( $prefix );
138  $wgDBprefix = $prefix;
139  }
140 }
CloneDatabase\cloneTableStructure
cloneTableStructure()
Clone the table structure.
Definition: CloneDatabase.php:73
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$wgSharedTables
$wgSharedTables
Definition: DefaultSettings.php:1931
$wgSharedDB
$wgSharedDB
Shared database for multiple wikis.
Definition: DefaultSettings.php:1921
CloneDatabase\$useTemporaryTables
bool $useTemporaryTables
Whether to use temporary tables or not.
Definition: CloneDatabase.php:40
$wgDBprefix
$wgDBprefix
Table name prefix.
Definition: DefaultSettings.php:1871
php
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:37
CloneDatabase\__construct
__construct(IMaintainableDatabase $db, array $tablesToClone, $newTablePrefix, $oldTablePrefix=null, $dropCurrentTables=true)
Definition: CloneDatabase.php:52
CloneDatabase\$tablesToClone
array $tablesToClone
List of tables to be cloned.
Definition: CloneDatabase.php:34
CloneDatabase\$oldTablePrefix
string $oldTablePrefix
Current table prefix.
Definition: CloneDatabase.php:31
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
CloneDatabase\destroy
destroy( $dropTables=false)
Change the prefix back to the original.
Definition: CloneDatabase.php:117
CloneDatabase\useTemporaryTables
useTemporaryTables( $u=true)
Set whether to use temporary tables or not.
Definition: CloneDatabase.php:66
CloneDatabase
Definition: CloneDatabase.php:26
CloneDatabase\changePrefix
static changePrefix( $prefix)
Change the table prefix on all open DB connections/.
Definition: CloneDatabase.php:133
as
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:22
CloneDatabase\$db
IMaintainableDatabase $db
Definition: CloneDatabase.php:43
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:25
CloneDatabase\$dropCurrentTables
bool $dropCurrentTables
Should we DROP tables containing the new names?
Definition: CloneDatabase.php:37
Wikimedia\Rdbms\IMaintainableDatabase
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:38
CloneDatabase\$newTablePrefix
string $newTablePrefix
Table prefix for cloning.
Definition: CloneDatabase.php:28