aboutsummaryrefslogtreecommitdiffstats
path: root/maintenance/initUserPreference.php
blob: eaa72a8f3157096100a98aa6ce8e6d8215f716ca (plain) (blame)
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
<?php

use MediaWiki\Maintenance\Maintenance;

// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd

/**
 * Maintenance script that initializes a user preference
 * based on the value of another preference.
 *
 * This is done by copying any non-empty (i.e. excluding 0 or null) value for a given
 * source preference to be the value of the target preference. Only users with the value set
 * will have the target preference set.
 *
 * @ingroup Maintenance
 */
class InitUserPreference extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addOption(
			'target',
			'Name of the user preference to initialize',
			true,
			true,
			't'
		);
		$this->addOption(
			'source',
			'Name of the user preference to take the value from',
			true,
			true,
			's'
		);
		$this->setBatchSize( 300 );
	}

	public function execute() {
		$target = $this->getOption( 'target' );
		$source = $this->getOption( 'source' );
		$this->output( "Initializing '$target' based on the value of '$source'\n" );

		$dbr = $this->getReplicaDB();
		$dbw = $this->getPrimaryDB();

		$iterator = new BatchRowIterator(
			$dbr,
			$dbr->newSelectQueryBuilder()
				->from( 'user_properties' )
				->select( [ 'up_user', 'up_value' ] )
				->where( [
					'up_property' => $source,
					$dbr->expr( 'up_value', '!=', null ),
					$dbr->expr( 'up_value', '!=', '0' ),
				] )
				->caller( __METHOD__ ),
			[ 'up_user', 'up_property' ],
			$this->getBatchSize()
		);

		$processed = 0;
		foreach ( $iterator as $batch ) {
			foreach ( $batch as $row ) {
				$dbw->newInsertQueryBuilder()
					->insertInto( 'user_properties' )
					->row( [
						'up_user' => $row->up_user,
						'up_property' => $target,
						'up_value' => $row->up_value,
					] )
					->onDuplicateKeyUpdate()
					->uniqueIndexFields( [ 'up_user', 'up_property' ] )
					->set( [ 'up_value' => $row->up_value ] )
					->caller( __METHOD__ )->execute();

				$processed += $dbw->affectedRows();
			}
		}

		$this->output( "Processed $processed user(s)\n" );
		$this->output( "Finished!\n" );
	}
}

// @codeCoverageIgnoreStart
$maintClass = InitUserPreference::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd