summaryrefslogtreecommitdiff
blob: 9fdf2347856dd3019b4218f698a92261bcc335ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?php

namespace MediaWiki\Extensions\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\Extensions\OAuth\Backend\Consumer;
use MediaWiki\Extensions\OAuth\Backend\ConsumerAcceptance;
use MediaWiki\Extensions\OAuth\Backend\MWOAuthDAO;
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->error( "Invalid table name. Must be one of 'oauth_registered_consumer' " .
				"or 'oauth_accepted_consumer'.\n", 1 );
			throw new \LogicException();
		}

		$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
		$oldDb = $lbFactory->getMainLB( $oldWiki )->getConnectionRef( DB_MASTER, [], $oldWiki );
		$targetDb = $lbFactory->getMainLB( $targetWiki )
			->getConnectionRef( DB_MASTER, [], $targetWiki );
		$targetDb->daoReadOnly = false;

		$newMax = $targetDb->selectField(
			$table,
			"MAX($idKey)",
			[],
			__METHOD__
		);

		$oldMax = $oldDb->selectField(
			$table,
			"MAX($idKey)",
			[],
			__METHOD__
		);

		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;