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
19 * @ingroup Maintenance
20 * @defgroup Maintenance Maintenance
23 // Bail on old versions of PHP, or if composer has not been run yet to install
25 require_once __DIR__
. '/../includes/PHPVersionCheck.php';
26 wfEntryPointCheck( 'cli' );
28 use MediaWiki\Shell\Shell
;
29 use Wikimedia\Rdbms\DBReplicationWaitError
;
32 * @defgroup MaintenanceArchive Maintenance archives
33 * @ingroup Maintenance
36 // Define this so scripts can easily find doMaintenance.php
37 define( 'RUN_MAINTENANCE_IF_MAIN', __DIR__
. '/doMaintenance.php' );
40 * @deprecated since 1.31
42 define( 'DO_MAINTENANCE', RUN_MAINTENANCE_IF_MAIN
); // original name, harmless
46 use Wikimedia\Rdbms\IDatabase
;
47 use MediaWiki\Logger\LoggerFactory
;
48 use MediaWiki\MediaWikiServices
;
49 use Wikimedia\Rdbms\LBFactory
;
50 use Wikimedia\Rdbms\IMaintainableDatabase
;
53 * Abstract maintenance class for quickly writing and churning out
54 * maintenance scripts with minimal effort. All that _must_ be defined
55 * is the execute() method. See docs/maintenance.txt for more info
56 * and a quick demo of how to use it.
59 * @ingroup Maintenance
61 abstract class Maintenance
{
63 * Constants for DB access type
64 * @see Maintenance::getDbType()
70 // Const for getStdin()
71 const STDIN_ALL
= 'all';
73 // This is the desired params
74 protected $mParams = [];
76 // Array of mapping short parameters to long ones
77 protected $mShortParamsMap = [];
79 // Array of desired args
80 protected $mArgList = [];
82 // This is the list of options that were actually passed
83 protected $mOptions = [];
85 // This is the list of arguments that were actually passed
86 protected $mArgs = [];
88 // Name of the script currently running
91 // Special vars for params that are always used
92 protected $mQuiet = false;
93 protected $mDbUser, $mDbPass;
95 // A description of the script, children should change this via addDescription()
96 protected $mDescription = '';
98 // Have we already loaded our user input?
99 protected $mInputLoaded = false;
102 * Batch size. If a script supports this, they should set
103 * a default with setBatchSize()
107 protected $mBatchSize = null;
109 // Generic options added by addDefaultParams()
110 private $mGenericParameters = [];
111 // Generic options which might or not be supported by the script
112 private $mDependantParameters = [];
115 * Used by getDB() / setDB()
116 * @var IMaintainableDatabase
120 /** @var float UNIX timestamp */
121 private $lastReplicationWait = 0.0;
124 * Used when creating separate schema files.
130 * Accessible via getConfig()
137 * @see Maintenance::requireExtension
140 private $requiredExtensions = [];
143 * Used to read the options in the order they were passed.
144 * Useful for option chaining (Ex. dumpBackup.php). It will
145 * be an empty array if the options are passed in through
146 * loadParamsAndArgs( $self, $opts, $args ).
148 * This is an array of arrays where
149 * 0 => the option and 1 => parameter value.
153 public $orderedOptions = [];
156 * Default constructor. Children should call this *first* if implementing
157 * their own constructors
159 public function __construct() {
160 // Setup $IP, using MW_INSTALL_PATH if it exists
162 $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
163 ?
getenv( 'MW_INSTALL_PATH' )
164 : realpath( __DIR__
. '/..' );
166 $this->addDefaultParams();
167 register_shutdown_function( [ $this, 'outputChanneled' ], false );
171 * Should we execute the maintenance script, or just allow it to be included
172 * as a standalone class? It checks that the call stack only includes this
173 * function and "requires" (meaning was called from the file scope)
177 public static function shouldExecute() {
178 global $wgCommandLineMode;
180 if ( !function_exists( 'debug_backtrace' ) ) {
181 // If someone has a better idea...
182 return $wgCommandLineMode;
185 $bt = debug_backtrace();
186 $count = count( $bt );
188 return false; // sanity
190 if ( $bt[0]['class'] !== self
::class ||
$bt[0]['function'] !== 'shouldExecute' ) {
191 return false; // last call should be to this function
193 $includeFuncs = [ 'require_once', 'require', 'include', 'include_once' ];
194 for ( $i = 1; $i < $count; $i++
) {
195 if ( !in_array( $bt[$i]['function'], $includeFuncs ) ) {
196 return false; // previous calls should all be "requires"
204 * Do the actual work. All child classes will need to implement this
206 abstract public function execute();
209 * Add a parameter to the script. Will be displayed on --help
210 * with the associated description
212 * @param string $name The name of the param (help, version, etc)
213 * @param string $description The description of the param to show on --help
214 * @param bool $required Is the param required?
215 * @param bool $withArg Is an argument required with this option?
216 * @param string|bool $shortName Character to use as short name
217 * @param bool $multiOccurrence Can this option be passed multiple times?
219 protected function addOption( $name, $description, $required = false,
220 $withArg = false, $shortName = false, $multiOccurrence = false
222 $this->mParams
[$name] = [
223 'desc' => $description,
224 'require' => $required,
225 'withArg' => $withArg,
226 'shortName' => $shortName,
227 'multiOccurrence' => $multiOccurrence
230 if ( $shortName !== false ) {
231 $this->mShortParamsMap
[$shortName] = $name;
236 * Checks to see if a particular param exists.
237 * @param string $name The name of the param
240 protected function hasOption( $name ) {
241 return isset( $this->mOptions
[$name] );
245 * Get an option, or return the default.
247 * If the option was added to support multiple occurrences,
248 * this will return an array.
250 * @param string $name The name of the param
251 * @param mixed $default Anything you want, default null
254 protected function getOption( $name, $default = null ) {
255 if ( $this->hasOption( $name ) ) {
256 return $this->mOptions
[$name];
258 // Set it so we don't have to provide the default again
259 $this->mOptions
[$name] = $default;
261 return $this->mOptions
[$name];
266 * Add some args that are needed
267 * @param string $arg Name of the arg, like 'start'
268 * @param string $description Short description of the arg
269 * @param bool $required Is this required?
271 protected function addArg( $arg, $description, $required = true ) {
272 $this->mArgList
[] = [
274 'desc' => $description,
275 'require' => $required
280 * Remove an option. Useful for removing options that won't be used in your script.
281 * @param string $name The option to remove.
283 protected function deleteOption( $name ) {
284 unset( $this->mParams
[$name] );
288 * Set the description text.
289 * @param string $text The text of the description
291 protected function addDescription( $text ) {
292 $this->mDescription
= $text;
296 * Does a given argument exist?
297 * @param int $argId The integer value (from zero) for the arg
300 protected function hasArg( $argId = 0 ) {
301 return isset( $this->mArgs
[$argId] );
306 * @param int $argId The integer value (from zero) for the arg
307 * @param mixed $default The default if it doesn't exist
310 protected function getArg( $argId = 0, $default = null ) {
311 return $this->hasArg( $argId ) ?
$this->mArgs
[$argId] : $default;
321 protected function getBatchSize() {
322 return $this->mBatchSize
;
326 * Set the batch size.
327 * @param int $s The number of operations to do in a batch
329 protected function setBatchSize( $s = 0 ) {
330 $this->mBatchSize
= $s;
332 // If we support $mBatchSize, show the option.
333 // Used to be in addDefaultParams, but in order for that to
334 // work, subclasses would have to call this function in the constructor
335 // before they called parent::__construct which is just weird
336 // (and really wasn't done).
337 if ( $this->mBatchSize
) {
338 $this->addOption( 'batch-size', 'Run this many operations ' .
339 'per batch, default: ' . $this->mBatchSize
, false, true );
340 if ( isset( $this->mParams
['batch-size'] ) ) {
341 // This seems a little ugly...
342 $this->mDependantParameters
['batch-size'] = $this->mParams
['batch-size'];
348 * Get the script's name
351 public function getName() {
356 * Return input from stdin.
357 * @param int $len The number of bytes to read. If null, just return the handle.
358 * Maintenance::STDIN_ALL returns the full length
361 protected function getStdin( $len = null ) {
362 if ( $len == self
::STDIN_ALL
) {
363 return file_get_contents( 'php://stdin' );
365 $f = fopen( 'php://stdin', 'rt' );
369 $input = fgets( $f, $len );
372 return rtrim( $input );
378 public function isQuiet() {
379 return $this->mQuiet
;
383 * Throw some output to the user. Scripts can call this with no fears,
384 * as we handle all --quiet stuff here
385 * @param string $out The text to show to the user
386 * @param mixed $channel Unique identifier for the channel. See function outputChanneled.
388 protected function output( $out, $channel = null ) {
389 // This is sometimes called very early, before Setup.php is included.
390 if ( class_exists( MediaWikiServices
::class ) ) {
391 // Try to periodically flush buffered metrics to avoid OOMs
392 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
393 if ( $stats->getDataCount() > 1000 ) {
394 MediaWiki
::emitBufferedStatsdData( $stats, $this->getConfig() );
398 if ( $this->mQuiet
) {
401 if ( $channel === null ) {
402 $this->cleanupChanneled();
405 $out = preg_replace( '/\n\z/', '', $out );
406 $this->outputChanneled( $out, $channel );
411 * Throw an error to the user. Doesn't respect --quiet, so don't use
412 * this for non-error output
413 * @param string $err The error to display
414 * @param int $die Deprecated since 1.31, use Maintenance::fatalError() instead
416 protected function error( $err, $die = 0 ) {
417 if ( intval( $die ) !== 0 ) {
418 wfDeprecated( __METHOD__
. '( $err, $die )', '1.31' );
419 $this->fatalError( $err, intval( $die ) );
421 $this->outputChanneled( false );
423 ( PHP_SAPI
== 'cli' || PHP_SAPI
== 'phpdbg' ) &&
424 !defined( 'MW_PHPUNIT_TEST' )
426 fwrite( STDERR
, $err . "\n" );
433 * Output a message and terminate the current script.
435 * @param string $msg Error message
436 * @param int $exitCode PHP exit status. Should be in range 1-254.
439 protected function fatalError( $msg, $exitCode = 1 ) {
440 $this->error( $msg );
444 private $atLineStart = true;
445 private $lastChannel = null;
448 * Clean up channeled output. Output a newline if necessary.
450 public function cleanupChanneled() {
451 if ( !$this->atLineStart
) {
453 $this->atLineStart
= true;
458 * Message outputter with channeled message support. Messages on the
459 * same channel are concatenated, but any intervening messages in another
460 * channel start a new line.
461 * @param string $msg The message without trailing newline
462 * @param string $channel Channel identifier or null for no
463 * channel. Channel comparison uses ===.
465 public function outputChanneled( $msg, $channel = null ) {
466 if ( $msg === false ) {
467 $this->cleanupChanneled();
472 // End the current line if necessary
473 if ( !$this->atLineStart
&& $channel !== $this->lastChannel
) {
479 $this->atLineStart
= false;
480 if ( $channel === null ) {
481 // For unchanneled messages, output trailing newline immediately
483 $this->atLineStart
= true;
485 $this->lastChannel
= $channel;
489 * Does the script need different DB access? By default, we give Maintenance
490 * scripts normal rights to the DB. Sometimes, a script needs admin rights
491 * access for a reason and sometimes they want no access. Subclasses should
492 * override and return one of the following values, as needed:
493 * Maintenance::DB_NONE - For no DB access at all
494 * Maintenance::DB_STD - For normal DB access, default
495 * Maintenance::DB_ADMIN - For admin DB access
498 public function getDbType() {
503 * Add the default parameters to the scripts
505 protected function addDefaultParams() {
506 # Generic (non script dependant) options:
508 $this->addOption( 'help', 'Display this help message', false, false, 'h' );
509 $this->addOption( 'quiet', 'Whether to supress non-error output', false, false, 'q' );
510 $this->addOption( 'conf', 'Location of LocalSettings.php, if not default', false, true );
511 $this->addOption( 'wiki', 'For specifying the wiki ID', false, true );
512 $this->addOption( 'globals', 'Output globals at the end of processing for debugging' );
515 'Set a specific memory limit for the script, '
516 . '"max" for no limit or "default" to avoid changing it',
520 $this->addOption( 'server', "The protocol and server name to use in URLs, e.g. " .
521 "http://en.wikipedia.org. This is sometimes necessary because " .
522 "server name detection may fail in command line scripts.", false, true );
523 $this->addOption( 'profiler', 'Profiler output format (usually "text")', false, true );
524 // This is named --mwdebug, because --debug would conflict in the phpunit.php CLI script.
525 $this->addOption( 'mwdebug', 'Enable built-in MediaWiki development settings', false, true );
527 # Save generic options to display them separately in help
528 $this->mGenericParameters
= $this->mParams
;
530 # Script dependant options:
532 // If we support a DB, show the options
533 if ( $this->getDbType() > 0 ) {
534 $this->addOption( 'dbuser', 'The DB user to use for this script', false, true );
535 $this->addOption( 'dbpass', 'The password to use for this script', false, true );
538 # Save additional script dependant options to display
539 # Â them separately in help
540 $this->mDependantParameters
= array_diff_key( $this->mParams
, $this->mGenericParameters
);
547 public function getConfig() {
548 if ( $this->config
=== null ) {
549 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
552 return $this->config
;
557 * @param Config $config
559 public function setConfig( Config
$config ) {
560 $this->config
= $config;
564 * Indicate that the specified extension must be
565 * loaded before the script can run.
567 * This *must* be called in the constructor.
570 * @param string $name
572 protected function requireExtension( $name ) {
573 $this->requiredExtensions
[] = $name;
577 * Verify that the required extensions are installed
581 public function checkRequiredExtensions() {
582 $registry = ExtensionRegistry
::getInstance();
584 foreach ( $this->requiredExtensions
as $name ) {
585 if ( !$registry->isLoaded( $name ) ) {
591 $joined = implode( ', ', $missing );
592 $msg = "The following extensions are required to be installed "
593 . "for this script to run: $joined. Please enable them and then try again.";
594 $this->fatalError( $msg );
599 * Set triggers like when to try to run deferred updates
602 public function setAgentAndTriggers() {
603 if ( function_exists( 'posix_getpwuid' ) ) {
604 $agent = posix_getpwuid( posix_geteuid() )['name'];
608 $agent .= '@' . wfHostname();
610 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
611 // Add a comment for easy SHOW PROCESSLIST interpretation
612 $lbFactory->setAgentName(
613 mb_strlen( $agent ) > 15 ?
mb_substr( $agent, 0, 15 ) . '...' : $agent
615 self
::setLBFactoryTriggers( $lbFactory, $this->getConfig() );
619 * @param LBFactory $LBFactory
620 * @param Config $config
623 public static function setLBFactoryTriggers( LBFactory
$LBFactory, Config
$config ) {
624 $services = MediaWikiServices
::getInstance();
625 $stats = $services->getStatsdDataFactory();
626 // Hook into period lag checks which often happen in long-running scripts
627 $lbFactory = $services->getDBLoadBalancerFactory();
628 $lbFactory->setWaitForReplicationListener(
630 function () use ( $stats, $config ) {
631 // Check config in case of JobRunner and unit tests
632 if ( $config->get( 'CommandLineMode' ) ) {
633 DeferredUpdates
::tryOpportunisticExecute( 'run' );
635 // Try to periodically flush buffered metrics to avoid OOMs
636 MediaWiki
::emitBufferedStatsdData( $stats, $config );
639 // Check for other windows to run them. A script may read or do a few writes
640 // to the master but mostly be writing to something else, like a file store.
641 $lbFactory->getMainLB()->setTransactionListener(
643 function ( $trigger ) use ( $stats, $config ) {
644 // Check config in case of JobRunner and unit tests
645 if ( $config->get( 'CommandLineMode' ) && $trigger === IDatabase
::TRIGGER_COMMIT
) {
646 DeferredUpdates
::tryOpportunisticExecute( 'run' );
648 // Try to periodically flush buffered metrics to avoid OOMs
649 MediaWiki
::emitBufferedStatsdData( $stats, $config );
655 * Run a child maintenance script. Pass all of the current arguments
657 * @param string $maintClass A name of a child maintenance class
658 * @param string $classFile Full path of where the child is
659 * @return Maintenance
661 public function runChild( $maintClass, $classFile = null ) {
662 // Make sure the class is loaded first
663 if ( !class_exists( $maintClass ) ) {
665 require_once $classFile;
667 if ( !class_exists( $maintClass ) ) {
668 $this->error( "Cannot spawn child: $maintClass" );
673 * @var $child Maintenance
675 $child = new $maintClass();
676 $child->loadParamsAndArgs( $this->mSelf
, $this->mOptions
, $this->mArgs
);
677 if ( !is_null( $this->mDb
) ) {
678 $child->setDB( $this->mDb
);
685 * Do some sanity checking and basic setup
687 public function setup() {
688 global $IP, $wgCommandLineMode;
690 # Abort if called from a web server
691 # wfIsCLI() is not available yet
692 if ( PHP_SAPI
!== 'cli' && PHP_SAPI
!== 'phpdbg' ) {
693 $this->fatalError( 'This script must be run from the command line' );
696 if ( $IP === null ) {
697 $this->fatalError( "\$IP not set, aborting!\n" .
698 '(Did you forget to call parent::__construct() in your maintenance script?)' );
701 # Make sure we can handle script parameters
702 if ( !defined( 'HPHP_VERSION' ) && !ini_get( 'register_argc_argv' ) ) {
703 $this->fatalError( 'Cannot get command line arguments, register_argc_argv is set to false' );
706 // Send PHP warnings and errors to stderr instead of stdout.
707 // This aids in diagnosing problems, while keeping messages
708 // out of redirected output.
709 if ( ini_get( 'display_errors' ) ) {
710 ini_set( 'display_errors', 'stderr' );
713 $this->loadParamsAndArgs();
716 # Set the memory limit
717 # Note we need to set it again later in cache LocalSettings changed it
718 $this->adjustMemoryLimit();
720 # Set max execution time to 0 (no limit). PHP.net says that
721 # "When running PHP from the command line the default setting is 0."
722 # But sometimes this doesn't seem to be the case.
723 ini_set( 'max_execution_time', 0 );
725 # Define us as being in MediaWiki
726 define( 'MEDIAWIKI', true );
728 $wgCommandLineMode = true;
730 # Turn off output buffering if it's on
731 while ( ob_get_level() > 0 ) {
735 $this->validateParamsAndArgs();
739 * Normally we disable the memory_limit when running admin scripts.
740 * Some scripts may wish to actually set a limit, however, to avoid
741 * blowing up unexpectedly. We also support a --memory-limit option,
742 * to allow sysadmins to explicitly set one if they'd prefer to override
743 * defaults (or for people using Suhosin which yells at you for trying
744 * to disable the limits)
747 public function memoryLimit() {
748 $limit = $this->getOption( 'memory-limit', 'max' );
749 $limit = trim( $limit, "\" '" ); // trim quotes in case someone misunderstood
754 * Adjusts PHP's memory limit to better suit our needs, if needed.
756 protected function adjustMemoryLimit() {
757 $limit = $this->memoryLimit();
758 if ( $limit == 'max' ) {
759 $limit = -1; // no memory limit
761 if ( $limit != 'default' ) {
762 ini_set( 'memory_limit', $limit );
767 * Activate the profiler (assuming $wgProfiler is set)
769 protected function activateProfiler() {
770 global $wgProfiler, $wgProfileLimit, $wgTrxProfilerLimits;
772 $output = $this->getOption( 'profiler' );
777 if ( is_array( $wgProfiler ) && isset( $wgProfiler['class'] ) ) {
778 $class = $wgProfiler['class'];
779 /** @var Profiler $profiler */
780 $profiler = new $class(
781 [ 'sampling' => 1, 'output' => [ $output ] ]
783 +
[ 'threshold' => $wgProfileLimit ]
785 $profiler->setTemplated( true );
786 Profiler
::replaceStubInstance( $profiler );
789 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
790 $trxProfiler->setLogger( LoggerFactory
::getInstance( 'DBPerformance' ) );
791 $trxProfiler->setExpectations( $wgTrxProfilerLimits['Maintenance'], __METHOD__
);
795 * Clear all params and arguments.
797 public function clearParamsAndArgs() {
798 $this->mOptions
= [];
800 $this->mInputLoaded
= false;
804 * Load params and arguments from a given array
805 * of command-line arguments
810 public function loadWithArgv( $argv ) {
813 $this->orderedOptions
= [];
816 for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
817 if ( $arg == '--' ) {
818 # End of options, remainder should be considered arguments
819 $arg = next( $argv );
820 while ( $arg !== false ) {
822 $arg = next( $argv );
825 } elseif ( substr( $arg, 0, 2 ) == '--' ) {
827 $option = substr( $arg, 2 );
828 if ( isset( $this->mParams
[$option] ) && $this->mParams
[$option]['withArg'] ) {
829 $param = next( $argv );
830 if ( $param === false ) {
831 $this->error( "\nERROR: $option parameter needs a value after it\n" );
832 $this->maybeHelp( true );
835 $this->setParam( $options, $option, $param );
837 $bits = explode( '=', $option, 2 );
838 if ( count( $bits ) > 1 ) {
845 $this->setParam( $options, $option, $param );
847 } elseif ( $arg == '-' ) {
848 # Lonely "-", often used to indicate stdin or stdout.
850 } elseif ( substr( $arg, 0, 1 ) == '-' ) {
852 $argLength = strlen( $arg );
853 for ( $p = 1; $p < $argLength; $p++
) {
855 if ( !isset( $this->mParams
[$option] ) && isset( $this->mShortParamsMap
[$option] ) ) {
856 $option = $this->mShortParamsMap
[$option];
859 if ( isset( $this->mParams
[$option]['withArg'] ) && $this->mParams
[$option]['withArg'] ) {
860 $param = next( $argv );
861 if ( $param === false ) {
862 $this->error( "\nERROR: $option parameter needs a value after it\n" );
863 $this->maybeHelp( true );
865 $this->setParam( $options, $option, $param );
867 $this->setParam( $options, $option, 1 );
875 $this->mOptions
= $options;
876 $this->mArgs
= $args;
877 $this->loadSpecialVars();
878 $this->mInputLoaded
= true;
882 * Helper function used solely by loadParamsAndArgs
883 * to prevent code duplication
885 * This sets the param in the options array based on
886 * whether or not it can be specified multiple times.
889 * @param array $options
890 * @param string $option
891 * @param mixed $value
893 private function setParam( &$options, $option, $value ) {
894 $this->orderedOptions
[] = [ $option, $value ];
896 if ( isset( $this->mParams
[$option] ) ) {
897 $multi = $this->mParams
[$option]['multiOccurrence'];
901 $exists = array_key_exists( $option, $options );
902 if ( $multi && $exists ) {
903 $options[$option][] = $value;
904 } elseif ( $multi ) {
905 $options[$option] = [ $value ];
906 } elseif ( !$exists ) {
907 $options[$option] = $value;
909 $this->error( "\nERROR: $option parameter given twice\n" );
910 $this->maybeHelp( true );
915 * Process command line arguments
916 * $mOptions becomes an array with keys set to the option names
917 * $mArgs becomes a zero-based array containing the non-option arguments
919 * @param string $self The name of the script, if any
920 * @param array $opts An array of options, in form of key=>value
921 * @param array $args An array of command line arguments
923 public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
924 # If we were given opts or args, set those and return early
926 $this->mSelf
= $self;
927 $this->mInputLoaded
= true;
930 $this->mOptions
= $opts;
931 $this->mInputLoaded
= true;
934 $this->mArgs
= $args;
935 $this->mInputLoaded
= true;
938 # If we've already loaded input (either by user values or from $argv)
939 # skip on loading it again. The array_shift() will corrupt values if
940 # it's run again and again
941 if ( $this->mInputLoaded
) {
942 $this->loadSpecialVars();
948 $this->mSelf
= $argv[0];
949 $this->loadWithArgv( array_slice( $argv, 1 ) );
953 * Run some validation checks on the params, etc
955 protected function validateParamsAndArgs() {
957 # Check to make sure we've got all the required options
958 foreach ( $this->mParams
as $opt => $info ) {
959 if ( $info['require'] && !$this->hasOption( $opt ) ) {
960 $this->error( "Param $opt required!" );
965 foreach ( $this->mArgList
as $k => $info ) {
966 if ( $info['require'] && !$this->hasArg( $k ) ) {
967 $this->error( 'Argument <' . $info['name'] . '> required!' );
973 $this->maybeHelp( true );
978 * Handle the special variables that are global to all scripts
980 protected function loadSpecialVars() {
981 if ( $this->hasOption( 'dbuser' ) ) {
982 $this->mDbUser
= $this->getOption( 'dbuser' );
984 if ( $this->hasOption( 'dbpass' ) ) {
985 $this->mDbPass
= $this->getOption( 'dbpass' );
987 if ( $this->hasOption( 'quiet' ) ) {
988 $this->mQuiet
= true;
990 if ( $this->hasOption( 'batch-size' ) ) {
991 $this->mBatchSize
= intval( $this->getOption( 'batch-size' ) );
996 * Maybe show the help.
997 * @param bool $force Whether to force the help to show, default false
999 protected function maybeHelp( $force = false ) {
1000 if ( !$force && !$this->hasOption( 'help' ) ) {
1004 $screenWidth = 80; // TODO: Calculate this!
1006 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
1008 ksort( $this->mParams
);
1009 $this->mQuiet
= false;
1012 if ( $this->mDescription
) {
1013 $this->output( "\n" . wordwrap( $this->mDescription
, $screenWidth ) . "\n" );
1015 $output = "\nUsage: php " . basename( $this->mSelf
);
1017 // ... append parameters ...
1018 if ( $this->mParams
) {
1019 $output .= " [--" . implode( "|--", array_keys( $this->mParams
) ) . "]";
1022 // ... and append arguments.
1023 if ( $this->mArgList
) {
1025 foreach ( $this->mArgList
as $k => $arg ) {
1026 if ( $arg['require'] ) {
1027 $output .= '<' . $arg['name'] . '>';
1029 $output .= '[' . $arg['name'] . ']';
1031 if ( $k < count( $this->mArgList
) - 1 ) {
1036 $this->output( "$output\n\n" );
1038 # TODO abstract some repetitive code below
1040 // Generic parameters
1041 $this->output( "Generic maintenance parameters:\n" );
1042 foreach ( $this->mGenericParameters
as $par => $info ) {
1043 if ( $info['shortName'] !== false ) {
1044 $par .= " (-{$info['shortName']})";
1047 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
1048 "\n$tab$tab" ) . "\n"
1051 $this->output( "\n" );
1053 $scriptDependantParams = $this->mDependantParameters
;
1054 if ( count( $scriptDependantParams ) > 0 ) {
1055 $this->output( "Script dependant parameters:\n" );
1056 // Parameters description
1057 foreach ( $scriptDependantParams as $par => $info ) {
1058 if ( $info['shortName'] !== false ) {
1059 $par .= " (-{$info['shortName']})";
1062 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
1063 "\n$tab$tab" ) . "\n"
1066 $this->output( "\n" );
1069 // Script specific parameters not defined on construction by
1070 // Maintenance::addDefaultParams()
1071 $scriptSpecificParams = array_diff_key(
1072 # all script parameters:
1074 # remove the Maintenance default parameters:
1075 $this->mGenericParameters
,
1076 $this->mDependantParameters
1078 if ( count( $scriptSpecificParams ) > 0 ) {
1079 $this->output( "Script specific parameters:\n" );
1080 // Parameters description
1081 foreach ( $scriptSpecificParams as $par => $info ) {
1082 if ( $info['shortName'] !== false ) {
1083 $par .= " (-{$info['shortName']})";
1086 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
1087 "\n$tab$tab" ) . "\n"
1090 $this->output( "\n" );
1094 if ( count( $this->mArgList
) > 0 ) {
1095 $this->output( "Arguments:\n" );
1096 // Arguments description
1097 foreach ( $this->mArgList
as $info ) {
1098 $openChar = $info['require'] ?
'<' : '[';
1099 $closeChar = $info['require'] ?
'>' : ']';
1101 wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
1102 $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
1105 $this->output( "\n" );
1112 * Handle some last-minute setup here.
1114 public function finalSetup() {
1115 global $wgCommandLineMode, $wgShowSQLErrors, $wgServer;
1116 global $wgDBadminuser, $wgDBadminpassword;
1117 global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
1119 # Turn off output buffering again, it might have been turned on in the settings files
1120 if ( ob_get_level() ) {
1124 $wgCommandLineMode = true;
1126 # Override $wgServer
1127 if ( $this->hasOption( 'server' ) ) {
1128 $wgServer = $this->getOption( 'server', $wgServer );
1131 # If these were passed, use them
1132 if ( $this->mDbUser
) {
1133 $wgDBadminuser = $this->mDbUser
;
1135 if ( $this->mDbPass
) {
1136 $wgDBadminpassword = $this->mDbPass
;
1139 if ( $this->getDbType() == self
::DB_ADMIN
&& isset( $wgDBadminuser ) ) {
1140 $wgDBuser = $wgDBadminuser;
1141 $wgDBpassword = $wgDBadminpassword;
1143 if ( $wgDBservers ) {
1145 * @var $wgDBservers array
1147 foreach ( $wgDBservers as $i => $server ) {
1148 $wgDBservers[$i]['user'] = $wgDBuser;
1149 $wgDBservers[$i]['password'] = $wgDBpassword;
1152 if ( isset( $wgLBFactoryConf['serverTemplate'] ) ) {
1153 $wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
1154 $wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
1156 MediaWikiServices
::getInstance()->getDBLoadBalancerFactory()->destroy();
1159 # Apply debug settings
1160 if ( $this->hasOption( 'mwdebug' ) ) {
1161 require __DIR__
. '/../includes/DevelopmentSettings.php';
1164 // Per-script profiling; useful for debugging
1165 $this->activateProfiler();
1167 $this->afterFinalSetup();
1169 $wgShowSQLErrors = true;
1171 Wikimedia\
suppressWarnings();
1172 set_time_limit( 0 );
1173 Wikimedia\restoreWarnings
();
1175 $this->adjustMemoryLimit();
1179 * Execute a callback function at the end of initialisation
1181 protected function afterFinalSetup() {
1182 if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
1183 call_user_func( MW_CMDLINE_CALLBACK
);
1188 * Potentially debug globals. Originally a feature only
1191 public function globals() {
1192 if ( $this->hasOption( 'globals' ) ) {
1193 print_r( $GLOBALS );
1198 * Generic setup for most installs. Returns the location of LocalSettings
1201 public function loadSettings() {
1202 global $wgCommandLineMode, $IP;
1204 if ( isset( $this->mOptions
['conf'] ) ) {
1205 $settingsFile = $this->mOptions
['conf'];
1206 } elseif ( defined( "MW_CONFIG_FILE" ) ) {
1207 $settingsFile = MW_CONFIG_FILE
;
1209 $settingsFile = "$IP/LocalSettings.php";
1211 if ( isset( $this->mOptions
['wiki'] ) ) {
1212 $bits = explode( '-', $this->mOptions
['wiki'] );
1213 if ( count( $bits ) == 1 ) {
1216 define( 'MW_DB', $bits[0] );
1217 define( 'MW_PREFIX', $bits[1] );
1218 } elseif ( isset( $this->mOptions
['server'] ) ) {
1219 // Provide the option for site admins to detect and configure
1220 // multiple wikis based on server names. This offers --server
1221 // as alternative to --wiki.
1222 // See https://www.mediawiki.org/wiki/Manual:Wiki_family
1223 $_SERVER['SERVER_NAME'] = $this->mOptions
['server'];
1226 if ( !is_readable( $settingsFile ) ) {
1227 $this->fatalError( "A copy of your installation's LocalSettings.php\n" .
1228 "must exist and be readable in the source directory.\n" .
1229 "Use --conf to specify it." );
1231 $wgCommandLineMode = true;
1233 return $settingsFile;
1237 * Support function for cleaning up redundant text records
1238 * @param bool $delete Whether or not to actually delete the records
1239 * @author Rob Church <robchur@gmail.com>
1241 public function purgeRedundantText( $delete = true ) {
1242 # Data should come off the master, wrapped in a transaction
1243 $dbw = $this->getDB( DB_MASTER
);
1244 $this->beginTransaction( $dbw, __METHOD__
);
1246 # Get "active" text records from the revisions table
1248 $this->output( 'Searching for active text records in revisions table...' );
1249 $res = $dbw->select( 'revision', 'rev_text_id', [], __METHOD__
, [ 'DISTINCT' ] );
1250 foreach ( $res as $row ) {
1251 $cur[] = $row->rev_text_id
;
1253 $this->output( "done.\n" );
1255 # Get "active" text records from the archive table
1256 $this->output( 'Searching for active text records in archive table...' );
1257 $res = $dbw->select( 'archive', 'ar_text_id', [], __METHOD__
, [ 'DISTINCT' ] );
1258 foreach ( $res as $row ) {
1259 # old pre-MW 1.5 records can have null ar_text_id's.
1260 if ( $row->ar_text_id
!== null ) {
1261 $cur[] = $row->ar_text_id
;
1264 $this->output( "done.\n" );
1266 # Get the IDs of all text records not in these sets
1267 $this->output( 'Searching for inactive text records...' );
1268 $cond = 'old_id NOT IN ( ' . $dbw->makeList( $cur ) . ' )';
1269 $res = $dbw->select( 'text', 'old_id', [ $cond ], __METHOD__
, [ 'DISTINCT' ] );
1271 foreach ( $res as $row ) {
1272 $old[] = $row->old_id
;
1274 $this->output( "done.\n" );
1276 # Inform the user of what we're going to do
1277 $count = count( $old );
1278 $this->output( "$count inactive items found.\n" );
1280 # Delete as appropriate
1281 if ( $delete && $count ) {
1282 $this->output( 'Deleting...' );
1283 $dbw->delete( 'text', [ 'old_id' => $old ], __METHOD__
);
1284 $this->output( "done.\n" );
1288 $this->commitTransaction( $dbw, __METHOD__
);
1292 * Get the maintenance directory.
1295 protected function getDir() {
1300 * Returns a database to be used by current maintenance script. It can be set by setDB().
1301 * If not set, wfGetDB() will be used.
1302 * This function has the same parameters as wfGetDB()
1304 * @param int $db DB index (DB_REPLICA/DB_MASTER)
1305 * @param string|string[] $groups default: empty array
1306 * @param string|bool $wiki default: current wiki
1307 * @return IMaintainableDatabase
1309 protected function getDB( $db, $groups = [], $wiki = false ) {
1310 if ( is_null( $this->mDb
) ) {
1311 return wfGetDB( $db, $groups, $wiki );
1318 * Sets database object to be returned by getDB().
1320 * @param IDatabase $db
1322 public function setDB( IDatabase
$db ) {
1327 * Begin a transcation on a DB
1329 * This method makes it clear that begin() is called from a maintenance script,
1330 * which has outermost scope. This is safe, unlike $dbw->begin() called in other places.
1332 * @param IDatabase $dbw
1333 * @param string $fname Caller name
1336 protected function beginTransaction( IDatabase
$dbw, $fname ) {
1337 $dbw->begin( $fname );
1341 * Commit the transcation on a DB handle and wait for replica DBs to catch up
1343 * This method makes it clear that commit() is called from a maintenance script,
1344 * which has outermost scope. This is safe, unlike $dbw->commit() called in other places.
1346 * @param IDatabase $dbw
1347 * @param string $fname Caller name
1348 * @return bool Whether the replica DB wait succeeded
1351 protected function commitTransaction( IDatabase
$dbw, $fname ) {
1352 $dbw->commit( $fname );
1354 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
1355 $lbFactory->waitForReplication(
1356 [ 'timeout' => 30, 'ifWritesSince' => $this->lastReplicationWait
]
1358 $this->lastReplicationWait
= microtime( true );
1361 } catch ( DBReplicationWaitError
$e ) {
1367 * Rollback the transcation on a DB handle
1369 * This method makes it clear that rollback() is called from a maintenance script,
1370 * which has outermost scope. This is safe, unlike $dbw->rollback() called in other places.
1372 * @param IDatabase $dbw
1373 * @param string $fname Caller name
1376 protected function rollbackTransaction( IDatabase
$dbw, $fname ) {
1377 $dbw->rollback( $fname );
1381 * Lock the search index
1382 * @param IMaintainableDatabase &$db
1384 private function lockSearchindex( $db ) {
1385 $write = [ 'searchindex' ];
1395 $db->lockTables( $read, $write, __CLASS__
. '::' . __METHOD__
);
1400 * @param IMaintainableDatabase &$db
1402 private function unlockSearchindex( $db ) {
1403 $db->unlockTables( __CLASS__
. '::' . __METHOD__
);
1407 * Unlock and lock again
1408 * Since the lock is low-priority, queued reads will be able to complete
1409 * @param IMaintainableDatabase &$db
1411 private function relockSearchindex( $db ) {
1412 $this->unlockSearchindex( $db );
1413 $this->lockSearchindex( $db );
1417 * Perform a search index update with locking
1418 * @param int $maxLockTime The maximum time to keep the search index locked.
1419 * @param string $callback The function that will update the function.
1420 * @param IMaintainableDatabase $dbw
1421 * @param array $results
1423 public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
1427 if ( $maxLockTime ) {
1428 $this->output( " --- Waiting for lock ---" );
1429 $this->lockSearchindex( $dbw );
1431 $this->output( "\n" );
1434 # Loop through the results and do a search update
1435 foreach ( $results as $row ) {
1436 # Allow reads to be processed
1437 if ( $maxLockTime && time() > $lockTime +
$maxLockTime ) {
1438 $this->output( " --- Relocking ---" );
1439 $this->relockSearchindex( $dbw );
1441 $this->output( "\n" );
1443 call_user_func( $callback, $dbw, $row );
1446 # Unlock searchindex
1447 if ( $maxLockTime ) {
1448 $this->output( " --- Unlocking --" );
1449 $this->unlockSearchindex( $dbw );
1450 $this->output( "\n" );
1455 * Update the searchindex table for a given pageid
1456 * @param IDatabase $dbw A database write handle
1457 * @param int $pageId The page ID to update.
1458 * @return null|string
1460 public function updateSearchIndexForPage( $dbw, $pageId ) {
1461 // Get current revision
1462 $rev = Revision
::loadFromPageId( $dbw, $pageId );
1465 $titleObj = $rev->getTitle();
1466 $title = $titleObj->getPrefixedDBkey();
1467 $this->output( "$title..." );
1468 # Update searchindex
1469 $u = new SearchUpdate( $pageId, $titleObj->getText(), $rev->getContent() );
1471 $this->output( "\n" );
1478 * Count down from $seconds to zero on the terminal, with a one-second pause
1479 * between showing each number. If the maintenance script is in quiet mode,
1480 * this function does nothing.
1484 * @codeCoverageIgnore
1485 * @param int $seconds
1487 protected function countDown( $seconds ) {
1488 if ( $this->isQuiet() ) {
1491 for ( $i = $seconds; $i >= 0; $i-- ) {
1492 if ( $i != $seconds ) {
1493 $this->output( str_repeat( "\x08", strlen( $i +
1 ) ) );
1495 $this->output( $i );
1500 $this->output( "\n" );
1504 * Wrapper for posix_isatty()
1505 * We default as considering stdin a tty (for nice readline methods)
1506 * but treating stout as not a tty to avoid color codes
1508 * @param mixed $fd File descriptor
1511 public static function posix_isatty( $fd ) {
1512 if ( !function_exists( 'posix_isatty' ) ) {
1515 return posix_isatty( $fd );
1520 * Prompt the console for input
1521 * @param string $prompt What to begin the line with, like '> '
1522 * @return string Response
1524 public static function readconsole( $prompt = '> ' ) {
1525 static $isatty = null;
1526 if ( is_null( $isatty ) ) {
1527 $isatty = self
::posix_isatty( 0 /*STDIN*/ );
1530 if ( $isatty && function_exists( 'readline' ) ) {
1531 return readline( $prompt );
1534 $st = self
::readlineEmulation( $prompt );
1536 if ( feof( STDIN
) ) {
1539 $st = fgets( STDIN
, 1024 );
1542 if ( $st === false ) {
1545 $resp = trim( $st );
1552 * Emulate readline()
1553 * @param string $prompt What to begin the line with, like '> '
1556 private static function readlineEmulation( $prompt ) {
1557 $bash = ExecutableFinder
::findInDefaultPaths( 'bash' );
1558 if ( !wfIsWindows() && $bash ) {
1560 $encPrompt = wfEscapeShellArg( $prompt );
1561 $command = "read -er -p $encPrompt && echo \"\$REPLY\"";
1562 $encCommand = wfEscapeShellArg( $command );
1563 $line = wfShellExec( "$bash -c $encCommand", $retval, [], [ 'walltime' => 0 ] );
1565 if ( $retval == 0 ) {
1567 } elseif ( $retval == 127 ) {
1568 // Couldn't execute bash even though we thought we saw it.
1569 // Shell probably spit out an error message, sorry :(
1570 // Fall through to fgets()...
1577 // Fallback... we'll have no editing controls, EWWW
1578 if ( feof( STDIN
) ) {
1583 return fgets( STDIN
, 1024 );
1587 * Get the terminal size as a two-element array where the first element
1588 * is the width (number of columns) and the second element is the height
1593 public static function getTermSize() {
1594 $default = [ 80, 50 ];
1595 if ( wfIsWindows() ) {
1598 // It's possible to get the screen size with VT-100 terminal escapes,
1599 // but reading the responses is not possible without setting raw mode
1600 // (unless you want to require the user to press enter), and that
1601 // requires an ioctl(), which we can't do. So we have to shell out to
1602 // something that can do the relevant syscalls. There are a few
1603 // options. Linux and Mac OS X both have "stty size" which does the
1605 $result = Shell
::command( 'stty', 'size' )
1607 if ( $result->getExitCode() !== 0 ) {
1610 if ( !preg_match( '/^(\d+) (\d+)$/', $result->getStdout(), $m ) ) {
1613 return [ intval( $m[2] ), intval( $m[1] ) ];
1617 * Call this to set up the autoloader to allow classes to be used from the
1620 public static function requireTestsAutoloader() {
1621 require_once __DIR__
. '/../tests/common/TestsAutoLoader.php';
1626 * Fake maintenance wrapper, mostly used for the web installer/updater
1628 class FakeMaintenance
extends Maintenance
{
1629 protected $mSelf = "FakeMaintenanceScript";
1631 public function execute() {
1637 * Class for scripts that perform database maintenance and want to log the
1638 * update in `updatelog` so we can later skip it
1640 abstract class LoggedUpdateMaintenance
extends Maintenance
{
1641 public function __construct() {
1642 parent
::__construct();
1643 $this->addOption( 'force', 'Run the update even if it was completed already' );
1644 $this->setBatchSize( 200 );
1647 public function execute() {
1648 $db = $this->getDB( DB_MASTER
);
1649 $key = $this->getUpdateKey();
1651 if ( !$this->hasOption( 'force' )
1652 && $db->selectRow( 'updatelog', '1', [ 'ul_key' => $key ], __METHOD__
)
1654 $this->output( "..." . $this->updateSkippedMessage() . "\n" );
1659 if ( !$this->doDBUpdates() ) {
1663 if ( $db->insert( 'updatelog', [ 'ul_key' => $key ], __METHOD__
, 'IGNORE' ) ) {
1666 $this->output( $this->updatelogFailedMessage() . "\n" );
1673 * Message to show that the update was done already and was just skipped
1676 protected function updateSkippedMessage() {
1677 $key = $this->getUpdateKey();
1679 return "Update '{$key}' already logged as completed.";
1683 * Message to show that the update log was unable to log the completion of this update
1686 protected function updatelogFailedMessage() {
1687 $key = $this->getUpdateKey();
1689 return "Unable to log update '{$key}' as completed.";
1693 * Do the actual work. All child classes will need to implement this.
1694 * Return true to log the update as done or false (usually on failure).
1697 abstract protected function doDBUpdates();
1700 * Get the update key name to go in the update log table
1703 abstract protected function getUpdateKey();