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