Don't use deprecated User::checkPassword() in TestUser
[mediawiki.git] / maintenance / Maintenance.php
bloba08297a6474ed5976dea52aba9cb92a1eec146c8
1 <?php
2 /**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
18 * @file
19 * @ingroup Maintenance
20 * @defgroup Maintenance Maintenance
23 // Bail on old versions of PHP, or if composer has not been run yet to install
24 // dependencies. Using dirname( __FILE__ ) here because __DIR__ is PHP5.3+.
25 // @codingStandardsIgnoreStart MediaWiki.Usage.DirUsage.FunctionFound
26 require_once dirname( __FILE__ ) . '/../includes/PHPVersionCheck.php';
27 // @codingStandardsIgnoreEnd
28 wfEntryPointCheck( 'cli' );
30 /**
31 * @defgroup MaintenanceArchive Maintenance archives
32 * @ingroup Maintenance
35 // Define this so scripts can easily find doMaintenance.php
36 define( 'RUN_MAINTENANCE_IF_MAIN', __DIR__ . '/doMaintenance.php' );
37 define( 'DO_MAINTENANCE', RUN_MAINTENANCE_IF_MAIN ); // original name, harmless
39 $maintClass = false;
41 use MediaWiki\Logger\LoggerFactory;
43 /**
44 * Abstract maintenance class for quickly writing and churning out
45 * maintenance scripts with minimal effort. All that _must_ be defined
46 * is the execute() method. See docs/maintenance.txt for more info
47 * and a quick demo of how to use it.
49 * @author Chad Horohoe <chad@anyonecanedit.org>
50 * @since 1.16
51 * @ingroup Maintenance
53 abstract class Maintenance {
54 /**
55 * Constants for DB access type
56 * @see Maintenance::getDbType()
58 const DB_NONE = 0;
59 const DB_STD = 1;
60 const DB_ADMIN = 2;
62 // Const for getStdin()
63 const STDIN_ALL = 'all';
65 // This is the desired params
66 protected $mParams = [];
68 // Array of mapping short parameters to long ones
69 protected $mShortParamsMap = [];
71 // Array of desired args
72 protected $mArgList = [];
74 // This is the list of options that were actually passed
75 protected $mOptions = [];
77 // This is the list of arguments that were actually passed
78 protected $mArgs = [];
80 // Name of the script currently running
81 protected $mSelf;
83 // Special vars for params that are always used
84 protected $mQuiet = false;
85 protected $mDbUser, $mDbPass;
87 // A description of the script, children should change this via addDescription()
88 protected $mDescription = '';
90 // Have we already loaded our user input?
91 protected $mInputLoaded = false;
93 /**
94 * Batch size. If a script supports this, they should set
95 * a default with setBatchSize()
97 * @var int
99 protected $mBatchSize = null;
101 // Generic options added by addDefaultParams()
102 private $mGenericParameters = [];
103 // Generic options which might or not be supported by the script
104 private $mDependantParameters = [];
107 * Used by getDB() / setDB()
108 * @var IDatabase
110 private $mDb = null;
112 /** @var float UNIX timestamp */
113 private $lastSlaveWait = 0.0;
116 * Used when creating separate schema files.
117 * @var resource
119 public $fileHandle;
122 * Accessible via getConfig()
124 * @var Config
126 private $config;
129 * Used to read the options in the order they were passed.
130 * Useful for option chaining (Ex. dumpBackup.php). It will
131 * be an empty array if the options are passed in through
132 * loadParamsAndArgs( $self, $opts, $args ).
134 * This is an array of arrays where
135 * 0 => the option and 1 => parameter value.
137 * @var array
139 public $orderedOptions = [];
142 * Default constructor. Children should call this *first* if implementing
143 * their own constructors
145 public function __construct() {
146 // Setup $IP, using MW_INSTALL_PATH if it exists
147 global $IP;
148 $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
149 ? getenv( 'MW_INSTALL_PATH' )
150 : realpath( __DIR__ . '/..' );
152 $this->addDefaultParams();
153 register_shutdown_function( [ $this, 'outputChanneled' ], false );
157 * Should we execute the maintenance script, or just allow it to be included
158 * as a standalone class? It checks that the call stack only includes this
159 * function and "requires" (meaning was called from the file scope)
161 * @return bool
163 public static function shouldExecute() {
164 global $wgCommandLineMode;
166 if ( !function_exists( 'debug_backtrace' ) ) {
167 // If someone has a better idea...
168 return $wgCommandLineMode;
171 $bt = debug_backtrace();
172 $count = count( $bt );
173 if ( $count < 2 ) {
174 return false; // sanity
176 if ( $bt[0]['class'] !== 'Maintenance' || $bt[0]['function'] !== 'shouldExecute' ) {
177 return false; // last call should be to this function
179 $includeFuncs = [ 'require_once', 'require', 'include', 'include_once' ];
180 for ( $i = 1; $i < $count; $i++ ) {
181 if ( !in_array( $bt[$i]['function'], $includeFuncs ) ) {
182 return false; // previous calls should all be "requires"
186 return true;
190 * Do the actual work. All child classes will need to implement this
192 abstract public function execute();
195 * Add a parameter to the script. Will be displayed on --help
196 * with the associated description
198 * @param string $name The name of the param (help, version, etc)
199 * @param string $description The description of the param to show on --help
200 * @param bool $required Is the param required?
201 * @param bool $withArg Is an argument required with this option?
202 * @param string $shortName Character to use as short name
203 * @param bool $multiOccurrence Can this option be passed multiple times?
205 protected function addOption( $name, $description, $required = false,
206 $withArg = false, $shortName = false, $multiOccurrence = false
208 $this->mParams[$name] = [
209 'desc' => $description,
210 'require' => $required,
211 'withArg' => $withArg,
212 'shortName' => $shortName,
213 'multiOccurrence' => $multiOccurrence
216 if ( $shortName !== false ) {
217 $this->mShortParamsMap[$shortName] = $name;
222 * Checks to see if a particular param exists.
223 * @param string $name The name of the param
224 * @return bool
226 protected function hasOption( $name ) {
227 return isset( $this->mOptions[$name] );
231 * Get an option, or return the default.
233 * If the option was added to support multiple occurrences,
234 * this will return an array.
236 * @param string $name The name of the param
237 * @param mixed $default Anything you want, default null
238 * @return mixed
240 protected function getOption( $name, $default = null ) {
241 if ( $this->hasOption( $name ) ) {
242 return $this->mOptions[$name];
243 } else {
244 // Set it so we don't have to provide the default again
245 $this->mOptions[$name] = $default;
247 return $this->mOptions[$name];
252 * Add some args that are needed
253 * @param string $arg Name of the arg, like 'start'
254 * @param string $description Short description of the arg
255 * @param bool $required Is this required?
257 protected function addArg( $arg, $description, $required = true ) {
258 $this->mArgList[] = [
259 'name' => $arg,
260 'desc' => $description,
261 'require' => $required
266 * Remove an option. Useful for removing options that won't be used in your script.
267 * @param string $name The option to remove.
269 protected function deleteOption( $name ) {
270 unset( $this->mParams[$name] );
274 * Set the description text.
275 * @param string $text The text of the description
277 protected function addDescription( $text ) {
278 $this->mDescription = $text;
282 * Does a given argument exist?
283 * @param int $argId The integer value (from zero) for the arg
284 * @return bool
286 protected function hasArg( $argId = 0 ) {
287 return isset( $this->mArgs[$argId] );
291 * Get an argument.
292 * @param int $argId The integer value (from zero) for the arg
293 * @param mixed $default The default if it doesn't exist
294 * @return mixed
296 protected function getArg( $argId = 0, $default = null ) {
297 return $this->hasArg( $argId ) ? $this->mArgs[$argId] : $default;
301 * Set the batch size.
302 * @param int $s The number of operations to do in a batch
304 protected function setBatchSize( $s = 0 ) {
305 $this->mBatchSize = $s;
307 // If we support $mBatchSize, show the option.
308 // Used to be in addDefaultParams, but in order for that to
309 // work, subclasses would have to call this function in the constructor
310 // before they called parent::__construct which is just weird
311 // (and really wasn't done).
312 if ( $this->mBatchSize ) {
313 $this->addOption( 'batch-size', 'Run this many operations ' .
314 'per batch, default: ' . $this->mBatchSize, false, true );
315 if ( isset( $this->mParams['batch-size'] ) ) {
316 // This seems a little ugly...
317 $this->mDependantParameters['batch-size'] = $this->mParams['batch-size'];
323 * Get the script's name
324 * @return string
326 public function getName() {
327 return $this->mSelf;
331 * Return input from stdin.
332 * @param int $len The number of bytes to read. If null, just return the handle.
333 * Maintenance::STDIN_ALL returns the full length
334 * @return mixed
336 protected function getStdin( $len = null ) {
337 if ( $len == Maintenance::STDIN_ALL ) {
338 return file_get_contents( 'php://stdin' );
340 $f = fopen( 'php://stdin', 'rt' );
341 if ( !$len ) {
342 return $f;
344 $input = fgets( $f, $len );
345 fclose( $f );
347 return rtrim( $input );
351 * @return bool
353 public function isQuiet() {
354 return $this->mQuiet;
358 * Throw some output to the user. Scripts can call this with no fears,
359 * as we handle all --quiet stuff here
360 * @param string $out The text to show to the user
361 * @param mixed $channel Unique identifier for the channel. See function outputChanneled.
363 protected function output( $out, $channel = null ) {
364 if ( $this->mQuiet ) {
365 return;
367 if ( $channel === null ) {
368 $this->cleanupChanneled();
369 print $out;
370 } else {
371 $out = preg_replace( '/\n\z/', '', $out );
372 $this->outputChanneled( $out, $channel );
377 * Throw an error to the user. Doesn't respect --quiet, so don't use
378 * this for non-error output
379 * @param string $err The error to display
380 * @param int $die If > 0, go ahead and die out using this int as the code
382 protected function error( $err, $die = 0 ) {
383 $this->outputChanneled( false );
384 if ( PHP_SAPI == 'cli' ) {
385 fwrite( STDERR, $err . "\n" );
386 } else {
387 print $err;
389 $die = intval( $die );
390 if ( $die > 0 ) {
391 die( $die );
395 private $atLineStart = true;
396 private $lastChannel = null;
399 * Clean up channeled output. Output a newline if necessary.
401 public function cleanupChanneled() {
402 if ( !$this->atLineStart ) {
403 print "\n";
404 $this->atLineStart = true;
409 * Message outputter with channeled message support. Messages on the
410 * same channel are concatenated, but any intervening messages in another
411 * channel start a new line.
412 * @param string $msg The message without trailing newline
413 * @param string $channel Channel identifier or null for no
414 * channel. Channel comparison uses ===.
416 public function outputChanneled( $msg, $channel = null ) {
417 if ( $msg === false ) {
418 $this->cleanupChanneled();
420 return;
423 // End the current line if necessary
424 if ( !$this->atLineStart && $channel !== $this->lastChannel ) {
425 print "\n";
428 print $msg;
430 $this->atLineStart = false;
431 if ( $channel === null ) {
432 // For unchanneled messages, output trailing newline immediately
433 print "\n";
434 $this->atLineStart = true;
436 $this->lastChannel = $channel;
440 * Does the script need different DB access? By default, we give Maintenance
441 * scripts normal rights to the DB. Sometimes, a script needs admin rights
442 * access for a reason and sometimes they want no access. Subclasses should
443 * override and return one of the following values, as needed:
444 * Maintenance::DB_NONE - For no DB access at all
445 * Maintenance::DB_STD - For normal DB access, default
446 * Maintenance::DB_ADMIN - For admin DB access
447 * @return int
449 public function getDbType() {
450 return Maintenance::DB_STD;
454 * Add the default parameters to the scripts
456 protected function addDefaultParams() {
458 # Generic (non script dependant) options:
460 $this->addOption( 'help', 'Display this help message', false, false, 'h' );
461 $this->addOption( 'quiet', 'Whether to supress non-error output', false, false, 'q' );
462 $this->addOption( 'conf', 'Location of LocalSettings.php, if not default', false, true );
463 $this->addOption( 'wiki', 'For specifying the wiki ID', false, true );
464 $this->addOption( 'globals', 'Output globals at the end of processing for debugging' );
465 $this->addOption(
466 'memory-limit',
467 'Set a specific memory limit for the script, '
468 . '"max" for no limit or "default" to avoid changing it'
470 $this->addOption( 'server', "The protocol and server name to use in URLs, e.g. " .
471 "http://en.wikipedia.org. This is sometimes necessary because " .
472 "server name detection may fail in command line scripts.", false, true );
473 $this->addOption( 'profiler', 'Profiler output format (usually "text")', false, true );
475 # Save generic options to display them separately in help
476 $this->mGenericParameters = $this->mParams;
478 # Script dependant options:
480 // If we support a DB, show the options
481 if ( $this->getDbType() > 0 ) {
482 $this->addOption( 'dbuser', 'The DB user to use for this script', false, true );
483 $this->addOption( 'dbpass', 'The password to use for this script', false, true );
486 # Save additional script dependant options to display
487 #  them separately in help
488 $this->mDependantParameters = array_diff_key( $this->mParams, $this->mGenericParameters );
492 * @since 1.24
493 * @return Config
495 public function getConfig() {
496 if ( $this->config === null ) {
497 $this->config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
500 return $this->config;
504 * @since 1.24
505 * @param Config $config
507 public function setConfig( Config $config ) {
508 $this->config = $config;
512 * Run a child maintenance script. Pass all of the current arguments
513 * to it.
514 * @param string $maintClass A name of a child maintenance class
515 * @param string $classFile Full path of where the child is
516 * @return Maintenance
518 public function runChild( $maintClass, $classFile = null ) {
519 // Make sure the class is loaded first
520 if ( !class_exists( $maintClass ) ) {
521 if ( $classFile ) {
522 require_once $classFile;
524 if ( !class_exists( $maintClass ) ) {
525 $this->error( "Cannot spawn child: $maintClass" );
530 * @var $child Maintenance
532 $child = new $maintClass();
533 $child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
534 if ( !is_null( $this->mDb ) ) {
535 $child->setDB( $this->mDb );
538 return $child;
542 * Do some sanity checking and basic setup
544 public function setup() {
545 global $IP, $wgCommandLineMode, $wgRequestTime;
547 # Abort if called from a web server
548 if ( isset( $_SERVER ) && isset( $_SERVER['REQUEST_METHOD'] ) ) {
549 $this->error( 'This script must be run from the command line', true );
552 if ( $IP === null ) {
553 $this->error( "\$IP not set, aborting!\n" .
554 '(Did you forget to call parent::__construct() in your maintenance script?)', 1 );
557 # Make sure we can handle script parameters
558 if ( !defined( 'HPHP_VERSION' ) && !ini_get( 'register_argc_argv' ) ) {
559 $this->error( 'Cannot get command line arguments, register_argc_argv is set to false', true );
562 // Send PHP warnings and errors to stderr instead of stdout.
563 // This aids in diagnosing problems, while keeping messages
564 // out of redirected output.
565 if ( ini_get( 'display_errors' ) ) {
566 ini_set( 'display_errors', 'stderr' );
569 $this->loadParamsAndArgs();
570 $this->maybeHelp();
572 # Set the memory limit
573 # Note we need to set it again later in cache LocalSettings changed it
574 $this->adjustMemoryLimit();
576 # Set max execution time to 0 (no limit). PHP.net says that
577 # "When running PHP from the command line the default setting is 0."
578 # But sometimes this doesn't seem to be the case.
579 ini_set( 'max_execution_time', 0 );
581 $wgRequestTime = microtime( true );
583 # Define us as being in MediaWiki
584 define( 'MEDIAWIKI', true );
586 $wgCommandLineMode = true;
588 # Turn off output buffering if it's on
589 while ( ob_get_level() > 0 ) {
590 ob_end_flush();
593 $this->validateParamsAndArgs();
597 * Normally we disable the memory_limit when running admin scripts.
598 * Some scripts may wish to actually set a limit, however, to avoid
599 * blowing up unexpectedly. We also support a --memory-limit option,
600 * to allow sysadmins to explicitly set one if they'd prefer to override
601 * defaults (or for people using Suhosin which yells at you for trying
602 * to disable the limits)
603 * @return string
605 public function memoryLimit() {
606 $limit = $this->getOption( 'memory-limit', 'max' );
607 $limit = trim( $limit, "\" '" ); // trim quotes in case someone misunderstood
608 return $limit;
612 * Adjusts PHP's memory limit to better suit our needs, if needed.
614 protected function adjustMemoryLimit() {
615 $limit = $this->memoryLimit();
616 if ( $limit == 'max' ) {
617 $limit = -1; // no memory limit
619 if ( $limit != 'default' ) {
620 ini_set( 'memory_limit', $limit );
625 * Activate the profiler (assuming $wgProfiler is set)
627 protected function activateProfiler() {
628 global $wgProfiler, $wgProfileLimit, $wgTrxProfilerLimits;
630 $output = $this->getOption( 'profiler' );
631 if ( !$output ) {
632 return;
635 if ( is_array( $wgProfiler ) && isset( $wgProfiler['class'] ) ) {
636 $class = $wgProfiler['class'];
637 $profiler = new $class(
638 [ 'sampling' => 1, 'output' => [ $output ] ]
639 + $wgProfiler
640 + [ 'threshold' => $wgProfileLimit ]
642 $profiler->setTemplated( true );
643 Profiler::replaceStubInstance( $profiler );
646 $trxProfiler = Profiler::instance()->getTransactionProfiler();
647 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
648 $trxProfiler->setExpectations( $wgTrxProfilerLimits['Maintenance'], __METHOD__ );
652 * Clear all params and arguments.
654 public function clearParamsAndArgs() {
655 $this->mOptions = [];
656 $this->mArgs = [];
657 $this->mInputLoaded = false;
661 * Load params and arguments from a given array
662 * of command-line arguments
664 * @since 1.27
665 * @param array $argv
667 public function loadWithArgv( $argv ) {
668 $options = [];
669 $args = [];
670 $this->orderedOptions = [];
672 # Parse arguments
673 for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
674 if ( $arg == '--' ) {
675 # End of options, remainder should be considered arguments
676 $arg = next( $argv );
677 while ( $arg !== false ) {
678 $args[] = $arg;
679 $arg = next( $argv );
681 break;
682 } elseif ( substr( $arg, 0, 2 ) == '--' ) {
683 # Long options
684 $option = substr( $arg, 2 );
685 if ( isset( $this->mParams[$option] ) && $this->mParams[$option]['withArg'] ) {
686 $param = next( $argv );
687 if ( $param === false ) {
688 $this->error( "\nERROR: $option parameter needs a value after it\n" );
689 $this->maybeHelp( true );
692 $this->setParam( $options, $option, $param );
693 } else {
694 $bits = explode( '=', $option, 2 );
695 if ( count( $bits ) > 1 ) {
696 $option = $bits[0];
697 $param = $bits[1];
698 } else {
699 $param = 1;
702 $this->setParam( $options, $option, $param );
704 } elseif ( $arg == '-' ) {
705 # Lonely "-", often used to indicate stdin or stdout.
706 $args[] = $arg;
707 } elseif ( substr( $arg, 0, 1 ) == '-' ) {
708 # Short options
709 $argLength = strlen( $arg );
710 for ( $p = 1; $p < $argLength; $p++ ) {
711 $option = $arg[$p];
712 if ( !isset( $this->mParams[$option] ) && isset( $this->mShortParamsMap[$option] ) ) {
713 $option = $this->mShortParamsMap[$option];
716 if ( isset( $this->mParams[$option]['withArg'] ) && $this->mParams[$option]['withArg'] ) {
717 $param = next( $argv );
718 if ( $param === false ) {
719 $this->error( "\nERROR: $option parameter needs a value after it\n" );
720 $this->maybeHelp( true );
722 $this->setParam( $options, $option, $param );
723 } else {
724 $this->setParam( $options, $option, 1 );
727 } else {
728 $args[] = $arg;
732 $this->mOptions = $options;
733 $this->mArgs = $args;
734 $this->loadSpecialVars();
735 $this->mInputLoaded = true;
739 * Helper function used solely by loadParamsAndArgs
740 * to prevent code duplication
742 * This sets the param in the options array based on
743 * whether or not it can be specified multiple times.
745 * @since 1.27
746 * @param array $options
747 * @param string $option
748 * @param mixed $value
750 private function setParam( &$options, $option, $value ) {
751 $this->orderedOptions[] = [ $option, $value ];
753 if ( isset( $this->mParams[$option] ) ) {
754 $multi = $this->mParams[$option]['multiOccurrence'];
755 } else {
756 $multi = false;
758 $exists = array_key_exists( $option, $options );
759 if ( $multi && $exists ) {
760 $options[$option][] = $value;
761 } elseif ( $multi ) {
762 $options[$option] = [ $value ];
763 } elseif ( !$exists ) {
764 $options[$option] = $value;
765 } else {
766 $this->error( "\nERROR: $option parameter given twice\n" );
767 $this->maybeHelp( true );
772 * Process command line arguments
773 * $mOptions becomes an array with keys set to the option names
774 * $mArgs becomes a zero-based array containing the non-option arguments
776 * @param string $self The name of the script, if any
777 * @param array $opts An array of options, in form of key=>value
778 * @param array $args An array of command line arguments
780 public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
781 # If we were given opts or args, set those and return early
782 if ( $self ) {
783 $this->mSelf = $self;
784 $this->mInputLoaded = true;
786 if ( $opts ) {
787 $this->mOptions = $opts;
788 $this->mInputLoaded = true;
790 if ( $args ) {
791 $this->mArgs = $args;
792 $this->mInputLoaded = true;
795 # If we've already loaded input (either by user values or from $argv)
796 # skip on loading it again. The array_shift() will corrupt values if
797 # it's run again and again
798 if ( $this->mInputLoaded ) {
799 $this->loadSpecialVars();
801 return;
804 global $argv;
805 $this->mSelf = $argv[0];
806 $this->loadWithArgv( array_slice( $argv, 1 ) );
810 * Run some validation checks on the params, etc
812 protected function validateParamsAndArgs() {
813 $die = false;
814 # Check to make sure we've got all the required options
815 foreach ( $this->mParams as $opt => $info ) {
816 if ( $info['require'] && !$this->hasOption( $opt ) ) {
817 $this->error( "Param $opt required!" );
818 $die = true;
821 # Check arg list too
822 foreach ( $this->mArgList as $k => $info ) {
823 if ( $info['require'] && !$this->hasArg( $k ) ) {
824 $this->error( 'Argument <' . $info['name'] . '> required!' );
825 $die = true;
829 if ( $die ) {
830 $this->maybeHelp( true );
835 * Handle the special variables that are global to all scripts
837 protected function loadSpecialVars() {
838 if ( $this->hasOption( 'dbuser' ) ) {
839 $this->mDbUser = $this->getOption( 'dbuser' );
841 if ( $this->hasOption( 'dbpass' ) ) {
842 $this->mDbPass = $this->getOption( 'dbpass' );
844 if ( $this->hasOption( 'quiet' ) ) {
845 $this->mQuiet = true;
847 if ( $this->hasOption( 'batch-size' ) ) {
848 $this->mBatchSize = intval( $this->getOption( 'batch-size' ) );
853 * Maybe show the help.
854 * @param bool $force Whether to force the help to show, default false
856 protected function maybeHelp( $force = false ) {
857 if ( !$force && !$this->hasOption( 'help' ) ) {
858 return;
861 $screenWidth = 80; // TODO: Calculate this!
862 $tab = " ";
863 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
865 ksort( $this->mParams );
866 $this->mQuiet = false;
868 // Description ...
869 if ( $this->mDescription ) {
870 $this->output( "\n" . $this->mDescription . "\n" );
872 $output = "\nUsage: php " . basename( $this->mSelf );
874 // ... append parameters ...
875 if ( $this->mParams ) {
876 $output .= " [--" . implode( array_keys( $this->mParams ), "|--" ) . "]";
879 // ... and append arguments.
880 if ( $this->mArgList ) {
881 $output .= ' ';
882 foreach ( $this->mArgList as $k => $arg ) {
883 if ( $arg['require'] ) {
884 $output .= '<' . $arg['name'] . '>';
885 } else {
886 $output .= '[' . $arg['name'] . ']';
888 if ( $k < count( $this->mArgList ) - 1 ) {
889 $output .= ' ';
893 $this->output( "$output\n\n" );
895 # TODO abstract some repetitive code below
897 // Generic parameters
898 $this->output( "Generic maintenance parameters:\n" );
899 foreach ( $this->mGenericParameters as $par => $info ) {
900 if ( $info['shortName'] !== false ) {
901 $par .= " (-{$info['shortName']})";
903 $this->output(
904 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
905 "\n$tab$tab" ) . "\n"
908 $this->output( "\n" );
910 $scriptDependantParams = $this->mDependantParameters;
911 if ( count( $scriptDependantParams ) > 0 ) {
912 $this->output( "Script dependant parameters:\n" );
913 // Parameters description
914 foreach ( $scriptDependantParams as $par => $info ) {
915 if ( $info['shortName'] !== false ) {
916 $par .= " (-{$info['shortName']})";
918 $this->output(
919 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
920 "\n$tab$tab" ) . "\n"
923 $this->output( "\n" );
926 // Script specific parameters not defined on construction by
927 // Maintenance::addDefaultParams()
928 $scriptSpecificParams = array_diff_key(
929 # all script parameters:
930 $this->mParams,
931 # remove the Maintenance default parameters:
932 $this->mGenericParameters,
933 $this->mDependantParameters
935 if ( count( $scriptSpecificParams ) > 0 ) {
936 $this->output( "Script specific parameters:\n" );
937 // Parameters description
938 foreach ( $scriptSpecificParams as $par => $info ) {
939 if ( $info['shortName'] !== false ) {
940 $par .= " (-{$info['shortName']})";
942 $this->output(
943 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
944 "\n$tab$tab" ) . "\n"
947 $this->output( "\n" );
950 // Print arguments
951 if ( count( $this->mArgList ) > 0 ) {
952 $this->output( "Arguments:\n" );
953 // Arguments description
954 foreach ( $this->mArgList as $info ) {
955 $openChar = $info['require'] ? '<' : '[';
956 $closeChar = $info['require'] ? '>' : ']';
957 $this->output(
958 wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
959 $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
962 $this->output( "\n" );
965 die( 1 );
969 * Handle some last-minute setup here.
971 public function finalSetup() {
972 global $wgCommandLineMode, $wgShowSQLErrors, $wgServer;
973 global $wgDBadminuser, $wgDBadminpassword;
974 global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
976 # Turn off output buffering again, it might have been turned on in the settings files
977 if ( ob_get_level() ) {
978 ob_end_flush();
980 # Same with these
981 $wgCommandLineMode = true;
983 # Override $wgServer
984 if ( $this->hasOption( 'server' ) ) {
985 $wgServer = $this->getOption( 'server', $wgServer );
988 # If these were passed, use them
989 if ( $this->mDbUser ) {
990 $wgDBadminuser = $this->mDbUser;
992 if ( $this->mDbPass ) {
993 $wgDBadminpassword = $this->mDbPass;
996 if ( $this->getDbType() == self::DB_ADMIN && isset( $wgDBadminuser ) ) {
997 $wgDBuser = $wgDBadminuser;
998 $wgDBpassword = $wgDBadminpassword;
1000 if ( $wgDBservers ) {
1002 * @var $wgDBservers array
1004 foreach ( $wgDBservers as $i => $server ) {
1005 $wgDBservers[$i]['user'] = $wgDBuser;
1006 $wgDBservers[$i]['password'] = $wgDBpassword;
1009 if ( isset( $wgLBFactoryConf['serverTemplate'] ) ) {
1010 $wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
1011 $wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
1013 LBFactory::destroyInstance();
1016 // Per-script profiling; useful for debugging
1017 $this->activateProfiler();
1019 $this->afterFinalSetup();
1021 $wgShowSQLErrors = true;
1023 MediaWiki\suppressWarnings();
1024 set_time_limit( 0 );
1025 MediaWiki\restoreWarnings();
1027 $this->adjustMemoryLimit();
1031 * Execute a callback function at the end of initialisation
1033 protected function afterFinalSetup() {
1034 if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
1035 call_user_func( MW_CMDLINE_CALLBACK );
1040 * Potentially debug globals. Originally a feature only
1041 * for refreshLinks
1043 public function globals() {
1044 if ( $this->hasOption( 'globals' ) ) {
1045 print_r( $GLOBALS );
1050 * Generic setup for most installs. Returns the location of LocalSettings
1051 * @return string
1053 public function loadSettings() {
1054 global $wgCommandLineMode, $IP;
1056 if ( isset( $this->mOptions['conf'] ) ) {
1057 $settingsFile = $this->mOptions['conf'];
1058 } elseif ( defined( "MW_CONFIG_FILE" ) ) {
1059 $settingsFile = MW_CONFIG_FILE;
1060 } else {
1061 $settingsFile = "$IP/LocalSettings.php";
1063 if ( isset( $this->mOptions['wiki'] ) ) {
1064 $bits = explode( '-', $this->mOptions['wiki'] );
1065 if ( count( $bits ) == 1 ) {
1066 $bits[] = '';
1068 define( 'MW_DB', $bits[0] );
1069 define( 'MW_PREFIX', $bits[1] );
1072 if ( !is_readable( $settingsFile ) ) {
1073 $this->error( "A copy of your installation's LocalSettings.php\n" .
1074 "must exist and be readable in the source directory.\n" .
1075 "Use --conf to specify it.", true );
1077 $wgCommandLineMode = true;
1079 return $settingsFile;
1083 * Support function for cleaning up redundant text records
1084 * @param bool $delete Whether or not to actually delete the records
1085 * @author Rob Church <robchur@gmail.com>
1087 public function purgeRedundantText( $delete = true ) {
1088 # Data should come off the master, wrapped in a transaction
1089 $dbw = $this->getDB( DB_MASTER );
1090 $this->beginTransaction( $dbw, __METHOD__ );
1092 # Get "active" text records from the revisions table
1093 $this->output( 'Searching for active text records in revisions table...' );
1094 $res = $dbw->select( 'revision', 'rev_text_id', [], __METHOD__, [ 'DISTINCT' ] );
1095 foreach ( $res as $row ) {
1096 $cur[] = $row->rev_text_id;
1098 $this->output( "done.\n" );
1100 # Get "active" text records from the archive table
1101 $this->output( 'Searching for active text records in archive table...' );
1102 $res = $dbw->select( 'archive', 'ar_text_id', [], __METHOD__, [ 'DISTINCT' ] );
1103 foreach ( $res as $row ) {
1104 # old pre-MW 1.5 records can have null ar_text_id's.
1105 if ( $row->ar_text_id !== null ) {
1106 $cur[] = $row->ar_text_id;
1109 $this->output( "done.\n" );
1111 # Get the IDs of all text records not in these sets
1112 $this->output( 'Searching for inactive text records...' );
1113 $cond = 'old_id NOT IN ( ' . $dbw->makeList( $cur ) . ' )';
1114 $res = $dbw->select( 'text', 'old_id', [ $cond ], __METHOD__, [ 'DISTINCT' ] );
1115 $old = [];
1116 foreach ( $res as $row ) {
1117 $old[] = $row->old_id;
1119 $this->output( "done.\n" );
1121 # Inform the user of what we're going to do
1122 $count = count( $old );
1123 $this->output( "$count inactive items found.\n" );
1125 # Delete as appropriate
1126 if ( $delete && $count ) {
1127 $this->output( 'Deleting...' );
1128 $dbw->delete( 'text', [ 'old_id' => $old ], __METHOD__ );
1129 $this->output( "done.\n" );
1132 # Done
1133 $this->commitTransaction( $dbw, __METHOD__ );
1137 * Get the maintenance directory.
1138 * @return string
1140 protected function getDir() {
1141 return __DIR__;
1145 * Returns a database to be used by current maintenance script. It can be set by setDB().
1146 * If not set, wfGetDB() will be used.
1147 * This function has the same parameters as wfGetDB()
1149 * @param integer $db DB index (DB_SLAVE/DB_MASTER)
1150 * @param array $groups; default: empty array
1151 * @param string|bool $wiki; default: current wiki
1152 * @return IDatabase
1154 protected function getDB( $db, $groups = [], $wiki = false ) {
1155 if ( is_null( $this->mDb ) ) {
1156 return wfGetDB( $db, $groups, $wiki );
1157 } else {
1158 return $this->mDb;
1163 * Sets database object to be returned by getDB().
1165 * @param IDatabase $db Database object to be used
1167 public function setDB( IDatabase $db ) {
1168 $this->mDb = $db;
1172 * Begin a transcation on a DB
1174 * This method makes it clear that begin() is called from a maintenance script,
1175 * which has outermost scope. This is safe, unlike $dbw->begin() called in other places.
1177 * @param IDatabase $dbw
1178 * @param string $fname Caller name
1179 * @since 1.27
1181 protected function beginTransaction( IDatabase $dbw, $fname ) {
1182 $dbw->begin( $fname );
1186 * Commit the transcation on a DB handle and wait for slaves to catch up
1188 * This method makes it clear that commit() is called from a maintenance script,
1189 * which has outermost scope. This is safe, unlike $dbw->commit() called in other places.
1191 * @param IDatabase $dbw
1192 * @param string $fname Caller name
1193 * @return bool Whether the slave wait succeeded
1194 * @since 1.27
1196 protected function commitTransaction( IDatabase $dbw, $fname ) {
1197 $dbw->commit( $fname );
1199 $ok = wfWaitForSlaves( $this->lastSlaveWait, false, '*', 30 );
1200 $this->lastSlaveWait = microtime( true );
1202 return $ok;
1206 * Rollback the transcation on a DB handle
1208 * This method makes it clear that rollback() is called from a maintenance script,
1209 * which has outermost scope. This is safe, unlike $dbw->rollback() called in other places.
1211 * @param IDatabase $dbw
1212 * @param string $fname Caller name
1213 * @since 1.27
1215 protected function rollbackTransaction( IDatabase $dbw, $fname ) {
1216 $dbw->rollback( $fname );
1220 * Lock the search index
1221 * @param DatabaseBase &$db
1223 private function lockSearchindex( $db ) {
1224 $write = [ 'searchindex' ];
1225 $read = [
1226 'page',
1227 'revision',
1228 'text',
1229 'interwiki',
1230 'l10n_cache',
1231 'user',
1232 'page_restrictions'
1234 $db->lockTables( $read, $write, __CLASS__ . '::' . __METHOD__ );
1238 * Unlock the tables
1239 * @param DatabaseBase &$db
1241 private function unlockSearchindex( $db ) {
1242 $db->unlockTables( __CLASS__ . '::' . __METHOD__ );
1246 * Unlock and lock again
1247 * Since the lock is low-priority, queued reads will be able to complete
1248 * @param DatabaseBase &$db
1250 private function relockSearchindex( $db ) {
1251 $this->unlockSearchindex( $db );
1252 $this->lockSearchindex( $db );
1256 * Perform a search index update with locking
1257 * @param int $maxLockTime The maximum time to keep the search index locked.
1258 * @param string $callback The function that will update the function.
1259 * @param DatabaseBase $dbw
1260 * @param array $results
1262 public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
1263 $lockTime = time();
1265 # Lock searchindex
1266 if ( $maxLockTime ) {
1267 $this->output( " --- Waiting for lock ---" );
1268 $this->lockSearchindex( $dbw );
1269 $lockTime = time();
1270 $this->output( "\n" );
1273 # Loop through the results and do a search update
1274 foreach ( $results as $row ) {
1275 # Allow reads to be processed
1276 if ( $maxLockTime && time() > $lockTime + $maxLockTime ) {
1277 $this->output( " --- Relocking ---" );
1278 $this->relockSearchindex( $dbw );
1279 $lockTime = time();
1280 $this->output( "\n" );
1282 call_user_func( $callback, $dbw, $row );
1285 # Unlock searchindex
1286 if ( $maxLockTime ) {
1287 $this->output( " --- Unlocking --" );
1288 $this->unlockSearchindex( $dbw );
1289 $this->output( "\n" );
1294 * Update the searchindex table for a given pageid
1295 * @param DatabaseBase $dbw A database write handle
1296 * @param int $pageId The page ID to update.
1297 * @return null|string
1299 public function updateSearchIndexForPage( $dbw, $pageId ) {
1300 // Get current revision
1301 $rev = Revision::loadFromPageId( $dbw, $pageId );
1302 $title = null;
1303 if ( $rev ) {
1304 $titleObj = $rev->getTitle();
1305 $title = $titleObj->getPrefixedDBkey();
1306 $this->output( "$title..." );
1307 # Update searchindex
1308 $u = new SearchUpdate( $pageId, $titleObj->getText(), $rev->getContent() );
1309 $u->doUpdate();
1310 $this->output( "\n" );
1313 return $title;
1317 * Wrapper for posix_isatty()
1318 * We default as considering stdin a tty (for nice readline methods)
1319 * but treating stout as not a tty to avoid color codes
1321 * @param mixed $fd File descriptor
1322 * @return bool
1324 public static function posix_isatty( $fd ) {
1325 if ( !function_exists( 'posix_isatty' ) ) {
1326 return !$fd;
1327 } else {
1328 return posix_isatty( $fd );
1333 * Prompt the console for input
1334 * @param string $prompt What to begin the line with, like '> '
1335 * @return string Response
1337 public static function readconsole( $prompt = '> ' ) {
1338 static $isatty = null;
1339 if ( is_null( $isatty ) ) {
1340 $isatty = self::posix_isatty( 0 /*STDIN*/ );
1343 if ( $isatty && function_exists( 'readline' ) ) {
1344 $resp = readline( $prompt );
1345 if ( $resp === null ) {
1346 // Workaround for https://github.com/facebook/hhvm/issues/4776
1347 return false;
1348 } else {
1349 return $resp;
1351 } else {
1352 if ( $isatty ) {
1353 $st = self::readlineEmulation( $prompt );
1354 } else {
1355 if ( feof( STDIN ) ) {
1356 $st = false;
1357 } else {
1358 $st = fgets( STDIN, 1024 );
1361 if ( $st === false ) {
1362 return false;
1364 $resp = trim( $st );
1366 return $resp;
1371 * Emulate readline()
1372 * @param string $prompt What to begin the line with, like '> '
1373 * @return string
1375 private static function readlineEmulation( $prompt ) {
1376 $bash = Installer::locateExecutableInDefaultPaths( [ 'bash' ] );
1377 if ( !wfIsWindows() && $bash ) {
1378 $retval = false;
1379 $encPrompt = wfEscapeShellArg( $prompt );
1380 $command = "read -er -p $encPrompt && echo \"\$REPLY\"";
1381 $encCommand = wfEscapeShellArg( $command );
1382 $line = wfShellExec( "$bash -c $encCommand", $retval, [], [ 'walltime' => 0 ] );
1384 if ( $retval == 0 ) {
1385 return $line;
1386 } elseif ( $retval == 127 ) {
1387 // Couldn't execute bash even though we thought we saw it.
1388 // Shell probably spit out an error message, sorry :(
1389 // Fall through to fgets()...
1390 } else {
1391 // EOF/ctrl+D
1392 return false;
1396 // Fallback... we'll have no editing controls, EWWW
1397 if ( feof( STDIN ) ) {
1398 return false;
1400 print $prompt;
1402 return fgets( STDIN, 1024 );
1407 * Fake maintenance wrapper, mostly used for the web installer/updater
1409 class FakeMaintenance extends Maintenance {
1410 protected $mSelf = "FakeMaintenanceScript";
1412 public function execute() {
1413 return;
1418 * Class for scripts that perform database maintenance and want to log the
1419 * update in `updatelog` so we can later skip it
1421 abstract class LoggedUpdateMaintenance extends Maintenance {
1422 public function __construct() {
1423 parent::__construct();
1424 $this->addOption( 'force', 'Run the update even if it was completed already' );
1425 $this->setBatchSize( 200 );
1428 public function execute() {
1429 $db = $this->getDB( DB_MASTER );
1430 $key = $this->getUpdateKey();
1432 if ( !$this->hasOption( 'force' )
1433 && $db->selectRow( 'updatelog', '1', [ 'ul_key' => $key ], __METHOD__ )
1435 $this->output( "..." . $this->updateSkippedMessage() . "\n" );
1437 return true;
1440 if ( !$this->doDBUpdates() ) {
1441 return false;
1444 if ( $db->insert( 'updatelog', [ 'ul_key' => $key ], __METHOD__, 'IGNORE' ) ) {
1445 return true;
1446 } else {
1447 $this->output( $this->updatelogFailedMessage() . "\n" );
1449 return false;
1454 * Message to show that the update was done already and was just skipped
1455 * @return string
1457 protected function updateSkippedMessage() {
1458 $key = $this->getUpdateKey();
1460 return "Update '{$key}' already logged as completed.";
1464 * Message to show that the update log was unable to log the completion of this update
1465 * @return string
1467 protected function updatelogFailedMessage() {
1468 $key = $this->getUpdateKey();
1470 return "Unable to log update '{$key}' as completed.";
1474 * Do the actual work. All child classes will need to implement this.
1475 * Return true to log the update as done or false (usually on failure).
1476 * @return bool
1478 abstract protected function doDBUpdates();
1481 * Get the update key name to go in the update log table
1482 * @return string
1484 abstract protected function getUpdateKey();