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