3 * Helper class for userOptions.php script.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup Maintenance
24 // Options we will use
25 $options = [ 'list', 'nowarn', 'quiet', 'usage', 'dry' ];
26 $optionsWithArgs = [ 'old', 'new' ];
28 require_once __DIR__ . '/commandLine.inc';
31 * @ingroup Maintenance
41 private $mMode, $mReady;
44 * Constructor. Will show usage and exit if script options are not correct
48 function __construct( $opts, $args ) {
49 if ( !$this->checkOpts( $opts, $args ) ) {
50 UserOptions::showUsageAndExit();
52 $this->mReady = $this->initializeOpts( $opts, $args );
57 * This is used to check options. Only needed on construction
64 private function checkOpts( $opts, $args ) {
65 // The three possible ways to run the script:
66 $list = isset( $opts['list'] );
67 $usage = isset( $opts['usage'] ) && ( count( $args ) <= 1 );
68 $change = isset( $opts['old'] ) && isset( $opts['new'] ) && ( count( $args ) <= 1 );
70 // We want only one of them
71 $isValid = ( ( $list + $usage + $change ) == 1 );
77 * load script options in the object
84 private function initializeOpts( $opts, $args ) {
86 $this->mQuick = isset( $opts['nowarn'] );
87 $this->mQuiet = isset( $opts['quiet'] );
88 $this->mDry = isset( $opts['dry'] );
90 // Set object properties, specially 'mMode' used by run()
91 if ( isset( $opts['list'] ) ) {
92 $this->mMode = 'LISTER';
93 } elseif ( isset( $opts['usage'] ) ) {
94 $this->mMode = 'USAGER';
95 $this->mAnOption = isset( $args[0] ) ? $args[0] : false;
96 } elseif ( isset( $opts['old'] ) && isset( $opts['new'] ) ) {
97 $this->mMode = 'CHANGER';
98 $this->mOldValue = $opts['old'];
99 $this->mNewValue = $opts['new'];
100 $this->mAnOption = $args[0];
102 die( "There is a bug in the software, this should never happen\n" );
109 * Dumb stuff to run a mode.
111 public function run() {
112 if ( !$this->mReady ) {
116 $this->{$this->mMode}();
122 * List default options and their value
124 private function LISTER() {
125 $def = User::getDefaultOptions();
128 foreach ( $def as $opt => $value ) {
129 $maxOpt = max( $maxOpt, strlen( $opt ) );
131 foreach ( $def as $opt => $value ) {
132 printf( "%-{$maxOpt}s: %s\n", $opt, $value );
139 private function USAGER() {
141 $defaultOptions = User::getDefaultOptions();
143 // We list user by user_id from one of the slave database
144 $dbr = wfGetDB( DB_SLAVE );
145 $result = $dbr->select( 'user',
151 foreach ( $result as $id ) {
153 $user = User::newFromId( $id->user_id );
155 // Get the options and update stats
156 if ( $this->mAnOption ) {
158 if ( !array_key_exists( $this->mAnOption, $defaultOptions ) ) {
159 print "Invalid user option. Use --list to see valid choices\n";
163 $userValue = $user->getOption( $this->mAnOption );
164 if ( $userValue <> $defaultOptions[$this->mAnOption] ) {
165 // @codingStandardsIgnoreStart Ignore silencing errors is discouraged warning
166 @$ret[$this->mAnOption][$userValue]++;
167 // @codingStandardsIgnoreEnd
171 foreach ( $defaultOptions as $name => $defaultValue ) {
172 $userValue = $user->getOption( $name );
173 if ( $userValue <> $defaultValue ) {
174 // @codingStandardsIgnoreStart Ignore silencing errors is discouraged warning
175 @$ret[$name][$userValue]++;
176 // @codingStandardsIgnoreEnd
182 foreach ( $ret as $optionName => $usageStats ) {
183 print "Usage for <$optionName> (default: '{$defaultOptions[$optionName]}'):\n";
184 foreach ( $usageStats as $value => $count ) {
185 print " $count user(s): '$value'\n";
192 * Change our users options
194 private function CHANGER() {
197 // We list user by user_id from one of the slave database
198 $dbr = wfGetDB( DB_SLAVE );
199 $result = $dbr->select( 'user',
205 foreach ( $result as $id ) {
207 $user = User::newFromId( $id->user_id );
209 $curValue = $user->getOption( $this->mAnOption );
210 $username = $user->getName();
212 if ( $curValue == $this->mOldValue ) {
214 if ( !$this->mQuiet ) {
215 print "Setting {$this->mAnOption} for $username from '{$this->mOldValue}' " .
216 "to '{$this->mNewValue}'): ";
220 $user->setOption( $this->mAnOption, $this->mNewValue );
222 // Will not save the settings if run with --dry
223 if ( !$this->mDry ) {
224 $user->saveSettings();
226 if ( !$this->mQuiet ) {
229 } elseif ( !$this->mQuiet ) {
230 print "Not changing '$username' using <{$this->mAnOption}> = '$curValue'\n";
236 * Return an array of option names
239 public static function getDefaultOptionsNames() {
240 $def = User::getDefaultOptions();
242 foreach ( $def as $optname => $defaultValue ) {
243 array_push( $ret, $optname );
249 public static function showUsageAndExit() {
252 This script pass through all users and change one of their options.
253 The new option is NOT validated.
256 php userOptions.php --list
257 php userOptions.php [user option] --usage
258 php userOptions.php [options] <user option> --old <old value> --new <new value>
261 --list : list available user options and their default value
263 --usage : report all options statistics or just one if you specify it.
265 --old <old value> : the value to look for
266 --new <new value> : new value to update users with
269 --nowarn: hides the 5 seconds warning
270 --quiet : do not print what is happening
271 --dry : do not save user settings back to database
278 * The warning message and countdown
281 public function warn() {
283 if ( $this->mQuick ) {
288 The script is about to change the skin for ALL USERS in the database.
289 Users with option <$this->mAnOption> = '$this->mOldValue' will be made to use '$this->mNewValue'.
291 Abort with control-c in the next five seconds....