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