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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<?php
/**
* Script to change users preferences on the fly.
*
* Made on an original idea by Fooey (freenode)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @author Antoine Musso <hashar at free dot fr>
*/
require_once __DIR__ . '/Maintenance.php';
/**
* @ingroup Maintenance
*/
class UserOptionsMaintenance extends Maintenance {
function __construct() {
parent::__construct();
$this->addDescription( 'Pass through all users and change one of their options.
The new option is NOT validated.' );
$this->addOption( 'list', 'List available user options and their default value' );
$this->addOption( 'usage', 'Report all options statistics or just one if you specify it' );
$this->addOption( 'old', 'The value to look for', false, true );
$this->addOption( 'new', 'Rew value to update users with', false, true );
$this->addOption( 'nowarn', 'Hides the 5 seconds warning' );
$this->addOption( 'dry', 'Do not save user settings back to database' );
$this->addArg( 'option name', 'Name of the option to change or provide statistics about', false );
}
/**
* Do the actual work
*/
public function execute() {
if ( $this->hasOption( 'list' ) ) {
$this->listAvailableOptions();
} elseif ( $this->hasOption( 'usage' ) ) {
$this->showUsageStats();
} elseif ( $this->hasOption( 'old' )
&& $this->hasOption( 'new' )
&& $this->hasArg( 0 )
) {
$this->updateOptions();
} else {
$this->maybeHelp( /* force = */ true );
}
}
/**
* List default options and their value
*/
private function listAvailableOptions() {
$def = User::getDefaultOptions();
ksort( $def );
$maxOpt = 0;
foreach ( $def as $opt => $value ) {
$maxOpt = max( $maxOpt, strlen( $opt ) );
}
foreach ( $def as $opt => $value ) {
$this->output( sprintf( "%-{$maxOpt}s: %s\n", $opt, $value ) );
}
}
/**
* List options usage
*/
private function showUsageStats() {
$option = $this->getArg( 0 );
$ret = [];
$defaultOptions = User::getDefaultOptions();
// We list user by user_id from one of the replica DBs
$dbr = wfGetDB( DB_REPLICA );
$result = $dbr->select( 'user',
[ 'user_id' ],
[],
__METHOD__
);
foreach ( $result as $id ) {
$user = User::newFromId( $id->user_id );
// Get the options and update stats
if ( $option ) {
if ( !array_key_exists( $option, $defaultOptions ) ) {
$this->fatalError( "Invalid user option. Use --list to see valid choices\n" );
}
$userValue = $user->getOption( $option );
if ( $userValue <> $defaultOptions[$option] ) {
// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
@$ret[$option][$userValue]++;
}
} else {
foreach ( $defaultOptions as $name => $defaultValue ) {
$userValue = $user->getOption( $name );
if ( $userValue != $defaultValue ) {
// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
@$ret[$name][$userValue]++;
}
}
}
}
foreach ( $ret as $optionName => $usageStats ) {
$this->output( "Usage for <$optionName> (default: '{$defaultOptions[$optionName]}'):\n" );
foreach ( $usageStats as $value => $count ) {
$this->output( " $count user(s): '$value'\n" );
}
print "\n";
}
}
/**
* Change our users options
*/
private function updateOptions() {
$dryRun = $this->hasOption( 'dry' );
$option = $this->getArg( 0 );
$from = $this->getOption( 'old' );
$to = $this->getOption( 'new' );
if ( !$dryRun ) {
$this->warn( $option, $from, $to );
}
// We list user by user_id from one of the replica DBs
// @todo: getting all users in one query does not scale
$dbr = wfGetDB( DB_REPLICA );
$result = $dbr->select( 'user',
[ 'user_id' ],
[],
__METHOD__
);
foreach ( $result as $id ) {
$user = User::newFromId( $id->user_id );
$curValue = $user->getOption( $option );
$username = $user->getName();
if ( $curValue == $from ) {
$this->output( "Setting {$option} for $username from '{$from}' to '{$to}'): " );
// Change value
$user->setOption( $option, $to );
// Will not save the settings if run with --dry
if ( !$dryRun ) {
$user->saveSettings();
}
$this->output( " OK\n" );
} else {
$this->output( "Not changing '$username' using <{$option}> = '$curValue'\n" );
}
}
}
/**
* The warning message and countdown
*
* @param string $option
* @param string $from
* @param string $to
*/
private function warn( $option, $from, $to ) {
if ( $this->hasOption( 'nowarn' ) ) {
return;
}
$this->output( <<<WARN
The script is about to change the options for ALL USERS in the database.
Users with option <$option> = '$from' will be made to use '$to'.
Abort with control-c in the next five seconds....
WARN
);
$this->countDown( 5 );
}
}
$maintClass = UserOptionsMaintenance::class;
require RUN_MAINTENANCE_IF_MAIN;
|
