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 // Make sure we're on PHP5.3.3 or better
24 if ( !function_exists( 'version_compare' ) ||
version_compare( PHP_VERSION
, '5.3.3' ) < 0 ) {
25 // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
26 require_once dirname( __FILE__
) . '/../includes/PHPVersionError.php';
27 wfPHPVersionError( 'cli' );
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
41 use MediaWiki\Logger\LoggerFactory
;
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>
51 * @ingroup Maintenance
53 abstract class Maintenance
{
55 * Constants for DB access type
56 * @see Maintenance::getDbType()
62 // Const for getStdin()
63 const STDIN_ALL
= 'all';
65 // This is the desired params
66 protected $mParams = array();
68 // Array of mapping short parameters to long ones
69 protected $mShortParamsMap = array();
71 // Array of desired args
72 protected $mArgList = array();
74 // This is the list of options that were actually passed
75 protected $mOptions = array();
77 // This is the list of arguments that were actually passed
78 protected $mArgs = array();
80 // Name of the script currently running
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
88 protected $mDescription = '';
90 // Have we already loaded our user input?
91 protected $mInputLoaded = false;
94 * Batch size. If a script supports this, they should set
95 * a default with setBatchSize()
99 protected $mBatchSize = null;
101 // Generic options added by addDefaultParams()
102 private $mGenericParameters = array();
103 // Generic options which might or not be supported by the script
104 private $mDependantParameters = array();
107 * Used by getDB() / setDB()
113 * Used when creating separate schema files.
119 * Accessible via getConfig()
126 * Default constructor. Children should call this *first* if implementing
127 * their own constructors
129 public function __construct() {
130 // Setup $IP, using MW_INSTALL_PATH if it exists
132 $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
133 ?
getenv( 'MW_INSTALL_PATH' )
134 : realpath( __DIR__
. '/..' );
136 $this->addDefaultParams();
137 register_shutdown_function( array( $this, 'outputChanneled' ), false );
141 * Should we execute the maintenance script, or just allow it to be included
142 * as a standalone class? It checks that the call stack only includes this
143 * function and "requires" (meaning was called from the file scope)
147 public static function shouldExecute() {
148 global $wgCommandLineMode;
150 if ( !function_exists( 'debug_backtrace' ) ) {
151 // If someone has a better idea...
152 return $wgCommandLineMode;
155 $bt = debug_backtrace();
156 $count = count( $bt );
158 return false; // sanity
160 if ( $bt[0]['class'] !== 'Maintenance' ||
$bt[0]['function'] !== 'shouldExecute' ) {
161 return false; // last call should be to this function
163 $includeFuncs = array( 'require_once', 'require', 'include', 'include_once' );
164 for ( $i = 1; $i < $count; $i++
) {
165 if ( !in_array( $bt[$i]['function'], $includeFuncs ) ) {
166 return false; // previous calls should all be "requires"
174 * Do the actual work. All child classes will need to implement this
176 abstract public function execute();
179 * Add a parameter to the script. Will be displayed on --help
180 * with the associated description
182 * @param string $name The name of the param (help, version, etc)
183 * @param string $description The description of the param to show on --help
184 * @param bool $required Is the param required?
185 * @param bool $withArg Is an argument required with this option?
186 * @param string $shortName Character to use as short name
188 protected function addOption( $name, $description, $required = false,
189 $withArg = false, $shortName = false
191 $this->mParams
[$name] = array(
192 'desc' => $description,
193 'require' => $required,
194 'withArg' => $withArg,
195 'shortName' => $shortName
198 if ( $shortName !== false ) {
199 $this->mShortParamsMap
[$shortName] = $name;
204 * Checks to see if a particular param exists.
205 * @param string $name The name of the param
208 protected function hasOption( $name ) {
209 return isset( $this->mOptions
[$name] );
213 * Get an option, or return the default
214 * @param string $name The name of the param
215 * @param mixed $default Anything you want, default null
218 protected function getOption( $name, $default = null ) {
219 if ( $this->hasOption( $name ) ) {
220 return $this->mOptions
[$name];
222 // Set it so we don't have to provide the default again
223 $this->mOptions
[$name] = $default;
225 return $this->mOptions
[$name];
230 * Add some args that are needed
231 * @param string $arg Name of the arg, like 'start'
232 * @param string $description Short description of the arg
233 * @param bool $required Is this required?
235 protected function addArg( $arg, $description, $required = true ) {
236 $this->mArgList
[] = array(
238 'desc' => $description,
239 'require' => $required
244 * Remove an option. Useful for removing options that won't be used in your script.
245 * @param string $name The option to remove.
247 protected function deleteOption( $name ) {
248 unset( $this->mParams
[$name] );
252 * Set the description text.
253 * @param string $text The text of the description
255 protected function addDescription( $text ) {
256 $this->mDescription
= $text;
260 * Does a given argument exist?
261 * @param int $argId The integer value (from zero) for the arg
264 protected function hasArg( $argId = 0 ) {
265 return isset( $this->mArgs
[$argId] );
270 * @param int $argId The integer value (from zero) for the arg
271 * @param mixed $default The default if it doesn't exist
274 protected function getArg( $argId = 0, $default = null ) {
275 return $this->hasArg( $argId ) ?
$this->mArgs
[$argId] : $default;
279 * Set the batch size.
280 * @param int $s The number of operations to do in a batch
282 protected function setBatchSize( $s = 0 ) {
283 $this->mBatchSize
= $s;
285 // If we support $mBatchSize, show the option.
286 // Used to be in addDefaultParams, but in order for that to
287 // work, subclasses would have to call this function in the constructor
288 // before they called parent::__construct which is just weird
289 // (and really wasn't done).
290 if ( $this->mBatchSize
) {
291 $this->addOption( 'batch-size', 'Run this many operations ' .
292 'per batch, default: ' . $this->mBatchSize
, false, true );
293 if ( isset( $this->mParams
['batch-size'] ) ) {
294 // This seems a little ugly...
295 $this->mDependantParameters
['batch-size'] = $this->mParams
['batch-size'];
301 * Get the script's name
304 public function getName() {
309 * Return input from stdin.
310 * @param int $len The number of bytes to read. If null, just return the handle.
311 * Maintenance::STDIN_ALL returns the full length
314 protected function getStdin( $len = null ) {
315 if ( $len == Maintenance
::STDIN_ALL
) {
316 return file_get_contents( 'php://stdin' );
318 $f = fopen( 'php://stdin', 'rt' );
322 $input = fgets( $f, $len );
325 return rtrim( $input );
331 public function isQuiet() {
332 return $this->mQuiet
;
336 * Throw some output to the user. Scripts can call this with no fears,
337 * as we handle all --quiet stuff here
338 * @param string $out The text to show to the user
339 * @param mixed $channel Unique identifier for the channel. See function outputChanneled.
341 protected function output( $out, $channel = null ) {
342 if ( $this->mQuiet
) {
345 if ( $channel === null ) {
346 $this->cleanupChanneled();
349 $out = preg_replace( '/\n\z/', '', $out );
350 $this->outputChanneled( $out, $channel );
355 * Throw an error to the user. Doesn't respect --quiet, so don't use
356 * this for non-error output
357 * @param string $err The error to display
358 * @param int $die If > 0, go ahead and die out using this int as the code
360 protected function error( $err, $die = 0 ) {
361 $this->outputChanneled( false );
362 if ( PHP_SAPI
== 'cli' ) {
363 fwrite( STDERR
, $err . "\n" );
367 $die = intval( $die );
373 private $atLineStart = true;
374 private $lastChannel = null;
377 * Clean up channeled output. Output a newline if necessary.
379 public function cleanupChanneled() {
380 if ( !$this->atLineStart
) {
382 $this->atLineStart
= true;
387 * Message outputter with channeled message support. Messages on the
388 * same channel are concatenated, but any intervening messages in another
389 * channel start a new line.
390 * @param string $msg The message without trailing newline
391 * @param string $channel Channel identifier or null for no
392 * channel. Channel comparison uses ===.
394 public function outputChanneled( $msg, $channel = null ) {
395 if ( $msg === false ) {
396 $this->cleanupChanneled();
401 // End the current line if necessary
402 if ( !$this->atLineStart
&& $channel !== $this->lastChannel
) {
408 $this->atLineStart
= false;
409 if ( $channel === null ) {
410 // For unchanneled messages, output trailing newline immediately
412 $this->atLineStart
= true;
414 $this->lastChannel
= $channel;
418 * Does the script need different DB access? By default, we give Maintenance
419 * scripts normal rights to the DB. Sometimes, a script needs admin rights
420 * access for a reason and sometimes they want no access. Subclasses should
421 * override and return one of the following values, as needed:
422 * Maintenance::DB_NONE - For no DB access at all
423 * Maintenance::DB_STD - For normal DB access, default
424 * Maintenance::DB_ADMIN - For admin DB access
427 public function getDbType() {
428 return Maintenance
::DB_STD
;
432 * Add the default parameters to the scripts
434 protected function addDefaultParams() {
436 # Generic (non script dependant) options:
438 $this->addOption( 'help', 'Display this help message', false, false, 'h' );
439 $this->addOption( 'quiet', 'Whether to supress non-error output', false, false, 'q' );
440 $this->addOption( 'conf', 'Location of LocalSettings.php, if not default', false, true );
441 $this->addOption( 'wiki', 'For specifying the wiki ID', false, true );
442 $this->addOption( 'globals', 'Output globals at the end of processing for debugging' );
445 'Set a specific memory limit for the script, '
446 . '"max" for no limit or "default" to avoid changing it'
448 $this->addOption( 'server', "The protocol and server name to use in URLs, e.g. " .
449 "http://en.wikipedia.org. This is sometimes necessary because " .
450 "server name detection may fail in command line scripts.", false, true );
451 $this->addOption( 'profiler', 'Profiler output format (usually "text")', false, true );
453 # Save generic options to display them separately in help
454 $this->mGenericParameters
= $this->mParams
;
456 # Script dependant options:
458 // If we support a DB, show the options
459 if ( $this->getDbType() > 0 ) {
460 $this->addOption( 'dbuser', 'The DB user to use for this script', false, true );
461 $this->addOption( 'dbpass', 'The password to use for this script', false, true );
464 # Save additional script dependant options to display
465 #Â them separately in help
466 $this->mDependantParameters
= array_diff_key( $this->mParams
, $this->mGenericParameters
);
473 public function getConfig() {
474 if ( $this->config
=== null ) {
475 $this->config
= ConfigFactory
::getDefaultInstance()->makeConfig( 'main' );
478 return $this->config
;
483 * @param Config $config
485 public function setConfig( Config
$config ) {
486 $this->config
= $config;
490 * Run a child maintenance script. Pass all of the current arguments
492 * @param string $maintClass A name of a child maintenance class
493 * @param string $classFile Full path of where the child is
494 * @return Maintenance
496 public function runChild( $maintClass, $classFile = null ) {
497 // Make sure the class is loaded first
498 if ( !class_exists( $maintClass ) ) {
500 require_once $classFile;
502 if ( !class_exists( $maintClass ) ) {
503 $this->error( "Cannot spawn child: $maintClass" );
508 * @var $child Maintenance
510 $child = new $maintClass();
511 $child->loadParamsAndArgs( $this->mSelf
, $this->mOptions
, $this->mArgs
);
512 if ( !is_null( $this->mDb
) ) {
513 $child->setDB( $this->mDb
);
520 * Do some sanity checking and basic setup
522 public function setup() {
523 global $IP, $wgCommandLineMode, $wgRequestTime;
525 # Abort if called from a web server
526 if ( isset( $_SERVER ) && isset( $_SERVER['REQUEST_METHOD'] ) ) {
527 $this->error( 'This script must be run from the command line', true );
530 if ( $IP === null ) {
531 $this->error( "\$IP not set, aborting!\n" .
532 '(Did you forget to call parent::__construct() in your maintenance script?)', 1 );
535 # Make sure we can handle script parameters
536 if ( !defined( 'HPHP_VERSION' ) && !ini_get( 'register_argc_argv' ) ) {
537 $this->error( 'Cannot get command line arguments, register_argc_argv is set to false', true );
540 // Send PHP warnings and errors to stderr instead of stdout.
541 // This aids in diagnosing problems, while keeping messages
542 // out of redirected output.
543 if ( ini_get( 'display_errors' ) ) {
544 ini_set( 'display_errors', 'stderr' );
547 $this->loadParamsAndArgs();
550 # Set the memory limit
551 # Note we need to set it again later in cache LocalSettings changed it
552 $this->adjustMemoryLimit();
554 # Set max execution time to 0 (no limit). PHP.net says that
555 # "When running PHP from the command line the default setting is 0."
556 # But sometimes this doesn't seem to be the case.
557 ini_set( 'max_execution_time', 0 );
559 $wgRequestTime = microtime( true );
561 # Define us as being in MediaWiki
562 define( 'MEDIAWIKI', true );
564 $wgCommandLineMode = true;
566 # Turn off output buffering if it's on
567 while ( ob_get_level() > 0 ) {
571 $this->validateParamsAndArgs();
575 * Normally we disable the memory_limit when running admin scripts.
576 * Some scripts may wish to actually set a limit, however, to avoid
577 * blowing up unexpectedly. We also support a --memory-limit option,
578 * to allow sysadmins to explicitly set one if they'd prefer to override
579 * defaults (or for people using Suhosin which yells at you for trying
580 * to disable the limits)
583 public function memoryLimit() {
584 $limit = $this->getOption( 'memory-limit', 'max' );
585 $limit = trim( $limit, "\" '" ); // trim quotes in case someone misunderstood
590 * Adjusts PHP's memory limit to better suit our needs, if needed.
592 protected function adjustMemoryLimit() {
593 $limit = $this->memoryLimit();
594 if ( $limit == 'max' ) {
595 $limit = -1; // no memory limit
597 if ( $limit != 'default' ) {
598 ini_set( 'memory_limit', $limit );
603 * Activate the profiler (assuming $wgProfiler is set)
605 protected function activateProfiler() {
606 global $wgProfiler, $wgTrxProfilerLimits;
608 $output = $this->getOption( 'profiler' );
609 if ( $output && is_array( $wgProfiler ) && isset( $wgProfiler['class'] ) ) {
610 $class = $wgProfiler['class'];
611 $profiler = new $class(
612 array( 'sampling' => 1, 'output' => $output ) +
$wgProfiler
614 $profiler->setTemplated( true );
615 Profiler
::replaceStubInstance( $profiler );
618 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
619 $trxProfiler->setLogger( LoggerFactory
::getInstance( 'DBPerformance' ) );
620 $trxProfiler->setExpectations( $wgTrxProfilerLimits['Maintenance'], __METHOD__
);
624 * Clear all params and arguments.
626 public function clearParamsAndArgs() {
627 $this->mOptions
= array();
628 $this->mArgs
= array();
629 $this->mInputLoaded
= false;
633 * Process command line arguments
634 * $mOptions becomes an array with keys set to the option names
635 * $mArgs becomes a zero-based array containing the non-option arguments
637 * @param string $self The name of the script, if any
638 * @param array $opts An array of options, in form of key=>value
639 * @param array $args An array of command line arguments
641 public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
642 # If we were given opts or args, set those and return early
644 $this->mSelf
= $self;
645 $this->mInputLoaded
= true;
648 $this->mOptions
= $opts;
649 $this->mInputLoaded
= true;
652 $this->mArgs
= $args;
653 $this->mInputLoaded
= true;
656 # If we've already loaded input (either by user values or from $argv)
657 # skip on loading it again. The array_shift() will corrupt values if
658 # it's run again and again
659 if ( $this->mInputLoaded
) {
660 $this->loadSpecialVars();
666 $this->mSelf
= array_shift( $argv );
672 for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
673 if ( $arg == '--' ) {
674 # End of options, remainder should be considered arguments
675 $arg = next( $argv );
676 while ( $arg !== false ) {
678 $arg = next( $argv );
681 } elseif ( substr( $arg, 0, 2 ) == '--' ) {
683 $option = substr( $arg, 2 );
684 if ( array_key_exists( $option, $options ) ) {
685 $this->error( "\nERROR: $option parameter given twice\n" );
686 $this->maybeHelp( true );
688 if ( isset( $this->mParams
[$option] ) && $this->mParams
[$option]['withArg'] ) {
689 $param = next( $argv );
690 if ( $param === false ) {
691 $this->error( "\nERROR: $option parameter needs a value after it\n" );
692 $this->maybeHelp( true );
694 $options[$option] = $param;
696 $bits = explode( '=', $option, 2 );
697 if ( count( $bits ) > 1 ) {
703 $options[$option] = $param;
705 } elseif ( $arg == '-' ) {
706 # Lonely "-", often used to indicate stdin or stdout.
708 } elseif ( substr( $arg, 0, 1 ) == '-' ) {
710 $argLength = strlen( $arg );
711 for ( $p = 1; $p < $argLength; $p++
) {
713 if ( !isset( $this->mParams
[$option] ) && isset( $this->mShortParamsMap
[$option] ) ) {
714 $option = $this->mShortParamsMap
[$option];
716 if ( array_key_exists( $option, $options ) ) {
717 $this->error( "\nERROR: $option parameter given twice\n" );
718 $this->maybeHelp( true );
720 if ( isset( $this->mParams
[$option]['withArg'] ) && $this->mParams
[$option]['withArg'] ) {
721 $param = next( $argv );
722 if ( $param === false ) {
723 $this->error( "\nERROR: $option parameter needs a value after it\n" );
724 $this->maybeHelp( true );
726 $options[$option] = $param;
728 $options[$option] = 1;
736 $this->mOptions
= $options;
737 $this->mArgs
= $args;
738 $this->loadSpecialVars();
739 $this->mInputLoaded
= true;
743 * Run some validation checks on the params, etc
745 protected function validateParamsAndArgs() {
747 # Check to make sure we've got all the required options
748 foreach ( $this->mParams
as $opt => $info ) {
749 if ( $info['require'] && !$this->hasOption( $opt ) ) {
750 $this->error( "Param $opt required!" );
755 foreach ( $this->mArgList
as $k => $info ) {
756 if ( $info['require'] && !$this->hasArg( $k ) ) {
757 $this->error( 'Argument <' . $info['name'] . '> required!' );
763 $this->maybeHelp( true );
768 * Handle the special variables that are global to all scripts
770 protected function loadSpecialVars() {
771 if ( $this->hasOption( 'dbuser' ) ) {
772 $this->mDbUser
= $this->getOption( 'dbuser' );
774 if ( $this->hasOption( 'dbpass' ) ) {
775 $this->mDbPass
= $this->getOption( 'dbpass' );
777 if ( $this->hasOption( 'quiet' ) ) {
778 $this->mQuiet
= true;
780 if ( $this->hasOption( 'batch-size' ) ) {
781 $this->mBatchSize
= intval( $this->getOption( 'batch-size' ) );
786 * Maybe show the help.
787 * @param bool $force Whether to force the help to show, default false
789 protected function maybeHelp( $force = false ) {
790 if ( !$force && !$this->hasOption( 'help' ) ) {
794 $screenWidth = 80; // TODO: Calculate this!
796 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
798 ksort( $this->mParams
);
799 $this->mQuiet
= false;
802 if ( $this->mDescription
) {
803 $this->output( "\n" . $this->mDescription
. "\n" );
805 $output = "\nUsage: php " . basename( $this->mSelf
);
807 // ... append parameters ...
808 if ( $this->mParams
) {
809 $output .= " [--" . implode( array_keys( $this->mParams
), "|--" ) . "]";
812 // ... and append arguments.
813 if ( $this->mArgList
) {
815 foreach ( $this->mArgList
as $k => $arg ) {
816 if ( $arg['require'] ) {
817 $output .= '<' . $arg['name'] . '>';
819 $output .= '[' . $arg['name'] . ']';
821 if ( $k < count( $this->mArgList
) - 1 ) {
826 $this->output( "$output\n\n" );
828 # TODO abstract some repetitive code below
830 // Generic parameters
831 $this->output( "Generic maintenance parameters:\n" );
832 foreach ( $this->mGenericParameters
as $par => $info ) {
833 if ( $info['shortName'] !== false ) {
834 $par .= " (-{$info['shortName']})";
837 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
838 "\n$tab$tab" ) . "\n"
841 $this->output( "\n" );
843 $scriptDependantParams = $this->mDependantParameters
;
844 if ( count( $scriptDependantParams ) > 0 ) {
845 $this->output( "Script dependant parameters:\n" );
846 // Parameters description
847 foreach ( $scriptDependantParams as $par => $info ) {
848 if ( $info['shortName'] !== false ) {
849 $par .= " (-{$info['shortName']})";
852 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
853 "\n$tab$tab" ) . "\n"
856 $this->output( "\n" );
859 // Script specific parameters not defined on construction by
860 // Maintenance::addDefaultParams()
861 $scriptSpecificParams = array_diff_key(
862 # all script parameters:
864 # remove the Maintenance default parameters:
865 $this->mGenericParameters
,
866 $this->mDependantParameters
868 if ( count( $scriptSpecificParams ) > 0 ) {
869 $this->output( "Script specific parameters:\n" );
870 // Parameters description
871 foreach ( $scriptSpecificParams as $par => $info ) {
872 if ( $info['shortName'] !== false ) {
873 $par .= " (-{$info['shortName']})";
876 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
877 "\n$tab$tab" ) . "\n"
880 $this->output( "\n" );
884 if ( count( $this->mArgList
) > 0 ) {
885 $this->output( "Arguments:\n" );
886 // Arguments description
887 foreach ( $this->mArgList
as $info ) {
888 $openChar = $info['require'] ?
'<' : '[';
889 $closeChar = $info['require'] ?
'>' : ']';
891 wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
892 $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
895 $this->output( "\n" );
902 * Handle some last-minute setup here.
904 public function finalSetup() {
905 global $wgCommandLineMode, $wgShowSQLErrors, $wgServer;
906 global $wgDBadminuser, $wgDBadminpassword;
907 global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
909 # Turn off output buffering again, it might have been turned on in the settings files
910 if ( ob_get_level() ) {
914 $wgCommandLineMode = true;
917 if ( $this->hasOption( 'server' ) ) {
918 $wgServer = $this->getOption( 'server', $wgServer );
921 # If these were passed, use them
922 if ( $this->mDbUser
) {
923 $wgDBadminuser = $this->mDbUser
;
925 if ( $this->mDbPass
) {
926 $wgDBadminpassword = $this->mDbPass
;
929 if ( $this->getDbType() == self
::DB_ADMIN
&& isset( $wgDBadminuser ) ) {
930 $wgDBuser = $wgDBadminuser;
931 $wgDBpassword = $wgDBadminpassword;
933 if ( $wgDBservers ) {
935 * @var $wgDBservers array
937 foreach ( $wgDBservers as $i => $server ) {
938 $wgDBservers[$i]['user'] = $wgDBuser;
939 $wgDBservers[$i]['password'] = $wgDBpassword;
942 if ( isset( $wgLBFactoryConf['serverTemplate'] ) ) {
943 $wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
944 $wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
946 LBFactory
::destroyInstance();
949 // Per-script profiling; useful for debugging
950 $this->activateProfiler();
952 $this->afterFinalSetup();
954 $wgShowSQLErrors = true;
956 // @codingStandardsIgnoreStart Allow error suppression. wfSuppressWarnings()
958 @set_time_limit
( 0 );
959 // @codingStandardsIgnoreStart
961 $this->adjustMemoryLimit();
965 * Execute a callback function at the end of initialisation
967 protected function afterFinalSetup() {
968 if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
969 call_user_func( MW_CMDLINE_CALLBACK
);
974 * Potentially debug globals. Originally a feature only
977 public function globals() {
978 if ( $this->hasOption( 'globals' ) ) {
984 * Generic setup for most installs. Returns the location of LocalSettings
987 public function loadSettings() {
988 global $wgCommandLineMode, $IP;
990 if ( isset( $this->mOptions
['conf'] ) ) {
991 $settingsFile = $this->mOptions
['conf'];
992 } elseif ( defined( "MW_CONFIG_FILE" ) ) {
993 $settingsFile = MW_CONFIG_FILE
;
995 $settingsFile = "$IP/LocalSettings.php";
997 if ( isset( $this->mOptions
['wiki'] ) ) {
998 $bits = explode( '-', $this->mOptions
['wiki'] );
999 if ( count( $bits ) == 1 ) {
1002 define( 'MW_DB', $bits[0] );
1003 define( 'MW_PREFIX', $bits[1] );
1006 if ( !is_readable( $settingsFile ) ) {
1007 $this->error( "A copy of your installation's LocalSettings.php\n" .
1008 "must exist and be readable in the source directory.\n" .
1009 "Use --conf to specify it.", true );
1011 $wgCommandLineMode = true;
1013 return $settingsFile;
1017 * Support function for cleaning up redundant text records
1018 * @param bool $delete Whether or not to actually delete the records
1019 * @author Rob Church <robchur@gmail.com>
1021 public function purgeRedundantText( $delete = true ) {
1022 # Data should come off the master, wrapped in a transaction
1023 $dbw = $this->getDB( DB_MASTER
);
1024 $dbw->begin( __METHOD__
);
1026 # Get "active" text records from the revisions table
1027 $this->output( 'Searching for active text records in revisions table...' );
1028 $res = $dbw->select( 'revision', 'rev_text_id', array(), __METHOD__
, array( 'DISTINCT' ) );
1029 foreach ( $res as $row ) {
1030 $cur[] = $row->rev_text_id
;
1032 $this->output( "done.\n" );
1034 # Get "active" text records from the archive table
1035 $this->output( 'Searching for active text records in archive table...' );
1036 $res = $dbw->select( 'archive', 'ar_text_id', array(), __METHOD__
, array( 'DISTINCT' ) );
1037 foreach ( $res as $row ) {
1038 # old pre-MW 1.5 records can have null ar_text_id's.
1039 if ( $row->ar_text_id
!== null ) {
1040 $cur[] = $row->ar_text_id
;
1043 $this->output( "done.\n" );
1045 # Get the IDs of all text records not in these sets
1046 $this->output( 'Searching for inactive text records...' );
1047 $cond = 'old_id NOT IN ( ' . $dbw->makeList( $cur ) . ' )';
1048 $res = $dbw->select( 'text', 'old_id', array( $cond ), __METHOD__
, array( 'DISTINCT' ) );
1050 foreach ( $res as $row ) {
1051 $old[] = $row->old_id
;
1053 $this->output( "done.\n" );
1055 # Inform the user of what we're going to do
1056 $count = count( $old );
1057 $this->output( "$count inactive items found.\n" );
1059 # Delete as appropriate
1060 if ( $delete && $count ) {
1061 $this->output( 'Deleting...' );
1062 $dbw->delete( 'text', array( 'old_id' => $old ), __METHOD__
);
1063 $this->output( "done.\n" );
1067 $dbw->commit( __METHOD__
);
1071 * Get the maintenance directory.
1074 protected function getDir() {
1079 * Returns a database to be used by current maintenance script. It can be set by setDB().
1080 * If not set, wfGetDB() will be used.
1081 * This function has the same parameters as wfGetDB()
1083 * @return DatabaseBase
1085 protected function getDB( $db, $groups = array(), $wiki = false ) {
1086 if ( is_null( $this->mDb
) ) {
1087 return wfGetDB( $db, $groups, $wiki );
1094 * Sets database object to be returned by getDB().
1096 * @param DatabaseBase $db Database object to be used
1098 public function setDB( $db ) {
1103 * Lock the search index
1104 * @param DatabaseBase &$db
1106 private function lockSearchindex( $db ) {
1107 $write = array( 'searchindex' );
1108 $read = array( 'page', 'revision', 'text', 'interwiki', 'l10n_cache', 'user', 'page_restrictions' );
1109 $db->lockTables( $read, $write, __CLASS__
. '::' . __METHOD__
);
1114 * @param DatabaseBase &$db
1116 private function unlockSearchindex( $db ) {
1117 $db->unlockTables( __CLASS__
. '::' . __METHOD__
);
1121 * Unlock and lock again
1122 * Since the lock is low-priority, queued reads will be able to complete
1123 * @param DatabaseBase &$db
1125 private function relockSearchindex( $db ) {
1126 $this->unlockSearchindex( $db );
1127 $this->lockSearchindex( $db );
1131 * Perform a search index update with locking
1132 * @param int $maxLockTime The maximum time to keep the search index locked.
1133 * @param string $callback The function that will update the function.
1134 * @param DatabaseBase $dbw
1135 * @param array $results
1137 public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
1141 if ( $maxLockTime ) {
1142 $this->output( " --- Waiting for lock ---" );
1143 $this->lockSearchindex( $dbw );
1145 $this->output( "\n" );
1148 # Loop through the results and do a search update
1149 foreach ( $results as $row ) {
1150 # Allow reads to be processed
1151 if ( $maxLockTime && time() > $lockTime +
$maxLockTime ) {
1152 $this->output( " --- Relocking ---" );
1153 $this->relockSearchindex( $dbw );
1155 $this->output( "\n" );
1157 call_user_func( $callback, $dbw, $row );
1160 # Unlock searchindex
1161 if ( $maxLockTime ) {
1162 $this->output( " --- Unlocking --" );
1163 $this->unlockSearchindex( $dbw );
1164 $this->output( "\n" );
1169 * Update the searchindex table for a given pageid
1170 * @param DatabaseBase $dbw A database write handle
1171 * @param int $pageId The page ID to update.
1172 * @return null|string
1174 public function updateSearchIndexForPage( $dbw, $pageId ) {
1175 // Get current revision
1176 $rev = Revision
::loadFromPageId( $dbw, $pageId );
1179 $titleObj = $rev->getTitle();
1180 $title = $titleObj->getPrefixedDBkey();
1181 $this->output( "$title..." );
1182 # Update searchindex
1183 $u = new SearchUpdate( $pageId, $titleObj->getText(), $rev->getContent() );
1185 $this->output( "\n" );
1192 * Wrapper for posix_isatty()
1193 * We default as considering stdin a tty (for nice readline methods)
1194 * but treating stout as not a tty to avoid color codes
1196 * @param mixed $fd File descriptor
1199 public static function posix_isatty( $fd ) {
1200 if ( !function_exists( 'posix_isatty' ) ) {
1203 return posix_isatty( $fd );
1208 * Prompt the console for input
1209 * @param string $prompt What to begin the line with, like '> '
1210 * @return string Response
1212 public static function readconsole( $prompt = '> ' ) {
1213 static $isatty = null;
1214 if ( is_null( $isatty ) ) {
1215 $isatty = self
::posix_isatty( 0 /*STDIN*/ );
1218 if ( $isatty && function_exists( 'readline' ) ) {
1219 $resp = readline( $prompt );
1220 if ( $resp === null ) {
1221 // Workaround for https://github.com/facebook/hhvm/issues/4776
1228 $st = self
::readlineEmulation( $prompt );
1230 if ( feof( STDIN
) ) {
1233 $st = fgets( STDIN
, 1024 );
1236 if ( $st === false ) {
1239 $resp = trim( $st );
1246 * Emulate readline()
1247 * @param string $prompt What to begin the line with, like '> '
1250 private static function readlineEmulation( $prompt ) {
1251 $bash = Installer
::locateExecutableInDefaultPaths( array( 'bash' ) );
1252 if ( !wfIsWindows() && $bash ) {
1254 $encPrompt = wfEscapeShellArg( $prompt );
1255 $command = "read -er -p $encPrompt && echo \"\$REPLY\"";
1256 $encCommand = wfEscapeShellArg( $command );
1257 $line = wfShellExec( "$bash -c $encCommand", $retval, array(), array( 'walltime' => 0 ) );
1259 if ( $retval == 0 ) {
1261 } elseif ( $retval == 127 ) {
1262 // Couldn't execute bash even though we thought we saw it.
1263 // Shell probably spit out an error message, sorry :(
1264 // Fall through to fgets()...
1271 // Fallback... we'll have no editing controls, EWWW
1272 if ( feof( STDIN
) ) {
1277 return fgets( STDIN
, 1024 );
1282 * Fake maintenance wrapper, mostly used for the web installer/updater
1284 class FakeMaintenance
extends Maintenance
{
1285 protected $mSelf = "FakeMaintenanceScript";
1287 public function execute() {
1293 * Class for scripts that perform database maintenance and want to log the
1294 * update in `updatelog` so we can later skip it
1296 abstract class LoggedUpdateMaintenance
extends Maintenance
{
1297 public function __construct() {
1298 parent
::__construct();
1299 $this->addOption( 'force', 'Run the update even if it was completed already' );
1300 $this->setBatchSize( 200 );
1303 public function execute() {
1304 $db = $this->getDB( DB_MASTER
);
1305 $key = $this->getUpdateKey();
1307 if ( !$this->hasOption( 'force' )
1308 && $db->selectRow( 'updatelog', '1', array( 'ul_key' => $key ), __METHOD__
)
1310 $this->output( "..." . $this->updateSkippedMessage() . "\n" );
1315 if ( !$this->doDBUpdates() ) {
1319 if ( $db->insert( 'updatelog', array( 'ul_key' => $key ), __METHOD__
, 'IGNORE' ) ) {
1322 $this->output( $this->updatelogFailedMessage() . "\n" );
1329 * Message to show that the update was done already and was just skipped
1332 protected function updateSkippedMessage() {
1333 $key = $this->getUpdateKey();
1335 return "Update '{$key}' already logged as completed.";
1339 * Message to show that the update log was unable to log the completion of this update
1342 protected function updatelogFailedMessage() {
1343 $key = $this->getUpdateKey();
1345 return "Unable to log update '{$key}' as completed.";
1349 * Do the actual work. All child classes will need to implement this.
1350 * Return true to log the update as done or false (usually on failure).
1353 abstract protected function doDBUpdates();
1356 * Get the update key name to go in the update log table
1359 abstract protected function getUpdateKey();