maintenance/Maintenance.php

   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  * @ingroup Maintenance
  20  * @defgroup Maintenance Maintenance
  21  */
  22
  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' );
  28 }
  29
  30 /**
  31  * @defgroup MaintenanceArchive Maintenance archives
  32  * @ingroup Maintenance
  33  */
  34
  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
  38
  39 $maintClass = false;
  40
  41 /**
  42  * Abstract maintenance class for quickly writing and churning out
  43  * maintenance scripts with minimal effort. All that _must_ be defined
  44  * is the execute() method. See docs/maintenance.txt for more info
  45  * and a quick demo of how to use it.
  46  *
  47  * @author Chad Horohoe <chad@anyonecanedit.org>
  48  * @since 1.16
  49  * @ingroup Maintenance
  50  */
  51 abstract class Maintenance {
  52         /**
  53          * Constants for DB access type
  54          * @see Maintenance::getDbType()
  55          */
  56         const DB_NONE = 0;
  57         const DB_STD = 1;
  58         const DB_ADMIN = 2;
  59
  60         // Const for getStdin()
  61         const STDIN_ALL = 'all';
  62
  63         // This is the desired params
  64         protected $mParams = array();
  65
  66         // Array of mapping short parameters to long ones
  67         protected $mShortParamsMap = array();
  68
  69         // Array of desired args
  70         protected $mArgList = array();
  71
  72         // This is the list of options that were actually passed
  73         protected $mOptions = array();
  74
  75         // This is the list of arguments that were actually passed
  76         protected $mArgs = array();
  77
  78         // Name of the script currently running
  79         protected $mSelf;
  80
  81         // Special vars for params that are always used
  82         protected $mQuiet = false;
  83         protected $mDbUser, $mDbPass;
  84
  85         // A description of the script, children should change this
  86         protected $mDescription = '';
  87
  88         // Have we already loaded our user input?
  89         protected $mInputLoaded = false;
  90
  91         /**
  92          * Batch size. If a script supports this, they should set
  93          * a default with setBatchSize()
  94          *
  95          * @var int
  96          */
  97         protected $mBatchSize = null;
  98
  99         // Generic options added by addDefaultParams()
 100         private $mGenericParameters = array();
 101         // Generic options which might or not be supported by the script
 102         private $mDependantParameters = array();
 103
 104         /**
 105          * Used by getDB() / setDB()
 106          * @var DatabaseBase
 107          */
 108         private $mDb = null;
 109
 110         /**
 111          * Used when creating separate schema files.
 112          * @var resource
 113          */
 114         public $fileHandle;
 115
 116         /**
 117          * Accessible via getConfig()
 118          *
 119          * @var Config
 120          */
 121         private $config;
 122
 123         /**
 124          * Default constructor. Children should call this *first* if implementing
 125          * their own constructors
 126          */
 127         public function __construct() {
 128                 // Setup $IP, using MW_INSTALL_PATH if it exists
 129                 global $IP;
 130                 $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
 131                         ? getenv( 'MW_INSTALL_PATH' )
 132                         : realpath( __DIR__ . '/..' );
 133
 134                 $this->addDefaultParams();
 135                 register_shutdown_function( array( $this, 'outputChanneled' ), false );
 136         }
 137
 138         /**
 139          * Should we execute the maintenance script, or just allow it to be included
 140          * as a standalone class? It checks that the call stack only includes this
 141          * function and "requires" (meaning was called from the file scope)
 142          *
 143          * @return bool
 144          */
 145         public static function shouldExecute() {
 146                 global $wgCommandLineMode;
 147
 148                 if ( !function_exists( 'debug_backtrace' ) ) {
 149                         // If someone has a better idea...
 150                         return $wgCommandLineMode;
 151                 }
 152
 153                 $bt = debug_backtrace();
 154                 $count = count( $bt );
 155                 if ( $count < 2 ) {
 156                         return false; // sanity
 157                 }
 158                 if ( $bt[0]['class'] !== 'Maintenance' || $bt[0]['function'] !== 'shouldExecute' ) {
 159                         return false; // last call should be to this function
 160                 }
 161                 $includeFuncs = array( 'require_once', 'require', 'include', 'include_once' );
 162                 for ( $i = 1; $i < $count; $i++ ) {
 163                         if ( !in_array( $bt[$i]['function'], $includeFuncs ) ) {
 164                                 return false; // previous calls should all be "requires"
 165                         }
 166                 }
 167
 168                 return true;
 169         }
 170
 171         /**
 172          * Do the actual work. All child classes will need to implement this
 173          */
 174         abstract public function execute();
 175
 176         /**
 177          * Add a parameter to the script. Will be displayed on --help
 178          * with the associated description
 179          *
 180          * @param string $name The name of the param (help, version, etc)
 181          * @param string $description The description of the param to show on --help
 182          * @param bool $required Is the param required?
 183          * @param bool $withArg Is an argument required with this option?
 184          * @param string $shortName Character to use as short name
 185          */
 186         protected function addOption( $name, $description, $required = false,
 187                 $withArg = false, $shortName = false
 188         ) {
 189                 $this->mParams[$name] = array(
 190                         'desc' => $description,
 191                         'require' => $required,
 192                         'withArg' => $withArg,
 193                         'shortName' => $shortName
 194                 );
 195
 196                 if ( $shortName !== false ) {
 197                         $this->mShortParamsMap[$shortName] = $name;
 198                 }
 199         }
 200
 201         /**
 202          * Checks to see if a particular param exists.
 203          * @param string $name The name of the param
 204          * @return bool
 205          */
 206         protected function hasOption( $name ) {
 207                 return isset( $this->mOptions[$name] );
 208         }
 209
 210         /**
 211          * Get an option, or return the default
 212          * @param string $name The name of the param
 213          * @param mixed $default Anything you want, default null
 214          * @return mixed
 215          */
 216         protected function getOption( $name, $default = null ) {
 217                 if ( $this->hasOption( $name ) ) {
 218                         return $this->mOptions[$name];
 219                 } else {
 220                         // Set it so we don't have to provide the default again
 221                         $this->mOptions[$name] = $default;
 222
 223                         return $this->mOptions[$name];
 224                 }
 225         }
 226
 227         /**
 228          * Add some args that are needed
 229          * @param string $arg Name of the arg, like 'start'
 230          * @param string $description Short description of the arg
 231          * @param bool $required Is this required?
 232          */
 233         protected function addArg( $arg, $description, $required = true ) {
 234                 $this->mArgList[] = array(
 235                         'name' => $arg,
 236                         'desc' => $description,
 237                         'require' => $required
 238                 );
 239         }
 240
 241         /**
 242          * Remove an option.  Useful for removing options that won't be used in your script.
 243          * @param string $name The option to remove.
 244          */
 245         protected function deleteOption( $name ) {
 246                 unset( $this->mParams[$name] );
 247         }
 248
 249         /**
 250          * Set the description text.
 251          * @param string $text The text of the description
 252          */
 253         protected function addDescription( $text ) {
 254                 $this->mDescription = $text;
 255         }
 256
 257         /**
 258          * Does a given argument exist?
 259          * @param int $argId The integer value (from zero) for the arg
 260          * @return bool
 261          */
 262         protected function hasArg( $argId = 0 ) {
 263                 return isset( $this->mArgs[$argId] );
 264         }
 265
 266         /**
 267          * Get an argument.
 268          * @param int $argId The integer value (from zero) for the arg
 269          * @param mixed $default The default if it doesn't exist
 270          * @return mixed
 271          */
 272         protected function getArg( $argId = 0, $default = null ) {
 273                 return $this->hasArg( $argId ) ? $this->mArgs[$argId] : $default;
 274         }
 275
 276         /**
 277          * Set the batch size.
 278          * @param int $s The number of operations to do in a batch
 279          */
 280         protected function setBatchSize( $s = 0 ) {
 281                 $this->mBatchSize = $s;
 282
 283                 // If we support $mBatchSize, show the option.
 284                 // Used to be in addDefaultParams, but in order for that to
 285                 // work, subclasses would have to call this function in the constructor
 286                 // before they called parent::__construct which is just weird
 287                 // (and really wasn't done).
 288                 if ( $this->mBatchSize ) {
 289                         $this->addOption( 'batch-size', 'Run this many operations ' .
 290                                 'per batch, default: ' . $this->mBatchSize, false, true );
 291                         if ( isset( $this->mParams['batch-size'] ) ) {
 292                                 // This seems a little ugly...
 293                                 $this->mDependantParameters['batch-size'] = $this->mParams['batch-size'];
 294                         }
 295                 }
 296         }
 297
 298         /**
 299          * Get the script's name
 300          * @return string
 301          */
 302         public function getName() {
 303                 return $this->mSelf;
 304         }
 305
 306         /**
 307          * Return input from stdin.
 308          * @param int $len The number of bytes to read. If null, just return the handle.
 309          *   Maintenance::STDIN_ALL returns the full length
 310          * @return mixed
 311          */
 312         protected function getStdin( $len = null ) {
 313                 if ( $len == Maintenance::STDIN_ALL ) {
 314                         return file_get_contents( 'php://stdin' );
 315                 }
 316                 $f = fopen( 'php://stdin', 'rt' );
 317                 if ( !$len ) {
 318                         return $f;
 319                 }
 320                 $input = fgets( $f, $len );
 321                 fclose( $f );
 322
 323                 return rtrim( $input );
 324         }
 325
 326         /**
 327          * @return bool
 328          */
 329         public function isQuiet() {
 330                 return $this->mQuiet;
 331         }
 332
 333         /**
 334          * Throw some output to the user. Scripts can call this with no fears,
 335          * as we handle all --quiet stuff here
 336          * @param string $out The text to show to the user
 337          * @param mixed $channel Unique identifier for the channel. See function outputChanneled.
 338          */
 339         protected function output( $out, $channel = null ) {
 340                 if ( $this->mQuiet ) {
 341                         return;
 342                 }
 343                 if ( $channel === null ) {
 344                         $this->cleanupChanneled();
 345                         print $out;
 346                 } else {
 347                         $out = preg_replace( '/\n\z/', '', $out );
 348                         $this->outputChanneled( $out, $channel );
 349                 }
 350         }
 351
 352         /**
 353          * Throw an error to the user. Doesn't respect --quiet, so don't use
 354          * this for non-error output
 355          * @param string $err The error to display
 356          * @param int $die If > 0, go ahead and die out using this int as the code
 357          */
 358         protected function error( $err, $die = 0 ) {
 359                 $this->outputChanneled( false );
 360                 if ( PHP_SAPI == 'cli' ) {
 361                         fwrite( STDERR, $err . "\n" );
 362                 } else {
 363                         print $err;
 364                 }
 365                 $die = intval( $die );
 366                 if ( $die > 0 ) {
 367                         die( $die );
 368                 }
 369         }
 370
 371         private $atLineStart = true;
 372         private $lastChannel = null;
 373
 374         /**
 375          * Clean up channeled output.  Output a newline if necessary.
 376          */
 377         public function cleanupChanneled() {
 378                 if ( !$this->atLineStart ) {
 379                         print "\n";
 380                         $this->atLineStart = true;
 381                 }
 382         }
 383
 384         /**
 385          * Message outputter with channeled message support. Messages on the
 386          * same channel are concatenated, but any intervening messages in another
 387          * channel start a new line.
 388          * @param string $msg The message without trailing newline
 389          * @param string $channel Channel identifier or null for no
 390          *     channel. Channel comparison uses ===.
 391          */
 392         public function outputChanneled( $msg, $channel = null ) {
 393                 if ( $msg === false ) {
 394                         $this->cleanupChanneled();
 395
 396                         return;
 397                 }
 398
 399                 // End the current line if necessary
 400                 if ( !$this->atLineStart && $channel !== $this->lastChannel ) {
 401                         print "\n";
 402                 }
 403
 404                 print $msg;
 405
 406                 $this->atLineStart = false;
 407                 if ( $channel === null ) {
 408                         // For unchanneled messages, output trailing newline immediately
 409                         print "\n";
 410                         $this->atLineStart = true;
 411                 }
 412                 $this->lastChannel = $channel;
 413         }
 414
 415         /**
 416          * Does the script need different DB access? By default, we give Maintenance
 417          * scripts normal rights to the DB. Sometimes, a script needs admin rights
 418          * access for a reason and sometimes they want no access. Subclasses should
 419          * override and return one of the following values, as needed:
 420          *    Maintenance::DB_NONE  -  For no DB access at all
 421          *    Maintenance::DB_STD   -  For normal DB access, default
 422          *    Maintenance::DB_ADMIN -  For admin DB access
 423          * @return int
 424          */
 425         public function getDbType() {
 426                 return Maintenance::DB_STD;
 427         }
 428
 429         /**
 430          * Add the default parameters to the scripts
 431          */
 432         protected function addDefaultParams() {
 433
 434                 # Generic (non script dependant) options:
 435
 436                 $this->addOption( 'help', 'Display this help message', false, false, 'h' );
 437                 $this->addOption( 'quiet', 'Whether to supress non-error output', false, false, 'q' );
 438                 $this->addOption( 'conf', 'Location of LocalSettings.php, if not default', false, true );
 439                 $this->addOption( 'wiki', 'For specifying the wiki ID', false, true );
 440                 $this->addOption( 'globals', 'Output globals at the end of processing for debugging' );
 441                 $this->addOption(
 442                         'memory-limit',
 443                         'Set a specific memory limit for the script, '
 444                                 . '"max" for no limit or "default" to avoid changing it'
 445                 );
 446                 $this->addOption( 'server', "The protocol and server name to use in URLs, e.g. " .
 447                         "http://en.wikipedia.org. This is sometimes necessary because " .
 448                         "server name detection may fail in command line scripts.", false, true );
 449                 $this->addOption( 'profiler', 'Profiler output format (usually "text")', false, true );
 450
 451                 # Save generic options to display them separately in help
 452                 $this->mGenericParameters = $this->mParams;
 453
 454                 # Script dependant options:
 455
 456                 // If we support a DB, show the options
 457                 if ( $this->getDbType() > 0 ) {
 458                         $this->addOption( 'dbuser', 'The DB user to use for this script', false, true );
 459                         $this->addOption( 'dbpass', 'The password to use for this script', false, true );
 460                 }
 461
 462                 # Save additional script dependant options to display
 463                 # them separately in help
 464                 $this->mDependantParameters = array_diff_key( $this->mParams, $this->mGenericParameters );
 465         }
 466
 467         /**
 468          * @since 1.24
 469          * @return Config
 470          */
 471         public function getConfig() {
 472                 if ( $this->config === null ) {
 473                         $this->config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
 474                 }
 475
 476                 return $this->config;
 477         }
 478
 479         /**
 480          * @since 1.24
 481          * @param Config $config
 482          */
 483         public function setConfig( Config $config ) {
 484                 $this->config = $config;
 485         }
 486
 487         /**
 488          * Run a child maintenance script. Pass all of the current arguments
 489          * to it.
 490          * @param string $maintClass A name of a child maintenance class
 491          * @param string $classFile Full path of where the child is
 492          * @return Maintenance
 493          */
 494         public function runChild( $maintClass, $classFile = null ) {
 495                 // Make sure the class is loaded first
 496                 if ( !class_exists( $maintClass ) ) {
 497                         if ( $classFile ) {
 498                                 require_once $classFile;
 499                         }
 500                         if ( !class_exists( $maintClass ) ) {
 501                                 $this->error( "Cannot spawn child: $maintClass" );
 502                         }
 503                 }
 504
 505                 /**
 506                  * @var $child Maintenance
 507                  */
 508                 $child = new $maintClass();
 509                 $child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
 510                 if ( !is_null( $this->mDb ) ) {
 511                         $child->setDB( $this->mDb );
 512                 }
 513
 514                 return $child;
 515         }
 516
 517         /**
 518          * Do some sanity checking and basic setup
 519          */
 520         public function setup() {
 521                 global $IP, $wgCommandLineMode, $wgRequestTime;
 522
 523                 # Abort if called from a web server
 524                 if ( isset( $_SERVER ) && isset( $_SERVER['REQUEST_METHOD'] ) ) {
 525                         $this->error( 'This script must be run from the command line', true );
 526                 }
 527
 528                 if ( $IP === null ) {
 529                         $this->error( "\$IP not set, aborting!\n" .
 530                                 '(Did you forget to call parent::__construct() in your maintenance script?)', 1 );
 531                 }
 532
 533                 # Make sure we can handle script parameters
 534                 if ( !defined( 'HPHP_VERSION' ) && !ini_get( 'register_argc_argv' ) ) {
 535                         $this->error( 'Cannot get command line arguments, register_argc_argv is set to false', true );
 536                 }
 537
 538                 // Send PHP warnings and errors to stderr instead of stdout.
 539                 // This aids in diagnosing problems, while keeping messages
 540                 // out of redirected output.
 541                 if ( ini_get( 'display_errors' ) ) {
 542                         ini_set( 'display_errors', 'stderr' );
 543                 }
 544
 545                 $this->loadParamsAndArgs();
 546                 $this->maybeHelp();
 547
 548                 # Set the memory limit
 549                 # Note we need to set it again later in cache LocalSettings changed it
 550                 $this->adjustMemoryLimit();
 551
 552                 # Set max execution time to 0 (no limit). PHP.net says that
 553                 # "When running PHP from the command line the default setting is 0."
 554                 # But sometimes this doesn't seem to be the case.
 555                 ini_set( 'max_execution_time', 0 );
 556
 557                 $wgRequestTime = microtime( true );
 558
 559                 # Define us as being in MediaWiki
 560                 define( 'MEDIAWIKI', true );
 561
 562                 $wgCommandLineMode = true;
 563
 564                 # Turn off output buffering if it's on
 565                 while ( ob_get_level() > 0 ) {
 566                         ob_end_flush();
 567                 }
 568
 569                 $this->validateParamsAndArgs();
 570         }
 571
 572         /**
 573          * Normally we disable the memory_limit when running admin scripts.
 574          * Some scripts may wish to actually set a limit, however, to avoid
 575          * blowing up unexpectedly. We also support a --memory-limit option,
 576          * to allow sysadmins to explicitly set one if they'd prefer to override
 577          * defaults (or for people using Suhosin which yells at you for trying
 578          * to disable the limits)
 579          * @return string
 580          */
 581         public function memoryLimit() {
 582                 $limit = $this->getOption( 'memory-limit', 'max' );
 583                 $limit = trim( $limit, "\" '" ); // trim quotes in case someone misunderstood
 584                 return $limit;
 585         }
 586
 587         /**
 588          * Adjusts PHP's memory limit to better suit our needs, if needed.
 589          */
 590         protected function adjustMemoryLimit() {
 591                 $limit = $this->memoryLimit();
 592                 if ( $limit == 'max' ) {
 593                         $limit = -1; // no memory limit
 594                 }
 595                 if ( $limit != 'default' ) {
 596                         ini_set( 'memory_limit', $limit );
 597                 }
 598         }
 599
 600         /**
 601          * Activate the profiler (assuming $wgProfiler is set)
 602          */
 603         protected function activateProfiler() {
 604                 global $wgProfiler;
 605
 606                 $output = $this->getOption( 'profiler' );
 607                 if ( $output && is_array( $wgProfiler ) ) {
 608                         $class = $wgProfiler['class'];
 609                         $profiler = new $class(
 610                                 array( 'sampling' => 1, 'output' => $output ) + $wgProfiler
 611                         );
 612                         $profiler->setTemplated( true );
 613                         Profiler::replaceStubInstance( $profiler );
 614                 }
 615         }
 616
 617         /**
 618          * Clear all params and arguments.
 619          */
 620         public function clearParamsAndArgs() {
 621                 $this->mOptions = array();
 622                 $this->mArgs = array();
 623                 $this->mInputLoaded = false;
 624         }
 625
 626         /**
 627          * Process command line arguments
 628          * $mOptions becomes an array with keys set to the option names
 629          * $mArgs becomes a zero-based array containing the non-option arguments
 630          *
 631          * @param string $self The name of the script, if any
 632          * @param array $opts An array of options, in form of key=>value
 633          * @param array $args An array of command line arguments
 634          */
 635         public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
 636                 # If we were given opts or args, set those and return early
 637                 if ( $self ) {
 638                         $this->mSelf = $self;
 639                         $this->mInputLoaded = true;
 640                 }
 641                 if ( $opts ) {
 642                         $this->mOptions = $opts;
 643                         $this->mInputLoaded = true;
 644                 }
 645                 if ( $args ) {
 646                         $this->mArgs = $args;
 647                         $this->mInputLoaded = true;
 648                 }
 649
 650                 # If we've already loaded input (either by user values or from $argv)
 651                 # skip on loading it again. The array_shift() will corrupt values if
 652                 # it's run again and again
 653                 if ( $this->mInputLoaded ) {
 654                         $this->loadSpecialVars();
 655
 656                         return;
 657                 }
 658
 659                 global $argv;
 660                 $this->mSelf = array_shift( $argv );
 661
 662                 $options = array();
 663                 $args = array();
 664
 665                 # Parse arguments
 666                 for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
 667                         if ( $arg == '--' ) {
 668                                 # End of options, remainder should be considered arguments
 669                                 $arg = next( $argv );
 670                                 while ( $arg !== false ) {
 671                                         $args[] = $arg;
 672                                         $arg = next( $argv );
 673                                 }
 674                                 break;
 675                         } elseif ( substr( $arg, 0, 2 ) == '--' ) {
 676                                 # Long options
 677                                 $option = substr( $arg, 2 );
 678                                 if ( array_key_exists( $option, $options ) ) {
 679                                         $this->error( "\nERROR: $option parameter given twice\n" );
 680                                         $this->maybeHelp( true );
 681                                 }
 682                                 if ( isset( $this->mParams[$option] ) && $this->mParams[$option]['withArg'] ) {
 683                                         $param = next( $argv );
 684                                         if ( $param === false ) {
 685                                                 $this->error( "\nERROR: $option parameter needs a value after it\n" );
 686                                                 $this->maybeHelp( true );
 687                                         }
 688                                         $options[$option] = $param;
 689                                 } else {
 690                                         $bits = explode( '=', $option, 2 );
 691                                         if ( count( $bits ) > 1 ) {
 692                                                 $option = $bits[0];
 693                                                 $param = $bits[1];
 694                                         } else {
 695                                                 $param = 1;
 696                                         }
 697                                         $options[$option] = $param;
 698                                 }
 699                         } elseif ( substr( $arg, 0, 1 ) == '-' ) {
 700                                 # Short options
 701                                 $argLength = strlen( $arg );
 702                                 for ( $p = 1; $p < $argLength; $p++ ) {
 703                                         $option = $arg[$p];
 704                                         if ( !isset( $this->mParams[$option] ) && isset( $this->mShortParamsMap[$option] ) ) {
 705                                                 $option = $this->mShortParamsMap[$option];
 706                                         }
 707                                         if ( array_key_exists( $option, $options ) ) {
 708                                                 $this->error( "\nERROR: $option parameter given twice\n" );
 709                                                 $this->maybeHelp( true );
 710                                         }
 711                                         if ( isset( $this->mParams[$option]['withArg'] ) && $this->mParams[$option]['withArg'] ) {
 712                                                 $param = next( $argv );
 713                                                 if ( $param === false ) {
 714                                                         $this->error( "\nERROR: $option parameter needs a value after it\n" );
 715                                                         $this->maybeHelp( true );
 716                                                 }
 717                                                 $options[$option] = $param;
 718                                         } else {
 719                                                 $options[$option] = 1;
 720                                         }
 721                                 }
 722                         } else {
 723                                 $args[] = $arg;
 724                         }
 725                 }
 726
 727                 $this->mOptions = $options;
 728                 $this->mArgs = $args;
 729                 $this->loadSpecialVars();
 730                 $this->mInputLoaded = true;
 731         }
 732
 733         /**
 734          * Run some validation checks on the params, etc
 735          */
 736         protected function validateParamsAndArgs() {
 737                 $die = false;
 738                 # Check to make sure we've got all the required options
 739                 foreach ( $this->mParams as $opt => $info ) {
 740                         if ( $info['require'] && !$this->hasOption( $opt ) ) {
 741                                 $this->error( "Param $opt required!" );
 742                                 $die = true;
 743                         }
 744                 }
 745                 # Check arg list too
 746                 foreach ( $this->mArgList as $k => $info ) {
 747                         if ( $info['require'] && !$this->hasArg( $k ) ) {
 748                                 $this->error( 'Argument <' . $info['name'] . '> required!' );
 749                                 $die = true;
 750                         }
 751                 }
 752
 753                 if ( $die ) {
 754                         $this->maybeHelp( true );
 755                 }
 756         }
 757
 758         /**
 759          * Handle the special variables that are global to all scripts
 760          */
 761         protected function loadSpecialVars() {
 762                 if ( $this->hasOption( 'dbuser' ) ) {
 763                         $this->mDbUser = $this->getOption( 'dbuser' );
 764                 }
 765                 if ( $this->hasOption( 'dbpass' ) ) {
 766                         $this->mDbPass = $this->getOption( 'dbpass' );
 767                 }
 768                 if ( $this->hasOption( 'quiet' ) ) {
 769                         $this->mQuiet = true;
 770                 }
 771                 if ( $this->hasOption( 'batch-size' ) ) {
 772                         $this->mBatchSize = intval( $this->getOption( 'batch-size' ) );
 773                 }
 774         }
 775
 776         /**
 777          * Maybe show the help.
 778          * @param bool $force Whether to force the help to show, default false
 779          */
 780         protected function maybeHelp( $force = false ) {
 781                 if ( !$force && !$this->hasOption( 'help' ) ) {
 782                         return;
 783                 }
 784
 785                 $screenWidth = 80; // TODO: Calculate this!
 786                 $tab = "    ";
 787                 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
 788
 789                 ksort( $this->mParams );
 790                 $this->mQuiet = false;
 791
 792                 // Description ...
 793                 if ( $this->mDescription ) {
 794                         $this->output( "\n" . $this->mDescription . "\n" );
 795                 }
 796                 $output = "\nUsage: php " . basename( $this->mSelf );
 797
 798                 // ... append parameters ...
 799                 if ( $this->mParams ) {
 800                         $output .= " [--" . implode( array_keys( $this->mParams ), "|--" ) . "]";
 801                 }
 802
 803                 // ... and append arguments.
 804                 if ( $this->mArgList ) {
 805                         $output .= ' ';
 806                         foreach ( $this->mArgList as $k => $arg ) {
 807                                 if ( $arg['require'] ) {
 808                                         $output .= '<' . $arg['name'] . '>';
 809                                 } else {
 810                                         $output .= '[' . $arg['name'] . ']';
 811                                 }
 812                                 if ( $k < count( $this->mArgList ) - 1 ) {
 813                                         $output .= ' ';
 814                                 }
 815                         }
 816                 }
 817                 $this->output( "$output\n\n" );
 818
 819                 # TODO abstract some repetitive code below
 820
 821                 // Generic parameters
 822                 $this->output( "Generic maintenance parameters:\n" );
 823                 foreach ( $this->mGenericParameters as $par => $info ) {
 824                         if ( $info['shortName'] !== false ) {
 825                                 $par .= " (-{$info['shortName']})";
 826                         }
 827                         $this->output(
 828                                 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
 829                                         "\n$tab$tab" ) . "\n"
 830                         );
 831                 }
 832                 $this->output( "\n" );
 833
 834                 $scriptDependantParams = $this->mDependantParameters;
 835                 if ( count( $scriptDependantParams ) > 0 ) {
 836                         $this->output( "Script dependant parameters:\n" );
 837                         // Parameters description
 838                         foreach ( $scriptDependantParams as $par => $info ) {
 839                                 if ( $info['shortName'] !== false ) {
 840                                         $par .= " (-{$info['shortName']})";
 841                                 }
 842                                 $this->output(
 843                                         wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
 844                                                 "\n$tab$tab" ) . "\n"
 845                                 );
 846                         }
 847                         $this->output( "\n" );
 848                 }
 849
 850                 // Script specific parameters not defined on construction by
 851                 // Maintenance::addDefaultParams()
 852                 $scriptSpecificParams = array_diff_key(
 853                         # all script parameters:
 854                         $this->mParams,
 855                         # remove the Maintenance default parameters:
 856                         $this->mGenericParameters,
 857                         $this->mDependantParameters
 858                 );
 859                 if ( count( $scriptSpecificParams ) > 0 ) {
 860                         $this->output( "Script specific parameters:\n" );
 861                         // Parameters description
 862                         foreach ( $scriptSpecificParams as $par => $info ) {
 863                                 if ( $info['shortName'] !== false ) {
 864                                         $par .= " (-{$info['shortName']})";
 865                                 }
 866                                 $this->output(
 867                                         wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
 868                                                 "\n$tab$tab" ) . "\n"
 869                                 );
 870                         }
 871                         $this->output( "\n" );
 872                 }
 873
 874                 // Print arguments
 875                 if ( count( $this->mArgList ) > 0 ) {
 876                         $this->output( "Arguments:\n" );
 877                         // Arguments description
 878                         foreach ( $this->mArgList as $info ) {
 879                                 $openChar = $info['require'] ? '<' : '[';
 880                                 $closeChar = $info['require'] ? '>' : ']';
 881                                 $this->output(
 882                                         wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
 883                                                 $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
 884                                 );
 885                         }
 886                         $this->output( "\n" );
 887                 }
 888
 889                 die( 1 );
 890         }
 891
 892         /**
 893          * Handle some last-minute setup here.
 894          */
 895         public function finalSetup() {
 896                 global $wgCommandLineMode, $wgShowSQLErrors, $wgServer;
 897                 global $wgDBadminuser, $wgDBadminpassword;
 898                 global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
 899
 900                 # Turn off output buffering again, it might have been turned on in the settings files
 901                 if ( ob_get_level() ) {
 902                         ob_end_flush();
 903                 }
 904                 # Same with these
 905                 $wgCommandLineMode = true;
 906
 907                 # Override $wgServer
 908                 if ( $this->hasOption( 'server' ) ) {
 909                         $wgServer = $this->getOption( 'server', $wgServer );
 910                 }
 911
 912                 # If these were passed, use them
 913                 if ( $this->mDbUser ) {
 914                         $wgDBadminuser = $this->mDbUser;
 915                 }
 916                 if ( $this->mDbPass ) {
 917                         $wgDBadminpassword = $this->mDbPass;
 918                 }
 919
 920                 if ( $this->getDbType() == self::DB_ADMIN && isset( $wgDBadminuser ) ) {
 921                         $wgDBuser = $wgDBadminuser;
 922                         $wgDBpassword = $wgDBadminpassword;
 923
 924                         if ( $wgDBservers ) {
 925                                 /**
 926                                  * @var $wgDBservers array
 927                                  */
 928                                 foreach ( $wgDBservers as $i => $server ) {
 929                                         $wgDBservers[$i]['user'] = $wgDBuser;
 930                                         $wgDBservers[$i]['password'] = $wgDBpassword;
 931                                 }
 932                         }
 933                         if ( isset( $wgLBFactoryConf['serverTemplate'] ) ) {
 934                                 $wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
 935                                 $wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
 936                         }
 937                         LBFactory::destroyInstance();
 938                 }
 939
 940                 // Per-script profiling; useful for debugging
 941                 $this->activateProfiler();
 942
 943                 $this->afterFinalSetup();
 944
 945                 $wgShowSQLErrors = true;
 946
 947                 // @codingStandardsIgnoreStart Allow error suppression. wfSuppressWarnings()
 948                 // is not available.
 949                 @set_time_limit( 0 );
 950                 // @codingStandardsIgnoreStart
 951
 952                 $this->adjustMemoryLimit();
 953         }
 954
 955         /**
 956          * Execute a callback function at the end of initialisation
 957          */
 958         protected function afterFinalSetup() {
 959                 if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
 960                         call_user_func( MW_CMDLINE_CALLBACK );
 961                 }
 962         }
 963
 964         /**
 965          * Potentially debug globals. Originally a feature only
 966          * for refreshLinks
 967          */
 968         public function globals() {
 969                 if ( $this->hasOption( 'globals' ) ) {
 970                         print_r( $GLOBALS );
 971                 }
 972         }
 973
 974         /**
 975          * Generic setup for most installs. Returns the location of LocalSettings
 976          * @return string
 977          */
 978         public function loadSettings() {
 979                 global $wgCommandLineMode, $IP;
 980
 981                 if ( isset( $this->mOptions['conf'] ) ) {
 982                         $settingsFile = $this->mOptions['conf'];
 983                 } elseif ( defined( "MW_CONFIG_FILE" ) ) {
 984                         $settingsFile = MW_CONFIG_FILE;
 985                 } else {
 986                         $settingsFile = "$IP/LocalSettings.php";
 987                 }
 988                 if ( isset( $this->mOptions['wiki'] ) ) {
 989                         $bits = explode( '-', $this->mOptions['wiki'] );
 990                         if ( count( $bits ) == 1 ) {
 991                                 $bits[] = '';
 992                         }
 993                         define( 'MW_DB', $bits[0] );
 994                         define( 'MW_PREFIX', $bits[1] );
 995                 }
 996
 997                 if ( !is_readable( $settingsFile ) ) {
 998                         $this->error( "A copy of your installation's LocalSettings.php\n" .
 999                                 "must exist and be readable in the source directory.\n" .
1000                                 "Use --conf to specify it.", true );
1001                 }
1002                 $wgCommandLineMode = true;
1003
1004                 return $settingsFile;
1005         }
1006
1007         /**
1008          * Support function for cleaning up redundant text records
1009          * @param bool $delete Whether or not to actually delete the records
1010          * @author Rob Church <robchur@gmail.com>
1011          */
1012         public function purgeRedundantText( $delete = true ) {
1013                 # Data should come off the master, wrapped in a transaction
1014                 $dbw = $this->getDB( DB_MASTER );
1015                 $dbw->begin( __METHOD__ );
1016
1017                 # Get "active" text records from the revisions table
1018                 $this->output( 'Searching for active text records in revisions table...' );
1019                 $res = $dbw->select( 'revision', 'rev_text_id', array(), __METHOD__, array( 'DISTINCT' ) );
1020                 foreach ( $res as $row ) {
1021                         $cur[] = $row->rev_text_id;
1022                 }
1023                 $this->output( "done.\n" );
1024
1025                 # Get "active" text records from the archive table
1026                 $this->output( 'Searching for active text records in archive table...' );
1027                 $res = $dbw->select( 'archive', 'ar_text_id', array(), __METHOD__, array( 'DISTINCT' ) );
1028                 foreach ( $res as $row ) {
1029                         # old pre-MW 1.5 records can have null ar_text_id's.
1030                         if ( $row->ar_text_id !== null ) {
1031                                 $cur[] = $row->ar_text_id;
1032                         }
1033                 }
1034                 $this->output( "done.\n" );
1035
1036                 # Get the IDs of all text records not in these sets
1037                 $this->output( 'Searching for inactive text records...' );
1038                 $cond = 'old_id NOT IN ( ' . $dbw->makeList( $cur ) . ' )';
1039                 $res = $dbw->select( 'text', 'old_id', array( $cond ), __METHOD__, array( 'DISTINCT' ) );
1040                 $old = array();
1041                 foreach ( $res as $row ) {
1042                         $old[] = $row->old_id;
1043                 }
1044                 $this->output( "done.\n" );
1045
1046                 # Inform the user of what we're going to do
1047                 $count = count( $old );
1048                 $this->output( "$count inactive items found.\n" );
1049
1050                 # Delete as appropriate
1051                 if ( $delete && $count ) {
1052                         $this->output( 'Deleting...' );
1053                         $dbw->delete( 'text', array( 'old_id' => $old ), __METHOD__ );
1054                         $this->output( "done.\n" );
1055                 }
1056
1057                 # Done
1058                 $dbw->commit( __METHOD__ );
1059         }
1060
1061         /**
1062          * Get the maintenance directory.
1063          * @return string
1064          */
1065         protected function getDir() {
1066                 return __DIR__;
1067         }
1068
1069         /**
1070          * Returns a database to be used by current maintenance script. It can be set by setDB().
1071          * If not set, wfGetDB() will be used.
1072          * This function has the same parameters as wfGetDB()
1073          *
1074          * @return DatabaseBase
1075          */
1076         protected function getDB( $db, $groups = array(), $wiki = false ) {
1077                 if ( is_null( $this->mDb ) ) {
1078                         return wfGetDB( $db, $groups, $wiki );
1079                 } else {
1080                         return $this->mDb;
1081                 }
1082         }
1083
1084         /**
1085          * Sets database object to be returned by getDB().
1086          *
1087          * @param DatabaseBase $db Database object to be used
1088          */
1089         public function setDB( $db ) {
1090                 $this->mDb = $db;
1091         }
1092
1093         /**
1094          * Lock the search index
1095          * @param DatabaseBase &$db
1096          */
1097         private function lockSearchindex( $db ) {
1098                 $write = array( 'searchindex' );
1099                 $read = array( 'page', 'revision', 'text', 'interwiki', 'l10n_cache', 'user' );
1100                 $db->lockTables( $read, $write, __CLASS__ . '::' . __METHOD__ );
1101         }
1102
1103         /**
1104          * Unlock the tables
1105          * @param DatabaseBase &$db
1106          */
1107         private function unlockSearchindex( $db ) {
1108                 $db->unlockTables( __CLASS__ . '::' . __METHOD__ );
1109         }
1110
1111         /**
1112          * Unlock and lock again
1113          * Since the lock is low-priority, queued reads will be able to complete
1114          * @param DatabaseBase &$db
1115          */
1116         private function relockSearchindex( $db ) {
1117                 $this->unlockSearchindex( $db );
1118                 $this->lockSearchindex( $db );
1119         }
1120
1121         /**
1122          * Perform a search index update with locking
1123          * @param int $maxLockTime The maximum time to keep the search index locked.
1124          * @param string $callback The function that will update the function.
1125          * @param DatabaseBase $dbw
1126          * @param array $results
1127          */
1128         public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
1129                 $lockTime = time();
1130
1131                 # Lock searchindex
1132                 if ( $maxLockTime ) {
1133                         $this->output( "   --- Waiting for lock ---" );
1134                         $this->lockSearchindex( $dbw );
1135                         $lockTime = time();
1136                         $this->output( "\n" );
1137                 }
1138
1139                 # Loop through the results and do a search update
1140                 foreach ( $results as $row ) {
1141                         # Allow reads to be processed
1142                         if ( $maxLockTime && time() > $lockTime + $maxLockTime ) {
1143                                 $this->output( "    --- Relocking ---" );
1144                                 $this->relockSearchindex( $dbw );
1145                                 $lockTime = time();
1146                                 $this->output( "\n" );
1147                         }
1148                         call_user_func( $callback, $dbw, $row );
1149                 }
1150
1151                 # Unlock searchindex
1152                 if ( $maxLockTime ) {
1153                         $this->output( "    --- Unlocking --" );
1154                         $this->unlockSearchindex( $dbw );
1155                         $this->output( "\n" );
1156                 }
1157         }
1158
1159         /**
1160          * Update the searchindex table for a given pageid
1161          * @param DatabaseBase $dbw A database write handle
1162          * @param int $pageId The page ID to update.
1163          * @return null|string
1164          */
1165         public function updateSearchIndexForPage( $dbw, $pageId ) {
1166                 // Get current revision
1167                 $rev = Revision::loadFromPageId( $dbw, $pageId );
1168                 $title = null;
1169                 if ( $rev ) {
1170                         $titleObj = $rev->getTitle();
1171                         $title = $titleObj->getPrefixedDBkey();
1172                         $this->output( "$title..." );
1173                         # Update searchindex
1174                         $u = new SearchUpdate( $pageId, $titleObj->getText(), $rev->getContent() );
1175                         $u->doUpdate();
1176                         $this->output( "\n" );
1177                 }
1178
1179                 return $title;
1180         }
1181
1182         /**
1183          * Wrapper for posix_isatty()
1184          * We default as considering stdin a tty (for nice readline methods)
1185          * but treating stout as not a tty to avoid color codes
1186          *
1187          * @param mixed $fd File descriptor
1188          * @return bool
1189          */
1190         public static function posix_isatty( $fd ) {
1191                 if ( !function_exists( 'posix_isatty' ) ) {
1192                         return !$fd;
1193                 } else {
1194                         return posix_isatty( $fd );
1195                 }
1196         }
1197
1198         /**
1199          * Prompt the console for input
1200          * @param string $prompt What to begin the line with, like '> '
1201          * @return string Response
1202          */
1203         public static function readconsole( $prompt = '> ' ) {
1204                 static $isatty = null;
1205                 if ( is_null( $isatty ) ) {
1206                         $isatty = self::posix_isatty( 0 /*STDIN*/ );
1207                 }
1208
1209                 if ( $isatty && function_exists( 'readline' ) ) {
1210                         return readline( $prompt );
1211                 } else {
1212                         if ( $isatty ) {
1213                                 $st = self::readlineEmulation( $prompt );
1214                         } else {
1215                                 if ( feof( STDIN ) ) {
1216                                         $st = false;
1217                                 } else {
1218                                         $st = fgets( STDIN, 1024 );
1219                                 }
1220                         }
1221                         if ( $st === false ) {
1222                                 return false;
1223                         }
1224                         $resp = trim( $st );
1225
1226                         return $resp;
1227                 }
1228         }
1229
1230         /**
1231          * Emulate readline()
1232          * @param string $prompt What to begin the line with, like '> '
1233          * @return string
1234          */
1235         private static function readlineEmulation( $prompt ) {
1236                 $bash = Installer::locateExecutableInDefaultPaths( array( 'bash' ) );
1237                 if ( !wfIsWindows() && $bash ) {
1238                         $retval = false;
1239                         $encPrompt = wfEscapeShellArg( $prompt );
1240                         $command = "read -er -p $encPrompt && echo \"\$REPLY\"";
1241                         $encCommand = wfEscapeShellArg( $command );
1242                         $line = wfShellExec( "$bash -c $encCommand", $retval, array(), array( 'walltime' => 0 ) );
1243
1244                         if ( $retval == 0 ) {
1245                                 return $line;
1246                         } elseif ( $retval == 127 ) {
1247                                 // Couldn't execute bash even though we thought we saw it.
1248                                 // Shell probably spit out an error message, sorry :(
1249                                 // Fall through to fgets()...
1250                         } else {
1251                                 // EOF/ctrl+D
1252                                 return false;
1253                         }
1254                 }
1255
1256                 // Fallback... we'll have no editing controls, EWWW
1257                 if ( feof( STDIN ) ) {
1258                         return false;
1259                 }
1260                 print $prompt;
1261
1262                 return fgets( STDIN, 1024 );
1263         }
1264 }
1265
1266 /**
1267  * Fake maintenance wrapper, mostly used for the web installer/updater
1268  */
1269 class FakeMaintenance extends Maintenance {
1270         protected $mSelf = "FakeMaintenanceScript";
1271
1272         public function execute() {
1273                 return;
1274         }
1275 }
1276
1277 /**
1278  * Class for scripts that perform database maintenance and want to log the
1279  * update in `updatelog` so we can later skip it
1280  */
1281 abstract class LoggedUpdateMaintenance extends Maintenance {
1282         public function __construct() {
1283                 parent::__construct();
1284                 $this->addOption( 'force', 'Run the update even if it was completed already' );
1285                 $this->setBatchSize( 200 );
1286         }
1287
1288         public function execute() {
1289                 $db = $this->getDB( DB_MASTER );
1290                 $key = $this->getUpdateKey();
1291
1292                 if ( !$this->hasOption( 'force' )
1293                         && $db->selectRow( 'updatelog', '1', array( 'ul_key' => $key ), __METHOD__ )
1294                 ) {
1295                         $this->output( "..." . $this->updateSkippedMessage() . "\n" );
1296
1297                         return true;
1298                 }
1299
1300                 if ( !$this->doDBUpdates() ) {
1301                         return false;
1302                 }
1303
1304                 if ( $db->insert( 'updatelog', array( 'ul_key' => $key ), __METHOD__, 'IGNORE' ) ) {
1305                         return true;
1306                 } else {
1307                         $this->output( $this->updatelogFailedMessage() . "\n" );
1308
1309                         return false;
1310                 }
1311         }
1312
1313         /**
1314          * Message to show that the update was done already and was just skipped
1315          * @return string
1316          */
1317         protected function updateSkippedMessage() {
1318                 $key = $this->getUpdateKey();
1319
1320                 return "Update '{$key}' already logged as completed.";
1321         }
1322
1323         /**
1324          * Message to show that the update log was unable to log the completion of this update
1325          * @return string
1326          */
1327         protected function updatelogFailedMessage() {
1328                 $key = $this->getUpdateKey();
1329
1330                 return "Unable to log update '{$key}' as completed.";
1331         }
1332
1333         /**
1334          * Do the actual work. All child classes will need to implement this.
1335          * Return true to log the update as done or false (usually on failure).
1336          * @return bool
1337          */
1338         abstract protected function doDBUpdates();
1339
1340         /**
1341          * Get the update key name to go in the update log table
1342          * @return string
1343          */
1344         abstract protected function getUpdateKey();
1345 }