includes/libs/rdbms/database/Database.php

   1 <?php
   2 /**
   3  * @defgroup Database Database
   4  *
   5  * This file deals with database interface functions
   6  * and query specifics/optimisations.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Database
  25  */
  26 namespace Wikimedia\Rdbms;
  27
  28 use Psr\Log\LoggerAwareInterface;
  29 use Psr\Log\LoggerInterface;
  30 use Psr\Log\NullLogger;
  31 use Wikimedia\ScopedCallback;
  32 use Wikimedia\Timestamp\ConvertibleTimestamp;
  33 use Wikimedia;
  34 use BagOStuff;
  35 use HashBagOStuff;
  36 use LogicException;
  37 use InvalidArgumentException;
  38 use UnexpectedValueException;
  39 use Exception;
  40 use RuntimeException;
  41
  42 /**
  43  * Relational database abstraction object
  44  *
  45  * @ingroup Database
  46  * @since 1.28
  47  */
  48 abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAwareInterface {
  49         /** Number of times to re-try an operation in case of deadlock */
  50         const DEADLOCK_TRIES = 4;
  51         /** Minimum time to wait before retry, in microseconds */
  52         const DEADLOCK_DELAY_MIN = 500000;
  53         /** Maximum time to wait before retry */
  54         const DEADLOCK_DELAY_MAX = 1500000;
  55
  56         /** How long before it is worth doing a dummy query to test the connection */
  57         const PING_TTL = 1.0;
  58         const PING_QUERY = 'SELECT 1 AS ping';
  59
  60         const TINY_WRITE_SEC = 0.010;
  61         const SLOW_WRITE_SEC = 0.500;
  62         const SMALL_WRITE_ROWS = 100;
  63
  64         /** @var string Whether lock granularity is on the level of the entire database */
  65         const ATTR_DB_LEVEL_LOCKING = 'db-level-locking';
  66
  67         /** @var int New Database instance will not be connected yet when returned */
  68         const NEW_UNCONNECTED = 0;
  69         /** @var int New Database instance will already be connected when returned */
  70         const NEW_CONNECTED = 1;
  71
  72         /** @var string SQL query */
  73         protected $lastQuery = '';
  74         /** @var float|bool UNIX timestamp of last write query */
  75         protected $lastWriteTime = false;
  76         /** @var string|bool */
  77         protected $phpError = false;
  78         /** @var string Server that this instance is currently connected to */
  79         protected $server;
  80         /** @var string User that this instance is currently connected under the name of */
  81         protected $user;
  82         /** @var string Password used to establish the current connection */
  83         protected $password;
  84         /** @var array[] Map of (table => (dbname, schema, prefix) map) */
  85         protected $tableAliases = [];
  86         /** @var string[] Map of (index alias => index) */
  87         protected $indexAliases = [];
  88         /** @var bool Whether this PHP instance is for a CLI script */
  89         protected $cliMode;
  90         /** @var string Agent name for query profiling */
  91         protected $agent;
  92         /** @var array Parameters used by initConnection() to establish a connection */
  93         protected $connectionParams = [];
  94         /** @var BagOStuff APC cache */
  95         protected $srvCache;
  96         /** @var LoggerInterface */
  97         protected $connLogger;
  98         /** @var LoggerInterface */
  99         protected $queryLogger;
 100         /** @var callable Error logging callback */
 101         protected $errorLogger;
 102         /** @var callable Deprecation logging callback */
 103         protected $deprecationLogger;
 104
 105         /** @var resource|null Database connection */
 106         protected $conn = null;
 107         /** @var bool */
 108         protected $opened = false;
 109
 110         /** @var array[] List of (callable, method name, atomic section id) */
 111         protected $trxIdleCallbacks = [];
 112         /** @var array[] List of (callable, method name, atomic section id) */
 113         protected $trxPreCommitCallbacks = [];
 114         /** @var array[] List of (callable, method name, atomic section id) */
 115         protected $trxEndCallbacks = [];
 116         /** @var callable[] Map of (name => callable) */
 117         protected $trxRecurringCallbacks = [];
 118         /** @var bool Whether to suppress triggering of transaction end callbacks */
 119         protected $trxEndCallbacksSuppressed = false;
 120
 121         /** @var int */
 122         protected $flags;
 123         /** @var array */
 124         protected $lbInfo = [];
 125         /** @var array|bool */
 126         protected $schemaVars = false;
 127         /** @var array */
 128         protected $sessionVars = [];
 129         /** @var array|null */
 130         protected $preparedArgs;
 131         /** @var string|bool|null Stashed value of html_errors INI setting */
 132         protected $htmlErrors;
 133         /** @var string */
 134         protected $delimiter = ';';
 135         /** @var DatabaseDomain */
 136         protected $currentDomain;
 137         /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
 138         protected $affectedRowCount;
 139
 140         /**
 141          * @var int Transaction status
 142          */
 143         protected $trxStatus = self::STATUS_TRX_NONE;
 144         /**
 145          * @var Exception|null The last error that caused the status to become STATUS_TRX_ERROR
 146          */
 147         protected $trxStatusCause;
 148         /**
 149          * @var array|null If wasKnownStatementRollbackError() prevented trxStatus from being set,
 150          *  the relevant details are stored here.
 151          */
 152         protected $trxStatusIgnoredCause;
 153         /**
 154          * Either 1 if a transaction is active or 0 otherwise.
 155          * The other Trx fields may not be meaningfull if this is 0.
 156          *
 157          * @var int
 158          */
 159         protected $trxLevel = 0;
 160         /**
 161          * Either a short hexidecimal string if a transaction is active or ""
 162          *
 163          * @var string
 164          * @see Database::trxLevel
 165          */
 166         protected $trxShortId = '';
 167         /**
 168          * The UNIX time that the transaction started. Callers can assume that if
 169          * snapshot isolation is used, then the data is *at least* up to date to that
 170          * point (possibly more up-to-date since the first SELECT defines the snapshot).
 171          *
 172          * @var float|null
 173          * @see Database::trxLevel
 174          */
 175         private $trxTimestamp = null;
 176         /** @var float Lag estimate at the time of BEGIN */
 177         private $trxReplicaLag = null;
 178         /**
 179          * Remembers the function name given for starting the most recent transaction via begin().
 180          * Used to provide additional context for error reporting.
 181          *
 182          * @var string
 183          * @see Database::trxLevel
 184          */
 185         private $trxFname = null;
 186         /**
 187          * Record if possible write queries were done in the last transaction started
 188          *
 189          * @var bool
 190          * @see Database::trxLevel
 191          */
 192         private $trxDoneWrites = false;
 193         /**
 194          * Record if the current transaction was started implicitly due to DBO_TRX being set.
 195          *
 196          * @var bool
 197          * @see Database::trxLevel
 198          */
 199         private $trxAutomatic = false;
 200         /**
 201          * Counter for atomic savepoint identifiers. Reset when a new transaction begins.
 202          *
 203          * @var int
 204          */
 205         private $trxAtomicCounter = 0;
 206         /**
 207          * Array of levels of atomicity within transactions
 208          *
 209          * @var array List of (name, unique ID, savepoint ID)
 210          */
 211         private $trxAtomicLevels = [];
 212         /**
 213          * Record if the current transaction was started implicitly by Database::startAtomic
 214          *
 215          * @var bool
 216          */
 217         private $trxAutomaticAtomic = false;
 218         /**
 219          * Track the write query callers of the current transaction
 220          *
 221          * @var string[]
 222          */
 223         private $trxWriteCallers = [];
 224         /**
 225          * @var float Seconds spent in write queries for the current transaction
 226          */
 227         private $trxWriteDuration = 0.0;
 228         /**
 229          * @var int Number of write queries for the current transaction
 230          */
 231         private $trxWriteQueryCount = 0;
 232         /**
 233          * @var int Number of rows affected by write queries for the current transaction
 234          */
 235         private $trxWriteAffectedRows = 0;
 236         /**
 237          * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
 238          */
 239         private $trxWriteAdjDuration = 0.0;
 240         /**
 241          * @var int Number of write queries counted in trxWriteAdjDuration
 242          */
 243         private $trxWriteAdjQueryCount = 0;
 244         /**
 245          * @var float RTT time estimate
 246          */
 247         private $rttEstimate = 0.0;
 248
 249         /** @var array Map of (name => 1) for locks obtained via lock() */
 250         private $namedLocksHeld = [];
 251         /** @var array Map of (table name => 1) for TEMPORARY tables */
 252         protected $sessionTempTables = [];
 253
 254         /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
 255         private $lazyMasterHandle;
 256
 257         /** @var float UNIX timestamp */
 258         protected $lastPing = 0.0;
 259
 260         /** @var int[] Prior flags member variable values */
 261         private $priorFlags = [];
 262
 263         /** @var mixed Class name or object With profileIn/profileOut methods */
 264         protected $profiler;
 265         /** @var TransactionProfiler */
 266         protected $trxProfiler;
 267
 268         /** @var int */
 269         protected $nonNativeInsertSelectBatchSize = 10000;
 270
 271         /** @var string Idiom used when a cancelable atomic section started the transaction */
 272         private static $NOT_APPLICABLE = 'n/a';
 273         /** @var string Prefix to the atomic section counter used to make savepoint IDs */
 274         private static $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic';
 275
 276         /** @var int Transaction is in a error state requiring a full or savepoint rollback */
 277         const STATUS_TRX_ERROR = 1;
 278         /** @var int Transaction is active and in a normal state */
 279         const STATUS_TRX_OK = 2;
 280         /** @var int No transaction is active */
 281         const STATUS_TRX_NONE = 3;
 282
 283         /**
 284          * @note exceptions for missing libraries/drivers should be thrown in initConnection()
 285          * @param array $params Parameters passed from Database::factory()
 286          */
 287         protected function __construct( array $params ) {
 288                 foreach ( [ 'host', 'user', 'password', 'dbname', 'schema', 'tablePrefix' ] as $name ) {
 289                         $this->connectionParams[$name] = $params[$name];
 290                 }
 291
 292                 $this->cliMode = $params['cliMode'];
 293                 // Agent name is added to SQL queries in a comment, so make sure it can't break out
 294                 $this->agent = str_replace( '/', '-', $params['agent'] );
 295
 296                 $this->flags = $params['flags'];
 297                 if ( $this->flags & self::DBO_DEFAULT ) {
 298                         if ( $this->cliMode ) {
 299                                 $this->flags &= ~self::DBO_TRX;
 300                         } else {
 301                                 $this->flags |= self::DBO_TRX;
 302                         }
 303                 }
 304                 // Disregard deprecated DBO_IGNORE flag (T189999)
 305                 $this->flags &= ~self::DBO_IGNORE;
 306
 307                 $this->sessionVars = $params['variables'];
 308
 309                 $this->srvCache = $params['srvCache'] ?? new HashBagOStuff();
 310
 311                 $this->profiler = $params['profiler'];
 312                 $this->trxProfiler = $params['trxProfiler'];
 313                 $this->connLogger = $params['connLogger'];
 314                 $this->queryLogger = $params['queryLogger'];
 315                 $this->errorLogger = $params['errorLogger'];
 316                 $this->deprecationLogger = $params['deprecationLogger'];
 317
 318                 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
 319                         $this->nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'];
 320                 }
 321
 322                 // Set initial dummy domain until open() sets the final DB/prefix
 323                 $this->currentDomain = new DatabaseDomain(
 324                         $params['dbname'] != '' ? $params['dbname'] : null,
 325                         $params['schema'] != '' ? $params['schema'] : null,
 326                         $params['tablePrefix']
 327                 );
 328         }
 329
 330         /**
 331          * Initialize the connection to the database over the wire (or to local files)
 332          *
 333          * @throws LogicException
 334          * @throws InvalidArgumentException
 335          * @throws DBConnectionError
 336          * @since 1.31
 337          */
 338         final public function initConnection() {
 339                 if ( $this->isOpen() ) {
 340                         throw new LogicException( __METHOD__ . ': already connected.' );
 341                 }
 342                 // Establish the connection
 343                 $this->doInitConnection();
 344         }
 345
 346         /**
 347          * Actually connect to the database over the wire (or to local files)
 348          *
 349          * @throws InvalidArgumentException
 350          * @throws DBConnectionError
 351          * @since 1.31
 352          */
 353         protected function doInitConnection() {
 354                 if ( strlen( $this->connectionParams['user'] ) ) {
 355                         $this->open(
 356                                 $this->connectionParams['host'],
 357                                 $this->connectionParams['user'],
 358                                 $this->connectionParams['password'],
 359                                 $this->connectionParams['dbname'],
 360                                 $this->connectionParams['schema'],
 361                                 $this->connectionParams['tablePrefix']
 362                         );
 363                 } else {
 364                         throw new InvalidArgumentException( "No database user provided." );
 365                 }
 366         }
 367
 368         /**
 369          * Open a new connection to the database (closing any existing one)
 370          *
 371          * @param string $server Database server host
 372          * @param string $user Database user name
 373          * @param string $password Database user password
 374          * @param string $dbName Database name
 375          * @param string|null $schema Database schema name
 376          * @param string $tablePrefix Table prefix
 377          * @return bool
 378          * @throws DBConnectionError
 379          */
 380         abstract protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix );
 381
 382         /**
 383          * Construct a Database subclass instance given a database type and parameters
 384          *
 385          * This also connects to the database immediately upon object construction
 386          *
 387          * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
 388          * @param array $p Parameter map with keys:
 389          *   - host : The hostname of the DB server
 390          *   - user : The name of the database user the client operates under
 391          *   - password : The password for the database user
 392          *   - dbname : The name of the database to use where queries do not specify one.
 393          *      The database must exist or an error might be thrown. Setting this to the empty string
 394          *      will avoid any such errors and make the handle have no implicit database scope. This is
 395          *      useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
 396          *      "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
 397          *      in which user names and such are defined, e.g. users are database-specific in Postgres.
 398          *   - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
 399          *      equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
 400          *   - tablePrefix : Optional table prefix that is implicitly added on to all table names
 401          *      recognized in queries. This can be used in place of schemas for handle site farms.
 402          *   - flags : Optional bitfield of DBO_* constants that define connection, protocol,
 403          *      buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
 404          *      flag in place UNLESS this this database simply acts as a key/value store.
 405          *   - driver: Optional name of a specific DB client driver. For MySQL, there is only the
 406          *      'mysqli' driver; the old one 'mysql' has been removed.
 407          *   - variables: Optional map of session variables to set after connecting. This can be
 408          *      used to adjust lock timeouts or encoding modes and the like.
 409          *   - connLogger: Optional PSR-3 logger interface instance.
 410          *   - queryLogger: Optional PSR-3 logger interface instance.
 411          *   - profiler: Optional class name or object with profileIn()/profileOut() methods.
 412          *      These will be called in query(), using a simplified version of the SQL that also
 413          *      includes the agent as a SQL comment.
 414          *   - trxProfiler: Optional TransactionProfiler instance.
 415          *   - errorLogger: Optional callback that takes an Exception and logs it.
 416          *   - deprecationLogger: Optional callback that takes a string and logs it.
 417          *   - cliMode: Whether to consider the execution context that of a CLI script.
 418          *   - agent: Optional name used to identify the end-user in query profiling/logging.
 419          *   - srvCache: Optional BagOStuff instance to an APC-style cache.
 420          *   - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
 421          * @param int $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
 422          * @return Database|null If the database driver or extension cannot be found
 423          * @throws InvalidArgumentException If the database driver or extension cannot be found
 424          * @since 1.18
 425          */
 426         final public static function factory( $dbType, $p = [], $connect = self::NEW_CONNECTED ) {
 427                 $class = self::getClass( $dbType, $p['driver'] ?? null );
 428
 429                 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase::class ) ) {
 430                         // Resolve some defaults for b/c
 431                         $p['host'] = $p['host'] ?? false;
 432                         $p['user'] = $p['user'] ?? false;
 433                         $p['password'] = $p['password'] ?? false;
 434                         $p['dbname'] = $p['dbname'] ?? false;
 435                         $p['flags'] = $p['flags'] ?? 0;
 436                         $p['variables'] = $p['variables'] ?? [];
 437                         $p['tablePrefix'] = $p['tablePrefix'] ?? '';
 438                         $p['schema'] = $p['schema'] ?? null;
 439                         $p['cliMode'] = $p['cliMode'] ?? ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' );
 440                         $p['agent'] = $p['agent'] ?? '';
 441                         if ( !isset( $p['connLogger'] ) ) {
 442                                 $p['connLogger'] = new NullLogger();
 443                         }
 444                         if ( !isset( $p['queryLogger'] ) ) {
 445                                 $p['queryLogger'] = new NullLogger();
 446                         }
 447                         $p['profiler'] = $p['profiler'] ?? null;
 448                         if ( !isset( $p['trxProfiler'] ) ) {
 449                                 $p['trxProfiler'] = new TransactionProfiler();
 450                         }
 451                         if ( !isset( $p['errorLogger'] ) ) {
 452                                 $p['errorLogger'] = function ( Exception $e ) {
 453                                         trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING );
 454                                 };
 455                         }
 456                         if ( !isset( $p['deprecationLogger'] ) ) {
 457                                 $p['deprecationLogger'] = function ( $msg ) {
 458                                         trigger_error( $msg, E_USER_DEPRECATED );
 459                                 };
 460                         }
 461
 462                         /** @var Database $conn */
 463                         $conn = new $class( $p );
 464                         if ( $connect == self::NEW_CONNECTED ) {
 465                                 $conn->initConnection();
 466                         }
 467                 } else {
 468                         $conn = null;
 469                 }
 470
 471                 return $conn;
 472         }
 473
 474         /**
 475          * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
 476          * @param string|null $driver Optional name of a specific DB client driver
 477          * @return array Map of (Database::ATTRIBUTE_* constant => value) for all such constants
 478          * @throws InvalidArgumentException
 479          * @since 1.31
 480          */
 481         final public static function attributesFromType( $dbType, $driver = null ) {
 482                 static $defaults = [ self::ATTR_DB_LEVEL_LOCKING => false ];
 483
 484                 $class = self::getClass( $dbType, $driver );
 485
 486                 return call_user_func( [ $class, 'getAttributes' ] ) + $defaults;
 487         }
 488
 489         /**
 490          * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
 491          * @param string|null $driver Optional name of a specific DB client driver
 492          * @return string Database subclass name to use
 493          * @throws InvalidArgumentException
 494          */
 495         private static function getClass( $dbType, $driver = null ) {
 496                 // For database types with built-in support, the below maps type to IDatabase
 497                 // implementations. For types with multipe driver implementations (PHP extensions),
 498                 // an array can be used, keyed by extension name. In case of an array, the
 499                 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
 500                 // we auto-detect the first available driver. For types without built-in support,
 501                 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
 502                 static $builtinTypes = [
 503                         'mssql' => DatabaseMssql::class,
 504                         'mysql' => [ 'mysqli' => DatabaseMysqli::class ],
 505                         'sqlite' => DatabaseSqlite::class,
 506                         'postgres' => DatabasePostgres::class,
 507                 ];
 508
 509                 $dbType = strtolower( $dbType );
 510                 $class = false;
 511
 512                 if ( isset( $builtinTypes[$dbType] ) ) {
 513                         $possibleDrivers = $builtinTypes[$dbType];
 514                         if ( is_string( $possibleDrivers ) ) {
 515                                 $class = $possibleDrivers;
 516                         } else {
 517                                 if ( (string)$driver !== '' ) {
 518                                         if ( !isset( $possibleDrivers[$driver] ) ) {
 519                                                 throw new InvalidArgumentException( __METHOD__ .
 520                                                         " type '$dbType' does not support driver '{$driver}'" );
 521                                         } else {
 522                                                 $class = $possibleDrivers[$driver];
 523                                         }
 524                                 } else {
 525                                         foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
 526                                                 if ( extension_loaded( $posDriver ) ) {
 527                                                         $class = $possibleClass;
 528                                                         break;
 529                                                 }
 530                                         }
 531                                 }
 532                         }
 533                 } else {
 534                         $class = 'Database' . ucfirst( $dbType );
 535                 }
 536
 537                 if ( $class === false ) {
 538                         throw new InvalidArgumentException( __METHOD__ .
 539                                 " no viable database extension found for type '$dbType'" );
 540                 }
 541
 542                 return $class;
 543         }
 544
 545         /**
 546          * @return array Map of (Database::ATTRIBUTE_* constant => value
 547          * @since 1.31
 548          */
 549         protected static function getAttributes() {
 550                 return [];
 551         }
 552
 553         /**
 554          * Set the PSR-3 logger interface to use for query logging. (The logger
 555          * interfaces for connection logging and error logging can be set with the
 556          * constructor.)
 557          *
 558          * @param LoggerInterface $logger
 559          */
 560         public function setLogger( LoggerInterface $logger ) {
 561                 $this->queryLogger = $logger;
 562         }
 563
 564         public function getServerInfo() {
 565                 return $this->getServerVersion();
 566         }
 567
 568         public function bufferResults( $buffer = null ) {
 569                 $res = !$this->getFlag( self::DBO_NOBUFFER );
 570                 if ( $buffer !== null ) {
 571                         $buffer
 572                                 ? $this->clearFlag( self::DBO_NOBUFFER )
 573                                 : $this->setFlag( self::DBO_NOBUFFER );
 574                 }
 575
 576                 return $res;
 577         }
 578
 579         public function trxLevel() {
 580                 return $this->trxLevel;
 581         }
 582
 583         public function trxTimestamp() {
 584                 return $this->trxLevel ? $this->trxTimestamp : null;
 585         }
 586
 587         /**
 588          * @return int One of the STATUS_TRX_* class constants
 589          * @since 1.31
 590          */
 591         public function trxStatus() {
 592                 return $this->trxStatus;
 593         }
 594
 595         public function tablePrefix( $prefix = null ) {
 596                 $old = $this->currentDomain->getTablePrefix();
 597                 if ( $prefix !== null ) {
 598                         $this->currentDomain = new DatabaseDomain(
 599                                 $this->currentDomain->getDatabase(),
 600                                 $this->currentDomain->getSchema(),
 601                                 $prefix
 602                         );
 603                 }
 604
 605                 return $old;
 606         }
 607
 608         public function dbSchema( $schema = null ) {
 609                 $old = $this->currentDomain->getSchema();
 610                 if ( $schema !== null ) {
 611                         $this->currentDomain = new DatabaseDomain(
 612                                 $this->currentDomain->getDatabase(),
 613                                 // DatabaseDomain uses null for unspecified schemas
 614                                 strlen( $schema ) ? $schema : null,
 615                                 $this->currentDomain->getTablePrefix()
 616                         );
 617                 }
 618
 619                 return (string)$old;
 620         }
 621
 622         /**
 623          * @return string Schema to use to qualify relations in queries
 624          */
 625         protected function relationSchemaQualifier() {
 626                 return $this->dbSchema();
 627         }
 628
 629         public function getLBInfo( $name = null ) {
 630                 if ( is_null( $name ) ) {
 631                         return $this->lbInfo;
 632                 } else {
 633                         if ( array_key_exists( $name, $this->lbInfo ) ) {
 634                                 return $this->lbInfo[$name];
 635                         } else {
 636                                 return null;
 637                         }
 638                 }
 639         }
 640
 641         public function setLBInfo( $name, $value = null ) {
 642                 if ( is_null( $value ) ) {
 643                         $this->lbInfo = $name;
 644                 } else {
 645                         $this->lbInfo[$name] = $value;
 646                 }
 647         }
 648
 649         public function setLazyMasterHandle( IDatabase $conn ) {
 650                 $this->lazyMasterHandle = $conn;
 651         }
 652
 653         /**
 654          * @return IDatabase|null
 655          * @see setLazyMasterHandle()
 656          * @since 1.27
 657          */
 658         protected function getLazyMasterHandle() {
 659                 return $this->lazyMasterHandle;
 660         }
 661
 662         public function implicitGroupby() {
 663                 return true;
 664         }
 665
 666         public function implicitOrderby() {
 667                 return true;
 668         }
 669
 670         public function lastQuery() {
 671                 return $this->lastQuery;
 672         }
 673
 674         public function doneWrites() {
 675                 return (bool)$this->lastWriteTime;
 676         }
 677
 678         public function lastDoneWrites() {
 679                 return $this->lastWriteTime ?: false;
 680         }
 681
 682         public function writesPending() {
 683                 return $this->trxLevel && $this->trxDoneWrites;
 684         }
 685
 686         public function writesOrCallbacksPending() {
 687                 return $this->trxLevel && (
 688                         $this->trxDoneWrites ||
 689                         $this->trxIdleCallbacks ||
 690                         $this->trxPreCommitCallbacks ||
 691                         $this->trxEndCallbacks
 692                 );
 693         }
 694
 695         public function preCommitCallbacksPending() {
 696                 return $this->trxLevel && $this->trxPreCommitCallbacks;
 697         }
 698
 699         /**
 700          * @return string|null
 701          */
 702         final protected function getTransactionRoundId() {
 703                 // If transaction round participation is enabled, see if one is active
 704                 if ( $this->getFlag( self::DBO_TRX ) ) {
 705                         $id = $this->getLBInfo( 'trxRoundId' );
 706
 707                         return is_string( $id ) ? $id : null;
 708                 }
 709
 710                 return null;
 711         }
 712
 713         public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
 714                 if ( !$this->trxLevel ) {
 715                         return false;
 716                 } elseif ( !$this->trxDoneWrites ) {
 717                         return 0.0;
 718                 }
 719
 720                 switch ( $type ) {
 721                         case self::ESTIMATE_DB_APPLY:
 722                                 return $this->pingAndCalculateLastTrxApplyTime();
 723                         default: // everything
 724                                 return $this->trxWriteDuration;
 725                 }
 726         }
 727
 728         /**
 729          * @return float Time to apply writes to replicas based on trxWrite* fields
 730          */
 731         private function pingAndCalculateLastTrxApplyTime() {
 732                 $this->ping( $rtt );
 733
 734                 $rttAdjTotal = $this->trxWriteAdjQueryCount * $rtt;
 735                 $applyTime = max( $this->trxWriteAdjDuration - $rttAdjTotal, 0 );
 736                 // For omitted queries, make them count as something at least
 737                 $omitted = $this->trxWriteQueryCount - $this->trxWriteAdjQueryCount;
 738                 $applyTime += self::TINY_WRITE_SEC * $omitted;
 739
 740                 return $applyTime;
 741         }
 742
 743         public function pendingWriteCallers() {
 744                 return $this->trxLevel ? $this->trxWriteCallers : [];
 745         }
 746
 747         public function pendingWriteRowsAffected() {
 748                 return $this->trxWriteAffectedRows;
 749         }
 750
 751         /**
 752          * List the methods that have write queries or callbacks for the current transaction
 753          *
 754          * This method should not be used outside of Database/LoadBalancer
 755          *
 756          * @return string[]
 757          * @since 1.32
 758          */
 759         public function pendingWriteAndCallbackCallers() {
 760                 $fnames = $this->pendingWriteCallers();
 761                 foreach ( [
 762                         $this->trxIdleCallbacks,
 763                         $this->trxPreCommitCallbacks,
 764                         $this->trxEndCallbacks
 765                 ] as $callbacks ) {
 766                         foreach ( $callbacks as $callback ) {
 767                                 $fnames[] = $callback[1];
 768                         }
 769                 }
 770
 771                 return $fnames;
 772         }
 773
 774         /**
 775          * @return string
 776          */
 777         private function flatAtomicSectionList() {
 778                 return array_reduce( $this->trxAtomicLevels, function ( $accum, $v ) {
 779                         return $accum === null ? $v[0] : "$accum, " . $v[0];
 780                 } );
 781         }
 782
 783         public function isOpen() {
 784                 return $this->opened;
 785         }
 786
 787         public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 788                 if ( ( $flag & self::DBO_IGNORE ) ) {
 789                         throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
 790                 }
 791
 792                 if ( $remember === self::REMEMBER_PRIOR ) {
 793                         array_push( $this->priorFlags, $this->flags );
 794                 }
 795                 $this->flags |= $flag;
 796         }
 797
 798         public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 799                 if ( ( $flag & self::DBO_IGNORE ) ) {
 800                         throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
 801                 }
 802
 803                 if ( $remember === self::REMEMBER_PRIOR ) {
 804                         array_push( $this->priorFlags, $this->flags );
 805                 }
 806                 $this->flags &= ~$flag;
 807         }
 808
 809         public function restoreFlags( $state = self::RESTORE_PRIOR ) {
 810                 if ( !$this->priorFlags ) {
 811                         return;
 812                 }
 813
 814                 if ( $state === self::RESTORE_INITIAL ) {
 815                         $this->flags = reset( $this->priorFlags );
 816                         $this->priorFlags = [];
 817                 } else {
 818                         $this->flags = array_pop( $this->priorFlags );
 819                 }
 820         }
 821
 822         public function getFlag( $flag ) {
 823                 return (bool)( $this->flags & $flag );
 824         }
 825
 826         /**
 827          * @param string $name Class field name
 828          * @return mixed
 829          * @deprecated Since 1.28
 830          */
 831         public function getProperty( $name ) {
 832                 return $this->$name;
 833         }
 834
 835         public function getDomainID() {
 836                 return $this->currentDomain->getId();
 837         }
 838
 839         final public function getWikiID() {
 840                 return $this->getDomainID();
 841         }
 842
 843         /**
 844          * Get information about an index into an object
 845          * @param string $table Table name
 846          * @param string $index Index name
 847          * @param string $fname Calling function name
 848          * @return mixed Database-specific index description class or false if the index does not exist
 849          */
 850         abstract function indexInfo( $table, $index, $fname = __METHOD__ );
 851
 852         /**
 853          * Wrapper for addslashes()
 854          *
 855          * @param string $s String to be slashed.
 856          * @return string Slashed string.
 857          */
 858         abstract function strencode( $s );
 859
 860         /**
 861          * Set a custom error handler for logging errors during database connection
 862          */
 863         protected function installErrorHandler() {
 864                 $this->phpError = false;
 865                 $this->htmlErrors = ini_set( 'html_errors', '0' );
 866                 set_error_handler( [ $this, 'connectionErrorLogger' ] );
 867         }
 868
 869         /**
 870          * Restore the previous error handler and return the last PHP error for this DB
 871          *
 872          * @return bool|string
 873          */
 874         protected function restoreErrorHandler() {
 875                 restore_error_handler();
 876                 if ( $this->htmlErrors !== false ) {
 877                         ini_set( 'html_errors', $this->htmlErrors );
 878                 }
 879
 880                 return $this->getLastPHPError();
 881         }
 882
 883         /**
 884          * @return string|bool Last PHP error for this DB (typically connection errors)
 885          */
 886         protected function getLastPHPError() {
 887                 if ( $this->phpError ) {
 888                         $error = preg_replace( '!\[<a.*</a>\]!', '', $this->phpError );
 889                         $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
 890
 891                         return $error;
 892                 }
 893
 894                 return false;
 895         }
 896
 897         /**
 898          * Error handler for logging errors during database connection
 899          * This method should not be used outside of Database classes
 900          *
 901          * @param int $errno
 902          * @param string $errstr
 903          */
 904         public function connectionErrorLogger( $errno, $errstr ) {
 905                 $this->phpError = $errstr;
 906         }
 907
 908         /**
 909          * Create a log context to pass to PSR-3 logger functions.
 910          *
 911          * @param array $extras Additional data to add to context
 912          * @return array
 913          */
 914         protected function getLogContext( array $extras = [] ) {
 915                 return array_merge(
 916                         [
 917                                 'db_server' => $this->server,
 918                                 'db_name' => $this->getDBname(),
 919                                 'db_user' => $this->user,
 920                         ],
 921                         $extras
 922                 );
 923         }
 924
 925         final public function close() {
 926                 $exception = null; // error to throw after disconnecting
 927
 928                 if ( $this->conn ) {
 929                         // Roll back any dangling transaction first
 930                         if ( $this->trxLevel ) {
 931                                 if ( $this->trxAtomicLevels ) {
 932                                         // Cannot let incomplete atomic sections be committed
 933                                         $levels = $this->flatAtomicSectionList();
 934                                         $exception = new DBUnexpectedError(
 935                                                 $this,
 936                                                 __METHOD__ . ": atomic sections $levels are still open."
 937                                         );
 938                                 } elseif ( $this->trxAutomatic ) {
 939                                         // Only the connection manager can commit non-empty DBO_TRX transactions
 940                                         // (empty ones we can silently roll back)
 941                                         if ( $this->writesOrCallbacksPending() ) {
 942                                                 $exception = new DBUnexpectedError(
 943                                                         $this,
 944                                                         __METHOD__ .
 945                                                         ": mass commit/rollback of peer transaction required (DBO_TRX set)."
 946                                                 );
 947                                         }
 948                                 } else {
 949                                         // Manual transactions should have been committed or rolled
 950                                         // back, even if empty.
 951                                         $exception = new DBUnexpectedError(
 952                                                 $this,
 953                                                 __METHOD__ . ": transaction is still open (from {$this->trxFname})."
 954                                         );
 955                                 }
 956
 957                                 if ( $this->trxEndCallbacksSuppressed ) {
 958                                         $exception = $exception ?: new DBUnexpectedError(
 959                                                 $this,
 960                                                 __METHOD__ . ': callbacks are suppressed; cannot properly commit.'
 961                                         );
 962                                 }
 963
 964                                 // Rollback the changes and run any callbacks as needed
 965                                 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
 966                         }
 967
 968                         // Close the actual connection in the binding handle
 969                         $closed = $this->closeConnection();
 970                         $this->conn = false;
 971                 } else {
 972                         $closed = true; // already closed; nothing to do
 973                 }
 974
 975                 $this->opened = false;
 976
 977                 // Throw any unexpected errors after having disconnected
 978                 if ( $exception instanceof Exception ) {
 979                         throw $exception;
 980                 }
 981
 982                 // Sanity check that no callbacks are dangling
 983                 $fnames = $this->pendingWriteAndCallbackCallers();
 984                 if ( $fnames ) {
 985                         throw new RuntimeException(
 986                                 "Transaction callbacks are still pending:\n" . implode( ', ', $fnames )
 987                         );
 988                 }
 989
 990                 return $closed;
 991         }
 992
 993         /**
 994          * Make sure isOpen() returns true as a sanity check
 995          *
 996          * @throws DBUnexpectedError
 997          */
 998         protected function assertOpen() {
 999                 if ( !$this->isOpen() ) {
1000                         throw new DBUnexpectedError( $this, "DB connection was already closed." );
1001                 }
1002         }
1003
1004         /**
1005          * Closes underlying database connection
1006          * @since 1.20
1007          * @return bool Whether connection was closed successfully
1008          */
1009         abstract protected function closeConnection();
1010
1011         /**
1012          * @deprecated since 1.32
1013          * @param string $error Fallback message, if none is given by DB
1014          * @throws DBConnectionError
1015          */
1016         public function reportConnectionError( $error = 'Unknown error' ) {
1017                 call_user_func( $this->deprecationLogger, 'Use of ' . __METHOD__ . ' is deprecated.' );
1018                 throw new DBConnectionError( $this, $this->lastError() ?: $error );
1019         }
1020
1021         /**
1022          * Run a query and return a DBMS-dependent wrapper or boolean
1023          *
1024          * For SELECT queries, this returns either:
1025          *   - a) A driver-specific value/resource, only on success. This can be iterated
1026          *        over by calling fetchObject()/fetchRow() until there are no more rows.
1027          *        Alternatively, the result can be passed to resultObject() to obtain a
1028          *        ResultWrapper instance which can then be iterated over via "foreach".
1029          *   - b) False, on any query failure
1030          *
1031          * For non-SELECT queries, this returns either:
1032          *   - a) A driver-specific value/resource, only on success
1033          *   - b) True, only on success (e.g. no meaningful result other than "OK")
1034          *   - c) False, on any query failure
1035          *
1036          * @param string $sql SQL query
1037          * @return mixed|bool An object, resource, or true on success; false on failure
1038          */
1039         abstract protected function doQuery( $sql );
1040
1041         /**
1042          * Determine whether a query writes to the DB. When in doubt, this returns true.
1043          *
1044          * Main use cases:
1045          *
1046          * - Subsequent web requests should not need to wait for replication from
1047          *   the master position seen by this web request, unless this request made
1048          *   changes to the master. This is handled by ChronologyProtector by checking
1049          *   doneWrites() at the end of the request. doneWrites() returns true if any
1050          *   query set lastWriteTime; which query() does based on isWriteQuery().
1051          *
1052          * - Reject write queries to replica DBs, in query().
1053          *
1054          * @param string $sql
1055          * @return bool
1056          */
1057         protected function isWriteQuery( $sql ) {
1058                 // BEGIN and COMMIT queries are considered read queries here.
1059                 // Database backends and drivers (MySQL, MariaDB, php-mysqli) generally
1060                 // treat these as write queries, in that their results have "affected rows"
1061                 // as meta data as from writes, instead of "num rows" as from reads.
1062                 // But, we treat them as read queries because when reading data (from
1063                 // either replica or master) we use transactions to enable repeatable-read
1064                 // snapshots, which ensures we get consistent results from the same snapshot
1065                 // for all queries within a request. Use cases:
1066                 // - Treating these as writes would trigger ChronologyProtector (see method doc).
1067                 // - We use this method to reject writes to replicas, but we need to allow
1068                 //   use of transactions on replicas for read snapshots. This fine given
1069                 //   that transactions by themselves don't make changes, only actual writes
1070                 //   within the transaction matter, which we still detect.
1071                 return !preg_match(
1072                         '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SAVEPOINT|RELEASE|SET|SHOW|EXPLAIN|\(SELECT)\b/i',
1073                         $sql
1074                 );
1075         }
1076
1077         /**
1078          * @param string $sql
1079          * @return string|null
1080          */
1081         protected function getQueryVerb( $sql ) {
1082                 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ? strtoupper( $m[1] ) : null;
1083         }
1084
1085         /**
1086          * Determine whether a SQL statement is sensitive to isolation level.
1087          *
1088          * A SQL statement is considered transactable if its result could vary
1089          * depending on the transaction isolation level. Operational commands
1090          * such as 'SET' and 'SHOW' are not considered to be transactable.
1091          *
1092          * Main purpose: Used by query() to decide whether to begin a transaction
1093          * before the current query (in DBO_TRX mode, on by default).
1094          *
1095          * @param string $sql
1096          * @return bool
1097          */
1098         protected function isTransactableQuery( $sql ) {
1099                 return !in_array(
1100                         $this->getQueryVerb( $sql ),
1101                         [ 'BEGIN', 'ROLLBACK', 'COMMIT', 'SET', 'SHOW', 'CREATE', 'ALTER' ],
1102                         true
1103                 );
1104         }
1105
1106         /**
1107          * @param string $sql A SQL query
1108          * @return bool Whether $sql is SQL for TEMPORARY table operation
1109          */
1110         protected function registerTempTableOperation( $sql ) {
1111                 if ( preg_match(
1112                         '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1113                         $sql,
1114                         $matches
1115                 ) ) {
1116                         $this->sessionTempTables[$matches[1]] = 1;
1117
1118                         return true;
1119                 } elseif ( preg_match(
1120                         '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1121                         $sql,
1122                         $matches
1123                 ) ) {
1124                         $isTemp = isset( $this->sessionTempTables[$matches[1]] );
1125                         unset( $this->sessionTempTables[$matches[1]] );
1126
1127                         return $isTemp;
1128                 } elseif ( preg_match(
1129                         '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1130                         $sql,
1131                         $matches
1132                 ) ) {
1133                         return isset( $this->sessionTempTables[$matches[1]] );
1134                 } elseif ( preg_match(
1135                         '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
1136                         $sql,
1137                         $matches
1138                 ) ) {
1139                         return isset( $this->sessionTempTables[$matches[1]] );
1140                 }
1141
1142                 return false;
1143         }
1144
1145         public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) {
1146                 $this->assertTransactionStatus( $sql, $fname );
1147
1148                 # Avoid fatals if close() was called
1149                 $this->assertOpen();
1150
1151                 $priorWritesPending = $this->writesOrCallbacksPending();
1152                 $this->lastQuery = $sql;
1153
1154                 $isWrite = $this->isWriteQuery( $sql );
1155                 if ( $isWrite ) {
1156                         $isNonTempWrite = !$this->registerTempTableOperation( $sql );
1157                 } else {
1158                         $isNonTempWrite = false;
1159                 }
1160
1161                 if ( $isWrite ) {
1162                         if ( $this->getLBInfo( 'replica' ) === true ) {
1163                                 throw new DBError(
1164                                         $this,
1165                                         'Write operations are not allowed on replica database connections.'
1166                                 );
1167                         }
1168                         # In theory, non-persistent writes are allowed in read-only mode, but due to things
1169                         # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
1170                         $reason = $this->getReadOnlyReason();
1171                         if ( $reason !== false ) {
1172                                 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
1173                         }
1174                         # Set a flag indicating that writes have been done
1175                         $this->lastWriteTime = microtime( true );
1176                 }
1177
1178                 # Add trace comment to the begin of the sql string, right after the operator.
1179                 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
1180                 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
1181
1182                 # Start implicit transactions that wrap the request if DBO_TRX is enabled
1183                 if ( !$this->trxLevel && $this->getFlag( self::DBO_TRX )
1184                         && $this->isTransactableQuery( $sql )
1185                 ) {
1186                         $this->begin( __METHOD__ . " ($fname)", self::TRANSACTION_INTERNAL );
1187                         $this->trxAutomatic = true;
1188                 }
1189
1190                 # Keep track of whether the transaction has write queries pending
1191                 if ( $this->trxLevel && !$this->trxDoneWrites && $isWrite ) {
1192                         $this->trxDoneWrites = true;
1193                         $this->trxProfiler->transactionWritingIn(
1194                                 $this->server, $this->getDomainID(), $this->trxShortId );
1195                 }
1196
1197                 if ( $this->getFlag( self::DBO_DEBUG ) ) {
1198                         $this->queryLogger->debug( "{$this->getDomainID()} {$commentedSql}" );
1199                 }
1200
1201                 # Send the query to the server and fetch any corresponding errors
1202                 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1203                 $lastError = $this->lastError();
1204                 $lastErrno = $this->lastErrno();
1205
1206                 # Try reconnecting if the connection was lost
1207                 if ( $ret === false && $this->wasConnectionLoss() ) {
1208                         # Check if any meaningful session state was lost
1209                         $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1210                         # Update session state tracking and try to restore the connection
1211                         $reconnected = $this->replaceLostConnection( __METHOD__ );
1212                         # Silently resend the query to the server if it is safe and possible
1213                         if ( $reconnected && $recoverable ) {
1214                                 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1215                                 $lastError = $this->lastError();
1216                                 $lastErrno = $this->lastErrno();
1217
1218                                 if ( $ret === false && $this->wasConnectionLoss() ) {
1219                                         # Query probably causes disconnects; reconnect and do not re-run it
1220                                         $this->replaceLostConnection( __METHOD__ );
1221                                 }
1222                         }
1223                 }
1224
1225                 if ( $ret === false ) {
1226                         if ( $this->trxLevel ) {
1227                                 if ( $this->wasKnownStatementRollbackError() ) {
1228                                         # We're ignoring an error that caused just the current query to be aborted.
1229                                         # But log the cause so we can log a deprecation notice if a caller actually
1230                                         # does ignore it.
1231                                         $this->trxStatusIgnoredCause = [ $lastError, $lastErrno, $fname ];
1232                                 } else {
1233                                         # Either the query was aborted or all queries after BEGIN where aborted.
1234                                         # In the first case, the only options going forward are (a) ROLLBACK, or
1235                                         # (b) ROLLBACK TO SAVEPOINT (if one was set). If the later case, the only
1236                                         # option is ROLLBACK, since the snapshots would have been released.
1237                                         $this->trxStatus = self::STATUS_TRX_ERROR;
1238                                         $this->trxStatusCause =
1239                                                 $this->makeQueryException( $lastError, $lastErrno, $sql, $fname );
1240                                         $tempIgnore = false; // cannot recover
1241                                         $this->trxStatusIgnoredCause = null;
1242                                 }
1243                         }
1244
1245                         $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $tempIgnore );
1246                 }
1247
1248                 return $this->resultObject( $ret );
1249         }
1250
1251         /**
1252          * Wrapper for query() that also handles profiling, logging, and affected row count updates
1253          *
1254          * @param string $sql Original SQL query
1255          * @param string $commentedSql SQL query with debugging/trace comment
1256          * @param bool $isWrite Whether the query is a (non-temporary) write operation
1257          * @param string $fname Name of the calling function
1258          * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1259          *     object for a successful read query, or false on failure
1260          */
1261         private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
1262                 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1263                 # generalizeSQL() will probably cut down the query to reasonable
1264                 # logging size most of the time. The substr is really just a sanity check.
1265                 if ( $isMaster ) {
1266                         $queryProf = 'query-m: ' . substr( self::generalizeSQL( $sql ), 0, 255 );
1267                 } else {
1268                         $queryProf = 'query: ' . substr( self::generalizeSQL( $sql ), 0, 255 );
1269                 }
1270
1271                 # Include query transaction state
1272                 $queryProf .= $this->trxShortId ? " [TRX#{$this->trxShortId}]" : "";
1273
1274                 $startTime = microtime( true );
1275                 if ( $this->profiler ) {
1276                         $this->profiler->profileIn( $queryProf );
1277                 }
1278                 $this->affectedRowCount = null;
1279                 $ret = $this->doQuery( $commentedSql );
1280                 $this->affectedRowCount = $this->affectedRows();
1281                 if ( $this->profiler ) {
1282                         $this->profiler->profileOut( $queryProf );
1283                 }
1284                 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1285
1286                 unset( $queryProfSection ); // profile out (if set)
1287
1288                 if ( $ret !== false ) {
1289                         $this->lastPing = $startTime;
1290                         if ( $isWrite && $this->trxLevel ) {
1291                                 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1292                                 $this->trxWriteCallers[] = $fname;
1293                         }
1294                 }
1295
1296                 if ( $sql === self::PING_QUERY ) {
1297                         $this->rttEstimate = $queryRuntime;
1298                 }
1299
1300                 $this->trxProfiler->recordQueryCompletion(
1301                         $queryProf,
1302                         $startTime,
1303                         $isWrite,
1304                         $isWrite ? $this->affectedRows() : $this->numRows( $ret )
1305                 );
1306                 $this->queryLogger->debug( $sql, [
1307                         'method' => $fname,
1308                         'master' => $isMaster,
1309                         'runtime' => $queryRuntime,
1310                 ] );
1311
1312                 return $ret;
1313         }
1314
1315         /**
1316          * Update the estimated run-time of a query, not counting large row lock times
1317          *
1318          * LoadBalancer can be set to rollback transactions that will create huge replication
1319          * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1320          * queries, like inserting a row can take a long time due to row locking. This method
1321          * uses some simple heuristics to discount those cases.
1322          *
1323          * @param string $sql A SQL write query
1324          * @param float $runtime Total runtime, including RTT
1325          * @param int $affected Affected row count
1326          */
1327         private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1328                 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1329                 $indicativeOfReplicaRuntime = true;
1330                 if ( $runtime > self::SLOW_WRITE_SEC ) {
1331                         $verb = $this->getQueryVerb( $sql );
1332                         // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1333                         if ( $verb === 'INSERT' ) {
1334                                 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS;
1335                         } elseif ( $verb === 'REPLACE' ) {
1336                                 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS / 2;
1337                         }
1338                 }
1339
1340                 $this->trxWriteDuration += $runtime;
1341                 $this->trxWriteQueryCount += 1;
1342                 $this->trxWriteAffectedRows += $affected;
1343                 if ( $indicativeOfReplicaRuntime ) {
1344                         $this->trxWriteAdjDuration += $runtime;
1345                         $this->trxWriteAdjQueryCount += 1;
1346                 }
1347         }
1348
1349         /**
1350          * Error out if the DB is not in a valid state for a query via query()
1351          *
1352          * @param string $sql
1353          * @param string $fname
1354          * @throws DBTransactionStateError
1355          */
1356         private function assertTransactionStatus( $sql, $fname ) {
1357                 $verb = $this->getQueryVerb( $sql );
1358                 if ( $verb === 'USE' ) {
1359                         throw new DBUnexpectedError( $this, "Got USE query; use selectDomain() instead." );
1360                 }
1361
1362                 if ( $verb === 'ROLLBACK' ) { // transaction/savepoint
1363                         return;
1364                 }
1365
1366                 if ( $this->trxStatus < self::STATUS_TRX_OK ) {
1367                         throw new DBTransactionStateError(
1368                                 $this,
1369                                 "Cannot execute query from $fname while transaction status is ERROR.",
1370                                 [],
1371                                 $this->trxStatusCause
1372                         );
1373                 } elseif ( $this->trxStatus === self::STATUS_TRX_OK && $this->trxStatusIgnoredCause ) {
1374                         list( $iLastError, $iLastErrno, $iFname ) = $this->trxStatusIgnoredCause;
1375                         call_user_func( $this->deprecationLogger,
1376                                 "Caller from $fname ignored an error originally raised from $iFname: " .
1377                                 "[$iLastErrno] $iLastError"
1378                         );
1379                         $this->trxStatusIgnoredCause = null;
1380                 }
1381         }
1382
1383         public function assertNoOpenTransactions() {
1384                 if ( $this->explicitTrxActive() ) {
1385                         throw new DBTransactionError(
1386                                 $this,
1387                                 "Explicit transaction still active. A caller may have caught an error. "
1388                                 . "Open transactions: " . $this->flatAtomicSectionList()
1389                         );
1390                 }
1391         }
1392
1393         /**
1394          * Determine whether or not it is safe to retry queries after a database
1395          * connection is lost
1396          *
1397          * @param string $sql SQL query
1398          * @param bool $priorWritesPending Whether there is a transaction open with
1399          *     possible write queries or transaction pre-commit/idle callbacks
1400          *     waiting on it to finish.
1401          * @return bool True if it is safe to retry the query, false otherwise
1402          */
1403         private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1404                 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1405                 # Dropped connections also mean that named locks are automatically released.
1406                 # Only allow error suppression in autocommit mode or when the lost transaction
1407                 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1408                 if ( $this->namedLocksHeld ) {
1409                         return false; // possible critical section violation
1410                 } elseif ( $this->sessionTempTables ) {
1411                         return false; // tables might be queried latter
1412                 } elseif ( $sql === 'COMMIT' ) {
1413                         return !$priorWritesPending; // nothing written anyway? (T127428)
1414                 } elseif ( $sql === 'ROLLBACK' ) {
1415                         return true; // transaction lost...which is also what was requested :)
1416                 } elseif ( $this->explicitTrxActive() ) {
1417                         return false; // don't drop atomocity and explicit snapshots
1418                 } elseif ( $priorWritesPending ) {
1419                         return false; // prior writes lost from implicit transaction
1420                 }
1421
1422                 return true;
1423         }
1424
1425         /**
1426          * Clean things up after session (and thus transaction) loss
1427          */
1428         private function handleSessionLoss() {
1429                 // Clean up tracking of session-level things...
1430                 // https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html
1431                 // https://www.postgresql.org/docs/9.2/static/sql-createtable.html (ignoring ON COMMIT)
1432                 $this->sessionTempTables = [];
1433                 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1434                 // https://www.postgresql.org/docs/9.4/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1435                 $this->namedLocksHeld = [];
1436                 // Session loss implies transaction loss
1437                 $this->handleTransactionLoss();
1438         }
1439
1440         /**
1441          * Clean things up after transaction loss
1442          */
1443         private function handleTransactionLoss() {
1444                 $this->trxLevel = 0;
1445                 $this->trxAtomicCounter = 0;
1446                 $this->trxIdleCallbacks = []; // T67263; transaction already lost
1447                 $this->trxPreCommitCallbacks = []; // T67263; transaction already lost
1448                 try {
1449                         // Handle callbacks in trxEndCallbacks, e.g. onTransactionResolution().
1450                         // If callback suppression is set then the array will remain unhandled.
1451                         $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
1452                 } catch ( Exception $ex ) {
1453                         // Already logged; move on...
1454                 }
1455                 try {
1456                         // Handle callbacks in trxRecurringCallbacks, e.g. setTransactionListener()
1457                         $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
1458                 } catch ( Exception $ex ) {
1459                         // Already logged; move on...
1460                 }
1461         }
1462
1463         /**
1464          * Checks whether the cause of the error is detected to be a timeout.
1465          *
1466          * It returns false by default, and not all engines support detecting this yet.
1467          * If this returns false, it will be treated as a generic query error.
1468          *
1469          * @param string $error Error text
1470          * @param int $errno Error number
1471          * @return bool
1472          */
1473         protected function wasQueryTimeout( $error, $errno ) {
1474                 return false;
1475         }
1476
1477         /**
1478          * Report a query error. Log the error, and if neither the object ignore
1479          * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1480          *
1481          * @param string $error
1482          * @param int $errno
1483          * @param string $sql
1484          * @param string $fname
1485          * @param bool $tempIgnore
1486          * @throws DBQueryError
1487          */
1488         public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1489                 if ( $tempIgnore ) {
1490                         $this->queryLogger->debug( "SQL ERROR (ignored): $error\n" );
1491                 } else {
1492                         $exception = $this->makeQueryException( $error, $errno, $sql, $fname );
1493
1494                         throw $exception;
1495                 }
1496         }
1497
1498         /**
1499          * @param string $error
1500          * @param string|int $errno
1501          * @param string $sql
1502          * @param string $fname
1503          * @return DBError
1504          */
1505         private function makeQueryException( $error, $errno, $sql, $fname ) {
1506                 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1507                 $this->queryLogger->error(
1508                         "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1509                         $this->getLogContext( [
1510                                 'method' => __METHOD__,
1511                                 'errno' => $errno,
1512                                 'error' => $error,
1513                                 'sql1line' => $sql1line,
1514                                 'fname' => $fname,
1515                         ] )
1516                 );
1517                 $this->queryLogger->debug( "SQL ERROR: " . $error . "\n" );
1518                 $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1519                 if ( $wasQueryTimeout ) {
1520                         $e = new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1521                 } else {
1522                         $e = new DBQueryError( $this, $error, $errno, $sql, $fname );
1523                 }
1524
1525                 return $e;
1526         }
1527
1528         public function freeResult( $res ) {
1529         }
1530
1531         public function selectField(
1532                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1533         ) {
1534                 if ( $var === '*' ) { // sanity
1535                         throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1536                 }
1537
1538                 if ( !is_array( $options ) ) {
1539                         $options = [ $options ];
1540                 }
1541
1542                 $options['LIMIT'] = 1;
1543
1544                 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1545                 if ( $res === false || !$this->numRows( $res ) ) {
1546                         return false;
1547                 }
1548
1549                 $row = $this->fetchRow( $res );
1550
1551                 if ( $row !== false ) {
1552                         return reset( $row );
1553                 } else {
1554                         return false;
1555                 }
1556         }
1557
1558         public function selectFieldValues(
1559                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1560         ) {
1561                 if ( $var === '*' ) { // sanity
1562                         throw new DBUnexpectedError( $this, "Cannot use a * field" );
1563                 } elseif ( !is_string( $var ) ) { // sanity
1564                         throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1565                 }
1566
1567                 if ( !is_array( $options ) ) {
1568                         $options = [ $options ];
1569                 }
1570
1571                 $res = $this->select( $table, [ 'value' => $var ], $cond, $fname, $options, $join_conds );
1572                 if ( $res === false ) {
1573                         return false;
1574                 }
1575
1576                 $values = [];
1577                 foreach ( $res as $row ) {
1578                         $values[] = $row->value;
1579                 }
1580
1581                 return $values;
1582         }
1583
1584         /**
1585          * Returns an optional USE INDEX clause to go after the table, and a
1586          * string to go at the end of the query.
1587          *
1588          * @param array $options Associative array of options to be turned into
1589          *   an SQL query, valid keys are listed in the function.
1590          * @return array
1591          * @see Database::select()
1592          */
1593         protected function makeSelectOptions( $options ) {
1594                 $preLimitTail = $postLimitTail = '';
1595                 $startOpts = '';
1596
1597                 $noKeyOptions = [];
1598
1599                 foreach ( $options as $key => $option ) {
1600                         if ( is_numeric( $key ) ) {
1601                                 $noKeyOptions[$option] = true;
1602                         }
1603                 }
1604
1605                 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1606
1607                 $preLimitTail .= $this->makeOrderBy( $options );
1608
1609                 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1610                         $postLimitTail .= ' FOR UPDATE';
1611                 }
1612
1613                 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1614                         $postLimitTail .= ' LOCK IN SHARE MODE';
1615                 }
1616
1617                 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1618                         $startOpts .= 'DISTINCT';
1619                 }
1620
1621                 # Various MySQL extensions
1622                 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1623                         $startOpts .= ' /*! STRAIGHT_JOIN */';
1624                 }
1625
1626                 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1627                         $startOpts .= ' HIGH_PRIORITY';
1628                 }
1629
1630                 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1631                         $startOpts .= ' SQL_BIG_RESULT';
1632                 }
1633
1634                 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1635                         $startOpts .= ' SQL_BUFFER_RESULT';
1636                 }
1637
1638                 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1639                         $startOpts .= ' SQL_SMALL_RESULT';
1640                 }
1641
1642                 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1643                         $startOpts .= ' SQL_CALC_FOUND_ROWS';
1644                 }
1645
1646                 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1647                         $startOpts .= ' SQL_CACHE';
1648                 }
1649
1650                 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1651                         $startOpts .= ' SQL_NO_CACHE';
1652                 }
1653
1654                 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1655                         $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1656                 } else {
1657                         $useIndex = '';
1658                 }
1659                 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1660                         $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1661                 } else {
1662                         $ignoreIndex = '';
1663                 }
1664
1665                 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1666         }
1667
1668         /**
1669          * Returns an optional GROUP BY with an optional HAVING
1670          *
1671          * @param array $options Associative array of options
1672          * @return string
1673          * @see Database::select()
1674          * @since 1.21
1675          */
1676         protected function makeGroupByWithHaving( $options ) {
1677                 $sql = '';
1678                 if ( isset( $options['GROUP BY'] ) ) {
1679                         $gb = is_array( $options['GROUP BY'] )
1680                                 ? implode( ',', $options['GROUP BY'] )
1681                                 : $options['GROUP BY'];
1682                         $sql .= ' GROUP BY ' . $gb;
1683                 }
1684                 if ( isset( $options['HAVING'] ) ) {
1685                         $having = is_array( $options['HAVING'] )
1686                                 ? $this->makeList( $options['HAVING'], self::LIST_AND )
1687                                 : $options['HAVING'];
1688                         $sql .= ' HAVING ' . $having;
1689                 }
1690
1691                 return $sql;
1692         }
1693
1694         /**
1695          * Returns an optional ORDER BY
1696          *
1697          * @param array $options Associative array of options
1698          * @return string
1699          * @see Database::select()
1700          * @since 1.21
1701          */
1702         protected function makeOrderBy( $options ) {
1703                 if ( isset( $options['ORDER BY'] ) ) {
1704                         $ob = is_array( $options['ORDER BY'] )
1705                                 ? implode( ',', $options['ORDER BY'] )
1706                                 : $options['ORDER BY'];
1707
1708                         return ' ORDER BY ' . $ob;
1709                 }
1710
1711                 return '';
1712         }
1713
1714         public function select(
1715                 $table, $vars, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1716         ) {
1717                 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1718
1719                 return $this->query( $sql, $fname );
1720         }
1721
1722         public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__,
1723                 $options = [], $join_conds = []
1724         ) {
1725                 if ( is_array( $vars ) ) {
1726                         $fields = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1727                 } else {
1728                         $fields = $vars;
1729                 }
1730
1731                 $options = (array)$options;
1732                 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1733                         ? $options['USE INDEX']
1734                         : [];
1735                 $ignoreIndexes = (
1736                         isset( $options['IGNORE INDEX'] ) &&
1737                         is_array( $options['IGNORE INDEX'] )
1738                 )
1739                         ? $options['IGNORE INDEX']
1740                         : [];
1741
1742                 if (
1743                         $this->selectOptionsIncludeLocking( $options ) &&
1744                         $this->selectFieldsOrOptionsAggregate( $vars, $options )
1745                 ) {
1746                         // Some DB types (postgres/oracle) disallow FOR UPDATE with aggregate
1747                         // functions. Discourage use of such queries to encourage compatibility.
1748                         call_user_func(
1749                                 $this->deprecationLogger,
1750                                 __METHOD__ . ": aggregation used with a locking SELECT ($fname)."
1751                         );
1752                 }
1753
1754                 if ( is_array( $table ) ) {
1755                         $from = ' FROM ' .
1756                                 $this->tableNamesWithIndexClauseOrJOIN(
1757                                         $table, $useIndexes, $ignoreIndexes, $join_conds );
1758                 } elseif ( $table != '' ) {
1759                         $from = ' FROM ' .
1760                                 $this->tableNamesWithIndexClauseOrJOIN(
1761                                         [ $table ], $useIndexes, $ignoreIndexes, [] );
1762                 } else {
1763                         $from = '';
1764                 }
1765
1766                 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1767                         $this->makeSelectOptions( $options );
1768
1769                 if ( is_array( $conds ) ) {
1770                         $conds = $this->makeList( $conds, self::LIST_AND );
1771                 }
1772
1773                 if ( $conds === null || $conds === false ) {
1774                         $this->queryLogger->warning(
1775                                 __METHOD__
1776                                 . ' called from '
1777                                 . $fname
1778                                 . ' with incorrect parameters: $conds must be a string or an array'
1779                         );
1780                         $conds = '';
1781                 }
1782
1783                 if ( $conds === '' || $conds === '*' ) {
1784                         $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex $preLimitTail";
1785                 } elseif ( is_string( $conds ) ) {
1786                         $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex " .
1787                                 "WHERE $conds $preLimitTail";
1788                 } else {
1789                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
1790                 }
1791
1792                 if ( isset( $options['LIMIT'] ) ) {
1793                         $sql = $this->limitResult( $sql, $options['LIMIT'],
1794                                 $options['OFFSET'] ?? false );
1795                 }
1796                 $sql = "$sql $postLimitTail";
1797
1798                 if ( isset( $options['EXPLAIN'] ) ) {
1799                         $sql = 'EXPLAIN ' . $sql;
1800                 }
1801
1802                 return $sql;
1803         }
1804
1805         public function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1806                 $options = [], $join_conds = []
1807         ) {
1808                 $options = (array)$options;
1809                 $options['LIMIT'] = 1;
1810                 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1811
1812                 if ( $res === false ) {
1813                         return false;
1814                 }
1815
1816                 if ( !$this->numRows( $res ) ) {
1817                         return false;
1818                 }
1819
1820                 $obj = $this->fetchObject( $res );
1821
1822                 return $obj;
1823         }
1824
1825         public function estimateRowCount(
1826                 $table, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1827         ) {
1828                 $conds = $this->normalizeConditions( $conds, $fname );
1829                 $column = $this->extractSingleFieldFromList( $var );
1830                 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1831                         $conds[] = "$column IS NOT NULL";
1832                 }
1833
1834                 $res = $this->select(
1835                         $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options, $join_conds
1836                 );
1837                 $row = $res ? $this->fetchRow( $res ) : [];
1838
1839                 return isset( $row['rowcount'] ) ? (int)$row['rowcount'] : 0;
1840         }
1841
1842         public function selectRowCount(
1843                 $tables, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1844         ) {
1845                 $conds = $this->normalizeConditions( $conds, $fname );
1846                 $column = $this->extractSingleFieldFromList( $var );
1847                 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1848                         $conds[] = "$column IS NOT NULL";
1849                 }
1850
1851                 $res = $this->select(
1852                         [
1853                                 'tmp_count' => $this->buildSelectSubquery(
1854                                         $tables,
1855                                         '1',
1856                                         $conds,
1857                                         $fname,
1858                                         $options,
1859                                         $join_conds
1860                                 )
1861                         ],
1862                         [ 'rowcount' => 'COUNT(*)' ],
1863                         [],
1864                         $fname
1865                 );
1866                 $row = $res ? $this->fetchRow( $res ) : [];
1867
1868                 return isset( $row['rowcount'] ) ? (int)$row['rowcount'] : 0;
1869         }
1870
1871         /**
1872          * @param string|array $options
1873          * @return bool
1874          */
1875         private function selectOptionsIncludeLocking( $options ) {
1876                 $options = (array)$options;
1877                 foreach ( [ 'FOR UPDATE', 'LOCK IN SHARE MODE' ] as $lock ) {
1878                         if ( in_array( $lock, $options, true ) ) {
1879                                 return true;
1880                         }
1881                 }
1882
1883                 return false;
1884         }
1885
1886         /**
1887          * @param array|string $fields
1888          * @param array|string $options
1889          * @return bool
1890          */
1891         private function selectFieldsOrOptionsAggregate( $fields, $options ) {
1892                 foreach ( (array)$options as $key => $value ) {
1893                         if ( is_string( $key ) ) {
1894                                 if ( preg_match( '/^(?:GROUP BY|HAVING)$/i', $key ) ) {
1895                                         return true;
1896                                 }
1897                         } elseif ( is_string( $value ) ) {
1898                                 if ( preg_match( '/^(?:DISTINCT|DISTINCTROW)$/i', $value ) ) {
1899                                         return true;
1900                                 }
1901                         }
1902                 }
1903
1904                 $regex = '/^(?:COUNT|MIN|MAX|SUM|GROUP_CONCAT|LISTAGG|ARRAY_AGG)\s*\\(/i';
1905                 foreach ( (array)$fields as $field ) {
1906                         if ( is_string( $field ) && preg_match( $regex, $field ) ) {
1907                                 return true;
1908                         }
1909                 }
1910
1911                 return false;
1912         }
1913
1914         /**
1915          * @param array|string $conds
1916          * @param string $fname
1917          * @return array
1918          */
1919         final protected function normalizeConditions( $conds, $fname ) {
1920                 if ( $conds === null || $conds === false ) {
1921                         $this->queryLogger->warning(
1922                                 __METHOD__
1923                                 . ' called from '
1924                                 . $fname
1925                                 . ' with incorrect parameters: $conds must be a string or an array'
1926                         );
1927                         $conds = '';
1928                 }
1929
1930                 if ( !is_array( $conds ) ) {
1931                         $conds = ( $conds === '' ) ? [] : [ $conds ];
1932                 }
1933
1934                 return $conds;
1935         }
1936
1937         /**
1938          * @param array|string $var Field parameter in the style of select()
1939          * @return string|null Column name or null; ignores aliases
1940          * @throws DBUnexpectedError Errors out if multiple columns are given
1941          */
1942         final protected function extractSingleFieldFromList( $var ) {
1943                 if ( is_array( $var ) ) {
1944                         if ( !$var ) {
1945                                 $column = null;
1946                         } elseif ( count( $var ) == 1 ) {
1947                                 $column = $var[0] ?? reset( $var );
1948                         } else {
1949                                 throw new DBUnexpectedError( $this, __METHOD__ . ': got multiple columns.' );
1950                         }
1951                 } else {
1952                         $column = $var;
1953                 }
1954
1955                 return $column;
1956         }
1957
1958         public function lockForUpdate(
1959                 $table, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1960         ) {
1961                 if ( !$this->trxLevel && !$this->getFlag( self::DBO_TRX ) ) {
1962                         throw new DBUnexpectedError(
1963                                 $this,
1964                                 __METHOD__ . ': no transaction is active nor is DBO_TRX set'
1965                         );
1966                 }
1967
1968                 $options = (array)$options;
1969                 $options[] = 'FOR UPDATE';
1970
1971                 return $this->selectRowCount( $table, '*', $conds, $fname, $options, $join_conds );
1972         }
1973
1974         /**
1975          * Removes most variables from an SQL query and replaces them with X or N for numbers.
1976          * It's only slightly flawed. Don't use for anything important.
1977          *
1978          * @param string $sql A SQL Query
1979          *
1980          * @return string
1981          */
1982         protected static function generalizeSQL( $sql ) {
1983                 # This does the same as the regexp below would do, but in such a way
1984                 # as to avoid crashing php on some large strings.
1985                 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1986
1987                 $sql = str_replace( "\\\\", '', $sql );
1988                 $sql = str_replace( "\\'", '', $sql );
1989                 $sql = str_replace( "\\\"", '', $sql );
1990                 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1991                 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1992
1993                 # All newlines, tabs, etc replaced by single space
1994                 $sql = preg_replace( '/\s+/', ' ', $sql );
1995
1996                 # All numbers => N,
1997                 # except the ones surrounded by characters, e.g. l10n
1998                 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1999                 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
2000
2001                 return $sql;
2002         }
2003
2004         public function fieldExists( $table, $field, $fname = __METHOD__ ) {
2005                 $info = $this->fieldInfo( $table, $field );
2006
2007                 return (bool)$info;
2008         }
2009
2010         public function indexExists( $table, $index, $fname = __METHOD__ ) {
2011                 if ( !$this->tableExists( $table ) ) {
2012                         return null;
2013                 }
2014
2015                 $info = $this->indexInfo( $table, $index, $fname );
2016                 if ( is_null( $info ) ) {
2017                         return null;
2018                 } else {
2019                         return $info !== false;
2020                 }
2021         }
2022
2023         abstract public function tableExists( $table, $fname = __METHOD__ );
2024
2025         public function indexUnique( $table, $index ) {
2026                 $indexInfo = $this->indexInfo( $table, $index );
2027
2028                 if ( !$indexInfo ) {
2029                         return null;
2030                 }
2031
2032                 return !$indexInfo[0]->Non_unique;
2033         }
2034
2035         /**
2036          * Helper for Database::insert().
2037          *
2038          * @param array $options
2039          * @return string
2040          */
2041         protected function makeInsertOptions( $options ) {
2042                 return implode( ' ', $options );
2043         }
2044
2045         public function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
2046                 # No rows to insert, easy just return now
2047                 if ( !count( $a ) ) {
2048                         return true;
2049                 }
2050
2051                 $table = $this->tableName( $table );
2052
2053                 if ( !is_array( $options ) ) {
2054                         $options = [ $options ];
2055                 }
2056
2057                 $options = $this->makeInsertOptions( $options );
2058
2059                 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
2060                         $multi = true;
2061                         $keys = array_keys( $a[0] );
2062                 } else {
2063                         $multi = false;
2064                         $keys = array_keys( $a );
2065                 }
2066
2067                 $sql = 'INSERT ' . $options .
2068                         " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2069
2070                 if ( $multi ) {
2071                         $first = true;
2072                         foreach ( $a as $row ) {
2073                                 if ( $first ) {
2074                                         $first = false;
2075                                 } else {
2076                                         $sql .= ',';
2077                                 }
2078                                 $sql .= '(' . $this->makeList( $row ) . ')';
2079                         }
2080                 } else {
2081                         $sql .= '(' . $this->makeList( $a ) . ')';
2082                 }
2083
2084                 $this->query( $sql, $fname );
2085
2086                 return true;
2087         }
2088
2089         /**
2090          * Make UPDATE options array for Database::makeUpdateOptions
2091          *
2092          * @param array $options
2093          * @return array
2094          */
2095         protected function makeUpdateOptionsArray( $options ) {
2096                 if ( !is_array( $options ) ) {
2097                         $options = [ $options ];
2098                 }
2099
2100                 $opts = [];
2101
2102                 if ( in_array( 'IGNORE', $options ) ) {
2103                         $opts[] = 'IGNORE';
2104                 }
2105
2106                 return $opts;
2107         }
2108
2109         /**
2110          * Make UPDATE options for the Database::update function
2111          *
2112          * @param array $options The options passed to Database::update
2113          * @return string
2114          */
2115         protected function makeUpdateOptions( $options ) {
2116                 $opts = $this->makeUpdateOptionsArray( $options );
2117
2118                 return implode( ' ', $opts );
2119         }
2120
2121         public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
2122                 $table = $this->tableName( $table );
2123                 $opts = $this->makeUpdateOptions( $options );
2124                 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self::LIST_SET );
2125
2126                 if ( $conds !== [] && $conds !== '*' ) {
2127                         $sql .= " WHERE " . $this->makeList( $conds, self::LIST_AND );
2128                 }
2129
2130                 $this->query( $sql, $fname );
2131
2132                 return true;
2133         }
2134
2135         public function makeList( $a, $mode = self::LIST_COMMA ) {
2136                 if ( !is_array( $a ) ) {
2137                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
2138                 }
2139
2140                 $first = true;
2141                 $list = '';
2142
2143                 foreach ( $a as $field => $value ) {
2144                         if ( !$first ) {
2145                                 if ( $mode == self::LIST_AND ) {
2146                                         $list .= ' AND ';
2147                                 } elseif ( $mode == self::LIST_OR ) {
2148                                         $list .= ' OR ';
2149                                 } else {
2150                                         $list .= ',';
2151                                 }
2152                         } else {
2153                                 $first = false;
2154                         }
2155
2156                         if ( ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_numeric( $field ) ) {
2157                                 $list .= "($value)";
2158                         } elseif ( $mode == self::LIST_SET && is_numeric( $field ) ) {
2159                                 $list .= "$value";
2160                         } elseif (
2161                                 ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_array( $value )
2162                         ) {
2163                                 // Remove null from array to be handled separately if found
2164                                 $includeNull = false;
2165                                 foreach ( array_keys( $value, null, true ) as $nullKey ) {
2166                                         $includeNull = true;
2167                                         unset( $value[$nullKey] );
2168                                 }
2169                                 if ( count( $value ) == 0 && !$includeNull ) {
2170                                         throw new InvalidArgumentException(
2171                                                 __METHOD__ . ": empty input for field $field" );
2172                                 } elseif ( count( $value ) == 0 ) {
2173                                         // only check if $field is null
2174                                         $list .= "$field IS NULL";
2175                                 } else {
2176                                         // IN clause contains at least one valid element
2177                                         if ( $includeNull ) {
2178                                                 // Group subconditions to ensure correct precedence
2179                                                 $list .= '(';
2180                                         }
2181                                         if ( count( $value ) == 1 ) {
2182                                                 // Special-case single values, as IN isn't terribly efficient
2183                                                 // Don't necessarily assume the single key is 0; we don't
2184                                                 // enforce linear numeric ordering on other arrays here.
2185                                                 $value = array_values( $value )[0];
2186                                                 $list .= $field . " = " . $this->addQuotes( $value );
2187                                         } else {
2188                                                 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2189                                         }
2190                                         // if null present in array, append IS NULL
2191                                         if ( $includeNull ) {
2192                                                 $list .= " OR $field IS NULL)";
2193                                         }
2194                                 }
2195                         } elseif ( $value === null ) {
2196                                 if ( $mode == self::LIST_AND || $mode == self::LIST_OR ) {
2197                                         $list .= "$field IS ";
2198                                 } elseif ( $mode == self::LIST_SET ) {
2199                                         $list .= "$field = ";
2200                                 }
2201                                 $list .= 'NULL';
2202                         } else {
2203                                 if (
2204                                         $mode == self::LIST_AND || $mode == self::LIST_OR || $mode == self::LIST_SET
2205                                 ) {
2206                                         $list .= "$field = ";
2207                                 }
2208                                 $list .= $mode == self::LIST_NAMES ? $value : $this->addQuotes( $value );
2209                         }
2210                 }
2211
2212                 return $list;
2213         }
2214
2215         public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2216                 $conds = [];
2217
2218                 foreach ( $data as $base => $sub ) {
2219                         if ( count( $sub ) ) {
2220                                 $conds[] = $this->makeList(
2221                                         [ $baseKey => $base, $subKey => array_keys( $sub ) ],
2222                                         self::LIST_AND );
2223                         }
2224                 }
2225
2226                 if ( $conds ) {
2227                         return $this->makeList( $conds, self::LIST_OR );
2228                 } else {
2229                         // Nothing to search for...
2230                         return false;
2231                 }
2232         }
2233
2234         public function aggregateValue( $valuedata, $valuename = 'value' ) {
2235                 return $valuename;
2236         }
2237
2238         public function bitNot( $field ) {
2239                 return "(~$field)";
2240         }
2241
2242         public function bitAnd( $fieldLeft, $fieldRight ) {
2243                 return "($fieldLeft & $fieldRight)";
2244         }
2245
2246         public function bitOr( $fieldLeft, $fieldRight ) {
2247                 return "($fieldLeft | $fieldRight)";
2248         }
2249
2250         public function buildConcat( $stringList ) {
2251                 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2252         }
2253
2254         public function buildGroupConcatField(
2255                 $delim, $table, $field, $conds = '', $join_conds = []
2256         ) {
2257                 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2258
2259                 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
2260         }
2261
2262         public function buildSubstring( $input, $startPosition, $length = null ) {
2263                 $this->assertBuildSubstringParams( $startPosition, $length );
2264                 $functionBody = "$input FROM $startPosition";
2265                 if ( $length !== null ) {
2266                         $functionBody .= " FOR $length";
2267                 }
2268                 return 'SUBSTRING(' . $functionBody . ')';
2269         }
2270
2271         /**
2272          * Check type and bounds for parameters to self::buildSubstring()
2273          *
2274          * All supported databases have substring functions that behave the same for
2275          * positive $startPosition and non-negative $length, but behaviors differ when
2276          * given 0 or negative $startPosition or negative $length. The simplest
2277          * solution to that is to just forbid those values.
2278          *
2279          * @param int $startPosition
2280          * @param int|null $length
2281          * @since 1.31
2282          */
2283         protected function assertBuildSubstringParams( $startPosition, $length ) {
2284                 if ( !is_int( $startPosition ) || $startPosition <= 0 ) {
2285                         throw new InvalidArgumentException(
2286                                 '$startPosition must be a positive integer'
2287                         );
2288                 }
2289                 if ( !( is_int( $length ) && $length >= 0 || $length === null ) ) {
2290                         throw new InvalidArgumentException(
2291                                 '$length must be null or an integer greater than or equal to 0'
2292                         );
2293                 }
2294         }
2295
2296         public function buildStringCast( $field ) {
2297                 // In theory this should work for any standards-compliant
2298                 // SQL implementation, although it may not be the best way to do it.
2299                 return "CAST( $field AS CHARACTER )";
2300         }
2301
2302         public function buildIntegerCast( $field ) {
2303                 return 'CAST( ' . $field . ' AS INTEGER )';
2304         }
2305
2306         public function buildSelectSubquery(
2307                 $table, $vars, $conds = '', $fname = __METHOD__,
2308                 $options = [], $join_conds = []
2309         ) {
2310                 return new Subquery(
2311                         $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds )
2312                 );
2313         }
2314
2315         public function databasesAreIndependent() {
2316                 return false;
2317         }
2318
2319         final public function selectDB( $db ) {
2320                 $this->selectDomain( new DatabaseDomain(
2321                         $db,
2322                         $this->currentDomain->getSchema(),
2323                         $this->currentDomain->getTablePrefix()
2324                 ) );
2325
2326                 return true;
2327         }
2328
2329         final public function selectDomain( $domain ) {
2330                 $this->doSelectDomain( DatabaseDomain::newFromId( $domain ) );
2331         }
2332
2333         protected function doSelectDomain( DatabaseDomain $domain ) {
2334                 $this->currentDomain = $domain;
2335         }
2336
2337         public function getDBname() {
2338                 return $this->currentDomain->getDatabase();
2339         }
2340
2341         public function getServer() {
2342                 return $this->server;
2343         }
2344
2345         public function tableName( $name, $format = 'quoted' ) {
2346                 if ( $name instanceof Subquery ) {
2347                         throw new DBUnexpectedError(
2348                                 $this,
2349                                 __METHOD__ . ': got Subquery instance when expecting a string.'
2350                         );
2351                 }
2352
2353                 # Skip the entire process when we have a string quoted on both ends.
2354                 # Note that we check the end so that we will still quote any use of
2355                 # use of `database`.table. But won't break things if someone wants
2356                 # to query a database table with a dot in the name.
2357                 if ( $this->isQuotedIdentifier( $name ) ) {
2358                         return $name;
2359                 }
2360
2361                 # Lets test for any bits of text that should never show up in a table
2362                 # name. Basically anything like JOIN or ON which are actually part of
2363                 # SQL queries, but may end up inside of the table value to combine
2364                 # sql. Such as how the API is doing.
2365                 # Note that we use a whitespace test rather than a \b test to avoid
2366                 # any remote case where a word like on may be inside of a table name
2367                 # surrounded by symbols which may be considered word breaks.
2368                 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2369                         $this->queryLogger->warning(
2370                                 __METHOD__ . ": use of subqueries is not supported this way.",
2371                                 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
2372                         );
2373
2374                         return $name;
2375                 }
2376
2377                 # Split database and table into proper variables.
2378                 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
2379
2380                 # Quote $table and apply the prefix if not quoted.
2381                 # $tableName might be empty if this is called from Database::replaceVars()
2382                 $tableName = "{$prefix}{$table}";
2383                 if ( $format === 'quoted'
2384                         && !$this->isQuotedIdentifier( $tableName )
2385                         && $tableName !== ''
2386                 ) {
2387                         $tableName = $this->addIdentifierQuotes( $tableName );
2388                 }
2389
2390                 # Quote $schema and $database and merge them with the table name if needed
2391                 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
2392                 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
2393
2394                 return $tableName;
2395         }
2396
2397         /**
2398          * Get the table components needed for a query given the currently selected database
2399          *
2400          * @param string $name Table name in the form of db.schema.table, db.table, or table
2401          * @return array (DB name or "" for default, schema name, table prefix, table name)
2402          */
2403         protected function qualifiedTableComponents( $name ) {
2404                 # We reverse the explode so that database.table and table both output the correct table.
2405                 $dbDetails = explode( '.', $name, 3 );
2406                 if ( count( $dbDetails ) == 3 ) {
2407                         list( $database, $schema, $table ) = $dbDetails;
2408                         # We don't want any prefix added in this case
2409                         $prefix = '';
2410                 } elseif ( count( $dbDetails ) == 2 ) {
2411                         list( $database, $table ) = $dbDetails;
2412                         # We don't want any prefix added in this case
2413                         $prefix = '';
2414                         # In dbs that support it, $database may actually be the schema
2415                         # but that doesn't affect any of the functionality here
2416                         $schema = '';
2417                 } else {
2418                         list( $table ) = $dbDetails;
2419                         if ( isset( $this->tableAliases[$table] ) ) {
2420                                 $database = $this->tableAliases[$table]['dbname'];
2421                                 $schema = is_string( $this->tableAliases[$table]['schema'] )
2422                                         ? $this->tableAliases[$table]['schema']
2423                                         : $this->relationSchemaQualifier();
2424                                 $prefix = is_string( $this->tableAliases[$table]['prefix'] )
2425                                         ? $this->tableAliases[$table]['prefix']
2426                                         : $this->tablePrefix();
2427                         } else {
2428                                 $database = '';
2429                                 $schema = $this->relationSchemaQualifier(); # Default schema
2430                                 $prefix = $this->tablePrefix(); # Default prefix
2431                         }
2432                 }
2433
2434                 return [ $database, $schema, $prefix, $table ];
2435         }
2436
2437         /**
2438          * @param string|null $namespace Database or schema
2439          * @param string $relation Name of table, view, sequence, etc...
2440          * @param string $format One of (raw, quoted)
2441          * @return string Relation name with quoted and merged $namespace as needed
2442          */
2443         private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2444                 if ( strlen( $namespace ) ) {
2445                         if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2446                                 $namespace = $this->addIdentifierQuotes( $namespace );
2447                         }
2448                         $relation = $namespace . '.' . $relation;
2449                 }
2450
2451                 return $relation;
2452         }
2453
2454         public function tableNames() {
2455                 $inArray = func_get_args();
2456                 $retVal = [];
2457
2458                 foreach ( $inArray as $name ) {
2459                         $retVal[$name] = $this->tableName( $name );
2460                 }
2461
2462                 return $retVal;
2463         }
2464
2465         public function tableNamesN() {
2466                 $inArray = func_get_args();
2467                 $retVal = [];
2468
2469                 foreach ( $inArray as $name ) {
2470                         $retVal[] = $this->tableName( $name );
2471                 }
2472
2473                 return $retVal;
2474         }
2475
2476         /**
2477          * Get an aliased table name
2478          *
2479          * This returns strings like "tableName AS newTableName" for aliased tables
2480          * and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
2481          *
2482          * @see Database::tableName()
2483          * @param string|Subquery $table Table name or object with a 'sql' field
2484          * @param string|bool $alias Table alias (optional)
2485          * @return string SQL name for aliased table. Will not alias a table to its own name
2486          */
2487         protected function tableNameWithAlias( $table, $alias = false ) {
2488                 if ( is_string( $table ) ) {
2489                         $quotedTable = $this->tableName( $table );
2490                 } elseif ( $table instanceof Subquery ) {
2491                         $quotedTable = (string)$table;
2492                 } else {
2493                         throw new InvalidArgumentException( "Table must be a string or Subquery." );
2494                 }
2495
2496                 if ( !strlen( $alias ) || $alias === $table ) {
2497                         if ( $table instanceof Subquery ) {
2498                                 throw new InvalidArgumentException( "Subquery table missing alias." );
2499                         }
2500
2501                         return $quotedTable;
2502                 } else {
2503                         return $quotedTable . ' ' . $this->addIdentifierQuotes( $alias );
2504                 }
2505         }
2506
2507         /**
2508          * Gets an array of aliased table names
2509          *
2510          * @param array $tables [ [alias] => table ]
2511          * @return string[] See tableNameWithAlias()
2512          */
2513         protected function tableNamesWithAlias( $tables ) {
2514                 $retval = [];
2515                 foreach ( $tables as $alias => $table ) {
2516                         if ( is_numeric( $alias ) ) {
2517                                 $alias = $table;
2518                         }
2519                         $retval[] = $this->tableNameWithAlias( $table, $alias );
2520                 }
2521
2522                 return $retval;
2523         }
2524
2525         /**
2526          * Get an aliased field name
2527          * e.g. fieldName AS newFieldName
2528          *
2529          * @param string $name Field name
2530          * @param string|bool $alias Alias (optional)
2531          * @return string SQL name for aliased field. Will not alias a field to its own name
2532          */
2533         protected function fieldNameWithAlias( $name, $alias = false ) {
2534                 if ( !$alias || (string)$alias === (string)$name ) {
2535                         return $name;
2536                 } else {
2537                         return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2538                 }
2539         }
2540
2541         /**
2542          * Gets an array of aliased field names
2543          *
2544          * @param array $fields [ [alias] => field ]
2545          * @return string[] See fieldNameWithAlias()
2546          */
2547         protected function fieldNamesWithAlias( $fields ) {
2548                 $retval = [];
2549                 foreach ( $fields as $alias => $field ) {
2550                         if ( is_numeric( $alias ) ) {
2551                                 $alias = $field;
2552                         }
2553                         $retval[] = $this->fieldNameWithAlias( $field, $alias );
2554                 }
2555
2556                 return $retval;
2557         }
2558
2559         /**
2560          * Get the aliased table name clause for a FROM clause
2561          * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2562          *
2563          * @param array $tables ( [alias] => table )
2564          * @param array $use_index Same as for select()
2565          * @param array $ignore_index Same as for select()
2566          * @param array $join_conds Same as for select()
2567          * @return string
2568          */
2569         protected function tableNamesWithIndexClauseOrJOIN(
2570                 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2571         ) {
2572                 $ret = [];
2573                 $retJOIN = [];
2574                 $use_index = (array)$use_index;
2575                 $ignore_index = (array)$ignore_index;
2576                 $join_conds = (array)$join_conds;
2577
2578                 foreach ( $tables as $alias => $table ) {
2579                         if ( !is_string( $alias ) ) {
2580                                 // No alias? Set it equal to the table name
2581                                 $alias = $table;
2582                         }
2583
2584                         if ( is_array( $table ) ) {
2585                                 // A parenthesized group
2586                                 if ( count( $table ) > 1 ) {
2587                                         $joinedTable = '(' .
2588                                                 $this->tableNamesWithIndexClauseOrJOIN(
2589                                                         $table, $use_index, $ignore_index, $join_conds ) . ')';
2590                                 } else {
2591                                         // Degenerate case
2592                                         $innerTable = reset( $table );
2593                                         $innerAlias = key( $table );
2594                                         $joinedTable = $this->tableNameWithAlias(
2595                                                 $innerTable,
2596                                                 is_string( $innerAlias ) ? $innerAlias : $innerTable
2597                                         );
2598                                 }
2599                         } else {
2600                                 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2601                         }
2602
2603                         // Is there a JOIN clause for this table?
2604                         if ( isset( $join_conds[$alias] ) ) {
2605                                 list( $joinType, $conds ) = $join_conds[$alias];
2606                                 $tableClause = $joinType;
2607                                 $tableClause .= ' ' . $joinedTable;
2608                                 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2609                                         $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2610                                         if ( $use != '' ) {
2611                                                 $tableClause .= ' ' . $use;
2612                                         }
2613                                 }
2614                                 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2615                                         $ignore = $this->ignoreIndexClause(
2616                                                 implode( ',', (array)$ignore_index[$alias] ) );
2617                                         if ( $ignore != '' ) {
2618                                                 $tableClause .= ' ' . $ignore;
2619                                         }
2620                                 }
2621                                 $on = $this->makeList( (array)$conds, self::LIST_AND );
2622                                 if ( $on != '' ) {
2623                                         $tableClause .= ' ON (' . $on . ')';
2624                                 }
2625
2626                                 $retJOIN[] = $tableClause;
2627                         } elseif ( isset( $use_index[$alias] ) ) {
2628                                 // Is there an INDEX clause for this table?
2629                                 $tableClause = $joinedTable;
2630                                 $tableClause .= ' ' . $this->useIndexClause(
2631                                                 implode( ',', (array)$use_index[$alias] )
2632                                         );
2633
2634                                 $ret[] = $tableClause;
2635                         } elseif ( isset( $ignore_index[$alias] ) ) {
2636                                 // Is there an INDEX clause for this table?
2637                                 $tableClause = $joinedTable;
2638                                 $tableClause .= ' ' . $this->ignoreIndexClause(
2639                                                 implode( ',', (array)$ignore_index[$alias] )
2640                                         );
2641
2642                                 $ret[] = $tableClause;
2643                         } else {
2644                                 $tableClause = $joinedTable;
2645
2646                                 $ret[] = $tableClause;
2647                         }
2648                 }
2649
2650                 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2651                 $implicitJoins = $ret ? implode( ',', $ret ) : "";
2652                 $explicitJoins = $retJOIN ? implode( ' ', $retJOIN ) : "";
2653
2654                 // Compile our final table clause
2655                 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2656         }
2657
2658         /**
2659          * Allows for index remapping in queries where this is not consistent across DBMS
2660          *
2661          * @param string $index
2662          * @return string
2663          */
2664         protected function indexName( $index ) {
2665                 return $this->indexAliases[$index] ?? $index;
2666         }
2667
2668         public function addQuotes( $s ) {
2669                 if ( $s instanceof Blob ) {
2670                         $s = $s->fetch();
2671                 }
2672                 if ( $s === null ) {
2673                         return 'NULL';
2674                 } elseif ( is_bool( $s ) ) {
2675                         return (int)$s;
2676                 } else {
2677                         # This will also quote numeric values. This should be harmless,
2678                         # and protects against weird problems that occur when they really
2679                         # _are_ strings such as article titles and string->number->string
2680                         # conversion is not 1:1.
2681                         return "'" . $this->strencode( $s ) . "'";
2682                 }
2683         }
2684
2685         public function addIdentifierQuotes( $s ) {
2686                 return '"' . str_replace( '"', '""', $s ) . '"';
2687         }
2688
2689         /**
2690          * Returns if the given identifier looks quoted or not according to
2691          * the database convention for quoting identifiers .
2692          *
2693          * @note Do not use this to determine if untrusted input is safe.
2694          *   A malicious user can trick this function.
2695          * @param string $name
2696          * @return bool
2697          */
2698         public function isQuotedIdentifier( $name ) {
2699                 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2700         }
2701
2702         /**
2703          * @param string $s
2704          * @param string $escapeChar
2705          * @return string
2706          */
2707         protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2708                 return str_replace( [ $escapeChar, '%', '_' ],
2709                         [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2710                         $s );
2711         }
2712
2713         public function buildLike() {
2714                 $params = func_get_args();
2715
2716                 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2717                         $params = $params[0];
2718                 }
2719
2720                 $s = '';
2721
2722                 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2723                 // may escape backslashes, creating problems of double escaping. The `
2724                 // character has good cross-DBMS compatibility, avoiding special operators
2725                 // in MS SQL like ^ and %
2726                 $escapeChar = '`';
2727
2728                 foreach ( $params as $value ) {
2729                         if ( $value instanceof LikeMatch ) {
2730                                 $s .= $value->toString();
2731                         } else {
2732                                 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2733                         }
2734                 }
2735
2736                 return ' LIKE ' .
2737                         $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2738         }
2739
2740         public function anyChar() {
2741                 return new LikeMatch( '_' );
2742         }
2743
2744         public function anyString() {
2745                 return new LikeMatch( '%' );
2746         }
2747
2748         public function nextSequenceValue( $seqName ) {
2749                 return null;
2750         }
2751
2752         /**
2753          * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2754          * is only needed because a) MySQL must be as efficient as possible due to
2755          * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2756          * which index to pick. Anyway, other databases might have different
2757          * indexes on a given table. So don't bother overriding this unless you're
2758          * MySQL.
2759          * @param string $index
2760          * @return string
2761          */
2762         public function useIndexClause( $index ) {
2763                 return '';
2764         }
2765
2766         /**
2767          * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2768          * is only needed because a) MySQL must be as efficient as possible due to
2769          * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2770          * which index to pick. Anyway, other databases might have different
2771          * indexes on a given table. So don't bother overriding this unless you're
2772          * MySQL.
2773          * @param string $index
2774          * @return string
2775          */
2776         public function ignoreIndexClause( $index ) {
2777                 return '';
2778         }
2779
2780         public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
2781                 if ( count( $rows ) == 0 ) {
2782                         return;
2783                 }
2784
2785                 // Single row case
2786                 if ( !is_array( reset( $rows ) ) ) {
2787                         $rows = [ $rows ];
2788                 }
2789
2790                 try {
2791                         $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
2792                         $affectedRowCount = 0;
2793                         foreach ( $rows as $row ) {
2794                                 // Delete rows which collide with this one
2795                                 $indexWhereClauses = [];
2796                                 foreach ( $uniqueIndexes as $index ) {
2797                                         $indexColumns = (array)$index;
2798                                         $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2799                                         if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2800                                                 throw new DBUnexpectedError(
2801                                                         $this,
2802                                                         'New record does not provide all values for unique key (' .
2803                                                         implode( ', ', $indexColumns ) . ')'
2804                                                 );
2805                                         } elseif ( in_array( null, $indexRowValues, true ) ) {
2806                                                 throw new DBUnexpectedError(
2807                                                         $this,
2808                                                         'New record has a null value for unique key (' .
2809                                                         implode( ', ', $indexColumns ) . ')'
2810                                                 );
2811                                         }
2812                                         $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND );
2813                                 }
2814
2815                                 if ( $indexWhereClauses ) {
2816                                         $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR ), $fname );
2817                                         $affectedRowCount += $this->affectedRows();
2818                                 }
2819
2820                                 // Now insert the row
2821                                 $this->insert( $table, $row, $fname );
2822                                 $affectedRowCount += $this->affectedRows();
2823                         }
2824                         $this->endAtomic( $fname );
2825                         $this->affectedRowCount = $affectedRowCount;
2826                 } catch ( Exception $e ) {
2827                         $this->cancelAtomic( $fname );
2828                         throw $e;
2829                 }
2830         }
2831
2832         /**
2833          * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2834          * statement.
2835          *
2836          * @param string $table Table name
2837          * @param array|string $rows Row(s) to insert
2838          * @param string $fname Caller function name
2839          */
2840         protected function nativeReplace( $table, $rows, $fname ) {
2841                 $table = $this->tableName( $table );
2842
2843                 # Single row case
2844                 if ( !is_array( reset( $rows ) ) ) {
2845                         $rows = [ $rows ];
2846                 }
2847
2848                 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2849                 $first = true;
2850
2851                 foreach ( $rows as $row ) {
2852                         if ( $first ) {
2853                                 $first = false;
2854                         } else {
2855                                 $sql .= ',';
2856                         }
2857
2858                         $sql .= '(' . $this->makeList( $row ) . ')';
2859                 }
2860
2861                 $this->query( $sql, $fname );
2862         }
2863
2864         public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2865                 $fname = __METHOD__
2866         ) {
2867                 if ( $rows === [] ) {
2868                         return true; // nothing to do
2869                 }
2870
2871                 if ( !is_array( reset( $rows ) ) ) {
2872                         $rows = [ $rows ];
2873                 }
2874
2875                 if ( count( $uniqueIndexes ) ) {
2876                         $clauses = []; // list WHERE clauses that each identify a single row
2877                         foreach ( $rows as $row ) {
2878                                 foreach ( $uniqueIndexes as $index ) {
2879                                         $index = is_array( $index ) ? $index : [ $index ]; // columns
2880                                         $rowKey = []; // unique key to this row
2881                                         foreach ( $index as $column ) {
2882                                                 $rowKey[$column] = $row[$column];
2883                                         }
2884                                         $clauses[] = $this->makeList( $rowKey, self::LIST_AND );
2885                                 }
2886                         }
2887                         $where = [ $this->makeList( $clauses, self::LIST_OR ) ];
2888                 } else {
2889                         $where = false;
2890                 }
2891
2892                 $affectedRowCount = 0;
2893                 try {
2894                         $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
2895                         # Update any existing conflicting row(s)
2896                         if ( $where !== false ) {
2897                                 $this->update( $table, $set, $where, $fname );
2898                                 $affectedRowCount += $this->affectedRows();
2899                         }
2900                         # Now insert any non-conflicting row(s)
2901                         $this->insert( $table, $rows, $fname, [ 'IGNORE' ] );
2902                         $affectedRowCount += $this->affectedRows();
2903                         $this->endAtomic( $fname );
2904                         $this->affectedRowCount = $affectedRowCount;
2905                 } catch ( Exception $e ) {
2906                         $this->cancelAtomic( $fname );
2907                         throw $e;
2908                 }
2909
2910                 return true;
2911         }
2912
2913         public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2914                 $fname = __METHOD__
2915         ) {
2916                 if ( !$conds ) {
2917                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
2918                 }
2919
2920                 $delTable = $this->tableName( $delTable );
2921                 $joinTable = $this->tableName( $joinTable );
2922                 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2923                 if ( $conds != '*' ) {
2924                         $sql .= 'WHERE ' . $this->makeList( $conds, self::LIST_AND );
2925                 }
2926                 $sql .= ')';
2927
2928                 $this->query( $sql, $fname );
2929         }
2930
2931         public function textFieldSize( $table, $field ) {
2932                 $table = $this->tableName( $table );
2933                 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2934                 $res = $this->query( $sql, __METHOD__ );
2935                 $row = $this->fetchObject( $res );
2936
2937                 $m = [];
2938
2939                 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
2940                         $size = $m[1];
2941                 } else {
2942                         $size = -1;
2943                 }
2944
2945                 return $size;
2946         }
2947
2948         public function delete( $table, $conds, $fname = __METHOD__ ) {
2949                 if ( !$conds ) {
2950                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with no conditions' );
2951                 }
2952
2953                 $table = $this->tableName( $table );
2954                 $sql = "DELETE FROM $table";
2955
2956                 if ( $conds != '*' ) {
2957                         if ( is_array( $conds ) ) {
2958                                 $conds = $this->makeList( $conds, self::LIST_AND );
2959                         }
2960                         $sql .= ' WHERE ' . $conds;
2961                 }
2962
2963                 $this->query( $sql, $fname );
2964
2965                 return true;
2966         }
2967
2968         final public function insertSelect(
2969                 $destTable, $srcTable, $varMap, $conds,
2970                 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2971         ) {
2972                 static $hints = [ 'NO_AUTO_COLUMNS' ];
2973
2974                 $insertOptions = (array)$insertOptions;
2975                 $selectOptions = (array)$selectOptions;
2976
2977                 if ( $this->cliMode && $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
2978                         // For massive migrations with downtime, we don't want to select everything
2979                         // into memory and OOM, so do all this native on the server side if possible.
2980                         $this->nativeInsertSelect(
2981                                 $destTable,
2982                                 $srcTable,
2983                                 $varMap,
2984                                 $conds,
2985                                 $fname,
2986                                 array_diff( $insertOptions, $hints ),
2987                                 $selectOptions,
2988                                 $selectJoinConds
2989                         );
2990                 } else {
2991                         $this->nonNativeInsertSelect(
2992                                 $destTable,
2993                                 $srcTable,
2994                                 $varMap,
2995                                 $conds,
2996                                 $fname,
2997                                 array_diff( $insertOptions, $hints ),
2998                                 $selectOptions,
2999                                 $selectJoinConds
3000                         );
3001                 }
3002
3003                 return true;
3004         }
3005
3006         /**
3007          * @param array $insertOptions INSERT options
3008          * @param array $selectOptions SELECT options
3009          * @return bool Whether an INSERT SELECT with these options will be replication safe
3010          * @since 1.31
3011          */
3012         protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
3013                 return true;
3014         }
3015
3016         /**
3017          * Implementation of insertSelect() based on select() and insert()
3018          *
3019          * @see IDatabase::insertSelect()
3020          * @since 1.30
3021          * @param string $destTable
3022          * @param string|array $srcTable
3023          * @param array $varMap
3024          * @param array $conds
3025          * @param string $fname
3026          * @param array $insertOptions
3027          * @param array $selectOptions
3028          * @param array $selectJoinConds
3029          */
3030         protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3031                 $fname = __METHOD__,
3032                 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3033         ) {
3034                 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
3035                 // on only the master (without needing row-based-replication). It also makes it easy to
3036                 // know how big the INSERT is going to be.
3037                 $fields = [];
3038                 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
3039                         $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
3040                 }
3041                 $selectOptions[] = 'FOR UPDATE';
3042                 $res = $this->select(
3043                         $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
3044                 );
3045                 if ( !$res ) {
3046                         return;
3047                 }
3048
3049                 try {
3050                         $affectedRowCount = 0;
3051                         $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
3052                         $rows = [];
3053                         $ok = true;
3054                         foreach ( $res as $row ) {
3055                                 $rows[] = (array)$row;
3056
3057                                 // Avoid inserts that are too huge
3058                                 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize ) {
3059                                         $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3060                                         if ( !$ok ) {
3061                                                 break;
3062                                         }
3063                                         $affectedRowCount += $this->affectedRows();
3064                                         $rows = [];
3065                                 }
3066                         }
3067                         if ( $rows && $ok ) {
3068                                 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3069                                 if ( $ok ) {
3070                                         $affectedRowCount += $this->affectedRows();
3071                                 }
3072                         }
3073                         if ( $ok ) {
3074                                 $this->endAtomic( $fname );
3075                                 $this->affectedRowCount = $affectedRowCount;
3076                         } else {
3077                                 $this->cancelAtomic( $fname );
3078                         }
3079                 } catch ( Exception $e ) {
3080                         $this->cancelAtomic( $fname );
3081                         throw $e;
3082                 }
3083         }
3084
3085         /**
3086          * Native server-side implementation of insertSelect() for situations where
3087          * we don't want to select everything into memory
3088          *
3089          * @see IDatabase::insertSelect()
3090          * @param string $destTable
3091          * @param string|array $srcTable
3092          * @param array $varMap
3093          * @param array $conds
3094          * @param string $fname
3095          * @param array $insertOptions
3096          * @param array $selectOptions
3097          * @param array $selectJoinConds
3098          */
3099         protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3100                 $fname = __METHOD__,
3101                 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3102         ) {
3103                 $destTable = $this->tableName( $destTable );
3104
3105                 if ( !is_array( $insertOptions ) ) {
3106                         $insertOptions = [ $insertOptions ];
3107                 }
3108
3109                 $insertOptions = $this->makeInsertOptions( $insertOptions );
3110
3111                 $selectSql = $this->selectSQLText(
3112                         $srcTable,
3113                         array_values( $varMap ),
3114                         $conds,
3115                         $fname,
3116                         $selectOptions,
3117                         $selectJoinConds
3118                 );
3119
3120                 $sql = "INSERT $insertOptions" .
3121                         " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
3122                         $selectSql;
3123
3124                 $this->query( $sql, $fname );
3125         }
3126
3127         /**
3128          * Construct a LIMIT query with optional offset. This is used for query
3129          * pages. The SQL should be adjusted so that only the first $limit rows
3130          * are returned. If $offset is provided as well, then the first $offset
3131          * rows should be discarded, and the next $limit rows should be returned.
3132          * If the result of the query is not ordered, then the rows to be returned
3133          * are theoretically arbitrary.
3134          *
3135          * $sql is expected to be a SELECT, if that makes a difference.
3136          *
3137          * The version provided by default works in MySQL and SQLite. It will very
3138          * likely need to be overridden for most other DBMSes.
3139          *
3140          * @param string $sql SQL query we will append the limit too
3141          * @param int $limit The SQL limit
3142          * @param int|bool $offset The SQL offset (default false)
3143          * @throws DBUnexpectedError
3144          * @return string
3145          */
3146         public function limitResult( $sql, $limit, $offset = false ) {
3147                 if ( !is_numeric( $limit ) ) {
3148                         throw new DBUnexpectedError( $this,
3149                                 "Invalid non-numeric limit passed to limitResult()\n" );
3150                 }
3151
3152                 return "$sql LIMIT "
3153                 . ( ( is_numeric( $offset ) && $offset != 0 ) ? "{$offset}," : "" )
3154                 . "{$limit} ";
3155         }
3156
3157         public function unionSupportsOrderAndLimit() {
3158                 return true; // True for almost every DB supported
3159         }
3160
3161         public function unionQueries( $sqls, $all ) {
3162                 $glue = $all ? ') UNION ALL (' : ') UNION (';
3163
3164                 return '(' . implode( $glue, $sqls ) . ')';
3165         }
3166
3167         public function unionConditionPermutations(
3168                 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
3169                 $options = [], $join_conds = []
3170         ) {
3171                 // First, build the Cartesian product of $permute_conds
3172                 $conds = [ [] ];
3173                 foreach ( $permute_conds as $field => $values ) {
3174                         if ( !$values ) {
3175                                 // Skip empty $values
3176                                 continue;
3177                         }
3178                         $values = array_unique( $values ); // For sanity
3179                         $newConds = [];
3180                         foreach ( $conds as $cond ) {
3181                                 foreach ( $values as $value ) {
3182                                         $cond[$field] = $value;
3183                                         $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
3184                                 }
3185                         }
3186                         $conds = $newConds;
3187                 }
3188
3189                 $extra_conds = $extra_conds === '' ? [] : (array)$extra_conds;
3190
3191                 // If there's just one condition and no subordering, hand off to
3192                 // selectSQLText directly.
3193                 if ( count( $conds ) === 1 &&
3194                         ( !isset( $options['INNER ORDER BY'] ) || !$this->unionSupportsOrderAndLimit() )
3195                 ) {
3196                         return $this->selectSQLText(
3197                                 $table, $vars, $conds[0] + $extra_conds, $fname, $options, $join_conds
3198                         );
3199                 }
3200
3201                 // Otherwise, we need to pull out the order and limit to apply after
3202                 // the union. Then build the SQL queries for each set of conditions in
3203                 // $conds. Then union them together (using UNION ALL, because the
3204                 // product *should* already be distinct).
3205                 $orderBy = $this->makeOrderBy( $options );
3206                 $limit = $options['LIMIT'] ?? null;
3207                 $offset = $options['OFFSET'] ?? false;
3208                 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
3209                 if ( !$this->unionSupportsOrderAndLimit() ) {
3210                         unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
3211                 } else {
3212                         if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
3213                                 $options['ORDER BY'] = $options['INNER ORDER BY'];
3214                         }
3215                         if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
3216                                 // We need to increase the limit by the offset rather than
3217                                 // using the offset directly, otherwise it'll skip incorrectly
3218                                 // in the subqueries.
3219                                 $options['LIMIT'] = $limit + $offset;
3220                                 unset( $options['OFFSET'] );
3221                         }
3222                 }
3223
3224                 $sqls = [];
3225                 foreach ( $conds as $cond ) {
3226                         $sqls[] = $this->selectSQLText(
3227                                 $table, $vars, $cond + $extra_conds, $fname, $options, $join_conds
3228                         );
3229                 }
3230                 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
3231                 if ( $limit !== null ) {
3232                         $sql = $this->limitResult( $sql, $limit, $offset );
3233                 }
3234
3235                 return $sql;
3236         }
3237
3238         public function conditional( $cond, $trueVal, $falseVal ) {
3239                 if ( is_array( $cond ) ) {
3240                         $cond = $this->makeList( $cond, self::LIST_AND );
3241                 }
3242
3243                 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3244         }
3245
3246         public function strreplace( $orig, $old, $new ) {
3247                 return "REPLACE({$orig}, {$old}, {$new})";
3248         }
3249
3250         public function getServerUptime() {
3251                 return 0;
3252         }
3253
3254         public function wasDeadlock() {
3255                 return false;
3256         }
3257
3258         public function wasLockTimeout() {
3259                 return false;
3260         }
3261
3262         public function wasConnectionLoss() {
3263                 return $this->wasConnectionError( $this->lastErrno() );
3264         }
3265
3266         public function wasReadOnlyError() {
3267                 return false;
3268         }
3269
3270         public function wasErrorReissuable() {
3271                 return (
3272                         $this->wasDeadlock() ||
3273                         $this->wasLockTimeout() ||
3274                         $this->wasConnectionLoss()
3275                 );
3276         }
3277
3278         /**
3279          * Do not use this method outside of Database/DBError classes
3280          *
3281          * @param int|string $errno
3282          * @return bool Whether the given query error was a connection drop
3283          */
3284         public function wasConnectionError( $errno ) {
3285                 return false;
3286         }
3287
3288         /**
3289          * @return bool Whether it is safe to assume the given error only caused statement rollback
3290          * @note This is for backwards compatibility for callers catching DBError exceptions in
3291          *   order to ignore problems like duplicate key errors or foriegn key violations
3292          * @since 1.31
3293          */
3294         protected function wasKnownStatementRollbackError() {
3295                 return false; // don't know; it could have caused a transaction rollback
3296         }
3297
3298         public function deadlockLoop() {
3299                 $args = func_get_args();
3300                 $function = array_shift( $args );
3301                 $tries = self::DEADLOCK_TRIES;
3302
3303                 $this->begin( __METHOD__ );
3304
3305                 $retVal = null;
3306                 /** @var Exception $e */
3307                 $e = null;
3308                 do {
3309                         try {
3310                                 $retVal = $function( ...$args );
3311                                 break;
3312                         } catch ( DBQueryError $e ) {
3313                                 if ( $this->wasDeadlock() ) {
3314                                         // Retry after a randomized delay
3315                                         usleep( mt_rand( self::DEADLOCK_DELAY_MIN, self::DEADLOCK_DELAY_MAX ) );
3316                                 } else {
3317                                         // Throw the error back up
3318                                         throw $e;
3319                                 }
3320                         }
3321                 } while ( --$tries > 0 );
3322
3323                 if ( $tries <= 0 ) {
3324                         // Too many deadlocks; give up
3325                         $this->rollback( __METHOD__ );
3326                         throw $e;
3327                 } else {
3328                         $this->commit( __METHOD__ );
3329
3330                         return $retVal;
3331                 }
3332         }
3333
3334         public function masterPosWait( DBMasterPos $pos, $timeout ) {
3335                 # Real waits are implemented in the subclass.
3336                 return 0;
3337         }
3338
3339         public function getReplicaPos() {
3340                 # Stub
3341                 return false;
3342         }
3343
3344         public function getMasterPos() {
3345                 # Stub
3346                 return false;
3347         }
3348
3349         public function serverIsReadOnly() {
3350                 return false;
3351         }
3352
3353         final public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
3354                 if ( !$this->trxLevel ) {
3355                         throw new DBUnexpectedError( $this, "No transaction is active." );
3356                 }
3357                 $this->trxEndCallbacks[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3358         }
3359
3360         final public function onTransactionCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
3361                 if ( !$this->trxLevel && $this->getTransactionRoundId() ) {
3362                         // Start an implicit transaction similar to how query() does
3363                         $this->begin( __METHOD__, self::TRANSACTION_INTERNAL );
3364                         $this->trxAutomatic = true;
3365                 }
3366
3367                 $this->trxIdleCallbacks[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3368                 if ( !$this->trxLevel ) {
3369                         $this->runOnTransactionIdleCallbacks( self::TRIGGER_IDLE );
3370                 }
3371         }
3372
3373         final public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
3374                 $this->onTransactionCommitOrIdle( $callback, $fname );
3375         }
3376
3377         final public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
3378                 if ( !$this->trxLevel && $this->getTransactionRoundId() ) {
3379                         // Start an implicit transaction similar to how query() does
3380                         $this->begin( __METHOD__, self::TRANSACTION_INTERNAL );
3381                         $this->trxAutomatic = true;
3382                 }
3383
3384                 if ( $this->trxLevel ) {
3385                         $this->trxPreCommitCallbacks[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3386                 } else {
3387                         // No transaction is active nor will start implicitly, so make one for this callback
3388                         $this->startAtomic( __METHOD__, self::ATOMIC_CANCELABLE );
3389                         try {
3390                                 $callback( $this );
3391                                 $this->endAtomic( __METHOD__ );
3392                         } catch ( Exception $e ) {
3393                                 $this->cancelAtomic( __METHOD__ );
3394                                 throw $e;
3395                         }
3396                 }
3397         }
3398
3399         /**
3400          * @return AtomicSectionIdentifier|null ID of the topmost atomic section level
3401          */
3402         private function currentAtomicSectionId() {
3403                 if ( $this->trxLevel && $this->trxAtomicLevels ) {
3404                         $levelInfo = end( $this->trxAtomicLevels );
3405
3406                         return $levelInfo[1];
3407                 }
3408
3409                 return null;
3410         }
3411
3412         /**
3413          * @param AtomicSectionIdentifier $old
3414          * @param AtomicSectionIdentifier $new
3415          */
3416         private function reassignCallbacksForSection(
3417                 AtomicSectionIdentifier $old, AtomicSectionIdentifier $new
3418         ) {
3419                 foreach ( $this->trxPreCommitCallbacks as $key => $info ) {
3420                         if ( $info[2] === $old ) {
3421                                 $this->trxPreCommitCallbacks[$key][2] = $new;
3422                         }
3423                 }
3424                 foreach ( $this->trxIdleCallbacks as $key => $info ) {
3425                         if ( $info[2] === $old ) {
3426                                 $this->trxIdleCallbacks[$key][2] = $new;
3427                         }
3428                 }
3429                 foreach ( $this->trxEndCallbacks as $key => $info ) {
3430                         if ( $info[2] === $old ) {
3431                                 $this->trxEndCallbacks[$key][2] = $new;
3432                         }
3433                 }
3434         }
3435
3436         /**
3437          * @param AtomicSectionIdentifier[] $sectionIds ID of an actual savepoint
3438          * @throws UnexpectedValueException
3439          */
3440         private function modifyCallbacksForCancel( array $sectionIds ) {
3441                 // Cancel the "on commit" callbacks owned by this savepoint
3442                 $this->trxIdleCallbacks = array_filter(
3443                         $this->trxIdleCallbacks,
3444                         function ( $entry ) use ( $sectionIds ) {
3445                                 return !in_array( $entry[2], $sectionIds, true );
3446                         }
3447                 );
3448                 $this->trxPreCommitCallbacks = array_filter(
3449                         $this->trxPreCommitCallbacks,
3450                         function ( $entry ) use ( $sectionIds ) {
3451                                 return !in_array( $entry[2], $sectionIds, true );
3452                         }
3453                 );
3454                 // Make "on resolution" callbacks owned by this savepoint to perceive a rollback
3455                 foreach ( $this->trxEndCallbacks as $key => $entry ) {
3456                         if ( in_array( $entry[2], $sectionIds, true ) ) {
3457                                 $callback = $entry[0];
3458                                 $this->trxEndCallbacks[$key][0] = function () use ( $callback ) {
3459                                         return $callback( self::TRIGGER_ROLLBACK, $this );
3460                                 };
3461                         }
3462                 }
3463         }
3464
3465         final public function setTransactionListener( $name, callable $callback = null ) {
3466                 if ( $callback ) {
3467                         $this->trxRecurringCallbacks[$name] = $callback;
3468                 } else {
3469                         unset( $this->trxRecurringCallbacks[$name] );
3470                 }
3471         }
3472
3473         /**
3474          * Whether to disable running of post-COMMIT/ROLLBACK callbacks
3475          *
3476          * This method should not be used outside of Database/LoadBalancer
3477          *
3478          * @param bool $suppress
3479          * @since 1.28
3480          */
3481         final public function setTrxEndCallbackSuppression( $suppress ) {
3482                 $this->trxEndCallbacksSuppressed = $suppress;
3483         }
3484
3485         /**
3486          * Actually consume and run any "on transaction idle/resolution" callbacks.
3487          *
3488          * This method should not be used outside of Database/LoadBalancer
3489          *
3490          * @param int $trigger IDatabase::TRIGGER_* constant
3491          * @return int Number of callbacks attempted
3492          * @since 1.20
3493          * @throws Exception
3494          */
3495         public function runOnTransactionIdleCallbacks( $trigger ) {
3496                 if ( $this->trxLevel ) { // sanity
3497                         throw new DBUnexpectedError( $this, __METHOD__ . ': a transaction is still open.' );
3498                 }
3499
3500                 if ( $this->trxEndCallbacksSuppressed ) {
3501                         return 0;
3502                 }
3503
3504                 $count = 0;
3505                 $autoTrx = $this->getFlag( self::DBO_TRX ); // automatic begin() enabled?
3506                 /** @var Exception $e */
3507                 $e = null; // first exception
3508                 do { // callbacks may add callbacks :)
3509                         $callbacks = array_merge(
3510                                 $this->trxIdleCallbacks,
3511                                 $this->trxEndCallbacks // include "transaction resolution" callbacks
3512                         );
3513                         $this->trxIdleCallbacks = []; // consumed (and recursion guard)
3514                         $this->trxEndCallbacks = []; // consumed (recursion guard)
3515                         foreach ( $callbacks as $callback ) {
3516                                 ++$count;
3517                                 list( $phpCallback ) = $callback;
3518                                 $this->clearFlag( self::DBO_TRX ); // make each query its own transaction
3519                                 try {
3520                                         call_user_func( $phpCallback, $trigger, $this );
3521                                 } catch ( Exception $ex ) {
3522                                         call_user_func( $this->errorLogger, $ex );
3523                                         $e = $e ?: $ex;
3524                                         // Some callbacks may use startAtomic/endAtomic, so make sure
3525                                         // their transactions are ended so other callbacks don't fail
3526                                         if ( $this->trxLevel() ) {
3527                                                 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
3528                                         }
3529                                 } finally {
3530                                         if ( $autoTrx ) {
3531                                                 $this->setFlag( self::DBO_TRX ); // restore automatic begin()
3532                                         } else {
3533                                                 $this->clearFlag( self::DBO_TRX ); // restore auto-commit
3534                                         }
3535                                 }
3536                         }
3537                 } while ( count( $this->trxIdleCallbacks ) );
3538
3539                 if ( $e instanceof Exception ) {
3540                         throw $e; // re-throw any first exception
3541                 }
3542
3543                 return $count;
3544         }
3545
3546         /**
3547          * Actually consume and run any "on transaction pre-commit" callbacks.
3548          *
3549          * This method should not be used outside of Database/LoadBalancer
3550          *
3551          * @since 1.22
3552          * @return int Number of callbacks attempted
3553          * @throws Exception
3554          */
3555         public function runOnTransactionPreCommitCallbacks() {
3556                 $count = 0;
3557
3558                 $e = null; // first exception
3559                 do { // callbacks may add callbacks :)
3560                         $callbacks = $this->trxPreCommitCallbacks;
3561                         $this->trxPreCommitCallbacks = []; // consumed (and recursion guard)
3562                         foreach ( $callbacks as $callback ) {
3563                                 try {
3564                                         ++$count;
3565                                         list( $phpCallback ) = $callback;
3566                                         $phpCallback( $this );
3567                                 } catch ( Exception $ex ) {
3568                                         ( $this->errorLogger )( $ex );
3569                                         $e = $e ?: $ex;
3570                                 }
3571                         }
3572                 } while ( count( $this->trxPreCommitCallbacks ) );
3573
3574                 if ( $e instanceof Exception ) {
3575                         throw $e; // re-throw any first exception
3576                 }
3577
3578                 return $count;
3579         }
3580
3581         /**
3582          * Actually run any "transaction listener" callbacks.
3583          *
3584          * This method should not be used outside of Database/LoadBalancer
3585          *
3586          * @param int $trigger IDatabase::TRIGGER_* constant
3587          * @throws Exception
3588          * @since 1.20
3589          */
3590         public function runTransactionListenerCallbacks( $trigger ) {
3591                 if ( $this->trxEndCallbacksSuppressed ) {
3592                         return;
3593                 }
3594
3595                 /** @var Exception $e */
3596                 $e = null; // first exception
3597
3598                 foreach ( $this->trxRecurringCallbacks as $phpCallback ) {
3599                         try {
3600                                 $phpCallback( $trigger, $this );
3601                         } catch ( Exception $ex ) {
3602                                 ( $this->errorLogger )( $ex );
3603                                 $e = $e ?: $ex;
3604                         }
3605                 }
3606
3607                 if ( $e instanceof Exception ) {
3608                         throw $e; // re-throw any first exception
3609                 }
3610         }
3611
3612         /**
3613          * Create a savepoint
3614          *
3615          * This is used internally to implement atomic sections. It should not be
3616          * used otherwise.
3617          *
3618          * @since 1.31
3619          * @param string $identifier Identifier for the savepoint
3620          * @param string $fname Calling function name
3621          */
3622         protected function doSavepoint( $identifier, $fname ) {
3623                 $this->query( 'SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3624         }
3625
3626         /**
3627          * Release a savepoint
3628          *
3629          * This is used internally to implement atomic sections. It should not be
3630          * used otherwise.
3631          *
3632          * @since 1.31
3633          * @param string $identifier Identifier for the savepoint
3634          * @param string $fname Calling function name
3635          */
3636         protected function doReleaseSavepoint( $identifier, $fname ) {
3637                 $this->query( 'RELEASE SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3638         }
3639
3640         /**
3641          * Rollback to a savepoint
3642          *
3643          * This is used internally to implement atomic sections. It should not be
3644          * used otherwise.
3645          *
3646          * @since 1.31
3647          * @param string $identifier Identifier for the savepoint
3648          * @param string $fname Calling function name
3649          */
3650         protected function doRollbackToSavepoint( $identifier, $fname ) {
3651                 $this->query( 'ROLLBACK TO SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3652         }
3653
3654         /**
3655          * @param string $fname
3656          * @return string
3657          */
3658         private function nextSavepointId( $fname ) {
3659                 $savepointId = self::$SAVEPOINT_PREFIX . ++$this->trxAtomicCounter;
3660                 if ( strlen( $savepointId ) > 30 ) {
3661                         // 30 == Oracle's identifier length limit (pre 12c)
3662                         // With a 22 character prefix, that puts the highest number at 99999999.
3663                         throw new DBUnexpectedError(
3664                                 $this,
3665                                 'There have been an excessively large number of atomic sections in a transaction'
3666                                 . " started by $this->trxFname (at $fname)"
3667                         );
3668                 }
3669
3670                 return $savepointId;
3671         }
3672
3673         final public function startAtomic(
3674                 $fname = __METHOD__, $cancelable = self::ATOMIC_NOT_CANCELABLE
3675         ) {
3676                 $savepointId = $cancelable === self::ATOMIC_CANCELABLE ? self::$NOT_APPLICABLE : null;
3677
3678                 if ( !$this->trxLevel ) {
3679                         $this->begin( $fname, self::TRANSACTION_INTERNAL ); // sets trxAutomatic
3680                         // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3681                         // in all changes being in one transaction to keep requests transactional.
3682                         if ( $this->getFlag( self::DBO_TRX ) ) {
3683                                 // Since writes could happen in between the topmost atomic sections as part
3684                                 // of the transaction, those sections will need savepoints.
3685                                 $savepointId = $this->nextSavepointId( $fname );
3686                                 $this->doSavepoint( $savepointId, $fname );
3687                         } else {
3688                                 $this->trxAutomaticAtomic = true;
3689                         }
3690                 } elseif ( $cancelable === self::ATOMIC_CANCELABLE ) {
3691                         $savepointId = $this->nextSavepointId( $fname );
3692                         $this->doSavepoint( $savepointId, $fname );
3693                 }
3694
3695                 $sectionId = new AtomicSectionIdentifier;
3696                 $this->trxAtomicLevels[] = [ $fname, $sectionId, $savepointId ];
3697                 $this->queryLogger->debug( 'startAtomic: entering level ' .
3698                         ( count( $this->trxAtomicLevels ) - 1 ) . " ($fname)" );
3699
3700                 return $sectionId;
3701         }
3702
3703         final public function endAtomic( $fname = __METHOD__ ) {
3704                 if ( !$this->trxLevel || !$this->trxAtomicLevels ) {
3705                         throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3706                 }
3707
3708                 // Check if the current section matches $fname
3709                 $pos = count( $this->trxAtomicLevels ) - 1;
3710                 list( $savedFname, $sectionId, $savepointId ) = $this->trxAtomicLevels[$pos];
3711                 $this->queryLogger->debug( "endAtomic: leaving level $pos ($fname)" );
3712
3713                 if ( $savedFname !== $fname ) {
3714                         throw new DBUnexpectedError(
3715                                 $this,
3716                                 "Invalid atomic section ended (got $fname but expected $savedFname)."
3717                         );
3718                 }
3719
3720                 // Remove the last section (no need to re-index the array)
3721                 array_pop( $this->trxAtomicLevels );
3722
3723                 if ( !$this->trxAtomicLevels && $this->trxAutomaticAtomic ) {
3724                         $this->commit( $fname, self::FLUSHING_INTERNAL );
3725                 } elseif ( $savepointId !== null && $savepointId !== self::$NOT_APPLICABLE ) {
3726                         $this->doReleaseSavepoint( $savepointId, $fname );
3727                 }
3728
3729                 // Hoist callback ownership for callbacks in the section that just ended;
3730                 // all callbacks should have an owner that is present in trxAtomicLevels.
3731                 $currentSectionId = $this->currentAtomicSectionId();
3732                 if ( $currentSectionId ) {
3733                         $this->reassignCallbacksForSection( $sectionId, $currentSectionId );
3734                 }
3735         }
3736
3737         final public function cancelAtomic(
3738                 $fname = __METHOD__, AtomicSectionIdentifier $sectionId = null
3739         ) {
3740                 if ( !$this->trxLevel || !$this->trxAtomicLevels ) {
3741                         throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3742                 }
3743
3744                 $excisedFnames = [];
3745                 if ( $sectionId !== null ) {
3746                         // Find the (last) section with the given $sectionId
3747                         $pos = -1;
3748                         foreach ( $this->trxAtomicLevels as $i => list( $asFname, $asId, $spId ) ) {
3749                                 if ( $asId === $sectionId ) {
3750                                         $pos = $i;
3751                                 }
3752                         }
3753                         if ( $pos < 0 ) {
3754                                 throw new DBUnexpectedError( $this, "Atomic section not found (for $fname)" );
3755                         }
3756                         // Remove all descendant sections and re-index the array
3757                         $excisedIds = [];
3758                         $len = count( $this->trxAtomicLevels );
3759                         for ( $i = $pos + 1; $i < $len; ++$i ) {
3760                                 $excisedFnames[] = $this->trxAtomicLevels[$i][0];
3761                                 $excisedIds[] = $this->trxAtomicLevels[$i][1];
3762                         }
3763                         $this->trxAtomicLevels = array_slice( $this->trxAtomicLevels, 0, $pos + 1 );
3764                         $this->modifyCallbacksForCancel( $excisedIds );
3765                 }
3766
3767                 // Check if the current section matches $fname
3768                 $pos = count( $this->trxAtomicLevels ) - 1;
3769                 list( $savedFname, $savedSectionId, $savepointId ) = $this->trxAtomicLevels[$pos];
3770
3771                 if ( $excisedFnames ) {
3772                         $this->queryLogger->debug( "cancelAtomic: canceling level $pos ($savedFname) " .
3773                                 "and descendants " . implode( ', ', $excisedFnames ) );
3774                 } else {
3775                         $this->queryLogger->debug( "cancelAtomic: canceling level $pos ($savedFname)" );
3776                 }
3777
3778                 if ( $savedFname !== $fname ) {
3779                         throw new DBUnexpectedError(
3780                                 $this,
3781                                 "Invalid atomic section ended (got $fname but expected $savedFname)."
3782                         );
3783                 }
3784
3785                 // Remove the last section (no need to re-index the array)
3786                 array_pop( $this->trxAtomicLevels );
3787                 $this->modifyCallbacksForCancel( [ $savedSectionId ] );
3788
3789                 if ( $savepointId !== null ) {
3790                         // Rollback the transaction to the state just before this atomic section
3791                         if ( $savepointId === self::$NOT_APPLICABLE ) {
3792                                 $this->rollback( $fname, self::FLUSHING_INTERNAL );
3793                         } else {
3794                                 $this->doRollbackToSavepoint( $savepointId, $fname );
3795                                 $this->trxStatus = self::STATUS_TRX_OK; // no exception; recovered
3796                                 $this->trxStatusIgnoredCause = null;
3797                         }
3798                 } elseif ( $this->trxStatus > self::STATUS_TRX_ERROR ) {
3799                         // Put the transaction into an error state if it's not already in one
3800                         $this->trxStatus = self::STATUS_TRX_ERROR;
3801                         $this->trxStatusCause = new DBUnexpectedError(
3802                                 $this,
3803                                 "Uncancelable atomic section canceled (got $fname)."
3804                         );
3805                 }
3806
3807                 $this->affectedRowCount = 0; // for the sake of consistency
3808         }
3809
3810         final public function doAtomicSection(
3811                 $fname, callable $callback, $cancelable = self::ATOMIC_NOT_CANCELABLE
3812         ) {
3813                 $sectionId = $this->startAtomic( $fname, $cancelable );
3814                 try {
3815                         $res = $callback( $this, $fname );
3816                 } catch ( Exception $e ) {
3817                         $this->cancelAtomic( $fname, $sectionId );
3818
3819                         throw $e;
3820                 }
3821                 $this->endAtomic( $fname );
3822
3823                 return $res;
3824         }
3825
3826         final public function begin( $fname = __METHOD__, $mode = self::TRANSACTION_EXPLICIT ) {
3827                 static $modes = [ self::TRANSACTION_EXPLICIT, self::TRANSACTION_INTERNAL ];
3828                 if ( !in_array( $mode, $modes, true ) ) {
3829                         throw new DBUnexpectedError( $this, "$fname: invalid mode parameter '$mode'." );
3830                 }
3831
3832                 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3833                 if ( $this->trxLevel ) {
3834                         if ( $this->trxAtomicLevels ) {
3835                                 $levels = $this->flatAtomicSectionList();
3836                                 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3837                                 throw new DBUnexpectedError( $this, $msg );
3838                         } elseif ( !$this->trxAutomatic ) {
3839                                 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3840                                 throw new DBUnexpectedError( $this, $msg );
3841                         } else {
3842                                 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3843                                 throw new DBUnexpectedError( $this, $msg );
3844                         }
3845                 } elseif ( $this->getFlag( self::DBO_TRX ) && $mode !== self::TRANSACTION_INTERNAL ) {
3846                         $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3847                         throw new DBUnexpectedError( $this, $msg );
3848                 }
3849
3850                 // Avoid fatals if close() was called
3851                 $this->assertOpen();
3852
3853                 $this->doBegin( $fname );
3854                 $this->trxStatus = self::STATUS_TRX_OK;
3855                 $this->trxStatusIgnoredCause = null;
3856                 $this->trxAtomicCounter = 0;
3857                 $this->trxTimestamp = microtime( true );
3858                 $this->trxFname = $fname;
3859                 $this->trxDoneWrites = false;
3860                 $this->trxAutomaticAtomic = false;
3861                 $this->trxAtomicLevels = [];
3862                 $this->trxShortId = sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3863                 $this->trxWriteDuration = 0.0;
3864                 $this->trxWriteQueryCount = 0;
3865                 $this->trxWriteAffectedRows = 0;
3866                 $this->trxWriteAdjDuration = 0.0;
3867                 $this->trxWriteAdjQueryCount = 0;
3868                 $this->trxWriteCallers = [];
3869                 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3870                 // Get an estimate of the replication lag before any such queries.
3871                 $this->trxReplicaLag = null; // clear cached value first
3872                 $this->trxReplicaLag = $this->getApproximateLagStatus()['lag'];
3873                 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3874                 // caller will think its OK to muck around with the transaction just because startAtomic()
3875                 // has not yet completed (e.g. setting trxAtomicLevels).
3876                 $this->trxAutomatic = ( $mode === self::TRANSACTION_INTERNAL );
3877         }
3878
3879         /**
3880          * Issues the BEGIN command to the database server.
3881          *
3882          * @see Database::begin()
3883          * @param string $fname
3884          */
3885         protected function doBegin( $fname ) {
3886                 $this->query( 'BEGIN', $fname );
3887                 $this->trxLevel = 1;
3888         }
3889
3890         final public function commit( $fname = __METHOD__, $flush = self::FLUSHING_ONE ) {
3891                 static $modes = [ self::FLUSHING_ONE, self::FLUSHING_ALL_PEERS, self::FLUSHING_INTERNAL ];
3892                 if ( !in_array( $flush, $modes, true ) ) {
3893                         throw new DBUnexpectedError( $this, "$fname: invalid flush parameter '$flush'." );
3894                 }
3895
3896                 if ( $this->trxLevel && $this->trxAtomicLevels ) {
3897                         // There are still atomic sections open; this cannot be ignored
3898                         $levels = $this->flatAtomicSectionList();
3899                         throw new DBUnexpectedError(
3900                                 $this,
3901                                 "$fname: Got COMMIT while atomic sections $levels are still open."
3902                         );
3903                 }
3904
3905                 if ( $flush === self::FLUSHING_INTERNAL || $flush === self::FLUSHING_ALL_PEERS ) {
3906                         if ( !$this->trxLevel ) {
3907                                 return; // nothing to do
3908                         } elseif ( !$this->trxAutomatic ) {
3909                                 throw new DBUnexpectedError(
3910                                         $this,
3911                                         "$fname: Flushing an explicit transaction, getting out of sync."
3912                                 );
3913                         }
3914                 } else {
3915                         if ( !$this->trxLevel ) {
3916                                 $this->queryLogger->error(
3917                                         "$fname: No transaction to commit, something got out of sync." );
3918                                 return; // nothing to do
3919                         } elseif ( $this->trxAutomatic ) {
3920                                 throw new DBUnexpectedError(
3921                                         $this,
3922                                         "$fname: Expected mass commit of all peer transactions (DBO_TRX set)."
3923                                 );
3924                         }
3925                 }
3926
3927                 // Avoid fatals if close() was called
3928                 $this->assertOpen();
3929
3930                 $this->runOnTransactionPreCommitCallbacks();
3931
3932                 $writeTime = $this->pendingWriteQueryDuration( self::ESTIMATE_DB_APPLY );
3933                 $this->doCommit( $fname );
3934                 $this->trxStatus = self::STATUS_TRX_NONE;
3935
3936                 if ( $this->trxDoneWrites ) {
3937                         $this->lastWriteTime = microtime( true );
3938                         $this->trxProfiler->transactionWritingOut(
3939                                 $this->server,
3940                                 $this->getDomainID(),
3941                                 $this->trxShortId,
3942                                 $writeTime,
3943                                 $this->trxWriteAffectedRows
3944                         );
3945                 }
3946
3947                 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3948                 if ( $flush !== self::FLUSHING_ALL_PEERS ) {
3949                         $this->runOnTransactionIdleCallbacks( self::TRIGGER_COMMIT );
3950                         $this->runTransactionListenerCallbacks( self::TRIGGER_COMMIT );
3951                 }
3952         }
3953
3954         /**
3955          * Issues the COMMIT command to the database server.
3956          *
3957          * @see Database::commit()
3958          * @param string $fname
3959          */
3960         protected function doCommit( $fname ) {
3961                 if ( $this->trxLevel ) {
3962                         $this->query( 'COMMIT', $fname );
3963                         $this->trxLevel = 0;
3964                 }
3965         }
3966
3967         final public function rollback( $fname = __METHOD__, $flush = '' ) {
3968                 $trxActive = $this->trxLevel;
3969
3970                 if ( $flush !== self::FLUSHING_INTERNAL && $flush !== self::FLUSHING_ALL_PEERS ) {
3971                         if ( $this->getFlag( self::DBO_TRX ) ) {
3972                                 throw new DBUnexpectedError(
3973                                         $this,
3974                                         "$fname: Expected mass rollback of all peer transactions (DBO_TRX set)."
3975                                 );
3976                         }
3977                 }
3978
3979                 if ( $trxActive ) {
3980                         // Avoid fatals if close() was called
3981                         $this->assertOpen();
3982
3983                         $this->doRollback( $fname );
3984                         $this->trxStatus = self::STATUS_TRX_NONE;
3985                         $this->trxAtomicLevels = [];
3986                         // Estimate the RTT via a query now that trxStatus is OK
3987                         $writeTime = $this->pingAndCalculateLastTrxApplyTime();
3988
3989                         if ( $this->trxDoneWrites ) {
3990                                 $this->trxProfiler->transactionWritingOut(
3991                                         $this->server,
3992                                         $this->getDomainID(),
3993                                         $this->trxShortId,
3994                                         $writeTime,
3995                                         $this->trxWriteAffectedRows
3996                                 );
3997                         }
3998                 }
3999
4000                 // Clear any commit-dependant callbacks. They might even be present
4001                 // only due to transaction rounds, with no SQL transaction being active
4002                 $this->trxIdleCallbacks = [];
4003                 $this->trxPreCommitCallbacks = [];
4004
4005                 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
4006                 if ( $trxActive && $flush !== self::FLUSHING_ALL_PEERS ) {
4007                         try {
4008                                 $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
4009                         } catch ( Exception $e ) {
4010                                 // already logged; finish and let LoadBalancer move on during mass-rollback
4011                         }
4012                         try {
4013                                 $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
4014                         } catch ( Exception $e ) {
4015                                 // already logged; let LoadBalancer move on during mass-rollback
4016                         }
4017
4018                         $this->affectedRowCount = 0; // for the sake of consistency
4019                 }
4020         }
4021
4022         /**
4023          * Issues the ROLLBACK command to the database server.
4024          *
4025          * @see Database::rollback()
4026          * @param string $fname
4027          */
4028         protected function doRollback( $fname ) {
4029                 if ( $this->trxLevel ) {
4030                         # Disconnects cause rollback anyway, so ignore those errors
4031                         $ignoreErrors = true;
4032                         $this->query( 'ROLLBACK', $fname, $ignoreErrors );
4033                         $this->trxLevel = 0;
4034                 }
4035         }
4036
4037         public function flushSnapshot( $fname = __METHOD__ ) {
4038                 if ( $this->writesOrCallbacksPending() || $this->explicitTrxActive() ) {
4039                         // This only flushes transactions to clear snapshots, not to write data
4040                         $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4041                         throw new DBUnexpectedError(
4042                                 $this,
4043                                 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
4044                         );
4045                 }
4046
4047                 $this->commit( $fname, self::FLUSHING_INTERNAL );
4048         }
4049
4050         public function explicitTrxActive() {
4051                 return $this->trxLevel && ( $this->trxAtomicLevels || !$this->trxAutomatic );
4052         }
4053
4054         public function duplicateTableStructure(
4055                 $oldName, $newName, $temporary = false, $fname = __METHOD__
4056         ) {
4057                 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
4058         }
4059
4060         public function listTables( $prefix = null, $fname = __METHOD__ ) {
4061                 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
4062         }
4063
4064         public function listViews( $prefix = null, $fname = __METHOD__ ) {
4065                 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
4066         }
4067
4068         public function timestamp( $ts = 0 ) {
4069                 $t = new ConvertibleTimestamp( $ts );
4070                 // Let errors bubble up to avoid putting garbage in the DB
4071                 return $t->getTimestamp( TS_MW );
4072         }
4073
4074         public function timestampOrNull( $ts = null ) {
4075                 if ( is_null( $ts ) ) {
4076                         return null;
4077                 } else {
4078                         return $this->timestamp( $ts );
4079                 }
4080         }
4081
4082         public function affectedRows() {
4083                 return ( $this->affectedRowCount === null )
4084                         ? $this->fetchAffectedRowCount() // default to driver value
4085                         : $this->affectedRowCount;
4086         }
4087
4088         /**
4089          * @return int Number of retrieved rows according to the driver
4090          */
4091         abstract protected function fetchAffectedRowCount();
4092
4093         /**
4094          * Take the result from a query, and wrap it in a ResultWrapper if
4095          * necessary. Boolean values are passed through as is, to indicate success
4096          * of write queries or failure.
4097          *
4098          * Once upon a time, Database::query() returned a bare MySQL result
4099          * resource, and it was necessary to call this function to convert it to
4100          * a wrapper. Nowadays, raw database objects are never exposed to external
4101          * callers, so this is unnecessary in external code.
4102          *
4103          * @param bool|ResultWrapper|resource $result
4104          * @return bool|ResultWrapper
4105          */
4106         protected function resultObject( $result ) {
4107                 if ( !$result ) {
4108                         return false;
4109                 } elseif ( $result instanceof ResultWrapper ) {
4110                         return $result;
4111                 } elseif ( $result === true ) {
4112                         // Successful write query
4113                         return $result;
4114                 } else {
4115                         return new ResultWrapper( $this, $result );
4116                 }
4117         }
4118
4119         public function ping( &$rtt = null ) {
4120                 // Avoid hitting the server if it was hit recently
4121                 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing ) < self::PING_TTL ) {
4122                         if ( !func_num_args() || $this->rttEstimate > 0 ) {
4123                                 $rtt = $this->rttEstimate;
4124                                 return true; // don't care about $rtt
4125                         }
4126                 }
4127
4128                 // This will reconnect if possible or return false if not
4129                 $this->clearFlag( self::DBO_TRX, self::REMEMBER_PRIOR );
4130                 $ok = ( $this->query( self::PING_QUERY, __METHOD__, true ) !== false );
4131                 $this->restoreFlags( self::RESTORE_PRIOR );
4132
4133                 if ( $ok ) {
4134                         $rtt = $this->rttEstimate;
4135                 }
4136
4137                 return $ok;
4138         }
4139
4140         /**
4141          * Close any existing (dead) database connection and open a new connection
4142          *
4143          * @param string $fname
4144          * @return bool True if new connection is opened successfully, false if error
4145          */
4146         protected function replaceLostConnection( $fname ) {
4147                 $this->closeConnection();
4148                 $this->opened = false;
4149                 $this->conn = false;
4150                 try {
4151                         $this->open(
4152                                 $this->server,
4153                                 $this->user,
4154                                 $this->password,
4155                                 $this->getDBname(),
4156                                 $this->dbSchema(),
4157                                 $this->tablePrefix()
4158                         );
4159                         $this->lastPing = microtime( true );
4160                         $ok = true;
4161
4162                         $this->connLogger->warning(
4163                                 $fname . ': lost connection to {dbserver}; reconnected',
4164                                 [
4165                                         'dbserver' => $this->getServer(),
4166                                         'trace' => ( new RuntimeException() )->getTraceAsString()
4167                                 ]
4168                         );
4169                 } catch ( DBConnectionError $e ) {
4170                         $ok = false;
4171
4172                         $this->connLogger->error(
4173                                 $fname . ': lost connection to {dbserver} permanently',
4174                                 [ 'dbserver' => $this->getServer() ]
4175                         );
4176                 }
4177
4178                 $this->handleSessionLoss();
4179
4180                 return $ok;
4181         }
4182
4183         public function getSessionLagStatus() {
4184                 return $this->getRecordedTransactionLagStatus() ?: $this->getApproximateLagStatus();
4185         }
4186
4187         /**
4188          * Get the replica DB lag when the current transaction started
4189          *
4190          * This is useful when transactions might use snapshot isolation
4191          * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
4192          * is this lag plus transaction duration. If they don't, it is still
4193          * safe to be pessimistic. This returns null if there is no transaction.
4194          *
4195          * This returns null if the lag status for this transaction was not yet recorded.
4196          *
4197          * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
4198          * @since 1.27
4199          */
4200         final protected function getRecordedTransactionLagStatus() {
4201                 return ( $this->trxLevel && $this->trxReplicaLag !== null )
4202                         ? [ 'lag' => $this->trxReplicaLag, 'since' => $this->trxTimestamp() ]
4203                         : null;
4204         }
4205
4206         /**
4207          * Get a replica DB lag estimate for this server
4208          *
4209          * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
4210          * @since 1.27
4211          */
4212         protected function getApproximateLagStatus() {
4213                 return [
4214                         'lag'   => $this->getLBInfo( 'replica' ) ? $this->getLag() : 0,
4215                         'since' => microtime( true )
4216                 ];
4217         }
4218
4219         /**
4220          * Merge the result of getSessionLagStatus() for several DBs
4221          * using the most pessimistic values to estimate the lag of
4222          * any data derived from them in combination
4223          *
4224          * This is information is useful for caching modules
4225          *
4226          * @see WANObjectCache::set()
4227          * @see WANObjectCache::getWithSetCallback()
4228          *
4229          * @param IDatabase $db1
4230          * @param IDatabase|null $db2 [optional]
4231          * @return array Map of values:
4232          *   - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
4233          *   - since: oldest UNIX timestamp of any of the DB lag estimates
4234          *   - pending: whether any of the DBs have uncommitted changes
4235          * @throws DBError
4236          * @since 1.27
4237          */
4238         public static function getCacheSetOptions( IDatabase $db1, IDatabase $db2 = null ) {
4239                 $res = [ 'lag' => 0, 'since' => INF, 'pending' => false ];
4240                 foreach ( func_get_args() as $db ) {
4241                         /** @var IDatabase $db */
4242                         $status = $db->getSessionLagStatus();
4243                         if ( $status['lag'] === false ) {
4244                                 $res['lag'] = false;
4245                         } elseif ( $res['lag'] !== false ) {
4246                                 $res['lag'] = max( $res['lag'], $status['lag'] );
4247                         }
4248                         $res['since'] = min( $res['since'], $status['since'] );
4249                         $res['pending'] = $res['pending'] ?: $db->writesPending();
4250                 }
4251
4252                 return $res;
4253         }
4254
4255         public function getLag() {
4256                 return 0;
4257         }
4258
4259         public function maxListLen() {
4260                 return 0;
4261         }
4262
4263         public function encodeBlob( $b ) {
4264                 return $b;
4265         }
4266
4267         public function decodeBlob( $b ) {
4268                 if ( $b instanceof Blob ) {
4269                         $b = $b->fetch();
4270                 }
4271                 return $b;
4272         }
4273
4274         public function setSessionOptions( array $options ) {
4275         }
4276
4277         public function sourceFile(
4278                 $filename,
4279                 callable $lineCallback = null,
4280                 callable $resultCallback = null,
4281                 $fname = false,
4282                 callable $inputCallback = null
4283         ) {
4284                 Wikimedia\suppressWarnings();
4285                 $fp = fopen( $filename, 'r' );
4286                 Wikimedia\restoreWarnings();
4287
4288                 if ( $fp === false ) {
4289                         throw new RuntimeException( "Could not open \"{$filename}\".\n" );
4290                 }
4291
4292                 if ( !$fname ) {
4293                         $fname = __METHOD__ . "( $filename )";
4294                 }
4295
4296                 try {
4297                         $error = $this->sourceStream(
4298                                 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
4299                 } catch ( Exception $e ) {
4300                         fclose( $fp );
4301                         throw $e;
4302                 }
4303
4304                 fclose( $fp );
4305
4306                 return $error;
4307         }
4308
4309         public function setSchemaVars( $vars ) {
4310                 $this->schemaVars = $vars;
4311         }
4312
4313         public function sourceStream(
4314                 $fp,
4315                 callable $lineCallback = null,
4316                 callable $resultCallback = null,
4317                 $fname = __METHOD__,
4318                 callable $inputCallback = null
4319         ) {
4320                 $delimiterReset = new ScopedCallback(
4321                         function ( $delimiter ) {
4322                                 $this->delimiter = $delimiter;
4323                         },
4324                         [ $this->delimiter ]
4325                 );
4326                 $cmd = '';
4327
4328                 while ( !feof( $fp ) ) {
4329                         if ( $lineCallback ) {
4330                                 call_user_func( $lineCallback );
4331                         }
4332
4333                         $line = trim( fgets( $fp ) );
4334
4335                         if ( $line == '' ) {
4336                                 continue;
4337                         }
4338
4339                         if ( $line[0] == '-' && $line[1] == '-' ) {
4340                                 continue;
4341                         }
4342
4343                         if ( $cmd != '' ) {
4344                                 $cmd .= ' ';
4345                         }
4346
4347                         $done = $this->streamStatementEnd( $cmd, $line );
4348
4349                         $cmd .= "$line\n";
4350
4351                         if ( $done || feof( $fp ) ) {
4352                                 $cmd = $this->replaceVars( $cmd );
4353
4354                                 if ( $inputCallback ) {
4355                                         $callbackResult = $inputCallback( $cmd );
4356
4357                                         if ( is_string( $callbackResult ) || !$callbackResult ) {
4358                                                 $cmd = $callbackResult;
4359                                         }
4360                                 }
4361
4362                                 if ( $cmd ) {
4363                                         $res = $this->query( $cmd, $fname );
4364
4365                                         if ( $resultCallback ) {
4366                                                 $resultCallback( $res, $this );
4367                                         }
4368
4369                                         if ( $res === false ) {
4370                                                 $err = $this->lastError();
4371
4372                                                 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4373                                         }
4374                                 }
4375                                 $cmd = '';
4376                         }
4377                 }
4378
4379                 ScopedCallback::consume( $delimiterReset );
4380                 return true;
4381         }
4382
4383         /**
4384          * Called by sourceStream() to check if we've reached a statement end
4385          *
4386          * @param string &$sql SQL assembled so far
4387          * @param string &$newLine New line about to be added to $sql
4388          * @return bool Whether $newLine contains end of the statement
4389          */
4390         public function streamStatementEnd( &$sql, &$newLine ) {
4391                 if ( $this->delimiter ) {
4392                         $prev = $newLine;
4393                         $newLine = preg_replace(
4394                                 '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine );
4395                         if ( $newLine != $prev ) {
4396                                 return true;
4397                         }
4398                 }
4399
4400                 return false;
4401         }
4402
4403         /**
4404          * Database independent variable replacement. Replaces a set of variables
4405          * in an SQL statement with their contents as given by $this->getSchemaVars().
4406          *
4407          * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4408          *
4409          * - '{$var}' should be used for text and is passed through the database's
4410          *   addQuotes method.
4411          * - `{$var}` should be used for identifiers (e.g. table and database names).
4412          *   It is passed through the database's addIdentifierQuotes method which
4413          *   can be overridden if the database uses something other than backticks.
4414          * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
4415          *   database's tableName method.
4416          * - / *i* / passes the name that follows through the database's indexName method.
4417          * - In all other cases, / *$var* / is left unencoded. Except for table options,
4418          *   its use should be avoided. In 1.24 and older, string encoding was applied.
4419          *
4420          * @param string $ins SQL statement to replace variables in
4421          * @return string The new SQL statement with variables replaced
4422          */
4423         protected function replaceVars( $ins ) {
4424                 $vars = $this->getSchemaVars();
4425                 return preg_replace_callback(
4426                         '!
4427                                 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
4428                                 \'\{\$ (\w+) }\'                  | # 3. addQuotes
4429                                 `\{\$ (\w+) }`                    | # 4. addIdentifierQuotes
4430                                 /\*\$ (\w+) \*/                     # 5. leave unencoded
4431                         !x',
4432                         function ( $m ) use ( $vars ) {
4433                                 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
4434                                 // check for both nonexistent keys *and* the empty string.
4435                                 if ( isset( $m[1] ) && $m[1] !== '' ) {
4436                                         if ( $m[1] === 'i' ) {
4437                                                 return $this->indexName( $m[2] );
4438                                         } else {
4439                                                 return $this->tableName( $m[2] );
4440                                         }
4441                                 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
4442                                         return $this->addQuotes( $vars[$m[3]] );
4443                                 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
4444                                         return $this->addIdentifierQuotes( $vars[$m[4]] );
4445                                 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
4446                                         return $vars[$m[5]];
4447                                 } else {
4448                                         return $m[0];
4449                                 }
4450                         },
4451                         $ins
4452                 );
4453         }
4454
4455         /**
4456          * Get schema variables. If none have been set via setSchemaVars(), then
4457          * use some defaults from the current object.
4458          *
4459          * @return array
4460          */
4461         protected function getSchemaVars() {
4462                 if ( $this->schemaVars ) {
4463                         return $this->schemaVars;
4464                 } else {
4465                         return $this->getDefaultSchemaVars();
4466                 }
4467         }
4468
4469         /**
4470          * Get schema variables to use if none have been set via setSchemaVars().
4471          *
4472          * Override this in derived classes to provide variables for tables.sql
4473          * and SQL patch files.
4474          *
4475          * @return array
4476          */
4477         protected function getDefaultSchemaVars() {
4478                 return [];
4479         }
4480
4481         public function lockIsFree( $lockName, $method ) {
4482                 // RDBMs methods for checking named locks may or may not count this thread itself.
4483                 // In MySQL, IS_FREE_LOCK() returns 0 if the thread already has the lock. This is
4484                 // the behavior choosen by the interface for this method.
4485                 return !isset( $this->namedLocksHeld[$lockName] );
4486         }
4487
4488         public function lock( $lockName, $method, $timeout = 5 ) {
4489                 $this->namedLocksHeld[$lockName] = 1;
4490
4491                 return true;
4492         }
4493
4494         public function unlock( $lockName, $method ) {
4495                 unset( $this->namedLocksHeld[$lockName] );
4496
4497                 return true;
4498         }
4499
4500         public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
4501                 if ( $this->writesOrCallbacksPending() ) {
4502                         // This only flushes transactions to clear snapshots, not to write data
4503                         $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4504                         throw new DBUnexpectedError(
4505                                 $this,
4506                                 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
4507                         );
4508                 }
4509
4510                 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
4511                         return null;
4512                 }
4513
4514                 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
4515                         if ( $this->trxLevel() ) {
4516                                 // There is a good chance an exception was thrown, causing any early return
4517                                 // from the caller. Let any error handler get a chance to issue rollback().
4518                                 // If there isn't one, let the error bubble up and trigger server-side rollback.
4519                                 $this->onTransactionResolution(
4520                                         function () use ( $lockKey, $fname ) {
4521                                                 $this->unlock( $lockKey, $fname );
4522                                         },
4523                                         $fname
4524                                 );
4525                         } else {
4526                                 $this->unlock( $lockKey, $fname );
4527                         }
4528                 } );
4529
4530                 $this->commit( $fname, self::FLUSHING_INTERNAL );
4531
4532                 return $unlocker;
4533         }
4534
4535         public function namedLocksEnqueue() {
4536                 return false;
4537         }
4538
4539         public function tableLocksHaveTransactionScope() {
4540                 return true;
4541         }
4542
4543         final public function lockTables( array $read, array $write, $method ) {
4544                 if ( $this->writesOrCallbacksPending() ) {
4545                         throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
4546                 }
4547
4548                 if ( $this->tableLocksHaveTransactionScope() ) {
4549                         $this->startAtomic( $method );
4550                 }
4551
4552                 return $this->doLockTables( $read, $write, $method );
4553         }
4554
4555         /**
4556          * Helper function for lockTables() that handles the actual table locking
4557          *
4558          * @param array $read Array of tables to lock for read access
4559          * @param array $write Array of tables to lock for write access
4560          * @param string $method Name of caller
4561          * @return true
4562          */
4563         protected function doLockTables( array $read, array $write, $method ) {
4564                 return true;
4565         }
4566
4567         final public function unlockTables( $method ) {
4568                 if ( $this->tableLocksHaveTransactionScope() ) {
4569                         $this->endAtomic( $method );
4570
4571                         return true; // locks released on COMMIT/ROLLBACK
4572                 }
4573
4574                 return $this->doUnlockTables( $method );
4575         }
4576
4577         /**
4578          * Helper function for unlockTables() that handles the actual table unlocking
4579          *
4580          * @param string $method Name of caller
4581          * @return true
4582          */
4583         protected function doUnlockTables( $method ) {
4584                 return true;
4585         }
4586
4587         /**
4588          * Delete a table
4589          * @param string $tableName
4590          * @param string $fName
4591          * @return bool|ResultWrapper
4592          * @since 1.18
4593          */
4594         public function dropTable( $tableName, $fName = __METHOD__ ) {
4595                 if ( !$this->tableExists( $tableName, $fName ) ) {
4596                         return false;
4597                 }
4598                 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
4599
4600                 return $this->query( $sql, $fName );
4601         }
4602
4603         public function getInfinity() {
4604                 return 'infinity';
4605         }
4606
4607         public function encodeExpiry( $expiry ) {
4608                 return ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() )
4609                         ? $this->getInfinity()
4610                         : $this->timestamp( $expiry );
4611         }
4612
4613         public function decodeExpiry( $expiry, $format = TS_MW ) {
4614                 if ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() ) {
4615                         return 'infinity';
4616                 }
4617
4618                 return ConvertibleTimestamp::convert( $format, $expiry );
4619         }
4620
4621         public function setBigSelects( $value = true ) {
4622                 // no-op
4623         }
4624
4625         public function isReadOnly() {
4626                 return ( $this->getReadOnlyReason() !== false );
4627         }
4628
4629         /**
4630          * @return string|bool Reason this DB is read-only or false if it is not
4631          */
4632         protected function getReadOnlyReason() {
4633                 $reason = $this->getLBInfo( 'readOnlyReason' );
4634
4635                 return is_string( $reason ) ? $reason : false;
4636         }
4637
4638         public function setTableAliases( array $aliases ) {
4639                 $this->tableAliases = $aliases;
4640         }
4641
4642         public function setIndexAliases( array $aliases ) {
4643                 $this->indexAliases = $aliases;
4644         }
4645
4646         /**
4647          * Get the underlying binding connection handle
4648          *
4649          * Makes sure the connection resource is set (disconnects and ping() failure can unset it).
4650          * This catches broken callers than catch and ignore disconnection exceptions.
4651          * Unlike checking isOpen(), this is safe to call inside of open().
4652          *
4653          * @return mixed
4654          * @throws DBUnexpectedError
4655          * @since 1.26
4656          */
4657         protected function getBindingHandle() {
4658                 if ( !$this->conn ) {
4659                         throw new DBUnexpectedError(
4660                                 $this,
4661                                 'DB connection was already closed or the connection dropped.'
4662                         );
4663                 }
4664
4665                 return $this->conn;
4666         }
4667
4668         /**
4669          * @since 1.19
4670          * @return string
4671          */
4672         public function __toString() {
4673                 return (string)$this->conn;
4674         }
4675
4676         /**
4677          * Make sure that copies do not share the same client binding handle
4678          * @throws DBConnectionError
4679          */
4680         public function __clone() {
4681                 $this->connLogger->warning(
4682                         "Cloning " . static::class . " is not recommended; forking connection:\n" .
4683                         ( new RuntimeException() )->getTraceAsString()
4684                 );
4685
4686                 if ( $this->isOpen() ) {
4687                         // Open a new connection resource without messing with the old one
4688                         $this->opened = false;
4689                         $this->conn = false;
4690                         $this->trxEndCallbacks = []; // don't copy
4691                         $this->handleSessionLoss(); // no trx or locks anymore
4692                         $this->open(
4693                                 $this->server,
4694                                 $this->user,
4695                                 $this->password,
4696                                 $this->getDBname(),
4697                                 $this->dbSchema(),
4698                                 $this->tablePrefix()
4699                         );
4700                         $this->lastPing = microtime( true );
4701                 }
4702         }
4703
4704         /**
4705          * Called by serialize. Throw an exception when DB connection is serialized.
4706          * This causes problems on some database engines because the connection is
4707          * not restored on unserialize.
4708          */
4709         public function __sleep() {
4710                 throw new RuntimeException( 'Database serialization may cause problems, since ' .
4711                         'the connection is not restored on wakeup.' );
4712         }
4713
4714         /**
4715          * Run a few simple sanity checks and close dangling connections
4716          */
4717         public function __destruct() {
4718                 if ( $this->trxLevel && $this->trxDoneWrites ) {
4719                         trigger_error( "Uncommitted DB writes (transaction from {$this->trxFname})." );
4720                 }
4721
4722                 $danglingWriters = $this->pendingWriteAndCallbackCallers();
4723                 if ( $danglingWriters ) {
4724                         $fnames = implode( ', ', $danglingWriters );
4725                         trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
4726                 }
4727
4728                 if ( $this->conn ) {
4729                         // Avoid connection leaks for sanity. Normally, resources close at script completion.
4730                         // The connection might already be closed in zend/hhvm by now, so suppress warnings.
4731                         Wikimedia\suppressWarnings();
4732                         $this->closeConnection();
4733                         Wikimedia\restoreWarnings();
4734                         $this->conn = false;
4735                         $this->opened = false;
4736                 }
4737         }
4738 }
4739
4740 /**
4741  * @deprecated since 1.28
4742  */
4743 class_alias( Database::class, 'DatabaseBase' );
4744
4745 /**
4746  * @deprecated since 1.29
4747  */
4748 class_alias( Database::class, 'Database' );