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