Page MenuHomeWickedGov Phorge
Files F5966587

migrateCentralWiki.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

migrateCentralWiki.php
View Options

<?php
namespace MediaWiki\Extension\OAuth;
/**
* Migrate oauth_registered_consumer and oauth_accepted_consumer tables to a
* new database with minimal downtime. This script assumes relatively small tables
* (The WMF has <100 consumers and aout 1000 authorizations right now).
*
* To migrate to a new central wiki within your cluster, you roughly want to:
* 1. Set $wgMWOAuthReadOnly = true for all wikis in your running config
* 2. Move the oauth_registered_consumer and oauth_accepted_consumer tables with this script
* 3. Update the cluster config to point to the new central wiki
* 4. Set $wgMWOAuthReadOnly back to false, so users can manage their consumers as normal.
* 5. Migrate the OAuth logs using importCentralWikiLogs.php.
* 6. Done!
*
* @ingroup Maintenance
*/
if ( getenv( 'MW_INSTALL_PATH' ) ) {
$IP = getenv( 'MW_INSTALL_PATH' );
} else {
$IP = __DIR__ . '/../../..';
}
require_once "$IP/maintenance/Maintenance.php";
use MediaWiki\Extension\OAuth\Backend\Consumer;
use MediaWiki\Extension\OAuth\Backend\ConsumerAcceptance;
use MediaWiki\Extension\OAuth\Backend\MWOAuthDAO;
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\MediaWikiServices;
class MigrateCentralWiki extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( "Migrate central wiki from one wiki to another. " .
"OAuth should be in Read Only mode while this is running." );
$this->addOption( 'old', 'Previous central wiki', true, true );
$this->addOption( 'target', 'New central wiki', true, true );
$this->addOption( 'table',
'Table name (oauth_registered_consumer or oauth_accepted_consumer)', true, true );
$this->setBatchSize( 200 );
$this->requireExtension( "OAuth" );
}
public function execute() {
$oldWiki = $this->getOption( 'old' );
$targetWiki = $this->getOption( 'target' );
$table = $this->getOption( 'table' );
if ( $table === 'oauth_registered_consumer' ) {
$idKey = 'oarc_id';
$cmrClass = Consumer::class;
$type = 'consumer';
} elseif ( $table === 'oauth_accepted_consumer' ) {
$idKey = 'oaac_id';
$cmrClass = ConsumerAcceptance::class;
$type = 'grant';
} else {
$this->fatalError( "Invalid table name. Must be one of 'oauth_registered_consumer' " .
"or 'oauth_accepted_consumer'.\n" );
}
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
$oldDb = $lbFactory->getMainLB( $oldWiki )->getConnection( DB_PRIMARY, [], $oldWiki );
$targetDb = $lbFactory->getMainLB( $targetWiki )
->getConnection( DB_PRIMARY, [], $targetWiki );
$newMax = $targetDb->newSelectQueryBuilder()
->select( "MAX($idKey)" )
->from( $table )
->caller( __METHOD__ )
->fetchField();
$oldMax = $oldDb->newSelectQueryBuilder()
->select( "MAX($idKey)" )
->from( $table )
->caller( __METHOD__ )
->fetchField();
if ( $newMax >= $oldMax ) {
$this->output( "No new rows.\n" );
}
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
for ( $currentId = $newMax + 1, $i = 1; $currentId <= $oldMax; ++$currentId, ++$i ) {
$this->output( "Migrating $type $currentId..." );
/** @var MWOAuthDAO $cmrClass */
$cmr = $cmrClass::newFromId( $oldDb, $currentId );
if ( $cmr ) {
$cmr->updateOrigin( 'new' );
$cmr->setPending( true );
$cmr->save( $targetDb );
$this->output( "done.\n" );
} else {
$this->output( "missing.\n" );
}
if ( $this->mBatchSize && $i % $this->mBatchSize === 0 ) {
$lbFactory->waitForReplication( [ 'domain' => $targetWiki ] );
}
}
}
}
$maintClass = MigrateCentralWiki::class;
require_once RUN_MAINTENANCE_IF_MAIN;

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 11:44 (4 d, 18 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
8a/73/3d04c843294aacf2ed2ff112fc7f
Default Alt Text
migrateCentralWiki.php (3 KB)

Event Timeline