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