*/
use MediaWiki\Logger\LegacyLogger;
+use MediaWiki\MediaWikiServices;
$optionsWithArgs = RecompressTracked::getOptionsWithArgs();
require __DIR__ . '/../commandLine.inc';
public $reportingInterval = 10;
public $numProcs = 1;
public $numBatches = 0;
- public $useDiff, $pageBlobClass, $orphanBlobClass;
- public $slavePipes, $slaveProcs, $prevSlaveId;
+ public $pageBlobClass, $orphanBlobClass;
+ public $replicaPipes, $replicaProcs, $prevReplicaId;
public $copyOnly = false;
public $isChild = false;
- public $slaveId = false;
+ public $replicaId = false;
public $noCount = false;
public $debugLog, $infoLog, $criticalLog;
public $store;
- private static $optionsWithArgs = array(
+ private static $optionsWithArgs = [
'procs',
- 'slave-id',
+ 'replica-id',
'debug-log',
'info-log',
'critical-log'
- );
+ ];
- private static $cmdLineOptionMap = array(
+ private static $cmdLineOptionMap = [
'no-count' => 'noCount',
'procs' => 'numProcs',
'copy-only' => 'copyOnly',
'child' => 'isChild',
- 'slave-id' => 'slaveId',
+ 'replica-id' => 'replicaId',
'debug-log' => 'debugLog',
'info-log' => 'infoLog',
'critical-log' => 'criticalLog',
- );
+ ];
static function getOptionsWithArgs() {
return self::$optionsWithArgs;
}
static function newFromCommandLine( $args, $options ) {
- $jobOptions = array( 'destClusters' => $args );
+ $jobOptions = [ 'destClusters' => $args ];
foreach ( self::$cmdLineOptionMap as $cmdOption => $classOption ) {
if ( isset( $options[$cmdOption] ) ) {
$jobOptions[$classOption] = $options[$cmdOption];
$this->store = new ExternalStoreDB;
if ( !$this->isChild ) {
$GLOBALS['wgDebugLogPrefix'] = "RCT M: ";
- } elseif ( $this->slaveId !== false ) {
- $GLOBALS['wgDebugLogPrefix'] = "RCT {$this->slaveId}: ";
+ } elseif ( $this->replicaId !== false ) {
+ $GLOBALS['wgDebugLogPrefix'] = "RCT {$this->replicaId}: ";
}
- $this->useDiff = function_exists( 'xdiff_string_bdiff' );
- $this->pageBlobClass = $this->useDiff ? 'DiffHistoryBlob' : 'ConcatenatedGzipHistoryBlob';
+ $this->pageBlobClass = function_exists( 'xdiff_string_bdiff' ) ?
+ 'DiffHistoryBlob' : 'ConcatenatedGzipHistoryBlob';
$this->orphanBlobClass = 'ConcatenatedGzipHistoryBlob';
}
function logToFile( $msg, $file ) {
$header = '[' . date( 'd\TH:i:s' ) . '] ' . wfHostname() . ' ' . posix_getpid();
- if ( $this->slaveId !== false ) {
- $header .= "({$this->slaveId})";
+ if ( $this->replicaId !== false ) {
+ $header .= "({$this->replicaId})";
}
$header .= ' ' . wfWikiID();
LegacyLogger::emit( sprintf( "%-50s %s\n", $header, $msg ), $file );
}
/**
- * Wait until the selected slave has caught up to the master.
- * This allows us to use the slave for things that were committed in a
+ * Wait until the selected replica DB has caught up to the master.
+ * This allows us to use the replica DB for things that were committed in a
* previous part of this batch process.
*/
function syncDBs() {
$dbw = wfGetDB( DB_MASTER );
- $dbr = wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_REPLICA );
$pos = $dbw->getMasterPos();
$dbr->masterPosWait( $pos, 100000 );
}
}
$this->syncDBs();
- $this->startSlaveProcs();
+ $this->startReplicaProcs();
$this->doAllPages();
$this->doAllOrphans();
- $this->killSlaveProcs();
+ $this->killReplicaProcs();
}
/**
* @return bool
*/
function checkTrackingTable() {
- $dbr = wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_REPLICA );
if ( !$dbr->tableExists( 'blob_tracking' ) ) {
$this->critical( "Error: blob_tracking table does not exist" );
* This necessary because text recompression is slow: loading, compressing and
* writing are all slow.
*/
- function startSlaveProcs() {
+ function startReplicaProcs() {
$cmd = 'php ' . wfEscapeShellArg( __FILE__ );
foreach ( self::$cmdLineOptionMap as $cmdOption => $classOption ) {
- if ( $cmdOption == 'slave-id' ) {
+ if ( $cmdOption == 'replica-id' ) {
continue;
} elseif ( in_array( $cmdOption, self::$optionsWithArgs ) && isset( $this->$classOption ) ) {
$cmd .= " --$cmdOption " . wfEscapeShellArg( $this->$classOption );
' --wiki ' . wfEscapeShellArg( wfWikiID() ) .
' ' . call_user_func_array( 'wfEscapeShellArg', $this->destClusters );
- $this->slavePipes = $this->slaveProcs = array();
+ $this->replicaPipes = $this->replicaProcs = [];
for ( $i = 0; $i < $this->numProcs; $i++ ) {
- $pipes = array();
- $spec = array(
- array( 'pipe', 'r' ),
- array( 'file', 'php://stdout', 'w' ),
- array( 'file', 'php://stderr', 'w' )
- );
+ $pipes = [];
+ $spec = [
+ [ 'pipe', 'r' ],
+ [ 'file', 'php://stdout', 'w' ],
+ [ 'file', 'php://stderr', 'w' ]
+ ];
MediaWiki\suppressWarnings();
- $proc = proc_open( "$cmd --slave-id $i", $spec, $pipes );
+ $proc = proc_open( "$cmd --replica-id $i", $spec, $pipes );
MediaWiki\restoreWarnings();
if ( !$proc ) {
- $this->critical( "Error opening slave process: $cmd" );
+ $this->critical( "Error opening replica DB process: $cmd" );
exit( 1 );
}
- $this->slaveProcs[$i] = $proc;
- $this->slavePipes[$i] = $pipes[0];
+ $this->replicaProcs[$i] = $proc;
+ $this->replicaPipes[$i] = $pipes[0];
}
- $this->prevSlaveId = -1;
+ $this->prevReplicaId = -1;
}
/**
* Gracefully terminate the child processes
*/
- function killSlaveProcs() {
- $this->info( "Waiting for slave processes to finish..." );
+ function killReplicaProcs() {
+ $this->info( "Waiting for replica DB processes to finish..." );
for ( $i = 0; $i < $this->numProcs; $i++ ) {
- $this->dispatchToSlave( $i, 'quit' );
+ $this->dispatchToReplica( $i, 'quit' );
}
for ( $i = 0; $i < $this->numProcs; $i++ ) {
- $status = proc_close( $this->slaveProcs[$i] );
+ $status = proc_close( $this->replicaProcs[$i] );
if ( $status ) {
$this->critical( "Warning: child #$i exited with status $status" );
}
}
/**
- * Dispatch a command to the next available slave.
- * This may block until a slave finishes its work and becomes available.
+ * Dispatch a command to the next available replica DB.
+ * This may block until a replica DB finishes its work and becomes available.
*/
function dispatch( /*...*/ ) {
$args = func_get_args();
- $pipes = $this->slavePipes;
- $numPipes = stream_select( $x = array(), $pipes, $y = array(), 3600 );
+ $pipes = $this->replicaPipes;
+ $numPipes = stream_select( $x = [], $pipes, $y = [], 3600 );
if ( !$numPipes ) {
- $this->critical( "Error waiting to write to slaves. Aborting" );
+ $this->critical( "Error waiting to write to replica DBs. Aborting" );
exit( 1 );
}
for ( $i = 0; $i < $this->numProcs; $i++ ) {
- $slaveId = ( $i + $this->prevSlaveId + 1 ) % $this->numProcs;
- if ( isset( $pipes[$slaveId] ) ) {
- $this->prevSlaveId = $slaveId;
- $this->dispatchToSlave( $slaveId, $args );
+ $replicaId = ( $i + $this->prevReplicaId + 1 ) % $this->numProcs;
+ if ( isset( $pipes[$replicaId] ) ) {
+ $this->prevReplicaId = $replicaId;
+ $this->dispatchToReplica( $replicaId, $args );
return;
}
}
/**
- * Dispatch a command to a specified slave
- * @param int $slaveId
+ * Dispatch a command to a specified replica DB
+ * @param int $replicaId
* @param array|string $args
*/
- function dispatchToSlave( $slaveId, $args ) {
+ function dispatchToReplica( $replicaId, $args ) {
$args = (array)$args;
$cmd = implode( ' ', $args );
- fwrite( $this->slavePipes[$slaveId], "$cmd\n" );
+ fwrite( $this->replicaPipes[$replicaId], "$cmd\n" );
}
/**
* Move all tracked pages to the new clusters
*/
function doAllPages() {
- $dbr = wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_REPLICA );
$i = 0;
$startId = 0;
if ( $this->noCount ) {
$numPages = $dbr->selectField( 'blob_tracking',
'COUNT(DISTINCT bt_page)',
# A condition is required so that this query uses the index
- array( 'bt_moved' => 0 ),
+ [ 'bt_moved' => 0 ],
__METHOD__
);
}
}
while ( true ) {
$res = $dbr->select( 'blob_tracking',
- array( 'bt_page' ),
- array(
+ [ 'bt_page' ],
+ [
'bt_moved' => 0,
'bt_page > ' . $dbr->addQuotes( $startId )
- ),
+ ],
__METHOD__,
- array(
+ [
'DISTINCT',
'ORDER BY' => 'bt_page',
'LIMIT' => $this->batchSize,
- )
+ ]
);
if ( !$res->numRows() ) {
break;
if ( $current == $end || $this->numBatches >= $this->reportingInterval ) {
$this->numBatches = 0;
$this->info( "$label: $current / $end" );
- wfWaitForSlaves();
+ MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->waitForReplication();
}
}
* Move all orphan text to the new clusters
*/
function doAllOrphans() {
- $dbr = wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_REPLICA );
$startId = 0;
$i = 0;
if ( $this->noCount ) {
} else {
$numOrphans = $dbr->selectField( 'blob_tracking',
'COUNT(DISTINCT bt_text_id)',
- array( 'bt_moved' => 0, 'bt_page' => 0 ),
+ [ 'bt_moved' => 0, 'bt_page' => 0 ],
__METHOD__ );
if ( !$numOrphans ) {
return;
while ( true ) {
$res = $dbr->select( 'blob_tracking',
- array( 'bt_text_id' ),
- array(
+ [ 'bt_text_id' ],
+ [
'bt_moved' => 0,
'bt_page' => 0,
'bt_text_id > ' . $dbr->addQuotes( $startId )
- ),
+ ],
__METHOD__,
- array(
+ [
'DISTINCT',
'ORDER BY' => 'bt_text_id',
'LIMIT' => $this->batchSize
- )
+ ]
);
if ( !$res->numRows() ) {
break;
}
- $ids = array();
+ $ids = [];
foreach ( $res as $row ) {
$startId = $row->bt_text_id;
$ids[] = $row->bt_text_id;
$args = array_slice( $ids, 0, $this->orphanBatchSize );
$ids = array_slice( $ids, $this->orphanBatchSize );
array_unshift( $args, 'doOrphanList' );
- call_user_func_array( array( $this, 'dispatch' ), $args );
+ call_user_func_array( [ $this, 'dispatch' ], $args );
}
if ( count( $ids ) ) {
$args = $ids;
array_unshift( $args, 'doOrphanList' );
- call_user_func_array( array( $this, 'dispatch' ), $args );
+ call_user_func_array( [ $this, 'dispatch' ], $args );
}
$this->report( 'orphans', $i, $numOrphans );
case 'quit':
return;
}
- wfWaitForSlaves();
+ MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->waitForReplication();
}
}
} else {
$titleText = '[deleted]';
}
- $dbr = wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_REPLICA );
// Finish any incomplete transactions
if ( !$this->copyOnly ) {
- $this->finishIncompleteMoves( array( 'bt_page' => $pageId ) );
+ $this->finishIncompleteMoves( [ 'bt_page' => $pageId ] );
$this->syncDBs();
}
$startId = 0;
$trx = new CgzCopyTransaction( $this, $this->pageBlobClass );
+ $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
while ( true ) {
$res = $dbr->select(
- array( 'blob_tracking', 'text' ),
+ [ 'blob_tracking', 'text' ],
'*',
- array(
+ [
'bt_page' => $pageId,
'bt_text_id > ' . $dbr->addQuotes( $startId ),
'bt_moved' => 0,
'bt_new_url IS NULL',
'bt_text_id=old_id',
- ),
+ ],
__METHOD__,
- array(
+ [
'ORDER BY' => 'bt_text_id',
'LIMIT' => $this->batchSize
- )
+ ]
);
if ( !$res->numRows() ) {
break;
$this->debug( "$titleText: committing blob with " . $trx->getSize() . " items" );
$trx->commit();
$trx = new CgzCopyTransaction( $this, $this->pageBlobClass );
- wfWaitForSlaves();
+ $lbFactory->waitForReplication();
}
}
}
$dbw = wfGetDB( DB_MASTER );
$dbw->begin( __METHOD__ );
$dbw->update( 'text',
- array( // set
+ [ // set
'old_text' => $url,
'old_flags' => 'external,utf-8',
- ),
- array( // where
+ ],
+ [ // where
'old_id' => $textId
- ),
+ ],
__METHOD__
);
$dbw->update( 'blob_tracking',
- array( 'bt_moved' => 1 ),
- array( 'bt_text_id' => $textId ),
+ [ 'bt_moved' => 1 ],
+ [ 'bt_text_id' => $textId ],
__METHOD__
);
$dbw->commit( __METHOD__ );
* @param array $conds
*/
function finishIncompleteMoves( $conds ) {
- $dbr = wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_REPLICA );
+ $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
$startId = 0;
- $conds = array_merge( $conds, array(
+ $conds = array_merge( $conds, [
'bt_moved' => 0,
'bt_new_url IS NOT NULL'
- ) );
+ ] );
while ( true ) {
$res = $dbr->select( 'blob_tracking',
'*',
- array_merge( $conds, array( 'bt_text_id > ' . $dbr->addQuotes( $startId ) ) ),
+ array_merge( $conds, [ 'bt_text_id > ' . $dbr->addQuotes( $startId ) ] ),
__METHOD__,
- array(
+ [
'ORDER BY' => 'bt_text_id',
'LIMIT' => $this->batchSize,
- )
+ ]
);
if ( !$res->numRows() ) {
break;
$startId = $row->bt_text_id;
$this->moveTextRow( $row->bt_text_id, $row->bt_new_url );
if ( $row->bt_text_id % 10 == 0 ) {
- wfWaitForSlaves();
+ $lbFactory->waitForReplication();
}
}
}
function doOrphanList( $textIds ) {
// Finish incomplete moves
if ( !$this->copyOnly ) {
- $this->finishIncompleteMoves( array( 'bt_text_id' => $textIds ) );
+ $this->finishIncompleteMoves( [ 'bt_text_id' => $textIds ] );
$this->syncDBs();
}
$trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
- $res = wfGetDB( DB_SLAVE )->select(
- array( 'text', 'blob_tracking' ),
- array( 'old_id', 'old_text', 'old_flags' ),
- array(
+ $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
+ $res = wfGetDB( DB_REPLICA )->select(
+ [ 'text', 'blob_tracking' ],
+ [ 'old_id', 'old_text', 'old_flags' ],
+ [
'old_id' => $textIds,
'bt_text_id=old_id',
'bt_moved' => 0,
- ),
+ ],
__METHOD__,
- array( 'DISTINCT' )
+ [ 'DISTINCT' ]
);
foreach ( $res as $row ) {
$this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
$trx->commit();
$trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
- wfWaitForSlaves();
+ $lbFactory->waitForReplication();
}
}
$this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
function __construct( $parent, $blobClass ) {
$this->blobClass = $blobClass;
$this->cgz = false;
- $this->texts = array();
+ $this->texts = [];
$this->parent = $parent;
}
function recompress() {
$class = $this->blobClass;
$this->cgz = new $class;
- $this->referrers = array();
+ $this->referrers = [];
foreach ( $this->texts as $textId => $text ) {
$hash = $this->cgz->addItem( $text );
$this->referrers[$textId] = $hash;
/* Check to see if the target text_ids have been moved already.
*
- * We originally read from the slave, so this can happen when a single
+ * We originally read from the replica DB, so this can happen when a single
* text_id is shared between multiple pages. It's rare, but possible
* if a delete/move/undelete cycle splits up a null edit.
*
$dbw = wfGetDB( DB_MASTER );
$dbw->begin( __METHOD__ );
$res = $dbw->select( 'blob_tracking',
- array( 'bt_text_id', 'bt_moved' ),
- array( 'bt_text_id' => array_keys( $this->referrers ) ),
- __METHOD__, array( 'FOR UPDATE' ) );
+ [ 'bt_text_id', 'bt_moved' ],
+ [ 'bt_text_id' => array_keys( $this->referrers ) ],
+ __METHOD__, [ 'FOR UPDATE' ] );
$dirty = false;
foreach ( $res as $row ) {
if ( $row->bt_moved ) {
foreach ( $this->referrers as $textId => $hash ) {
$url = $baseUrl . '/' . $hash;
$dbw->update( 'blob_tracking',
- array( 'bt_new_url' => $url ),
- array(
+ [ 'bt_new_url' => $url ],
+ [
'bt_text_id' => $textId,
'bt_moved' => 0, # Check for concurrent conflicting update
- ),
+ ],
__METHOD__
);
}