maintenance/Maintenance.php

   1 <?php
   2 /**
   3  * @file
   4  * @ingroup Maintenance
   5  * @defgroup Maintenance Maintenance
   6  */
   7
   8 // Define this so scripts can easily find doMaintenance.php
   9 define( 'DO_MAINTENANCE', dirname( __FILE__ ) . '/doMaintenance.php' );
  10 $maintClass = false;
  11
  12 // Make sure we're on PHP5 or better
  13 if( version_compare( PHP_VERSION, '5.0.0' ) < 0 ) {
  14         echo( "Sorry! This version of MediaWiki requires PHP 5; you are running " .
  15                 PHP_VERSION . ".\n\n" .
  16                 "If you are sure you already have PHP 5 installed, it may be installed\n" .
  17                 "in a different path from PHP 4. Check with your system administrator.\n" );
  18         die();
  19 }
  20
  21 /**
  22  * Abstract maintenance class for quickly writing and churning out
  23  * maintenance scripts with minimal effort. All that _must_ be defined
  24  * is the execute() method. See docs/maintenance.txt for more info
  25  * and a quick demo of how to use it.
  26  *
  27  * This program is free software; you can redistribute it and/or modify
  28  * it under the terms of the GNU General Public License as published by
  29  * the Free Software Foundation; either version 2 of the License, or
  30  * (at your option) any later version.
  31  *
  32  * This program is distributed in the hope that it will be useful,
  33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  35  * GNU General Public License for more details.
  36  *
  37  * You should have received a copy of the GNU General Public License along
  38  * with this program; if not, write to the Free Software Foundation, Inc.,
  39  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  40  * http://www.gnu.org/copyleft/gpl.html
  41  *
  42  * @author Chad Horohoe <chad@anyonecanedit.org>
  43  * @since 1.16
  44  * @ingroup Maintenance
  45  */
  46 abstract class Maintenance {
  47
  48         /**
  49          * Constants for DB access type
  50          * @see Maintenance::getDbType()
  51          */
  52         const DB_NONE  = 0;
  53         const DB_STD   = 1;
  54         const DB_ADMIN = 2;
  55
  56         // Const for getStdin()
  57         const STDIN_ALL = 'all';
  58
  59         // This is the desired params
  60         protected $mParams = array();
  61
  62         // Array of desired args
  63         protected $mArgList = array();
  64
  65         // This is the list of options that were actually passed
  66         protected $mOptions = array();
  67
  68         // This is the list of arguments that were actually passed
  69         protected $mArgs = array();
  70
  71         // Name of the script currently running
  72         protected $mSelf;
  73
  74         // Special vars for params that are always used
  75         protected $mQuiet = false;
  76         protected $mDbUser, $mDbPass;
  77
  78         // A description of the script, children should change this
  79         protected $mDescription = '';
  80
  81         // Have we already loaded our user input?
  82         protected $mInputLoaded = false;
  83
  84         // Batch size. If a script supports this, they should set
  85         // a default with setBatchSize()
  86         protected $mBatchSize = null;
  87
  88         /**
  89          * List of all the core maintenance scripts. This is added
  90          * to scripts added by extensions in $wgMaintenanceScripts
  91          * and returned by getMaintenanceScripts()
  92          */
  93         protected static $mCoreScripts = null;
  94
  95         /**
  96          * Default constructor. Children should call this if implementing
  97          * their own constructors
  98          */
  99         public function __construct() {
 100                 $this->addDefaultParams();
 101                 register_shutdown_function( array( $this, 'outputChanneled' ), false );
 102         }
 103
 104         /**
 105          * Do the actual work. All child classes will need to implement this
 106          */
 107         abstract public function execute();
 108
 109         /**
 110          * Add a parameter to the script. Will be displayed on --help
 111          * with the associated description
 112          *
 113          * @param $name String The name of the param (help, version, etc)
 114          * @param $description String The description of the param to show on --help
 115          * @param $required boolean Is the param required?
 116          * @param $withArg Boolean Is an argument required with this option?
 117          */
 118         protected function addOption( $name, $description, $required = false, $withArg = false ) {
 119                 $this->mParams[$name] = array( 'desc' => $description, 'require' => $required, 'withArg' => $withArg );
 120         }
 121
 122         /**
 123          * Checks to see if a particular param exists.
 124          * @param $name String The name of the param
 125          * @return boolean
 126          */
 127         protected function hasOption( $name ) {
 128                 return isset( $this->mOptions[$name] );
 129         }
 130
 131         /**
 132          * Get an option, or return the default
 133          * @param $name String The name of the param
 134          * @param $default mixed Anything you want, default null
 135          * @return mixed
 136          */
 137         protected function getOption( $name, $default = null ) {
 138                 if( $this->hasOption( $name ) ) {
 139                         return $this->mOptions[$name];
 140                 } else {
 141                         // Set it so we don't have to provide the default again
 142                         $this->mOptions[$name] = $default;
 143                         return $this->mOptions[$name];
 144                 }
 145         }
 146
 147         /**
 148          * Add some args that are needed
 149          * @param $arg String Name of the arg, like 'start'
 150          * @param $description String Short description of the arg
 151          * @param $required Boolean Is this required?
 152          */
 153         protected function addArg( $arg, $description, $required = true ) {
 154                 $this->mArgList[] = array(
 155                         'name' => $arg,
 156                         'desc' => $description,
 157                         'require' => $required
 158                 );
 159         }
 160
 161         /**
 162          * Does a given argument exist?
 163          * @param $argId int The integer value (from zero) for the arg
 164          * @return boolean
 165          */
 166         protected function hasArg( $argId = 0 ) {
 167                 return isset( $this->mArgs[$argId] );
 168         }
 169
 170         /**
 171          * Get an argument.
 172          * @param $argId int The integer value (from zero) for the arg
 173          * @param $default mixed The default if it doesn't exist
 174          * @return mixed
 175          */
 176         protected function getArg( $argId = 0, $default = null ) {
 177                 return $this->hasArg( $argId ) ? $this->mArgs[$argId] : $default;
 178         }
 179
 180         /**
 181          * Set the batch size.
 182          * @param $s int The number of operations to do in a batch
 183          */
 184         protected function setBatchSize( $s = 0 ) {
 185                 $this->mBatchSize = $s;
 186         }
 187
 188         /**
 189          * Get the script's name
 190          * @return String
 191          */
 192         public function getName() {
 193                 return $this->mSelf;
 194         }
 195
 196         /**
 197          * Return input from stdin.
 198          * @param $length int The number of bytes to read. If null,
 199          *        just return the handle. Maintenance::STDIN_ALL returns
 200          *        the full length
 201          * @return mixed
 202          */
 203         protected function getStdin( $len = null ) {
 204                 if ( $len == Maintenance::STDIN_ALL )
 205                         return file_get_contents( 'php://stdin' );
 206                 $f = fopen( 'php://stdin', 'rt' );
 207                 if( !$len )
 208                         return $f;
 209                 $input = fgets( $f, $len );
 210                 fclose( $f );
 211                 return rtrim( $input );
 212         }
 213
 214         /**
 215          * Throw some output to the user. Scripts can call this with no fears,
 216          * as we handle all --quiet stuff here
 217          * @param $out String The text to show to the user
 218          * @param $channel Mixed Unique identifier for the channel. See function outputChanneled.
 219          */
 220         protected function output( $out, $channel = null ) {
 221                 if( $this->mQuiet ) {
 222                         return;
 223                 }
 224                 if ( $channel === null ) {
 225                         $f = fopen( 'php://stdout', 'w' );
 226                         fwrite( $f, $out );
 227                         fclose( $f );
 228                 }
 229                 else {
 230                         $out = preg_replace( '/\n\z/', '', $out );
 231                         $this->outputChanneled( $out, $channel );
 232                 }
 233         }
 234
 235         /**
 236          * Throw an error to the user. Doesn't respect --quiet, so don't use
 237          * this for non-error output
 238          * @param $err String The error to display
 239          * @param $die boolean If true, go ahead and die out.
 240          */
 241         protected function error( $err, $die = false ) {
 242                 $this->outputChanneled( false );
 243                 if ( php_sapi_name() == 'cli' ) {
 244                         fwrite( STDERR, $err . "\n" );
 245                 } else {
 246                         $f = fopen( 'php://stderr', 'w' );
 247                         fwrite( $f, $err . "\n" );
 248                         fclose( $f );
 249                 }
 250                 if( $die ) die();
 251         }
 252
 253         private $atLineStart = true;
 254         private $lastChannel = null;
 255
 256         /**
 257          * Message outputter with channeled message support. Messages on the
 258          * same channel are concatenated, but any intervening messages in another
 259          * channel start a new line.
 260          * @param $msg String The message without trailing newline
 261          * @param $channel Channel identifier or null for no channel. Channel comparison uses ===.
 262          */
 263         public function outputChanneled( $msg, $channel = null ) {
 264                 $handle = fopen( 'php://stdout', 'w' );
 265
 266                 if ( $msg === false ) {
 267                         // For cleanup
 268                         if ( !$this->atLineStart ) fwrite( $handle, "\n" );
 269                         fclose( $handle );
 270                         return;
 271                 }
 272
 273                 // End the current line if necessary
 274                 if ( !$this->atLineStart && $channel !== $this->lastChannel ) {
 275                         fwrite( $handle, "\n" );
 276                 }
 277
 278                 fwrite( $handle, $msg );
 279
 280                 $this->atLineStart = false;
 281                 if ( $channel === null ) {
 282                         // For unchanneled messages, output trailing newline immediately
 283                         fwrite( $handle, "\n" );
 284                         $this->atLineStart = true;
 285                 }
 286                 $this->lastChannel = $channel;
 287
 288                 // Cleanup handle
 289                 fclose( $handle );
 290         }
 291
 292         /**
 293          * Does the script need different DB access? By default, we give Maintenance
 294          * scripts normal rights to the DB. Sometimes, a script needs admin rights
 295          * access for a reason and sometimes they want no access. Subclasses should
 296          * override and return one of the following values, as needed:
 297          *    Maintenance::DB_NONE  -  For no DB access at all
 298          *    Maintenance::DB_STD   -  For normal DB access, default
 299          *    Maintenance::DB_ADMIN -  For admin DB access
 300          * @return int
 301          */
 302         public function getDbType() {
 303                 return Maintenance::DB_STD;
 304         }
 305
 306         /**
 307          * Add the default parameters to the scripts
 308          */
 309         protected function addDefaultParams() {
 310                 $this->addOption( 'help', "Display this help message" );
 311                 $this->addOption( 'quiet', "Whether to supress non-error output" );
 312                 $this->addOption( 'conf', "Location of LocalSettings.php, if not default", false, true );
 313                 $this->addOption( 'wiki', "For specifying the wiki ID", false, true );
 314                 $this->addOption( 'globals', "Output globals at the end of processing for debugging" );
 315                 // If we support a DB, show the options
 316                 if( $this->getDbType() > 0 ) {
 317                         $this->addOption( 'dbuser', "The DB user to use for this script", false, true );
 318                         $this->addOption( 'dbpass', "The password to use for this script", false, true );
 319                 }
 320                 // If we support $mBatchSize, show the option
 321                 if( $this->mBatchSize ) {
 322                         $this->addOption( 'batch-size', 'Run this many operations ' .
 323                                 'per batch, default: ' . $this->mBatchSize , false, true );
 324                 }
 325         }
 326
 327         /**
 328          * Run a child maintenance script. Pass all of the current arguments
 329          * to it.
 330          * @param $maintClass String A name of a child maintenance class
 331          * @param $classFile String Full path of where the child is
 332          * @return Maintenance child
 333          */
 334         protected function runChild( $maintClass, $classFile = null ) {
 335                 // If we haven't already specified, kill setup procedures
 336                 // for child scripts, we've already got a sane environment
 337                 self::disableSetup();
 338
 339                 // Make sure the class is loaded first
 340                 if( !class_exists( $maintClass ) ) {
 341                         if( $classFile ) {
 342                                 require_once( $classFile );
 343                         }
 344                         if( !class_exists( $maintClass ) ) {
 345                                 $this->error( "Cannot spawn child: $maintClass" );
 346                         }
 347                 }
 348
 349                 $child = new $maintClass();
 350                 $child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
 351                 return $child;
 352         }
 353
 354         /**
 355          * Disable Setup.php mostly
 356          */
 357         protected static function disableSetup() {
 358                 if( !defined( 'MW_NO_SETUP' ) )
 359                         define( 'MW_NO_SETUP', true );
 360         }
 361
 362         /**
 363          * Do some sanity checking and basic setup
 364          */
 365         public function setup() {
 366                 global $IP, $wgCommandLineMode, $wgRequestTime;
 367
 368                 # Abort if called from a web server
 369                 if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
 370                         $this->error( "This script must be run from the command line", true );
 371                 }
 372
 373                 # Make sure we can handle script parameters
 374                 if( !ini_get( 'register_argc_argv' ) ) {
 375                         $this->error( "Cannot get command line arguments, register_argc_argv is set to false", true );
 376                 }
 377
 378                 if( version_compare( phpversion(), '5.2.4' ) >= 0 ) {
 379                         // Send PHP warnings and errors to stderr instead of stdout.
 380                         // This aids in diagnosing problems, while keeping messages
 381                         // out of redirected output.
 382                         if( ini_get( 'display_errors' ) ) {
 383                                 ini_set( 'display_errors', 'stderr' );
 384                         }
 385
 386                         // Don't touch the setting on earlier versions of PHP,
 387                         // as setting it would disable output if you'd wanted it.
 388
 389                         // Note that exceptions are also sent to stderr when
 390                         // command-line mode is on, regardless of PHP version.
 391                 }
 392
 393                 # Set the memory limit
 394                 # Note we need to set it again later in cache LocalSettings changed it
 395                 ini_set( 'memory_limit', $this->memoryLimit() );
 396
 397                 # Set max execution time to 0 (no limit). PHP.net says that
 398                 # "When running PHP from the command line the default setting is 0."
 399                 # But sometimes this doesn't seem to be the case.
 400                 ini_set( 'max_execution_time', 0 );
 401
 402                 $wgRequestTime = microtime( true );
 403
 404                 # Define us as being in MediaWiki
 405                 define( 'MEDIAWIKI', true );
 406
 407                 # Setup $IP, using MW_INSTALL_PATH if it exists
 408                 $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
 409                         ? getenv( 'MW_INSTALL_PATH' )
 410                         : realpath( dirname( __FILE__ ) . '/..' );
 411
 412                 $wgCommandLineMode = true;
 413                 # Turn off output buffering if it's on
 414                 @ob_end_flush();
 415
 416                 $this->loadParamsAndArgs();
 417                 $this->maybeHelp();
 418                 $this->validateParamsAndArgs();
 419         }
 420
 421         /**
 422          * Normally we disable the memory_limit when running admin scripts.
 423          * Some scripts may wish to actually set a limit, however, to avoid
 424          * blowing up unexpectedly.
 425          */
 426         public function memoryLimit() {
 427                 return -1;
 428         }
 429
 430         /**
 431          * Clear all params and arguments.
 432          */
 433         public function clearParamsAndArgs() {
 434                 $this->mOptions = array();
 435                 $this->mArgs = array();
 436                 $this->mInputLoaded = false;
 437         }
 438
 439         /**
 440          * Process command line arguments
 441          * $mOptions becomes an array with keys set to the option names
 442          * $mArgs becomes a zero-based array containing the non-option arguments
 443          *
 444          * @param $self String The name of the script, if any
 445          * @param $opts Array An array of options, in form of key=>value
 446          * @param $args Array An array of command line arguments
 447          */
 448         public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
 449                 # If we were given opts or args, set those and return early
 450                 if( $self ) {
 451                         $this->mSelf = $self;
 452                         $this->mInputLoaded = true;
 453                 }
 454                 if( $opts ) {
 455                         $this->mOptions = $opts;
 456                         $this->mInputLoaded = true;
 457                 }
 458                 if( $args ) {
 459                         $this->mArgs = $args;
 460                         $this->mInputLoaded = true;
 461                 }
 462
 463                 # If we've already loaded input (either by user values or from $argv)
 464                 # skip on loading it again. The array_shift() will corrupt values if
 465                 # it's run again and again
 466                 if( $this->mInputLoaded ) {
 467                         $this->loadSpecialVars();
 468                         return;
 469                 }
 470
 471                 global $argv;
 472                 $this->mSelf = array_shift( $argv );
 473
 474                 $options = array();
 475                 $args = array();
 476
 477                 # Parse arguments
 478                 for( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
 479                         if ( $arg == '--' ) {
 480                                 # End of options, remainder should be considered arguments
 481                                 $arg = next( $argv );
 482                                 while( $arg !== false ) {
 483                                         $args[] = $arg;
 484                                         $arg = next( $argv );
 485                                 }
 486                                 break;
 487                         } elseif ( substr( $arg, 0, 2 ) == '--' ) {
 488                                 # Long options
 489                                 $option = substr( $arg, 2 );
 490                                 if ( isset( $this->mParams[$option] ) && $this->mParams[$option]['withArg'] ) {
 491                                         $param = next( $argv );
 492                                         if ( $param === false ) {
 493                                                 $this->error( "\nERROR: $option needs a value after it\n" );
 494                                                 $this->maybeHelp( true );
 495                                         }
 496                                         $options[$option] = $param;
 497                                 } else {
 498                                         $bits = explode( '=', $option, 2 );
 499                                         if( count( $bits ) > 1 ) {
 500                                                 $option = $bits[0];
 501                                                 $param = $bits[1];
 502                                         } else {
 503                                                 $param = 1;
 504                                         }
 505                                         $options[$option] = $param;
 506                                 }
 507                         } elseif ( substr( $arg, 0, 1 ) == '-' ) {
 508                                 # Short options
 509                                 for ( $p=1; $p<strlen( $arg ); $p++ ) {
 510                                         $option = $arg{$p};
 511                                         if ( isset( $this->mParams[$option]['withArg'] ) && $this->mParams[$option]['withArg'] ) {
 512                                                 $param = next( $argv );
 513                                                 if ( $param === false ) {
 514                                                         $this->error( "\nERROR: $option needs a value after it\n" );
 515                                                         $this->maybeHelp( true );
 516                                                 }
 517                                                 $options[$option] = $param;
 518                                         } else {
 519                                                 $options[$option] = 1;
 520                                         }
 521                                 }
 522                         } else {
 523                                 $args[] = $arg;
 524                         }
 525                 }
 526
 527                 $this->mOptions = $options;
 528                 $this->mArgs = $args;
 529                 $this->loadSpecialVars();
 530                 $this->mInputLoaded = true;
 531         }
 532
 533         /**
 534          * Run some validation checks on the params, etc
 535          */
 536         protected function validateParamsAndArgs() {
 537                 $die = false;
 538                 # Check to make sure we've got all the required options
 539                 foreach( $this->mParams as $opt => $info ) {
 540                         if( $info['require'] && !$this->hasOption( $opt ) ) {
 541                                 $this->error( "Param $opt required!" );
 542                                 $die = true;
 543                         }
 544                 }
 545                 # Check arg list too
 546                 foreach( $this->mArgList as $k => $info ) {
 547                         if( $info['require'] && !$this->hasArg($k) ) {
 548                                 $this->error( "Argument <" . $info['name'] . "> required!" );
 549                                 $die = true;
 550                         }
 551                 }
 552
 553                 if( $die ) $this->maybeHelp( true );
 554         }
 555
 556         /**
 557          * Handle the special variables that are global to all scripts
 558          */
 559         protected function loadSpecialVars() {
 560                 if( $this->hasOption( 'dbuser' ) )
 561                         $this->mDbUser = $this->getOption( 'dbuser' );
 562                 if( $this->hasOption( 'dbpass' ) )
 563                         $this->mDbPass = $this->getOption( 'dbpass' );
 564                 if( $this->hasOption( 'quiet' ) )
 565                         $this->mQuiet = true;
 566                 if( $this->hasOption( 'batch-size' ) )
 567                         $this->mBatchSize = $this->getOption( 'batch-size' );
 568         }
 569
 570         /**
 571          * Maybe show the help.
 572          * @param $force boolean Whether to force the help to show, default false
 573          */
 574         protected function maybeHelp( $force = false ) {
 575                 $screenWidth = 80;      // TODO: Caculate this!
 576                 $tab = "    ";
 577                 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
 578
 579                 ksort( $this->mParams );
 580                 if( $this->hasOption( 'help' ) || $force ) {
 581                         $this->mQuiet = false;
 582
 583                         if( $this->mDescription ) {
 584                                 $this->output( "\n" . $this->mDescription . "\n" );
 585                         }
 586                         $output = "\nUsage: php " . basename( $this->mSelf );
 587                         if( $this->mParams ) {
 588                                 $output .= " [--" . implode( array_keys( $this->mParams ), "|--" ) . "]";
 589                         }
 590                         if( $this->mArgList ) {
 591                                 $output .= " <";
 592                                 foreach( $this->mArgList as $k => $arg ) {
 593                                         $output .= $arg['name'] . ">";
 594                                         if( $k < count( $this->mArgList ) - 1 )
 595                                                 $output .= " <";
 596                                 }
 597                         }
 598                         $this->output( "$output\n" );
 599                         foreach( $this->mParams as $par => $info ) {
 600                                 $this->output( wordwrap( "$tab$par : " . $info['desc'], $descWidth,
 601                                                "\n$tab$tab" ) . "\n" );
 602                         }
 603                         foreach( $this->mArgList as $info ) {
 604                                 $this->output( wordwrap( "$tab<" . $info['name'] . "> : " .
 605                                                $info['desc'], $descWidth, "\n$tab$tab" ) . "\n" );
 606                         }
 607                         die( 1 );
 608                 }
 609         }
 610
 611         /**
 612          * Handle some last-minute setup here.
 613          */
 614         public function finalSetup() {
 615                 global $wgCommandLineMode, $wgShowSQLErrors;
 616                 global $wgTitle, $wgProfiling, $IP, $wgDBadminuser, $wgDBadminpassword;
 617                 global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
 618
 619                 # Turn off output buffering again, it might have been turned on in the settings files
 620                 if( ob_get_level() ) {
 621                         ob_end_flush();
 622                 }
 623                 # Same with these
 624                 $wgCommandLineMode = true;
 625
 626                 # If these were passed, use them
 627                 if( $this->mDbUser )
 628                         $wgDBadminuser = $this->mDbUser;
 629                 if( $this->mDbPass )
 630                         $wgDBadminpassword = $this->mDbPass;
 631
 632                 if ( $this->getDbType() == self::DB_ADMIN && isset( $wgDBadminuser ) ) {
 633                         $wgDBuser = $wgDBadminuser;
 634                         $wgDBpassword = $wgDBadminpassword;
 635
 636                         if( $wgDBservers ) {
 637                                 foreach ( $wgDBservers as $i => $server ) {
 638                                         $wgDBservers[$i]['user'] = $wgDBuser;
 639                                         $wgDBservers[$i]['password'] = $wgDBpassword;
 640                                 }
 641                         }
 642                         if( isset( $wgLBFactoryConf['serverTemplate'] ) ) {
 643                                 $wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
 644                                 $wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
 645                         }
 646                 }
 647
 648                 if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
 649                         $fn = MW_CMDLINE_CALLBACK;
 650                         $fn();
 651                 }
 652
 653                 $wgShowSQLErrors = true;
 654                 @set_time_limit( 0 );
 655                 ini_set( 'memory_limit', $this->memoryLimit() );
 656
 657                 $wgProfiling = false; // only for Profiler.php mode; avoids OOM errors
 658         }
 659
 660         /**
 661          * Potentially debug globals. Originally a feature only
 662          * for refreshLinks
 663          */
 664         public function globals() {
 665                 if( $this->hasOption( 'globals' ) ) {
 666                         print_r( $GLOBALS );
 667                 }
 668         }
 669
 670         /**
 671          * Do setup specific to WMF
 672          */
 673         public function loadWikimediaSettings() {
 674                 global $IP, $wgNoDBParam, $wgUseNormalUser, $wgConf, $site, $lang;
 675
 676                 if ( empty( $wgNoDBParam ) ) {
 677                         # Check if we were passed a db name
 678                         if ( isset( $this->mOptions['wiki'] ) ) {
 679                                 $db = $this->mOptions['wiki'];
 680                         } else {
 681                                 $db = array_shift( $this->mArgs );
 682                         }
 683                         list( $site, $lang ) = $wgConf->siteFromDB( $db );
 684
 685                         # If not, work out the language and site the old way
 686                         if ( is_null( $site ) || is_null( $lang ) ) {
 687                                 if ( !$db ) {
 688                                         $lang = 'aa';
 689                                 } else {
 690                                         $lang = $db;
 691                                 }
 692                                 if ( isset( $this->mArgs[0] ) ) {
 693                                         $site = array_shift( $this->mArgs );
 694                                 } else {
 695                                         $site = 'wikipedia';
 696                                 }
 697                         }
 698                 } else {
 699                         $lang = 'aa';
 700                         $site = 'wikipedia';
 701                 }
 702
 703                 # This is for the IRC scripts, which now run as the apache user
 704                 # The apache user doesn't have access to the wikiadmin_pass command
 705                 if ( $_ENV['USER'] == 'apache' ) {
 706                 #if ( posix_geteuid() == 48 ) {
 707                         $wgUseNormalUser = true;
 708                 }
 709
 710                 putenv( 'wikilang=' . $lang );
 711
 712                 $DP = $IP;
 713                 ini_set( 'include_path', ".:$IP:$IP/includes:$IP/languages:$IP/maintenance" );
 714
 715                 if ( $lang == 'test' && $site == 'wikipedia' ) {
 716                         define( 'TESTWIKI', 1 );
 717                 }
 718         }
 719
 720         /**
 721          * Generic setup for most installs. Returns the location of LocalSettings
 722          * @return String
 723          */
 724         public function loadSettings() {
 725                 global $wgWikiFarm, $wgCommandLineMode, $IP, $DP;
 726
 727                 $wgWikiFarm = false;
 728                 if ( isset( $this->mOptions['conf'] ) ) {
 729                         $settingsFile = $this->mOptions['conf'];
 730                 } else {
 731                         $settingsFile = "$IP/LocalSettings.php";
 732                 }
 733                 if ( isset( $this->mOptions['wiki'] ) ) {
 734                         $bits = explode( '-', $this->mOptions['wiki'] );
 735                         if ( count( $bits ) == 1 ) {
 736                                 $bits[] = '';
 737                         }
 738                         define( 'MW_DB', $bits[0] );
 739                         define( 'MW_PREFIX', $bits[1] );
 740                 }
 741
 742                 if ( !is_readable( $settingsFile ) ) {
 743                         $this->error( "A copy of your installation's LocalSettings.php\n" .
 744                                                 "must exist and be readable in the source directory.", true );
 745                 }
 746                 $wgCommandLineMode = true;
 747                 $DP = $IP;
 748                 return $settingsFile;
 749         }
 750
 751         /**
 752          * Support function for cleaning up redundant text records
 753          * @param $delete boolean Whether or not to actually delete the records
 754          * @author Rob Church <robchur@gmail.com>
 755          */
 756         protected function purgeRedundantText( $delete = true ) {
 757                 # Data should come off the master, wrapped in a transaction
 758                 $dbw = wfGetDB( DB_MASTER );
 759                 $dbw->begin();
 760
 761                 $tbl_arc = $dbw->tableName( 'archive' );
 762                 $tbl_rev = $dbw->tableName( 'revision' );
 763                 $tbl_txt = $dbw->tableName( 'text' );
 764
 765                 # Get "active" text records from the revisions table
 766                 $this->output( "Searching for active text records in revisions table..." );
 767                 $res = $dbw->query( "SELECT DISTINCT rev_text_id FROM $tbl_rev" );
 768                 foreach( $res as $row ) {
 769                         $cur[] = $row->rev_text_id;
 770                 }
 771                 $this->output( "done.\n" );
 772
 773                 # Get "active" text records from the archive table
 774                 $this->output( "Searching for active text records in archive table..." );
 775                 $res = $dbw->query( "SELECT DISTINCT ar_text_id FROM $tbl_arc" );
 776                 foreach( $res as $row ) {
 777                         $cur[] = $row->ar_text_id;
 778                 }
 779                 $this->output( "done.\n" );
 780
 781                 # Get the IDs of all text records not in these sets
 782                 $this->output( "Searching for inactive text records..." );
 783                 $set = implode( ', ', $cur );
 784                 $res = $dbw->query( "SELECT old_id FROM $tbl_txt WHERE old_id NOT IN ( $set )" );
 785                 $old = array();
 786                 foreach( $res as $row ) {
 787                         $old[] = $row->old_id;
 788                 }
 789                 $this->output( "done.\n" );
 790
 791                 # Inform the user of what we're going to do
 792                 $count = count( $old );
 793                 $this->output( "$count inactive items found.\n" );
 794
 795                 # Delete as appropriate
 796                 if( $delete && $count ) {
 797                         $this->output( "Deleting..." );
 798                         $set = implode( ', ', $old );
 799                         $dbw->query( "DELETE FROM $tbl_txt WHERE old_id IN ( $set )" );
 800                         $this->output( "done.\n" );
 801                 }
 802
 803                 # Done
 804                 $dbw->commit();
 805         }
 806
 807         /**
 808          * Get the maintenance directory.
 809          */
 810         protected function getDir() {
 811                 return dirname( __FILE__ );
 812         }
 813
 814         /**
 815          * Get the list of available maintenance scripts. Note
 816          * that if you call this _before_ calling doMaintenance
 817          * you won't have any extensions in it yet
 818          * @return array
 819          */
 820         public static function getMaintenanceScripts() {
 821                 global $wgMaintenanceScripts;
 822                 return $wgMaintenanceScripts + self::getCoreScripts();
 823         }
 824
 825         /**
 826          * Return all of the core maintenance scripts
 827          * @return array
 828          */
 829         protected static function getCoreScripts() {
 830                 if( !self::$mCoreScripts ) {
 831                         self::disableSetup();
 832                         $paths = array(
 833                                 dirname( __FILE__ ),
 834                                 dirname( __FILE__ ) . '/gearman',
 835                                 dirname( __FILE__ ) . '/language',
 836                                 dirname( __FILE__ ) . '/storage',
 837                         );
 838                         self::$mCoreScripts = array();
 839                         foreach( $paths as $p ) {
 840                                 $handle = opendir( $p );
 841                                 while( ( $file = readdir( $handle ) ) !== false ) {
 842                                         if( $file == 'Maintenance.php' )
 843                                                 continue;
 844                                         $file = $p . '/' . $file;
 845                                         if( is_dir( $file ) || !strpos( $file, '.php' ) ||
 846                                                 ( strpos( file_get_contents( $file ), '$maintClass' ) === false ) ) {
 847                                                 continue;
 848                                         }
 849                                         require( $file );
 850                                         $vars = get_defined_vars();
 851                                         if( array_key_exists( 'maintClass', $vars ) ) {
 852                                                 self::$mCoreScripts[$vars['maintClass']] = $file;
 853                                         }
 854                                 }
 855                                 closedir( $handle );
 856                         }
 857                 }
 858                 return self::$mCoreScripts;
 859         }
 860 }