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 Wikimedia\ScopedCallback;
  31 use Wikimedia\Timestamp\ConvertibleTimestamp;
  32 use MediaWiki;
  33 use BagOStuff;
  34 use HashBagOStuff;
  35 use InvalidArgumentException;
  36 use Exception;
  37 use RuntimeException;
  38
  39 /**
  40  * Relational database abstraction object
  41  *
  42  * @ingroup Database
  43  * @since 1.28
  44  */
  45 abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAwareInterface {
  46         /** Number of times to re-try an operation in case of deadlock */
  47         const DEADLOCK_TRIES = 4;
  48         /** Minimum time to wait before retry, in microseconds */
  49         const DEADLOCK_DELAY_MIN = 500000;
  50         /** Maximum time to wait before retry */
  51         const DEADLOCK_DELAY_MAX = 1500000;
  52
  53         /** How long before it is worth doing a dummy query to test the connection */
  54         const PING_TTL = 1.0;
  55         const PING_QUERY = 'SELECT 1 AS ping';
  56
  57         const TINY_WRITE_SEC = 0.010;
  58         const SLOW_WRITE_SEC = 0.500;
  59         const SMALL_WRITE_ROWS = 100;
  60
  61         /** @var string SQL query */
  62         protected $mLastQuery = '';
  63         /** @var float|bool UNIX timestamp of last write query */
  64         protected $mLastWriteTime = false;
  65         /** @var string|bool */
  66         protected $mPHPError = false;
  67         /** @var string */
  68         protected $mServer;
  69         /** @var string */
  70         protected $mUser;
  71         /** @var string */
  72         protected $mPassword;
  73         /** @var string */
  74         protected $mDBname;
  75         /** @var array[] $aliases Map of (table => (dbname, schema, prefix) map) */
  76         protected $tableAliases = [];
  77         /** @var bool Whether this PHP instance is for a CLI script */
  78         protected $cliMode;
  79         /** @var string Agent name for query profiling */
  80         protected $agent;
  81
  82         /** @var BagOStuff APC cache */
  83         protected $srvCache;
  84         /** @var LoggerInterface */
  85         protected $connLogger;
  86         /** @var LoggerInterface */
  87         protected $queryLogger;
  88         /** @var callback Error logging callback */
  89         protected $errorLogger;
  90
  91         /** @var resource|null Database connection */
  92         protected $mConn = null;
  93         /** @var bool */
  94         protected $mOpened = false;
  95
  96         /** @var array[] List of (callable, method name) */
  97         protected $mTrxIdleCallbacks = [];
  98         /** @var array[] List of (callable, method name) */
  99         protected $mTrxPreCommitCallbacks = [];
 100         /** @var array[] List of (callable, method name) */
 101         protected $mTrxEndCallbacks = [];
 102         /** @var callable[] Map of (name => callable) */
 103         protected $mTrxRecurringCallbacks = [];
 104         /** @var bool Whether to suppress triggering of transaction end callbacks */
 105         protected $mTrxEndCallbacksSuppressed = false;
 106
 107         /** @var string */
 108         protected $mTablePrefix = '';
 109         /** @var string */
 110         protected $mSchema = '';
 111         /** @var int */
 112         protected $mFlags;
 113         /** @var array */
 114         protected $mLBInfo = [];
 115         /** @var bool|null */
 116         protected $mDefaultBigSelects = null;
 117         /** @var array|bool */
 118         protected $mSchemaVars = false;
 119         /** @var array */
 120         protected $mSessionVars = [];
 121         /** @var array|null */
 122         protected $preparedArgs;
 123         /** @var string|bool|null Stashed value of html_errors INI setting */
 124         protected $htmlErrors;
 125         /** @var string */
 126         protected $delimiter = ';';
 127         /** @var DatabaseDomain */
 128         protected $currentDomain;
 129
 130         /**
 131          * Either 1 if a transaction is active or 0 otherwise.
 132          * The other Trx fields may not be meaningfull if this is 0.
 133          *
 134          * @var int
 135          */
 136         protected $mTrxLevel = 0;
 137         /**
 138          * Either a short hexidecimal string if a transaction is active or ""
 139          *
 140          * @var string
 141          * @see Database::mTrxLevel
 142          */
 143         protected $mTrxShortId = '';
 144         /**
 145          * The UNIX time that the transaction started. Callers can assume that if
 146          * snapshot isolation is used, then the data is *at least* up to date to that
 147          * point (possibly more up-to-date since the first SELECT defines the snapshot).
 148          *
 149          * @var float|null
 150          * @see Database::mTrxLevel
 151          */
 152         private $mTrxTimestamp = null;
 153         /** @var float Lag estimate at the time of BEGIN */
 154         private $mTrxReplicaLag = null;
 155         /**
 156          * Remembers the function name given for starting the most recent transaction via begin().
 157          * Used to provide additional context for error reporting.
 158          *
 159          * @var string
 160          * @see Database::mTrxLevel
 161          */
 162         private $mTrxFname = null;
 163         /**
 164          * Record if possible write queries were done in the last transaction started
 165          *
 166          * @var bool
 167          * @see Database::mTrxLevel
 168          */
 169         private $mTrxDoneWrites = false;
 170         /**
 171          * Record if the current transaction was started implicitly due to DBO_TRX being set.
 172          *
 173          * @var bool
 174          * @see Database::mTrxLevel
 175          */
 176         private $mTrxAutomatic = false;
 177         /**
 178          * Array of levels of atomicity within transactions
 179          *
 180          * @var array
 181          */
 182         private $mTrxAtomicLevels = [];
 183         /**
 184          * Record if the current transaction was started implicitly by Database::startAtomic
 185          *
 186          * @var bool
 187          */
 188         private $mTrxAutomaticAtomic = false;
 189         /**
 190          * Track the write query callers of the current transaction
 191          *
 192          * @var string[]
 193          */
 194         private $mTrxWriteCallers = [];
 195         /**
 196          * @var float Seconds spent in write queries for the current transaction
 197          */
 198         private $mTrxWriteDuration = 0.0;
 199         /**
 200          * @var int Number of write queries for the current transaction
 201          */
 202         private $mTrxWriteQueryCount = 0;
 203         /**
 204          * @var int Number of rows affected by write queries for the current transaction
 205          */
 206         private $mTrxWriteAffectedRows = 0;
 207         /**
 208          * @var float Like mTrxWriteQueryCount but excludes lock-bound, easy to replicate, queries
 209          */
 210         private $mTrxWriteAdjDuration = 0.0;
 211         /**
 212          * @var int Number of write queries counted in mTrxWriteAdjDuration
 213          */
 214         private $mTrxWriteAdjQueryCount = 0;
 215         /**
 216          * @var float RTT time estimate
 217          */
 218         private $mRTTEstimate = 0.0;
 219
 220         /** @var array Map of (name => 1) for locks obtained via lock() */
 221         private $mNamedLocksHeld = [];
 222         /** @var array Map of (table name => 1) for TEMPORARY tables */
 223         protected $mSessionTempTables = [];
 224
 225         /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
 226         private $lazyMasterHandle;
 227
 228         /** @var float UNIX timestamp */
 229         protected $lastPing = 0.0;
 230
 231         /** @var int[] Prior mFlags values */
 232         private $priorFlags = [];
 233
 234         /** @var object|string Class name or object With profileIn/profileOut methods */
 235         protected $profiler;
 236         /** @var TransactionProfiler */
 237         protected $trxProfiler;
 238
 239         /**
 240          * Constructor and database handle and attempt to connect to the DB server
 241          *
 242          * IDatabase classes should not be constructed directly in external
 243          * code. Database::factory() should be used instead.
 244          *
 245          * @param array $params Parameters passed from Database::factory()
 246          */
 247         function __construct( array $params ) {
 248                 $server = $params['host'];
 249                 $user = $params['user'];
 250                 $password = $params['password'];
 251                 $dbName = $params['dbname'];
 252
 253                 $this->mSchema = $params['schema'];
 254                 $this->mTablePrefix = $params['tablePrefix'];
 255
 256                 $this->cliMode = $params['cliMode'];
 257                 // Agent name is added to SQL queries in a comment, so make sure it can't break out
 258                 $this->agent = str_replace( '/', '-', $params['agent'] );
 259
 260                 $this->mFlags = $params['flags'];
 261                 if ( $this->mFlags & self::DBO_DEFAULT ) {
 262                         if ( $this->cliMode ) {
 263                                 $this->mFlags &= ~self::DBO_TRX;
 264                         } else {
 265                                 $this->mFlags |= self::DBO_TRX;
 266                         }
 267                 }
 268
 269                 $this->mSessionVars = $params['variables'];
 270
 271                 $this->srvCache = isset( $params['srvCache'] )
 272                         ? $params['srvCache']
 273                         : new HashBagOStuff();
 274
 275                 $this->profiler = $params['profiler'];
 276                 $this->trxProfiler = $params['trxProfiler'];
 277                 $this->connLogger = $params['connLogger'];
 278                 $this->queryLogger = $params['queryLogger'];
 279                 $this->errorLogger = $params['errorLogger'];
 280
 281                 // Set initial dummy domain until open() sets the final DB/prefix
 282                 $this->currentDomain = DatabaseDomain::newUnspecified();
 283
 284                 if ( $user ) {
 285                         $this->open( $server, $user, $password, $dbName );
 286                 } elseif ( $this->requiresDatabaseUser() ) {
 287                         throw new InvalidArgumentException( "No database user provided." );
 288                 }
 289
 290                 // Set the domain object after open() sets the relevant fields
 291                 if ( $this->mDBname != '' ) {
 292                         // Domains with server scope but a table prefix are not used by IDatabase classes
 293                         $this->currentDomain = new DatabaseDomain( $this->mDBname, null, $this->mTablePrefix );
 294                 }
 295         }
 296
 297         /**
 298          * Construct a Database subclass instance given a database type and parameters
 299          *
 300          * This also connects to the database immediately upon object construction
 301          *
 302          * @param string $dbType A possible DB type (sqlite, mysql, postgres)
 303          * @param array $p Parameter map with keys:
 304          *   - host : The hostname of the DB server
 305          *   - user : The name of the database user the client operates under
 306          *   - password : The password for the database user
 307          *   - dbname : The name of the database to use where queries do not specify one.
 308          *      The database must exist or an error might be thrown. Setting this to the empty string
 309          *      will avoid any such errors and make the handle have no implicit database scope. This is
 310          *      useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
 311          *      "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
 312          *      in which user names and such are defined, e.g. users are database-specific in Postgres.
 313          *   - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
 314          *      equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
 315          *   - tablePrefix : Optional table prefix that is implicitly added on to all table names
 316          *      recognized in queries. This can be used in place of schemas for handle site farms.
 317          *   - flags : Optional bitfield of DBO_* constants that define connection, protocol,
 318          *      buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
 319          *      flag in place UNLESS this this database simply acts as a key/value store.
 320          *   - driver: Optional name of a specific DB client driver. For MySQL, there is the old
 321          *      'mysql' driver and the newer 'mysqli' driver.
 322          *   - variables: Optional map of session variables to set after connecting. This can be
 323          *      used to adjust lock timeouts or encoding modes and the like.
 324          *   - connLogger: Optional PSR-3 logger interface instance.
 325          *   - queryLogger: Optional PSR-3 logger interface instance.
 326          *   - profiler: Optional class name or object with profileIn()/profileOut() methods.
 327          *      These will be called in query(), using a simplified version of the SQL that also
 328          *      includes the agent as a SQL comment.
 329          *   - trxProfiler: Optional TransactionProfiler instance.
 330          *   - errorLogger: Optional callback that takes an Exception and logs it.
 331          *   - cliMode: Whether to consider the execution context that of a CLI script.
 332          *   - agent: Optional name used to identify the end-user in query profiling/logging.
 333          *   - srvCache: Optional BagOStuff instance to an APC-style cache.
 334          * @return Database|null If the database driver or extension cannot be found
 335          * @throws InvalidArgumentException If the database driver or extension cannot be found
 336          * @since 1.18
 337          */
 338         final public static function factory( $dbType, $p = [] ) {
 339                 static $canonicalDBTypes = [
 340                         'mysql' => [ 'mysqli', 'mysql' ],
 341                         'postgres' => [],
 342                         'sqlite' => [],
 343                         'oracle' => [],
 344                         'mssql' => [],
 345                 ];
 346                 static $classAliases = [
 347                         'DatabaseMssql' => DatabaseMssql::class,
 348                         'DatabaseMysql' => DatabaseMysql::class,
 349                         'DatabaseMysqli' => DatabaseMysqli::class,
 350                         'DatabaseSqlite' => DatabaseSqlite::class,
 351                         'DatabasePostgres' => DatabasePostgres::class
 352                 ];
 353
 354                 $driver = false;
 355                 $dbType = strtolower( $dbType );
 356                 if ( isset( $canonicalDBTypes[$dbType] ) && $canonicalDBTypes[$dbType] ) {
 357                         $possibleDrivers = $canonicalDBTypes[$dbType];
 358                         if ( !empty( $p['driver'] ) ) {
 359                                 if ( in_array( $p['driver'], $possibleDrivers ) ) {
 360                                         $driver = $p['driver'];
 361                                 } else {
 362                                         throw new InvalidArgumentException( __METHOD__ .
 363                                                 " type '$dbType' does not support driver '{$p['driver']}'" );
 364                                 }
 365                         } else {
 366                                 foreach ( $possibleDrivers as $posDriver ) {
 367                                         if ( extension_loaded( $posDriver ) ) {
 368                                                 $driver = $posDriver;
 369                                                 break;
 370                                         }
 371                                 }
 372                         }
 373                 } else {
 374                         $driver = $dbType;
 375                 }
 376
 377                 if ( $driver === false || $driver === '' ) {
 378                         throw new InvalidArgumentException( __METHOD__ .
 379                                 " no viable database extension found for type '$dbType'" );
 380                 }
 381
 382                 $class = 'Database' . ucfirst( $driver );
 383                 if ( isset( $classAliases[$class] ) ) {
 384                         $class = $classAliases[$class];
 385                 }
 386
 387                 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase::class ) ) {
 388                         // Resolve some defaults for b/c
 389                         $p['host'] = isset( $p['host'] ) ? $p['host'] : false;
 390                         $p['user'] = isset( $p['user'] ) ? $p['user'] : false;
 391                         $p['password'] = isset( $p['password'] ) ? $p['password'] : false;
 392                         $p['dbname'] = isset( $p['dbname'] ) ? $p['dbname'] : false;
 393                         $p['flags'] = isset( $p['flags'] ) ? $p['flags'] : 0;
 394                         $p['variables'] = isset( $p['variables'] ) ? $p['variables'] : [];
 395                         $p['tablePrefix'] = isset( $p['tablePrefix'] ) ? $p['tablePrefix'] : '';
 396                         $p['schema'] = isset( $p['schema'] ) ? $p['schema'] : '';
 397                         $p['cliMode'] = isset( $p['cliMode'] ) ? $p['cliMode'] : ( PHP_SAPI === 'cli' );
 398                         $p['agent'] = isset( $p['agent'] ) ? $p['agent'] : '';
 399                         if ( !isset( $p['connLogger'] ) ) {
 400                                 $p['connLogger'] = new \Psr\Log\NullLogger();
 401                         }
 402                         if ( !isset( $p['queryLogger'] ) ) {
 403                                 $p['queryLogger'] = new \Psr\Log\NullLogger();
 404                         }
 405                         $p['profiler'] = isset( $p['profiler'] ) ? $p['profiler'] : null;
 406                         if ( !isset( $p['trxProfiler'] ) ) {
 407                                 $p['trxProfiler'] = new TransactionProfiler();
 408                         }
 409                         if ( !isset( $p['errorLogger'] ) ) {
 410                                 $p['errorLogger'] = function ( Exception $e ) {
 411                                         trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING );
 412                                 };
 413                         }
 414
 415                         $conn = new $class( $p );
 416                 } else {
 417                         $conn = null;
 418                 }
 419
 420                 return $conn;
 421         }
 422
 423         /**
 424          * Set the PSR-3 logger interface to use for query logging. (The logger
 425          * interfaces for connection logging and error logging can be set with the
 426          * constructor.)
 427          *
 428          * @param LoggerInterface $logger
 429          */
 430         public function setLogger( LoggerInterface $logger ) {
 431                 $this->queryLogger = $logger;
 432         }
 433
 434         public function getServerInfo() {
 435                 return $this->getServerVersion();
 436         }
 437
 438         public function bufferResults( $buffer = null ) {
 439                 $res = !$this->getFlag( self::DBO_NOBUFFER );
 440                 if ( $buffer !== null ) {
 441                         $buffer
 442                                 ? $this->clearFlag( self::DBO_NOBUFFER )
 443                                 : $this->setFlag( self::DBO_NOBUFFER );
 444                 }
 445
 446                 return $res;
 447         }
 448
 449         /**
 450          * Turns on (false) or off (true) the automatic generation and sending
 451          * of a "we're sorry, but there has been a database error" page on
 452          * database errors. Default is on (false). When turned off, the
 453          * code should use lastErrno() and lastError() to handle the
 454          * situation as appropriate.
 455          *
 456          * Do not use this function outside of the Database classes.
 457          *
 458          * @param null|bool $ignoreErrors
 459          * @return bool The previous value of the flag.
 460          */
 461         protected function ignoreErrors( $ignoreErrors = null ) {
 462                 $res = $this->getFlag( self::DBO_IGNORE );
 463                 if ( $ignoreErrors !== null ) {
 464                         $ignoreErrors
 465                                 ? $this->setFlag( self::DBO_IGNORE )
 466                                 : $this->clearFlag( self::DBO_IGNORE );
 467                 }
 468
 469                 return $res;
 470         }
 471
 472         public function trxLevel() {
 473                 return $this->mTrxLevel;
 474         }
 475
 476         public function trxTimestamp() {
 477                 return $this->mTrxLevel ? $this->mTrxTimestamp : null;
 478         }
 479
 480         public function tablePrefix( $prefix = null ) {
 481                 $old = $this->mTablePrefix;
 482                 if ( $prefix !== null ) {
 483                         $this->mTablePrefix = $prefix;
 484                         $this->currentDomain = ( $this->mDBname != '' )
 485                                 ? new DatabaseDomain( $this->mDBname, null, $this->mTablePrefix )
 486                                 : DatabaseDomain::newUnspecified();
 487                 }
 488
 489                 return $old;
 490         }
 491
 492         public function dbSchema( $schema = null ) {
 493                 $old = $this->mSchema;
 494                 if ( $schema !== null ) {
 495                         $this->mSchema = $schema;
 496                 }
 497
 498                 return $old;
 499         }
 500
 501         public function getLBInfo( $name = null ) {
 502                 if ( is_null( $name ) ) {
 503                         return $this->mLBInfo;
 504                 } else {
 505                         if ( array_key_exists( $name, $this->mLBInfo ) ) {
 506                                 return $this->mLBInfo[$name];
 507                         } else {
 508                                 return null;
 509                         }
 510                 }
 511         }
 512
 513         public function setLBInfo( $name, $value = null ) {
 514                 if ( is_null( $value ) ) {
 515                         $this->mLBInfo = $name;
 516                 } else {
 517                         $this->mLBInfo[$name] = $value;
 518                 }
 519         }
 520
 521         public function setLazyMasterHandle( IDatabase $conn ) {
 522                 $this->lazyMasterHandle = $conn;
 523         }
 524
 525         /**
 526          * @return IDatabase|null
 527          * @see setLazyMasterHandle()
 528          * @since 1.27
 529          */
 530         protected function getLazyMasterHandle() {
 531                 return $this->lazyMasterHandle;
 532         }
 533
 534         public function implicitGroupby() {
 535                 return true;
 536         }
 537
 538         public function implicitOrderby() {
 539                 return true;
 540         }
 541
 542         public function lastQuery() {
 543                 return $this->mLastQuery;
 544         }
 545
 546         public function doneWrites() {
 547                 return (bool)$this->mLastWriteTime;
 548         }
 549
 550         public function lastDoneWrites() {
 551                 return $this->mLastWriteTime ?: false;
 552         }
 553
 554         public function writesPending() {
 555                 return $this->mTrxLevel && $this->mTrxDoneWrites;
 556         }
 557
 558         public function writesOrCallbacksPending() {
 559                 return $this->mTrxLevel && (
 560                         $this->mTrxDoneWrites || $this->mTrxIdleCallbacks || $this->mTrxPreCommitCallbacks
 561                 );
 562         }
 563
 564         public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) {
 565                 if ( !$this->mTrxLevel ) {
 566                         return false;
 567                 } elseif ( !$this->mTrxDoneWrites ) {
 568                         return 0.0;
 569                 }
 570
 571                 switch ( $type ) {
 572                         case self::ESTIMATE_DB_APPLY:
 573                                 $this->ping( $rtt );
 574                                 $rttAdjTotal = $this->mTrxWriteAdjQueryCount * $rtt;
 575                                 $applyTime = max( $this->mTrxWriteAdjDuration - $rttAdjTotal, 0 );
 576                                 // For omitted queries, make them count as something at least
 577                                 $omitted = $this->mTrxWriteQueryCount - $this->mTrxWriteAdjQueryCount;
 578                                 $applyTime += self::TINY_WRITE_SEC * $omitted;
 579
 580                                 return $applyTime;
 581                         default: // everything
 582                                 return $this->mTrxWriteDuration;
 583                 }
 584         }
 585
 586         public function pendingWriteCallers() {
 587                 return $this->mTrxLevel ? $this->mTrxWriteCallers : [];
 588         }
 589
 590         public function pendingWriteRowsAffected() {
 591                 return $this->mTrxWriteAffectedRows;
 592         }
 593
 594         /**
 595          * Get the list of method names that have pending write queries or callbacks
 596          * for this transaction
 597          *
 598          * @return array
 599          */
 600         protected function pendingWriteAndCallbackCallers() {
 601                 if ( !$this->mTrxLevel ) {
 602                         return [];
 603                 }
 604
 605                 $fnames = $this->mTrxWriteCallers;
 606                 foreach ( [
 607                         $this->mTrxIdleCallbacks,
 608                         $this->mTrxPreCommitCallbacks,
 609                         $this->mTrxEndCallbacks
 610                 ] as $callbacks ) {
 611                         foreach ( $callbacks as $callback ) {
 612                                 $fnames[] = $callback[1];
 613                         }
 614                 }
 615
 616                 return $fnames;
 617         }
 618
 619         public function isOpen() {
 620                 return $this->mOpened;
 621         }
 622
 623         public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 624                 if ( $remember === self::REMEMBER_PRIOR ) {
 625                         array_push( $this->priorFlags, $this->mFlags );
 626                 }
 627                 $this->mFlags |= $flag;
 628         }
 629
 630         public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) {
 631                 if ( $remember === self::REMEMBER_PRIOR ) {
 632                         array_push( $this->priorFlags, $this->mFlags );
 633                 }
 634                 $this->mFlags &= ~$flag;
 635         }
 636
 637         public function restoreFlags( $state = self::RESTORE_PRIOR ) {
 638                 if ( !$this->priorFlags ) {
 639                         return;
 640                 }
 641
 642                 if ( $state === self::RESTORE_INITIAL ) {
 643                         $this->mFlags = reset( $this->priorFlags );
 644                         $this->priorFlags = [];
 645                 } else {
 646                         $this->mFlags = array_pop( $this->priorFlags );
 647                 }
 648         }
 649
 650         public function getFlag( $flag ) {
 651                 return !!( $this->mFlags & $flag );
 652         }
 653
 654         /**
 655          * @param string $name Class field name
 656          * @return mixed
 657          * @deprecated Since 1.28
 658          */
 659         public function getProperty( $name ) {
 660                 return $this->$name;
 661         }
 662
 663         public function getDomainID() {
 664                 return $this->currentDomain->getId();
 665         }
 666
 667         final public function getWikiID() {
 668                 return $this->getDomainID();
 669         }
 670
 671         /**
 672          * Get information about an index into an object
 673          * @param string $table Table name
 674          * @param string $index Index name
 675          * @param string $fname Calling function name
 676          * @return mixed Database-specific index description class or false if the index does not exist
 677          */
 678         abstract function indexInfo( $table, $index, $fname = __METHOD__ );
 679
 680         /**
 681          * Wrapper for addslashes()
 682          *
 683          * @param string $s String to be slashed.
 684          * @return string Slashed string.
 685          */
 686         abstract function strencode( $s );
 687
 688         /**
 689          * Set a custom error handler for logging errors during database connection
 690          */
 691         protected function installErrorHandler() {
 692                 $this->mPHPError = false;
 693                 $this->htmlErrors = ini_set( 'html_errors', '0' );
 694                 set_error_handler( [ $this, 'connectionErrorLogger' ] );
 695         }
 696
 697         /**
 698          * Restore the previous error handler and return the last PHP error for this DB
 699          *
 700          * @return bool|string
 701          */
 702         protected function restoreErrorHandler() {
 703                 restore_error_handler();
 704                 if ( $this->htmlErrors !== false ) {
 705                         ini_set( 'html_errors', $this->htmlErrors );
 706                 }
 707
 708                 return $this->getLastPHPError();
 709         }
 710
 711         /**
 712          * @return string|bool Last PHP error for this DB (typically connection errors)
 713          */
 714         protected function getLastPHPError() {
 715                 if ( $this->mPHPError ) {
 716                         $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError );
 717                         $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
 718
 719                         return $error;
 720                 }
 721
 722                 return false;
 723         }
 724
 725         /**
 726          * Error handler for logging errors during database connection
 727          * This method should not be used outside of Database classes
 728          *
 729          * @param int $errno
 730          * @param string $errstr
 731          */
 732         public function connectionErrorLogger( $errno, $errstr ) {
 733                 $this->mPHPError = $errstr;
 734         }
 735
 736         /**
 737          * Create a log context to pass to PSR-3 logger functions.
 738          *
 739          * @param array $extras Additional data to add to context
 740          * @return array
 741          */
 742         protected function getLogContext( array $extras = [] ) {
 743                 return array_merge(
 744                         [
 745                                 'db_server' => $this->mServer,
 746                                 'db_name' => $this->mDBname,
 747                                 'db_user' => $this->mUser,
 748                         ],
 749                         $extras
 750                 );
 751         }
 752
 753         public function close() {
 754                 if ( $this->mConn ) {
 755                         if ( $this->trxLevel() ) {
 756                                 $this->commit( __METHOD__, self::FLUSHING_INTERNAL );
 757                         }
 758
 759                         $closed = $this->closeConnection();
 760                         $this->mConn = false;
 761                 } elseif (
 762                         $this->mTrxIdleCallbacks ||
 763                         $this->mTrxPreCommitCallbacks ||
 764                         $this->mTrxEndCallbacks
 765                 ) { // sanity
 766                         throw new RuntimeException( "Transaction callbacks still pending." );
 767                 } else {
 768                         $closed = true;
 769                 }
 770                 $this->mOpened = false;
 771
 772                 return $closed;
 773         }
 774
 775         /**
 776          * Make sure isOpen() returns true as a sanity check
 777          *
 778          * @throws DBUnexpectedError
 779          */
 780         protected function assertOpen() {
 781                 if ( !$this->isOpen() ) {
 782                         throw new DBUnexpectedError( $this, "DB connection was already closed." );
 783                 }
 784         }
 785
 786         /**
 787          * Closes underlying database connection
 788          * @since 1.20
 789          * @return bool Whether connection was closed successfully
 790          */
 791         abstract protected function closeConnection();
 792
 793         public function reportConnectionError( $error = 'Unknown error' ) {
 794                 $myError = $this->lastError();
 795                 if ( $myError ) {
 796                         $error = $myError;
 797                 }
 798
 799                 # New method
 800                 throw new DBConnectionError( $this, $error );
 801         }
 802
 803         /**
 804          * The DBMS-dependent part of query()
 805          *
 806          * @param string $sql SQL query.
 807          * @return ResultWrapper|bool Result object to feed to fetchObject,
 808          *   fetchRow, ...; or false on failure
 809          */
 810         abstract protected function doQuery( $sql );
 811
 812         /**
 813          * Determine whether a query writes to the DB.
 814          * Should return true if unsure.
 815          *
 816          * @param string $sql
 817          * @return bool
 818          */
 819         protected function isWriteQuery( $sql ) {
 820                 return !preg_match(
 821                         '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
 822         }
 823
 824         /**
 825          * @param string $sql
 826          * @return string|null
 827          */
 828         protected function getQueryVerb( $sql ) {
 829                 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ? strtoupper( $m[1] ) : null;
 830         }
 831
 832         /**
 833          * Determine whether a SQL statement is sensitive to isolation level.
 834          * A SQL statement is considered transactable if its result could vary
 835          * depending on the transaction isolation level. Operational commands
 836          * such as 'SET' and 'SHOW' are not considered to be transactable.
 837          *
 838          * @param string $sql
 839          * @return bool
 840          */
 841         protected function isTransactableQuery( $sql ) {
 842                 return !in_array(
 843                         $this->getQueryVerb( $sql ),
 844                         [ 'BEGIN', 'COMMIT', 'ROLLBACK', 'SHOW', 'SET', 'CREATE', 'ALTER' ],
 845                         true
 846                 );
 847         }
 848
 849         /**
 850          * @param string $sql A SQL query
 851          * @return bool Whether $sql is SQL for TEMPORARY table operation
 852          */
 853         protected function registerTempTableOperation( $sql ) {
 854                 if ( preg_match(
 855                         '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
 856                         $sql,
 857                         $matches
 858                 ) ) {
 859                         $this->mSessionTempTables[$matches[1]] = 1;
 860
 861                         return true;
 862                 } elseif ( preg_match(
 863                         '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
 864                         $sql,
 865                         $matches
 866                 ) ) {
 867                         $isTemp = isset( $this->mSessionTempTables[$matches[1]] );
 868                         unset( $this->mSessionTempTables[$matches[1]] );
 869
 870                         return $isTemp;
 871                 } elseif ( preg_match(
 872                         '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
 873                         $sql,
 874                         $matches
 875                 ) ) {
 876                         return isset( $this->mSessionTempTables[$matches[1]] );
 877                 } elseif ( preg_match(
 878                         '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
 879                         $sql,
 880                         $matches
 881                 ) ) {
 882                         return isset( $this->mSessionTempTables[$matches[1]] );
 883                 }
 884
 885                 return false;
 886         }
 887
 888         public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) {
 889                 $priorWritesPending = $this->writesOrCallbacksPending();
 890                 $this->mLastQuery = $sql;
 891
 892                 $isWrite = $this->isWriteQuery( $sql );
 893                 if ( $isWrite ) {
 894                         $isNonTempWrite = !$this->registerTempTableOperation( $sql );
 895                 } else {
 896                         $isNonTempWrite = false;
 897                 }
 898
 899                 if ( $isWrite ) {
 900                         # In theory, non-persistent writes are allowed in read-only mode, but due to things
 901                         # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
 902                         $reason = $this->getReadOnlyReason();
 903                         if ( $reason !== false ) {
 904                                 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
 905                         }
 906                         # Set a flag indicating that writes have been done
 907                         $this->mLastWriteTime = microtime( true );
 908                 }
 909
 910                 # Add trace comment to the begin of the sql string, right after the operator.
 911                 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
 912                 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
 913
 914                 # Start implicit transactions that wrap the request if DBO_TRX is enabled
 915                 if ( !$this->mTrxLevel && $this->getFlag( self::DBO_TRX )
 916                         && $this->isTransactableQuery( $sql )
 917                 ) {
 918                         $this->begin( __METHOD__ . " ($fname)", self::TRANSACTION_INTERNAL );
 919                         $this->mTrxAutomatic = true;
 920                 }
 921
 922                 # Keep track of whether the transaction has write queries pending
 923                 if ( $this->mTrxLevel && !$this->mTrxDoneWrites && $isWrite ) {
 924                         $this->mTrxDoneWrites = true;
 925                         $this->trxProfiler->transactionWritingIn(
 926                                 $this->mServer, $this->mDBname, $this->mTrxShortId );
 927                 }
 928
 929                 if ( $this->getFlag( self::DBO_DEBUG ) ) {
 930                         $this->queryLogger->debug( "{$this->mDBname} {$commentedSql}" );
 931                 }
 932
 933                 # Avoid fatals if close() was called
 934                 $this->assertOpen();
 935
 936                 # Send the query to the server
 937                 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
 938
 939                 # Try reconnecting if the connection was lost
 940                 if ( false === $ret && $this->wasErrorReissuable() ) {
 941                         $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
 942                         # Stash the last error values before anything might clear them
 943                         $lastError = $this->lastError();
 944                         $lastErrno = $this->lastErrno();
 945                         # Update state tracking to reflect transaction loss due to disconnection
 946                         $this->handleSessionLoss();
 947                         if ( $this->reconnect() ) {
 948                                 $msg = __METHOD__ . ": lost connection to {$this->getServer()}; reconnected";
 949                                 $this->connLogger->warning( $msg );
 950                                 $this->queryLogger->warning(
 951                                         "$msg:\n" . ( new RuntimeException() )->getTraceAsString() );
 952
 953                                 if ( !$recoverable ) {
 954                                         # Callers may catch the exception and continue to use the DB
 955                                         $this->reportQueryError( $lastError, $lastErrno, $sql, $fname );
 956                                 } else {
 957                                         # Should be safe to silently retry the query
 958                                         $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
 959                                 }
 960                         } else {
 961                                 $msg = __METHOD__ . ": lost connection to {$this->getServer()} permanently";
 962                                 $this->connLogger->error( $msg );
 963                         }
 964                 }
 965
 966                 if ( false === $ret ) {
 967                         # Deadlocks cause the entire transaction to abort, not just the statement.
 968                         # https://dev.mysql.com/doc/refman/5.7/en/innodb-error-handling.html
 969                         # https://www.postgresql.org/docs/9.1/static/explicit-locking.html
 970                         if ( $this->wasDeadlock() ) {
 971                                 if ( $this->explicitTrxActive() || $priorWritesPending ) {
 972                                         $tempIgnore = false; // not recoverable
 973                                 }
 974                                 # Update state tracking to reflect transaction loss
 975                                 $this->handleSessionLoss();
 976                         }
 977
 978                         $this->reportQueryError(
 979                                 $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
 980                 }
 981
 982                 $res = $this->resultObject( $ret );
 983
 984                 return $res;
 985         }
 986
 987         /**
 988          * Helper method for query() that handles profiling and logging and sends
 989          * the query to doQuery()
 990          *
 991          * @param string $sql Original SQL query
 992          * @param string $commentedSql SQL query with debugging/trace comment
 993          * @param bool $isWrite Whether the query is a (non-temporary) write operation
 994          * @param string $fname Name of the calling function
 995          * @return bool|ResultWrapper True for a successful write query, ResultWrapper
 996          *     object for a successful read query, or false on failure
 997          */
 998         private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
 999                 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1000                 # generalizeSQL() will probably cut down the query to reasonable
1001                 # logging size most of the time. The substr is really just a sanity check.
1002                 if ( $isMaster ) {
1003                         $queryProf = 'query-m: ' . substr( self::generalizeSQL( $sql ), 0, 255 );
1004                 } else {
1005                         $queryProf = 'query: ' . substr( self::generalizeSQL( $sql ), 0, 255 );
1006                 }
1007
1008                 # Include query transaction state
1009                 $queryProf .= $this->mTrxShortId ? " [TRX#{$this->mTrxShortId}]" : "";
1010
1011                 $startTime = microtime( true );
1012                 if ( $this->profiler ) {
1013                         call_user_func( [ $this->profiler, 'profileIn' ], $queryProf );
1014                 }
1015                 $ret = $this->doQuery( $commentedSql );
1016                 if ( $this->profiler ) {
1017                         call_user_func( [ $this->profiler, 'profileOut' ], $queryProf );
1018                 }
1019                 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1020
1021                 unset( $queryProfSection ); // profile out (if set)
1022
1023                 if ( $ret !== false ) {
1024                         $this->lastPing = $startTime;
1025                         if ( $isWrite && $this->mTrxLevel ) {
1026                                 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1027                                 $this->mTrxWriteCallers[] = $fname;
1028                         }
1029                 }
1030
1031                 if ( $sql === self::PING_QUERY ) {
1032                         $this->mRTTEstimate = $queryRuntime;
1033                 }
1034
1035                 $this->trxProfiler->recordQueryCompletion(
1036                         $queryProf, $startTime, $isWrite, $this->affectedRows()
1037                 );
1038                 $this->queryLogger->debug( $sql, [
1039                         'method' => $fname,
1040                         'master' => $isMaster,
1041                         'runtime' => $queryRuntime,
1042                 ] );
1043
1044                 return $ret;
1045         }
1046
1047         /**
1048          * Update the estimated run-time of a query, not counting large row lock times
1049          *
1050          * LoadBalancer can be set to rollback transactions that will create huge replication
1051          * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1052          * queries, like inserting a row can take a long time due to row locking. This method
1053          * uses some simple heuristics to discount those cases.
1054          *
1055          * @param string $sql A SQL write query
1056          * @param float $runtime Total runtime, including RTT
1057          * @param int $affected Affected row count
1058          */
1059         private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1060                 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1061                 $indicativeOfReplicaRuntime = true;
1062                 if ( $runtime > self::SLOW_WRITE_SEC ) {
1063                         $verb = $this->getQueryVerb( $sql );
1064                         // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1065                         if ( $verb === 'INSERT' ) {
1066                                 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS;
1067                         } elseif ( $verb === 'REPLACE' ) {
1068                                 $indicativeOfReplicaRuntime = $this->affectedRows() > self::SMALL_WRITE_ROWS / 2;
1069                         }
1070                 }
1071
1072                 $this->mTrxWriteDuration += $runtime;
1073                 $this->mTrxWriteQueryCount += 1;
1074                 $this->mTrxWriteAffectedRows += $affected;
1075                 if ( $indicativeOfReplicaRuntime ) {
1076                         $this->mTrxWriteAdjDuration += $runtime;
1077                         $this->mTrxWriteAdjQueryCount += 1;
1078                 }
1079         }
1080
1081         /**
1082          * Determine whether or not it is safe to retry queries after a database
1083          * connection is lost
1084          *
1085          * @param string $sql SQL query
1086          * @param bool $priorWritesPending Whether there is a transaction open with
1087          *     possible write queries or transaction pre-commit/idle callbacks
1088          *     waiting on it to finish.
1089          * @return bool True if it is safe to retry the query, false otherwise
1090          */
1091         private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1092                 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1093                 # Dropped connections also mean that named locks are automatically released.
1094                 # Only allow error suppression in autocommit mode or when the lost transaction
1095                 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1096                 if ( $this->mNamedLocksHeld ) {
1097                         return false; // possible critical section violation
1098                 } elseif ( $sql === 'COMMIT' ) {
1099                         return !$priorWritesPending; // nothing written anyway? (T127428)
1100                 } elseif ( $sql === 'ROLLBACK' ) {
1101                         return true; // transaction lost...which is also what was requested :)
1102                 } elseif ( $this->explicitTrxActive() ) {
1103                         return false; // don't drop atomocity
1104                 } elseif ( $priorWritesPending ) {
1105                         return false; // prior writes lost from implicit transaction
1106                 }
1107
1108                 return true;
1109         }
1110
1111         /**
1112          * Clean things up after transaction loss due to disconnection
1113          *
1114          * @return null|Exception
1115          */
1116         private function handleSessionLoss() {
1117                 $this->mTrxLevel = 0;
1118                 $this->mTrxIdleCallbacks = []; // T67263
1119                 $this->mTrxPreCommitCallbacks = []; // T67263
1120                 $this->mSessionTempTables = [];
1121                 $this->mNamedLocksHeld = [];
1122                 try {
1123                         // Handle callbacks in mTrxEndCallbacks
1124                         $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
1125                         $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
1126                         return null;
1127                 } catch ( Exception $e ) {
1128                         // Already logged; move on...
1129                         return $e;
1130                 }
1131         }
1132
1133         /**
1134          * Checks whether the cause of the error is detected to be a timeout.
1135          *
1136          * It returns false by default, and not all engines support detecting this yet.
1137          * If this returns false, it will be treated as a generic query error.
1138          *
1139          * @param string $error Error text
1140          * @param int $errno Error number
1141          * @return bool
1142          */
1143         protected function wasQueryTimeout( $error, $errno ) {
1144                 return false;
1145         }
1146
1147         public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1148                 if ( $this->ignoreErrors() || $tempIgnore ) {
1149                         $this->queryLogger->debug( "SQL ERROR (ignored): $error\n" );
1150                 } else {
1151                         $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1152                         $this->queryLogger->error(
1153                                 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1154                                 $this->getLogContext( [
1155                                         'method' => __METHOD__,
1156                                         'errno' => $errno,
1157                                         'error' => $error,
1158                                         'sql1line' => $sql1line,
1159                                         'fname' => $fname,
1160                                 ] )
1161                         );
1162                         $this->queryLogger->debug( "SQL ERROR: " . $error . "\n" );
1163                         $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1164                         if ( $wasQueryTimeout ) {
1165                                 throw new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1166                         } else {
1167                                 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1168                         }
1169                 }
1170         }
1171
1172         public function freeResult( $res ) {
1173         }
1174
1175         public function selectField(
1176                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1177         ) {
1178                 if ( $var === '*' ) { // sanity
1179                         throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1180                 }
1181
1182                 if ( !is_array( $options ) ) {
1183                         $options = [ $options ];
1184                 }
1185
1186                 $options['LIMIT'] = 1;
1187
1188                 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1189                 if ( $res === false || !$this->numRows( $res ) ) {
1190                         return false;
1191                 }
1192
1193                 $row = $this->fetchRow( $res );
1194
1195                 if ( $row !== false ) {
1196                         return reset( $row );
1197                 } else {
1198                         return false;
1199                 }
1200         }
1201
1202         public function selectFieldValues(
1203                 $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
1204         ) {
1205                 if ( $var === '*' ) { // sanity
1206                         throw new DBUnexpectedError( $this, "Cannot use a * field" );
1207                 } elseif ( !is_string( $var ) ) { // sanity
1208                         throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1209                 }
1210
1211                 if ( !is_array( $options ) ) {
1212                         $options = [ $options ];
1213                 }
1214
1215                 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1216                 if ( $res === false ) {
1217                         return false;
1218                 }
1219
1220                 $values = [];
1221                 foreach ( $res as $row ) {
1222                         $values[] = $row->$var;
1223                 }
1224
1225                 return $values;
1226         }
1227
1228         /**
1229          * Returns an optional USE INDEX clause to go after the table, and a
1230          * string to go at the end of the query.
1231          *
1232          * @param array $options Associative array of options to be turned into
1233          *   an SQL query, valid keys are listed in the function.
1234          * @return array
1235          * @see Database::select()
1236          */
1237         protected function makeSelectOptions( $options ) {
1238                 $preLimitTail = $postLimitTail = '';
1239                 $startOpts = '';
1240
1241                 $noKeyOptions = [];
1242
1243                 foreach ( $options as $key => $option ) {
1244                         if ( is_numeric( $key ) ) {
1245                                 $noKeyOptions[$option] = true;
1246                         }
1247                 }
1248
1249                 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1250
1251                 $preLimitTail .= $this->makeOrderBy( $options );
1252
1253                 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1254                         $postLimitTail .= ' FOR UPDATE';
1255                 }
1256
1257                 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1258                         $postLimitTail .= ' LOCK IN SHARE MODE';
1259                 }
1260
1261                 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1262                         $startOpts .= 'DISTINCT';
1263                 }
1264
1265                 # Various MySQL extensions
1266                 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1267                         $startOpts .= ' /*! STRAIGHT_JOIN */';
1268                 }
1269
1270                 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1271                         $startOpts .= ' HIGH_PRIORITY';
1272                 }
1273
1274                 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1275                         $startOpts .= ' SQL_BIG_RESULT';
1276                 }
1277
1278                 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1279                         $startOpts .= ' SQL_BUFFER_RESULT';
1280                 }
1281
1282                 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1283                         $startOpts .= ' SQL_SMALL_RESULT';
1284                 }
1285
1286                 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1287                         $startOpts .= ' SQL_CALC_FOUND_ROWS';
1288                 }
1289
1290                 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1291                         $startOpts .= ' SQL_CACHE';
1292                 }
1293
1294                 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1295                         $startOpts .= ' SQL_NO_CACHE';
1296                 }
1297
1298                 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1299                         $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1300                 } else {
1301                         $useIndex = '';
1302                 }
1303                 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1304                         $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1305                 } else {
1306                         $ignoreIndex = '';
1307                 }
1308
1309                 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1310         }
1311
1312         /**
1313          * Returns an optional GROUP BY with an optional HAVING
1314          *
1315          * @param array $options Associative array of options
1316          * @return string
1317          * @see Database::select()
1318          * @since 1.21
1319          */
1320         protected function makeGroupByWithHaving( $options ) {
1321                 $sql = '';
1322                 if ( isset( $options['GROUP BY'] ) ) {
1323                         $gb = is_array( $options['GROUP BY'] )
1324                                 ? implode( ',', $options['GROUP BY'] )
1325                                 : $options['GROUP BY'];
1326                         $sql .= ' GROUP BY ' . $gb;
1327                 }
1328                 if ( isset( $options['HAVING'] ) ) {
1329                         $having = is_array( $options['HAVING'] )
1330                                 ? $this->makeList( $options['HAVING'], self::LIST_AND )
1331                                 : $options['HAVING'];
1332                         $sql .= ' HAVING ' . $having;
1333                 }
1334
1335                 return $sql;
1336         }
1337
1338         /**
1339          * Returns an optional ORDER BY
1340          *
1341          * @param array $options Associative array of options
1342          * @return string
1343          * @see Database::select()
1344          * @since 1.21
1345          */
1346         protected function makeOrderBy( $options ) {
1347                 if ( isset( $options['ORDER BY'] ) ) {
1348                         $ob = is_array( $options['ORDER BY'] )
1349                                 ? implode( ',', $options['ORDER BY'] )
1350                                 : $options['ORDER BY'];
1351
1352                         return ' ORDER BY ' . $ob;
1353                 }
1354
1355                 return '';
1356         }
1357
1358         public function select( $table, $vars, $conds = '', $fname = __METHOD__,
1359                 $options = [], $join_conds = [] ) {
1360                 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1361
1362                 return $this->query( $sql, $fname );
1363         }
1364
1365         public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__,
1366                 $options = [], $join_conds = []
1367         ) {
1368                 if ( is_array( $vars ) ) {
1369                         $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1370                 }
1371
1372                 $options = (array)$options;
1373                 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1374                         ? $options['USE INDEX']
1375                         : [];
1376                 $ignoreIndexes = (
1377                         isset( $options['IGNORE INDEX'] ) &&
1378                         is_array( $options['IGNORE INDEX'] )
1379                 )
1380                         ? $options['IGNORE INDEX']
1381                         : [];
1382
1383                 if ( is_array( $table ) ) {
1384                         $from = ' FROM ' .
1385                                 $this->tableNamesWithIndexClauseOrJOIN(
1386                                         $table, $useIndexes, $ignoreIndexes, $join_conds );
1387                 } elseif ( $table != '' ) {
1388                         if ( $table[0] == ' ' ) {
1389                                 $from = ' FROM ' . $table;
1390                         } else {
1391                                 $from = ' FROM ' .
1392                                         $this->tableNamesWithIndexClauseOrJOIN(
1393                                                 [ $table ], $useIndexes, $ignoreIndexes, [] );
1394                         }
1395                 } else {
1396                         $from = '';
1397                 }
1398
1399                 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1400                         $this->makeSelectOptions( $options );
1401
1402                 if ( !empty( $conds ) ) {
1403                         if ( is_array( $conds ) ) {
1404                                 $conds = $this->makeList( $conds, self::LIST_AND );
1405                         }
1406                         $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex " .
1407                                 "WHERE $conds $preLimitTail";
1408                 } else {
1409                         $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex $preLimitTail";
1410                 }
1411
1412                 if ( isset( $options['LIMIT'] ) ) {
1413                         $sql = $this->limitResult( $sql, $options['LIMIT'],
1414                                 isset( $options['OFFSET'] ) ? $options['OFFSET'] : false );
1415                 }
1416                 $sql = "$sql $postLimitTail";
1417
1418                 if ( isset( $options['EXPLAIN'] ) ) {
1419                         $sql = 'EXPLAIN ' . $sql;
1420                 }
1421
1422                 return $sql;
1423         }
1424
1425         public function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1426                 $options = [], $join_conds = []
1427         ) {
1428                 $options = (array)$options;
1429                 $options['LIMIT'] = 1;
1430                 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1431
1432                 if ( $res === false ) {
1433                         return false;
1434                 }
1435
1436                 if ( !$this->numRows( $res ) ) {
1437                         return false;
1438                 }
1439
1440                 $obj = $this->fetchObject( $res );
1441
1442                 return $obj;
1443         }
1444
1445         public function estimateRowCount(
1446                 $table, $vars = '*', $conds = '', $fname = __METHOD__, $options = []
1447         ) {
1448                 $rows = 0;
1449                 $res = $this->select( $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options );
1450
1451                 if ( $res ) {
1452                         $row = $this->fetchRow( $res );
1453                         $rows = ( isset( $row['rowcount'] ) ) ? (int)$row['rowcount'] : 0;
1454                 }
1455
1456                 return $rows;
1457         }
1458
1459         public function selectRowCount(
1460                 $tables, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
1461         ) {
1462                 $rows = 0;
1463                 $sql = $this->selectSQLText( $tables, '1', $conds, $fname, $options, $join_conds );
1464                 // The identifier quotes is primarily for MSSQL.
1465                 $rowCountCol = $this->addIdentifierQuotes( "rowcount" );
1466                 $tableName = $this->addIdentifierQuotes( "tmp_count" );
1467                 $res = $this->query( "SELECT COUNT(*) AS $rowCountCol FROM ($sql) $tableName", $fname );
1468
1469                 if ( $res ) {
1470                         $row = $this->fetchRow( $res );
1471                         $rows = ( isset( $row['rowcount'] ) ) ? (int)$row['rowcount'] : 0;
1472                 }
1473
1474                 return $rows;
1475         }
1476
1477         /**
1478          * Removes most variables from an SQL query and replaces them with X or N for numbers.
1479          * It's only slightly flawed. Don't use for anything important.
1480          *
1481          * @param string $sql A SQL Query
1482          *
1483          * @return string
1484          */
1485         protected static function generalizeSQL( $sql ) {
1486                 # This does the same as the regexp below would do, but in such a way
1487                 # as to avoid crashing php on some large strings.
1488                 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1489
1490                 $sql = str_replace( "\\\\", '', $sql );
1491                 $sql = str_replace( "\\'", '', $sql );
1492                 $sql = str_replace( "\\\"", '', $sql );
1493                 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1494                 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1495
1496                 # All newlines, tabs, etc replaced by single space
1497                 $sql = preg_replace( '/\s+/', ' ', $sql );
1498
1499                 # All numbers => N,
1500                 # except the ones surrounded by characters, e.g. l10n
1501                 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1502                 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1503
1504                 return $sql;
1505         }
1506
1507         public function fieldExists( $table, $field, $fname = __METHOD__ ) {
1508                 $info = $this->fieldInfo( $table, $field );
1509
1510                 return (bool)$info;
1511         }
1512
1513         public function indexExists( $table, $index, $fname = __METHOD__ ) {
1514                 if ( !$this->tableExists( $table ) ) {
1515                         return null;
1516                 }
1517
1518                 $info = $this->indexInfo( $table, $index, $fname );
1519                 if ( is_null( $info ) ) {
1520                         return null;
1521                 } else {
1522                         return $info !== false;
1523                 }
1524         }
1525
1526         public function tableExists( $table, $fname = __METHOD__ ) {
1527                 $tableRaw = $this->tableName( $table, 'raw' );
1528                 if ( isset( $this->mSessionTempTables[$tableRaw] ) ) {
1529                         return true; // already known to exist
1530                 }
1531
1532                 $table = $this->tableName( $table );
1533                 $ignoreErrors = true;
1534                 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname, $ignoreErrors );
1535
1536                 return (bool)$res;
1537         }
1538
1539         public function indexUnique( $table, $index ) {
1540                 $indexInfo = $this->indexInfo( $table, $index );
1541
1542                 if ( !$indexInfo ) {
1543                         return null;
1544                 }
1545
1546                 return !$indexInfo[0]->Non_unique;
1547         }
1548
1549         /**
1550          * Helper for Database::insert().
1551          *
1552          * @param array $options
1553          * @return string
1554          */
1555         protected function makeInsertOptions( $options ) {
1556                 return implode( ' ', $options );
1557         }
1558
1559         public function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
1560                 # No rows to insert, easy just return now
1561                 if ( !count( $a ) ) {
1562                         return true;
1563                 }
1564
1565                 $table = $this->tableName( $table );
1566
1567                 if ( !is_array( $options ) ) {
1568                         $options = [ $options ];
1569                 }
1570
1571                 $fh = null;
1572                 if ( isset( $options['fileHandle'] ) ) {
1573                         $fh = $options['fileHandle'];
1574                 }
1575                 $options = $this->makeInsertOptions( $options );
1576
1577                 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1578                         $multi = true;
1579                         $keys = array_keys( $a[0] );
1580                 } else {
1581                         $multi = false;
1582                         $keys = array_keys( $a );
1583                 }
1584
1585                 $sql = 'INSERT ' . $options .
1586                         " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1587
1588                 if ( $multi ) {
1589                         $first = true;
1590                         foreach ( $a as $row ) {
1591                                 if ( $first ) {
1592                                         $first = false;
1593                                 } else {
1594                                         $sql .= ',';
1595                                 }
1596                                 $sql .= '(' . $this->makeList( $row ) . ')';
1597                         }
1598                 } else {
1599                         $sql .= '(' . $this->makeList( $a ) . ')';
1600                 }
1601
1602                 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1603                         return false;
1604                 } elseif ( $fh !== null ) {
1605                         return true;
1606                 }
1607
1608                 return (bool)$this->query( $sql, $fname );
1609         }
1610
1611         /**
1612          * Make UPDATE options array for Database::makeUpdateOptions
1613          *
1614          * @param array $options
1615          * @return array
1616          */
1617         protected function makeUpdateOptionsArray( $options ) {
1618                 if ( !is_array( $options ) ) {
1619                         $options = [ $options ];
1620                 }
1621
1622                 $opts = [];
1623
1624                 if ( in_array( 'IGNORE', $options ) ) {
1625                         $opts[] = 'IGNORE';
1626                 }
1627
1628                 return $opts;
1629         }
1630
1631         /**
1632          * Make UPDATE options for the Database::update function
1633          *
1634          * @param array $options The options passed to Database::update
1635          * @return string
1636          */
1637         protected function makeUpdateOptions( $options ) {
1638                 $opts = $this->makeUpdateOptionsArray( $options );
1639
1640                 return implode( ' ', $opts );
1641         }
1642
1643         public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
1644                 $table = $this->tableName( $table );
1645                 $opts = $this->makeUpdateOptions( $options );
1646                 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self::LIST_SET );
1647
1648                 if ( $conds !== [] && $conds !== '*' ) {
1649                         $sql .= " WHERE " . $this->makeList( $conds, self::LIST_AND );
1650                 }
1651
1652                 return (bool)$this->query( $sql, $fname );
1653         }
1654
1655         public function makeList( $a, $mode = self::LIST_COMMA ) {
1656                 if ( !is_array( $a ) ) {
1657                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
1658                 }
1659
1660                 $first = true;
1661                 $list = '';
1662
1663                 foreach ( $a as $field => $value ) {
1664                         if ( !$first ) {
1665                                 if ( $mode == self::LIST_AND ) {
1666                                         $list .= ' AND ';
1667                                 } elseif ( $mode == self::LIST_OR ) {
1668                                         $list .= ' OR ';
1669                                 } else {
1670                                         $list .= ',';
1671                                 }
1672                         } else {
1673                                 $first = false;
1674                         }
1675
1676                         if ( ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_numeric( $field ) ) {
1677                                 $list .= "($value)";
1678                         } elseif ( $mode == self::LIST_SET && is_numeric( $field ) ) {
1679                                 $list .= "$value";
1680                         } elseif (
1681                                 ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_array( $value )
1682                         ) {
1683                                 // Remove null from array to be handled separately if found
1684                                 $includeNull = false;
1685                                 foreach ( array_keys( $value, null, true ) as $nullKey ) {
1686                                         $includeNull = true;
1687                                         unset( $value[$nullKey] );
1688                                 }
1689                                 if ( count( $value ) == 0 && !$includeNull ) {
1690                                         throw new InvalidArgumentException(
1691                                                 __METHOD__ . ": empty input for field $field" );
1692                                 } elseif ( count( $value ) == 0 ) {
1693                                         // only check if $field is null
1694                                         $list .= "$field IS NULL";
1695                                 } else {
1696                                         // IN clause contains at least one valid element
1697                                         if ( $includeNull ) {
1698                                                 // Group subconditions to ensure correct precedence
1699                                                 $list .= '(';
1700                                         }
1701                                         if ( count( $value ) == 1 ) {
1702                                                 // Special-case single values, as IN isn't terribly efficient
1703                                                 // Don't necessarily assume the single key is 0; we don't
1704                                                 // enforce linear numeric ordering on other arrays here.
1705                                                 $value = array_values( $value )[0];
1706                                                 $list .= $field . " = " . $this->addQuotes( $value );
1707                                         } else {
1708                                                 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1709                                         }
1710                                         // if null present in array, append IS NULL
1711                                         if ( $includeNull ) {
1712                                                 $list .= " OR $field IS NULL)";
1713                                         }
1714                                 }
1715                         } elseif ( $value === null ) {
1716                                 if ( $mode == self::LIST_AND || $mode == self::LIST_OR ) {
1717                                         $list .= "$field IS ";
1718                                 } elseif ( $mode == self::LIST_SET ) {
1719                                         $list .= "$field = ";
1720                                 }
1721                                 $list .= 'NULL';
1722                         } else {
1723                                 if (
1724                                         $mode == self::LIST_AND || $mode == self::LIST_OR || $mode == self::LIST_SET
1725                                 ) {
1726                                         $list .= "$field = ";
1727                                 }
1728                                 $list .= $mode == self::LIST_NAMES ? $value : $this->addQuotes( $value );
1729                         }
1730                 }
1731
1732                 return $list;
1733         }
1734
1735         public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1736                 $conds = [];
1737
1738                 foreach ( $data as $base => $sub ) {
1739                         if ( count( $sub ) ) {
1740                                 $conds[] = $this->makeList(
1741                                         [ $baseKey => $base, $subKey => array_keys( $sub ) ],
1742                                         self::LIST_AND );
1743                         }
1744                 }
1745
1746                 if ( $conds ) {
1747                         return $this->makeList( $conds, self::LIST_OR );
1748                 } else {
1749                         // Nothing to search for...
1750                         return false;
1751                 }
1752         }
1753
1754         public function aggregateValue( $valuedata, $valuename = 'value' ) {
1755                 return $valuename;
1756         }
1757
1758         public function bitNot( $field ) {
1759                 return "(~$field)";
1760         }
1761
1762         public function bitAnd( $fieldLeft, $fieldRight ) {
1763                 return "($fieldLeft & $fieldRight)";
1764         }
1765
1766         public function bitOr( $fieldLeft, $fieldRight ) {
1767                 return "($fieldLeft | $fieldRight)";
1768         }
1769
1770         public function buildConcat( $stringList ) {
1771                 return 'CONCAT(' . implode( ',', $stringList ) . ')';
1772         }
1773
1774         public function buildGroupConcatField(
1775                 $delim, $table, $field, $conds = '', $join_conds = []
1776         ) {
1777                 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
1778
1779                 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1780         }
1781
1782         public function buildStringCast( $field ) {
1783                 return $field;
1784         }
1785
1786         public function databasesAreIndependent() {
1787                 return false;
1788         }
1789
1790         public function selectDB( $db ) {
1791                 # Stub. Shouldn't cause serious problems if it's not overridden, but
1792                 # if your database engine supports a concept similar to MySQL's
1793                 # databases you may as well.
1794                 $this->mDBname = $db;
1795
1796                 return true;
1797         }
1798
1799         public function getDBname() {
1800                 return $this->mDBname;
1801         }
1802
1803         public function getServer() {
1804                 return $this->mServer;
1805         }
1806
1807         public function tableName( $name, $format = 'quoted' ) {
1808                 # Skip the entire process when we have a string quoted on both ends.
1809                 # Note that we check the end so that we will still quote any use of
1810                 # use of `database`.table. But won't break things if someone wants
1811                 # to query a database table with a dot in the name.
1812                 if ( $this->isQuotedIdentifier( $name ) ) {
1813                         return $name;
1814                 }
1815
1816                 # Lets test for any bits of text that should never show up in a table
1817                 # name. Basically anything like JOIN or ON which are actually part of
1818                 # SQL queries, but may end up inside of the table value to combine
1819                 # sql. Such as how the API is doing.
1820                 # Note that we use a whitespace test rather than a \b test to avoid
1821                 # any remote case where a word like on may be inside of a table name
1822                 # surrounded by symbols which may be considered word breaks.
1823                 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
1824                         return $name;
1825                 }
1826
1827                 # Split database and table into proper variables.
1828                 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
1829
1830                 # Quote $table and apply the prefix if not quoted.
1831                 # $tableName might be empty if this is called from Database::replaceVars()
1832                 $tableName = "{$prefix}{$table}";
1833                 if ( $format === 'quoted'
1834                         && !$this->isQuotedIdentifier( $tableName )
1835                         && $tableName !== ''
1836                 ) {
1837                         $tableName = $this->addIdentifierQuotes( $tableName );
1838                 }
1839
1840                 # Quote $schema and $database and merge them with the table name if needed
1841                 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
1842                 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
1843
1844                 return $tableName;
1845         }
1846
1847         /**
1848          * Get the table components needed for a query given the currently selected database
1849          *
1850          * @param string $name Table name in the form of db.schema.table, db.table, or table
1851          * @return array (DB name or "" for default, schema name, table prefix, table name)
1852          */
1853         protected function qualifiedTableComponents( $name ) {
1854                 # We reverse the explode so that database.table and table both output the correct table.
1855                 $dbDetails = explode( '.', $name, 3 );
1856                 if ( count( $dbDetails ) == 3 ) {
1857                         list( $database, $schema, $table ) = $dbDetails;
1858                         # We don't want any prefix added in this case
1859                         $prefix = '';
1860                 } elseif ( count( $dbDetails ) == 2 ) {
1861                         list( $database, $table ) = $dbDetails;
1862                         # We don't want any prefix added in this case
1863                         $prefix = '';
1864                         # In dbs that support it, $database may actually be the schema
1865                         # but that doesn't affect any of the functionality here
1866                         $schema = '';
1867                 } else {
1868                         list( $table ) = $dbDetails;
1869                         if ( isset( $this->tableAliases[$table] ) ) {
1870                                 $database = $this->tableAliases[$table]['dbname'];
1871                                 $schema = is_string( $this->tableAliases[$table]['schema'] )
1872                                         ? $this->tableAliases[$table]['schema']
1873                                         : $this->mSchema;
1874                                 $prefix = is_string( $this->tableAliases[$table]['prefix'] )
1875                                         ? $this->tableAliases[$table]['prefix']
1876                                         : $this->mTablePrefix;
1877                         } else {
1878                                 $database = '';
1879                                 $schema = $this->mSchema; # Default schema
1880                                 $prefix = $this->mTablePrefix; # Default prefix
1881                         }
1882                 }
1883
1884                 return [ $database, $schema, $prefix, $table ];
1885         }
1886
1887         /**
1888          * @param string|null $namespace Database or schema
1889          * @param string $relation Name of table, view, sequence, etc...
1890          * @param string $format One of (raw, quoted)
1891          * @return string Relation name with quoted and merged $namespace as needed
1892          */
1893         private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
1894                 if ( strlen( $namespace ) ) {
1895                         if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
1896                                 $namespace = $this->addIdentifierQuotes( $namespace );
1897                         }
1898                         $relation = $namespace . '.' . $relation;
1899                 }
1900
1901                 return $relation;
1902         }
1903
1904         public function tableNames() {
1905                 $inArray = func_get_args();
1906                 $retVal = [];
1907
1908                 foreach ( $inArray as $name ) {
1909                         $retVal[$name] = $this->tableName( $name );
1910                 }
1911
1912                 return $retVal;
1913         }
1914
1915         public function tableNamesN() {
1916                 $inArray = func_get_args();
1917                 $retVal = [];
1918
1919                 foreach ( $inArray as $name ) {
1920                         $retVal[] = $this->tableName( $name );
1921                 }
1922
1923                 return $retVal;
1924         }
1925
1926         /**
1927          * Get an aliased table name
1928          * e.g. tableName AS newTableName
1929          *
1930          * @param string $name Table name, see tableName()
1931          * @param string|bool $alias Alias (optional)
1932          * @return string SQL name for aliased table. Will not alias a table to its own name
1933          */
1934         protected function tableNameWithAlias( $name, $alias = false ) {
1935                 if ( !$alias || $alias == $name ) {
1936                         return $this->tableName( $name );
1937                 } else {
1938                         return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
1939                 }
1940         }
1941
1942         /**
1943          * Gets an array of aliased table names
1944          *
1945          * @param array $tables [ [alias] => table ]
1946          * @return string[] See tableNameWithAlias()
1947          */
1948         protected function tableNamesWithAlias( $tables ) {
1949                 $retval = [];
1950                 foreach ( $tables as $alias => $table ) {
1951                         if ( is_numeric( $alias ) ) {
1952                                 $alias = $table;
1953                         }
1954                         $retval[] = $this->tableNameWithAlias( $table, $alias );
1955                 }
1956
1957                 return $retval;
1958         }
1959
1960         /**
1961          * Get an aliased field name
1962          * e.g. fieldName AS newFieldName
1963          *
1964          * @param string $name Field name
1965          * @param string|bool $alias Alias (optional)
1966          * @return string SQL name for aliased field. Will not alias a field to its own name
1967          */
1968         protected function fieldNameWithAlias( $name, $alias = false ) {
1969                 if ( !$alias || (string)$alias === (string)$name ) {
1970                         return $name;
1971                 } else {
1972                         return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
1973                 }
1974         }
1975
1976         /**
1977          * Gets an array of aliased field names
1978          *
1979          * @param array $fields [ [alias] => field ]
1980          * @return string[] See fieldNameWithAlias()
1981          */
1982         protected function fieldNamesWithAlias( $fields ) {
1983                 $retval = [];
1984                 foreach ( $fields as $alias => $field ) {
1985                         if ( is_numeric( $alias ) ) {
1986                                 $alias = $field;
1987                         }
1988                         $retval[] = $this->fieldNameWithAlias( $field, $alias );
1989                 }
1990
1991                 return $retval;
1992         }
1993
1994         /**
1995          * Get the aliased table name clause for a FROM clause
1996          * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
1997          *
1998          * @param array $tables ( [alias] => table )
1999          * @param array $use_index Same as for select()
2000          * @param array $ignore_index Same as for select()
2001          * @param array $join_conds Same as for select()
2002          * @return string
2003          */
2004         protected function tableNamesWithIndexClauseOrJOIN(
2005                 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2006         ) {
2007                 $ret = [];
2008                 $retJOIN = [];
2009                 $use_index = (array)$use_index;
2010                 $ignore_index = (array)$ignore_index;
2011                 $join_conds = (array)$join_conds;
2012
2013                 foreach ( $tables as $alias => $table ) {
2014                         if ( !is_string( $alias ) ) {
2015                                 // No alias? Set it equal to the table name
2016                                 $alias = $table;
2017                         }
2018                         // Is there a JOIN clause for this table?
2019                         if ( isset( $join_conds[$alias] ) ) {
2020                                 list( $joinType, $conds ) = $join_conds[$alias];
2021                                 $tableClause = $joinType;
2022                                 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2023                                 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2024                                         $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2025                                         if ( $use != '' ) {
2026                                                 $tableClause .= ' ' . $use;
2027                                         }
2028                                 }
2029                                 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2030                                         $ignore = $this->ignoreIndexClause(
2031                                                 implode( ',', (array)$ignore_index[$alias] ) );
2032                                         if ( $ignore != '' ) {
2033                                                 $tableClause .= ' ' . $ignore;
2034                                         }
2035                                 }
2036                                 $on = $this->makeList( (array)$conds, self::LIST_AND );
2037                                 if ( $on != '' ) {
2038                                         $tableClause .= ' ON (' . $on . ')';
2039                                 }
2040
2041                                 $retJOIN[] = $tableClause;
2042                         } elseif ( isset( $use_index[$alias] ) ) {
2043                                 // Is there an INDEX clause for this table?
2044                                 $tableClause = $this->tableNameWithAlias( $table, $alias );
2045                                 $tableClause .= ' ' . $this->useIndexClause(
2046                                                 implode( ',', (array)$use_index[$alias] )
2047                                         );
2048
2049                                 $ret[] = $tableClause;
2050                         } elseif ( isset( $ignore_index[$alias] ) ) {
2051                                 // Is there an INDEX clause for this table?
2052                                 $tableClause = $this->tableNameWithAlias( $table, $alias );
2053                                 $tableClause .= ' ' . $this->ignoreIndexClause(
2054                                                 implode( ',', (array)$ignore_index[$alias] )
2055                                         );
2056
2057                                 $ret[] = $tableClause;
2058                         } else {
2059                                 $tableClause = $this->tableNameWithAlias( $table, $alias );
2060
2061                                 $ret[] = $tableClause;
2062                         }
2063                 }
2064
2065                 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2066                 $implicitJoins = !empty( $ret ) ? implode( ',', $ret ) : "";
2067                 $explicitJoins = !empty( $retJOIN ) ? implode( ' ', $retJOIN ) : "";
2068
2069                 // Compile our final table clause
2070                 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2071         }
2072
2073         /**
2074          * Allows for index remapping in queries where this is not consistent across DBMS
2075          *
2076          * @param string $index
2077          * @return string
2078          */
2079         protected function indexName( $index ) {
2080                 return $index;
2081         }
2082
2083         public function addQuotes( $s ) {
2084                 if ( $s instanceof Blob ) {
2085                         $s = $s->fetch();
2086                 }
2087                 if ( $s === null ) {
2088                         return 'NULL';
2089                 } elseif ( is_bool( $s ) ) {
2090                         return (int)$s;
2091                 } else {
2092                         # This will also quote numeric values. This should be harmless,
2093                         # and protects against weird problems that occur when they really
2094                         # _are_ strings such as article titles and string->number->string
2095                         # conversion is not 1:1.
2096                         return "'" . $this->strencode( $s ) . "'";
2097                 }
2098         }
2099
2100         /**
2101          * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2102          * MySQL uses `backticks` while basically everything else uses double quotes.
2103          * Since MySQL is the odd one out here the double quotes are our generic
2104          * and we implement backticks in DatabaseMysqlBase.
2105          *
2106          * @param string $s
2107          * @return string
2108          */
2109         public function addIdentifierQuotes( $s ) {
2110                 return '"' . str_replace( '"', '""', $s ) . '"';
2111         }
2112
2113         /**
2114          * Returns if the given identifier looks quoted or not according to
2115          * the database convention for quoting identifiers .
2116          *
2117          * @note Do not use this to determine if untrusted input is safe.
2118          *   A malicious user can trick this function.
2119          * @param string $name
2120          * @return bool
2121          */
2122         public function isQuotedIdentifier( $name ) {
2123                 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2124         }
2125
2126         /**
2127          * @param string $s
2128          * @param string $escapeChar
2129          * @return string
2130          */
2131         protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2132                 return str_replace( [ $escapeChar, '%', '_' ],
2133                         [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2134                         $s );
2135         }
2136
2137         public function buildLike() {
2138                 $params = func_get_args();
2139
2140                 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2141                         $params = $params[0];
2142                 }
2143
2144                 $s = '';
2145
2146                 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2147                 // may escape backslashes, creating problems of double escaping. The `
2148                 // character has good cross-DBMS compatibility, avoiding special operators
2149                 // in MS SQL like ^ and %
2150                 $escapeChar = '`';
2151
2152                 foreach ( $params as $value ) {
2153                         if ( $value instanceof LikeMatch ) {
2154                                 $s .= $value->toString();
2155                         } else {
2156                                 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2157                         }
2158                 }
2159
2160                 return ' LIKE ' . $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2161         }
2162
2163         public function anyChar() {
2164                 return new LikeMatch( '_' );
2165         }
2166
2167         public function anyString() {
2168                 return new LikeMatch( '%' );
2169         }
2170
2171         public function nextSequenceValue( $seqName ) {
2172                 return null;
2173         }
2174
2175         /**
2176          * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2177          * is only needed because a) MySQL must be as efficient as possible due to
2178          * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2179          * which index to pick. Anyway, other databases might have different
2180          * indexes on a given table. So don't bother overriding this unless you're
2181          * MySQL.
2182          * @param string $index
2183          * @return string
2184          */
2185         public function useIndexClause( $index ) {
2186                 return '';
2187         }
2188
2189         /**
2190          * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2191          * is only needed because a) MySQL must be as efficient as possible due to
2192          * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2193          * which index to pick. Anyway, other databases might have different
2194          * indexes on a given table. So don't bother overriding this unless you're
2195          * MySQL.
2196          * @param string $index
2197          * @return string
2198          */
2199         public function ignoreIndexClause( $index ) {
2200                 return '';
2201         }
2202
2203         public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
2204                 $quotedTable = $this->tableName( $table );
2205
2206                 if ( count( $rows ) == 0 ) {
2207                         return;
2208                 }
2209
2210                 # Single row case
2211                 if ( !is_array( reset( $rows ) ) ) {
2212                         $rows = [ $rows ];
2213                 }
2214
2215                 // @FXIME: this is not atomic, but a trx would break affectedRows()
2216                 foreach ( $rows as $row ) {
2217                         # Delete rows which collide
2218                         if ( $uniqueIndexes ) {
2219                                 $sql = "DELETE FROM $quotedTable WHERE ";
2220                                 $first = true;
2221                                 foreach ( $uniqueIndexes as $index ) {
2222                                         if ( $first ) {
2223                                                 $first = false;
2224                                                 $sql .= '( ';
2225                                         } else {
2226                                                 $sql .= ' ) OR ( ';
2227                                         }
2228                                         if ( is_array( $index ) ) {
2229                                                 $first2 = true;
2230                                                 foreach ( $index as $col ) {
2231                                                         if ( $first2 ) {
2232                                                                 $first2 = false;
2233                                                         } else {
2234                                                                 $sql .= ' AND ';
2235                                                         }
2236                                                         $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2237                                                 }
2238                                         } else {
2239                                                 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2240                                         }
2241                                 }
2242                                 $sql .= ' )';
2243                                 $this->query( $sql, $fname );
2244                         }
2245
2246                         # Now insert the row
2247                         $this->insert( $table, $row, $fname );
2248                 }
2249         }
2250
2251         /**
2252          * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2253          * statement.
2254          *
2255          * @param string $table Table name
2256          * @param array|string $rows Row(s) to insert
2257          * @param string $fname Caller function name
2258          *
2259          * @return ResultWrapper
2260          */
2261         protected function nativeReplace( $table, $rows, $fname ) {
2262                 $table = $this->tableName( $table );
2263
2264                 # Single row case
2265                 if ( !is_array( reset( $rows ) ) ) {
2266                         $rows = [ $rows ];
2267                 }
2268
2269                 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2270                 $first = true;
2271
2272                 foreach ( $rows as $row ) {
2273                         if ( $first ) {
2274                                 $first = false;
2275                         } else {
2276                                 $sql .= ',';
2277                         }
2278
2279                         $sql .= '(' . $this->makeList( $row ) . ')';
2280                 }
2281
2282                 return $this->query( $sql, $fname );
2283         }
2284
2285         public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2286                 $fname = __METHOD__
2287         ) {
2288                 if ( !count( $rows ) ) {
2289                         return true; // nothing to do
2290                 }
2291
2292                 if ( !is_array( reset( $rows ) ) ) {
2293                         $rows = [ $rows ];
2294                 }
2295
2296                 if ( count( $uniqueIndexes ) ) {
2297                         $clauses = []; // list WHERE clauses that each identify a single row
2298                         foreach ( $rows as $row ) {
2299                                 foreach ( $uniqueIndexes as $index ) {
2300                                         $index = is_array( $index ) ? $index : [ $index ]; // columns
2301                                         $rowKey = []; // unique key to this row
2302                                         foreach ( $index as $column ) {
2303                                                 $rowKey[$column] = $row[$column];
2304                                         }
2305                                         $clauses[] = $this->makeList( $rowKey, self::LIST_AND );
2306                                 }
2307                         }
2308                         $where = [ $this->makeList( $clauses, self::LIST_OR ) ];
2309                 } else {
2310                         $where = false;
2311                 }
2312
2313                 $useTrx = !$this->mTrxLevel;
2314                 if ( $useTrx ) {
2315                         $this->begin( $fname, self::TRANSACTION_INTERNAL );
2316                 }
2317                 try {
2318                         # Update any existing conflicting row(s)
2319                         if ( $where !== false ) {
2320                                 $ok = $this->update( $table, $set, $where, $fname );
2321                         } else {
2322                                 $ok = true;
2323                         }
2324                         # Now insert any non-conflicting row(s)
2325                         $ok = $this->insert( $table, $rows, $fname, [ 'IGNORE' ] ) && $ok;
2326                 } catch ( Exception $e ) {
2327                         if ( $useTrx ) {
2328                                 $this->rollback( $fname, self::FLUSHING_INTERNAL );
2329                         }
2330                         throw $e;
2331                 }
2332                 if ( $useTrx ) {
2333                         $this->commit( $fname, self::FLUSHING_INTERNAL );
2334                 }
2335
2336                 return $ok;
2337         }
2338
2339         public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2340                 $fname = __METHOD__
2341         ) {
2342                 if ( !$conds ) {
2343                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
2344                 }
2345
2346                 $delTable = $this->tableName( $delTable );
2347                 $joinTable = $this->tableName( $joinTable );
2348                 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2349                 if ( $conds != '*' ) {
2350                         $sql .= 'WHERE ' . $this->makeList( $conds, self::LIST_AND );
2351                 }
2352                 $sql .= ')';
2353
2354                 $this->query( $sql, $fname );
2355         }
2356
2357         public function textFieldSize( $table, $field ) {
2358                 $table = $this->tableName( $table );
2359                 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2360                 $res = $this->query( $sql, __METHOD__ );
2361                 $row = $this->fetchObject( $res );
2362
2363                 $m = [];
2364
2365                 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
2366                         $size = $m[1];
2367                 } else {
2368                         $size = -1;
2369                 }
2370
2371                 return $size;
2372         }
2373
2374         public function delete( $table, $conds, $fname = __METHOD__ ) {
2375                 if ( !$conds ) {
2376                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with no conditions' );
2377                 }
2378
2379                 $table = $this->tableName( $table );
2380                 $sql = "DELETE FROM $table";
2381
2382                 if ( $conds != '*' ) {
2383                         if ( is_array( $conds ) ) {
2384                                 $conds = $this->makeList( $conds, self::LIST_AND );
2385                         }
2386                         $sql .= ' WHERE ' . $conds;
2387                 }
2388
2389                 return $this->query( $sql, $fname );
2390         }
2391
2392         public function insertSelect(
2393                 $destTable, $srcTable, $varMap, $conds,
2394                 $fname = __METHOD__, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2395         ) {
2396                 if ( $this->cliMode ) {
2397                         // For massive migrations with downtime, we don't want to select everything
2398                         // into memory and OOM, so do all this native on the server side if possible.
2399                         return $this->nativeInsertSelect(
2400                                 $destTable,
2401                                 $srcTable,
2402                                 $varMap,
2403                                 $conds,
2404                                 $fname,
2405                                 $insertOptions,
2406                                 $selectOptions,
2407                                 $selectJoinConds
2408                         );
2409                 }
2410
2411                 return $this->nonNativeInsertSelect(
2412                         $destTable,
2413                         $srcTable,
2414                         $varMap,
2415                         $conds,
2416                         $fname,
2417                         $insertOptions,
2418                         $selectOptions,
2419                         $selectJoinConds
2420                 );
2421         }
2422
2423         /**
2424          * Implementation of insertSelect() based on select() and insert()
2425          *
2426          * @see IDatabase::insertSelect()
2427          * @since 1.30
2428          * @param string $destTable
2429          * @param string|array $srcTable
2430          * @param array $varMap
2431          * @param array $conds
2432          * @param string $fname
2433          * @param array $insertOptions
2434          * @param array $selectOptions
2435          * @param array $selectJoinConds
2436          * @return bool
2437          */
2438         protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
2439                 $fname = __METHOD__,
2440                 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2441         ) {
2442                 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
2443                 // on only the master (without needing row-based-replication). It also makes it easy to
2444                 // know how big the INSERT is going to be.
2445                 $fields = [];
2446                 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
2447                         $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
2448                 }
2449                 $selectOptions[] = 'FOR UPDATE';
2450                 $res = $this->select(
2451                         $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
2452                 );
2453                 if ( !$res ) {
2454                         return false;
2455                 }
2456
2457                 $rows = [];
2458                 foreach ( $res as $row ) {
2459                         $rows[] = (array)$row;
2460                 }
2461
2462                 return $this->insert( $destTable, $rows, $fname, $insertOptions );
2463         }
2464
2465         /**
2466          * Native server-side implementation of insertSelect() for situations where
2467          * we don't want to select everything into memory
2468          *
2469          * @see IDatabase::insertSelect()
2470          * @param string $destTable
2471          * @param string|array $srcTable
2472          * @param array $varMap
2473          * @param array $conds
2474          * @param string $fname
2475          * @param array $insertOptions
2476          * @param array $selectOptions
2477          * @param array $selectJoinConds
2478          * @return bool
2479          */
2480         protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
2481                 $fname = __METHOD__,
2482                 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2483         ) {
2484                 $destTable = $this->tableName( $destTable );
2485
2486                 if ( !is_array( $insertOptions ) ) {
2487                         $insertOptions = [ $insertOptions ];
2488                 }
2489
2490                 $insertOptions = $this->makeInsertOptions( $insertOptions );
2491
2492                 $selectSql = $this->selectSQLText(
2493                         $srcTable,
2494                         array_values( $varMap ),
2495                         $conds,
2496                         $fname,
2497                         $selectOptions,
2498                         $selectJoinConds
2499                 );
2500
2501                 $sql = "INSERT $insertOptions" .
2502                         " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
2503                         $selectSql;
2504
2505                 return $this->query( $sql, $fname );
2506         }
2507
2508         /**
2509          * Construct a LIMIT query with optional offset. This is used for query
2510          * pages. The SQL should be adjusted so that only the first $limit rows
2511          * are returned. If $offset is provided as well, then the first $offset
2512          * rows should be discarded, and the next $limit rows should be returned.
2513          * If the result of the query is not ordered, then the rows to be returned
2514          * are theoretically arbitrary.
2515          *
2516          * $sql is expected to be a SELECT, if that makes a difference.
2517          *
2518          * The version provided by default works in MySQL and SQLite. It will very
2519          * likely need to be overridden for most other DBMSes.
2520          *
2521          * @param string $sql SQL query we will append the limit too
2522          * @param int $limit The SQL limit
2523          * @param int|bool $offset The SQL offset (default false)
2524          * @throws DBUnexpectedError
2525          * @return string
2526          */
2527         public function limitResult( $sql, $limit, $offset = false ) {
2528                 if ( !is_numeric( $limit ) ) {
2529                         throw new DBUnexpectedError( $this,
2530                                 "Invalid non-numeric limit passed to limitResult()\n" );
2531                 }
2532
2533                 return "$sql LIMIT "
2534                 . ( ( is_numeric( $offset ) && $offset != 0 ) ? "{$offset}," : "" )
2535                 . "{$limit} ";
2536         }
2537
2538         public function unionSupportsOrderAndLimit() {
2539                 return true; // True for almost every DB supported
2540         }
2541
2542         public function unionQueries( $sqls, $all ) {
2543                 $glue = $all ? ') UNION ALL (' : ') UNION (';
2544
2545                 return '(' . implode( $glue, $sqls ) . ')';
2546         }
2547
2548         public function unionConditionPermutations(
2549                 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__,
2550                 $options = [], $join_conds = []
2551         ) {
2552                 // First, build the Cartesian product of $permute_conds
2553                 $conds = [ [] ];
2554                 foreach ( $permute_conds as $field => $values ) {
2555                         if ( !$values ) {
2556                                 // Skip empty $values
2557                                 continue;
2558                         }
2559                         $values = array_unique( $values ); // For sanity
2560                         $newConds = [];
2561                         foreach ( $conds as $cond ) {
2562                                 foreach ( $values as $value ) {
2563                                         $cond[$field] = $value;
2564                                         $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
2565                                 }
2566                         }
2567                         $conds = $newConds;
2568                 }
2569
2570                 $extra_conds = $extra_conds === '' ? [] : (array)$extra_conds;
2571
2572                 // If there's just one condition and no subordering, hand off to
2573                 // selectSQLText directly.
2574                 if ( count( $conds ) === 1 &&
2575                         ( !isset( $options['INNER ORDER BY'] ) || !$this->unionSupportsOrderAndLimit() )
2576                 ) {
2577                         return $this->selectSQLText(
2578                                 $table, $vars, $conds[0] + $extra_conds, $fname, $options, $join_conds
2579                         );
2580                 }
2581
2582                 // Otherwise, we need to pull out the order and limit to apply after
2583                 // the union. Then build the SQL queries for each set of conditions in
2584                 // $conds. Then union them together (using UNION ALL, because the
2585                 // product *should* already be distinct).
2586                 $orderBy = $this->makeOrderBy( $options );
2587                 $limit = isset( $options['LIMIT'] ) ? $options['LIMIT'] : null;
2588                 $offset = isset( $options['OFFSET'] ) ? $options['OFFSET'] : false;
2589                 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
2590                 if ( !$this->unionSupportsOrderAndLimit() ) {
2591                         unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
2592                 } else {
2593                         if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
2594                                 $options['ORDER BY'] = $options['INNER ORDER BY'];
2595                         }
2596                         if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
2597                                 // We need to increase the limit by the offset rather than
2598                                 // using the offset directly, otherwise it'll skip incorrectly
2599                                 // in the subqueries.
2600                                 $options['LIMIT'] = $limit + $offset;
2601                                 unset( $options['OFFSET'] );
2602                         }
2603                 }
2604
2605                 $sqls = [];
2606                 foreach ( $conds as $cond ) {
2607                         $sqls[] = $this->selectSQLText(
2608                                 $table, $vars, $cond + $extra_conds, $fname, $options, $join_conds
2609                         );
2610                 }
2611                 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
2612                 if ( $limit !== null ) {
2613                         $sql = $this->limitResult( $sql, $limit, $offset );
2614                 }
2615
2616                 return $sql;
2617         }
2618
2619         public function conditional( $cond, $trueVal, $falseVal ) {
2620                 if ( is_array( $cond ) ) {
2621                         $cond = $this->makeList( $cond, self::LIST_AND );
2622                 }
2623
2624                 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2625         }
2626
2627         public function strreplace( $orig, $old, $new ) {
2628                 return "REPLACE({$orig}, {$old}, {$new})";
2629         }
2630
2631         public function getServerUptime() {
2632                 return 0;
2633         }
2634
2635         public function wasDeadlock() {
2636                 return false;
2637         }
2638
2639         public function wasLockTimeout() {
2640                 return false;
2641         }
2642
2643         public function wasErrorReissuable() {
2644                 return false;
2645         }
2646
2647         public function wasReadOnlyError() {
2648                 return false;
2649         }
2650
2651         /**
2652          * Do not use this method outside of Database/DBError classes
2653          *
2654          * @param int|string $errno
2655          * @return bool Whether the given query error was a connection drop
2656          */
2657         public function wasConnectionError( $errno ) {
2658                 return false;
2659         }
2660
2661         public function deadlockLoop() {
2662                 $args = func_get_args();
2663                 $function = array_shift( $args );
2664                 $tries = self::DEADLOCK_TRIES;
2665
2666                 $this->begin( __METHOD__ );
2667
2668                 $retVal = null;
2669                 /** @var Exception $e */
2670                 $e = null;
2671                 do {
2672                         try {
2673                                 $retVal = call_user_func_array( $function, $args );
2674                                 break;
2675                         } catch ( DBQueryError $e ) {
2676                                 if ( $this->wasDeadlock() ) {
2677                                         // Retry after a randomized delay
2678                                         usleep( mt_rand( self::DEADLOCK_DELAY_MIN, self::DEADLOCK_DELAY_MAX ) );
2679                                 } else {
2680                                         // Throw the error back up
2681                                         throw $e;
2682                                 }
2683                         }
2684                 } while ( --$tries > 0 );
2685
2686                 if ( $tries <= 0 ) {
2687                         // Too many deadlocks; give up
2688                         $this->rollback( __METHOD__ );
2689                         throw $e;
2690                 } else {
2691                         $this->commit( __METHOD__ );
2692
2693                         return $retVal;
2694                 }
2695         }
2696
2697         public function masterPosWait( DBMasterPos $pos, $timeout ) {
2698                 # Real waits are implemented in the subclass.
2699                 return 0;
2700         }
2701
2702         public function getReplicaPos() {
2703                 # Stub
2704                 return false;
2705         }
2706
2707         public function getMasterPos() {
2708                 # Stub
2709                 return false;
2710         }
2711
2712         public function serverIsReadOnly() {
2713                 return false;
2714         }
2715
2716         final public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) {
2717                 if ( !$this->mTrxLevel ) {
2718                         throw new DBUnexpectedError( $this, "No transaction is active." );
2719                 }
2720                 $this->mTrxEndCallbacks[] = [ $callback, $fname ];
2721         }
2722
2723         final public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) {
2724                 $this->mTrxIdleCallbacks[] = [ $callback, $fname ];
2725                 if ( !$this->mTrxLevel ) {
2726                         $this->runOnTransactionIdleCallbacks( self::TRIGGER_IDLE );
2727                 }
2728         }
2729
2730         final public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) {
2731                 if ( $this->mTrxLevel || $this->getFlag( self::DBO_TRX ) ) {
2732                         // As long as DBO_TRX is set, writes will accumulate until the load balancer issues
2733                         // an implicit commit of all peer databases. This is true even if a transaction has
2734                         // not yet been triggered by writes; make sure $callback runs *after* any such writes.
2735                         $this->mTrxPreCommitCallbacks[] = [ $callback, $fname ];
2736                 } else {
2737                         // No transaction is active nor will start implicitly, so make one for this callback
2738                         $this->startAtomic( __METHOD__ );
2739                         try {
2740                                 call_user_func( $callback );
2741                                 $this->endAtomic( __METHOD__ );
2742                         } catch ( Exception $e ) {
2743                                 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
2744                                 throw $e;
2745                         }
2746                 }
2747         }
2748
2749         final public function setTransactionListener( $name, callable $callback = null ) {
2750                 if ( $callback ) {
2751                         $this->mTrxRecurringCallbacks[$name] = $callback;
2752                 } else {
2753                         unset( $this->mTrxRecurringCallbacks[$name] );
2754                 }
2755         }
2756
2757         /**
2758          * Whether to disable running of post-COMMIT/ROLLBACK callbacks
2759          *
2760          * This method should not be used outside of Database/LoadBalancer
2761          *
2762          * @param bool $suppress
2763          * @since 1.28
2764          */
2765         final public function setTrxEndCallbackSuppression( $suppress ) {
2766                 $this->mTrxEndCallbacksSuppressed = $suppress;
2767         }
2768
2769         /**
2770          * Actually run and consume any "on transaction idle/resolution" callbacks.
2771          *
2772          * This method should not be used outside of Database/LoadBalancer
2773          *
2774          * @param int $trigger IDatabase::TRIGGER_* constant
2775          * @since 1.20
2776          * @throws Exception
2777          */
2778         public function runOnTransactionIdleCallbacks( $trigger ) {
2779                 if ( $this->mTrxEndCallbacksSuppressed ) {
2780                         return;
2781                 }
2782
2783                 $autoTrx = $this->getFlag( self::DBO_TRX ); // automatic begin() enabled?
2784                 /** @var Exception $e */
2785                 $e = null; // first exception
2786                 do { // callbacks may add callbacks :)
2787                         $callbacks = array_merge(
2788                                 $this->mTrxIdleCallbacks,
2789                                 $this->mTrxEndCallbacks // include "transaction resolution" callbacks
2790                         );
2791                         $this->mTrxIdleCallbacks = []; // consumed (and recursion guard)
2792                         $this->mTrxEndCallbacks = []; // consumed (recursion guard)
2793                         foreach ( $callbacks as $callback ) {
2794                                 try {
2795                                         list( $phpCallback ) = $callback;
2796                                         $this->clearFlag( self::DBO_TRX ); // make each query its own transaction
2797                                         call_user_func_array( $phpCallback, [ $trigger ] );
2798                                         if ( $autoTrx ) {
2799                                                 $this->setFlag( self::DBO_TRX ); // restore automatic begin()
2800                                         } else {
2801                                                 $this->clearFlag( self::DBO_TRX ); // restore auto-commit
2802                                         }
2803                                 } catch ( Exception $ex ) {
2804                                         call_user_func( $this->errorLogger, $ex );
2805                                         $e = $e ?: $ex;
2806                                         // Some callbacks may use startAtomic/endAtomic, so make sure
2807                                         // their transactions are ended so other callbacks don't fail
2808                                         if ( $this->trxLevel() ) {
2809                                                 $this->rollback( __METHOD__, self::FLUSHING_INTERNAL );
2810                                         }
2811                                 }
2812                         }
2813                 } while ( count( $this->mTrxIdleCallbacks ) );
2814
2815                 if ( $e instanceof Exception ) {
2816                         throw $e; // re-throw any first exception
2817                 }
2818         }
2819
2820         /**
2821          * Actually run and consume any "on transaction pre-commit" callbacks.
2822          *
2823          * This method should not be used outside of Database/LoadBalancer
2824          *
2825          * @since 1.22
2826          * @throws Exception
2827          */
2828         public function runOnTransactionPreCommitCallbacks() {
2829                 $e = null; // first exception
2830                 do { // callbacks may add callbacks :)
2831                         $callbacks = $this->mTrxPreCommitCallbacks;
2832                         $this->mTrxPreCommitCallbacks = []; // consumed (and recursion guard)
2833                         foreach ( $callbacks as $callback ) {
2834                                 try {
2835                                         list( $phpCallback ) = $callback;
2836                                         call_user_func( $phpCallback );
2837                                 } catch ( Exception $ex ) {
2838                                         call_user_func( $this->errorLogger, $ex );
2839                                         $e = $e ?: $ex;
2840                                 }
2841                         }
2842                 } while ( count( $this->mTrxPreCommitCallbacks ) );
2843
2844                 if ( $e instanceof Exception ) {
2845                         throw $e; // re-throw any first exception
2846                 }
2847         }
2848
2849         /**
2850          * Actually run any "transaction listener" callbacks.
2851          *
2852          * This method should not be used outside of Database/LoadBalancer
2853          *
2854          * @param int $trigger IDatabase::TRIGGER_* constant
2855          * @throws Exception
2856          * @since 1.20
2857          */
2858         public function runTransactionListenerCallbacks( $trigger ) {
2859                 if ( $this->mTrxEndCallbacksSuppressed ) {
2860                         return;
2861                 }
2862
2863                 /** @var Exception $e */
2864                 $e = null; // first exception
2865
2866                 foreach ( $this->mTrxRecurringCallbacks as $phpCallback ) {
2867                         try {
2868                                 $phpCallback( $trigger, $this );
2869                         } catch ( Exception $ex ) {
2870                                 call_user_func( $this->errorLogger, $ex );
2871                                 $e = $e ?: $ex;
2872                         }
2873                 }
2874
2875                 if ( $e instanceof Exception ) {
2876                         throw $e; // re-throw any first exception
2877                 }
2878         }
2879
2880         final public function startAtomic( $fname = __METHOD__ ) {
2881                 if ( !$this->mTrxLevel ) {
2882                         $this->begin( $fname, self::TRANSACTION_INTERNAL );
2883                         // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
2884                         // in all changes being in one transaction to keep requests transactional.
2885                         if ( !$this->getFlag( self::DBO_TRX ) ) {
2886                                 $this->mTrxAutomaticAtomic = true;
2887                         }
2888                 }
2889
2890                 $this->mTrxAtomicLevels[] = $fname;
2891         }
2892
2893         final public function endAtomic( $fname = __METHOD__ ) {
2894                 if ( !$this->mTrxLevel ) {
2895                         throw new DBUnexpectedError( $this, "No atomic transaction is open (got $fname)." );
2896                 }
2897                 if ( !$this->mTrxAtomicLevels ||
2898                         array_pop( $this->mTrxAtomicLevels ) !== $fname
2899                 ) {
2900                         throw new DBUnexpectedError( $this, "Invalid atomic section ended (got $fname)." );
2901                 }
2902
2903                 if ( !$this->mTrxAtomicLevels && $this->mTrxAutomaticAtomic ) {
2904                         $this->commit( $fname, self::FLUSHING_INTERNAL );
2905                 }
2906         }
2907
2908         final public function doAtomicSection( $fname, callable $callback ) {
2909                 $this->startAtomic( $fname );
2910                 try {
2911                         $res = call_user_func_array( $callback, [ $this, $fname ] );
2912                 } catch ( Exception $e ) {
2913                         $this->rollback( $fname, self::FLUSHING_INTERNAL );
2914                         throw $e;
2915                 }
2916                 $this->endAtomic( $fname );
2917
2918                 return $res;
2919         }
2920
2921         final public function begin( $fname = __METHOD__, $mode = self::TRANSACTION_EXPLICIT ) {
2922                 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
2923                 if ( $this->mTrxLevel ) {
2924                         if ( $this->mTrxAtomicLevels ) {
2925                                 $levels = implode( ', ', $this->mTrxAtomicLevels );
2926                                 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
2927                                 throw new DBUnexpectedError( $this, $msg );
2928                         } elseif ( !$this->mTrxAutomatic ) {
2929                                 $msg = "$fname: Explicit transaction already active (from {$this->mTrxFname}).";
2930                                 throw new DBUnexpectedError( $this, $msg );
2931                         } else {
2932                                 // @TODO: make this an exception at some point
2933                                 $msg = "$fname: Implicit transaction already active (from {$this->mTrxFname}).";
2934                                 $this->queryLogger->error( $msg );
2935                                 return; // join the main transaction set
2936                         }
2937                 } elseif ( $this->getFlag( self::DBO_TRX ) && $mode !== self::TRANSACTION_INTERNAL ) {
2938                         // @TODO: make this an exception at some point
2939                         $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
2940                         $this->queryLogger->error( $msg );
2941                         return; // let any writes be in the main transaction
2942                 }
2943
2944                 // Avoid fatals if close() was called
2945                 $this->assertOpen();
2946
2947                 $this->doBegin( $fname );
2948                 $this->mTrxTimestamp = microtime( true );
2949                 $this->mTrxFname = $fname;
2950                 $this->mTrxDoneWrites = false;
2951                 $this->mTrxAutomaticAtomic = false;
2952                 $this->mTrxAtomicLevels = [];
2953                 $this->mTrxShortId = sprintf( '%06x', mt_rand( 0, 0xffffff ) );
2954                 $this->mTrxWriteDuration = 0.0;
2955                 $this->mTrxWriteQueryCount = 0;
2956                 $this->mTrxWriteAffectedRows = 0;
2957                 $this->mTrxWriteAdjDuration = 0.0;
2958                 $this->mTrxWriteAdjQueryCount = 0;
2959                 $this->mTrxWriteCallers = [];
2960                 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
2961                 // Get an estimate of the replica DB lag before then, treating estimate staleness
2962                 // as lag itself just to be safe
2963                 $status = $this->getApproximateLagStatus();
2964                 $this->mTrxReplicaLag = $status['lag'] + ( microtime( true ) - $status['since'] );
2965                 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
2966                 // caller will think its OK to muck around with the transaction just because startAtomic()
2967                 // has not yet completed (e.g. setting mTrxAtomicLevels).
2968                 $this->mTrxAutomatic = ( $mode === self::TRANSACTION_INTERNAL );
2969         }
2970
2971         /**
2972          * Issues the BEGIN command to the database server.
2973          *
2974          * @see Database::begin()
2975          * @param string $fname
2976          */
2977         protected function doBegin( $fname ) {
2978                 $this->query( 'BEGIN', $fname );
2979                 $this->mTrxLevel = 1;
2980         }
2981
2982         final public function commit( $fname = __METHOD__, $flush = '' ) {
2983                 if ( $this->mTrxLevel && $this->mTrxAtomicLevels ) {
2984                         // There are still atomic sections open. This cannot be ignored
2985                         $levels = implode( ', ', $this->mTrxAtomicLevels );
2986                         throw new DBUnexpectedError(
2987                                 $this,
2988                                 "$fname: Got COMMIT while atomic sections $levels are still open."
2989                         );
2990                 }
2991
2992                 if ( $flush === self::FLUSHING_INTERNAL || $flush === self::FLUSHING_ALL_PEERS ) {
2993                         if ( !$this->mTrxLevel ) {
2994                                 return; // nothing to do
2995                         } elseif ( !$this->mTrxAutomatic ) {
2996                                 throw new DBUnexpectedError(
2997                                         $this,
2998                                         "$fname: Flushing an explicit transaction, getting out of sync."
2999                                 );
3000                         }
3001                 } else {
3002                         if ( !$this->mTrxLevel ) {
3003                                 $this->queryLogger->error(
3004                                         "$fname: No transaction to commit, something got out of sync." );
3005                                 return; // nothing to do
3006                         } elseif ( $this->mTrxAutomatic ) {
3007                                 // @TODO: make this an exception at some point
3008                                 $msg = "$fname: Explicit commit of implicit transaction.";
3009                                 $this->queryLogger->error( $msg );
3010                                 return; // wait for the main transaction set commit round
3011                         }
3012                 }
3013
3014                 // Avoid fatals if close() was called
3015                 $this->assertOpen();
3016
3017                 $this->runOnTransactionPreCommitCallbacks();
3018                 $writeTime = $this->pendingWriteQueryDuration( self::ESTIMATE_DB_APPLY );
3019                 $this->doCommit( $fname );
3020                 if ( $this->mTrxDoneWrites ) {
3021                         $this->mLastWriteTime = microtime( true );
3022                         $this->trxProfiler->transactionWritingOut(
3023                                 $this->mServer,
3024                                 $this->mDBname,
3025                                 $this->mTrxShortId,
3026                                 $writeTime,
3027                                 $this->mTrxWriteAffectedRows
3028                         );
3029                 }
3030
3031                 $this->runOnTransactionIdleCallbacks( self::TRIGGER_COMMIT );
3032                 $this->runTransactionListenerCallbacks( self::TRIGGER_COMMIT );
3033         }
3034
3035         /**
3036          * Issues the COMMIT command to the database server.
3037          *
3038          * @see Database::commit()
3039          * @param string $fname
3040          */
3041         protected function doCommit( $fname ) {
3042                 if ( $this->mTrxLevel ) {
3043                         $this->query( 'COMMIT', $fname );
3044                         $this->mTrxLevel = 0;
3045                 }
3046         }
3047
3048         final public function rollback( $fname = __METHOD__, $flush = '' ) {
3049                 if ( $flush === self::FLUSHING_INTERNAL || $flush === self::FLUSHING_ALL_PEERS ) {
3050                         if ( !$this->mTrxLevel ) {
3051                                 return; // nothing to do
3052                         }
3053                 } else {
3054                         if ( !$this->mTrxLevel ) {
3055                                 $this->queryLogger->error(
3056                                         "$fname: No transaction to rollback, something got out of sync." );
3057                                 return; // nothing to do
3058                         } elseif ( $this->getFlag( self::DBO_TRX ) ) {
3059                                 throw new DBUnexpectedError(
3060                                         $this,
3061                                         "$fname: Expected mass rollback of all peer databases (DBO_TRX set)."
3062                                 );
3063                         }
3064                 }
3065
3066                 // Avoid fatals if close() was called
3067                 $this->assertOpen();
3068
3069                 $this->doRollback( $fname );
3070                 $this->mTrxAtomicLevels = [];
3071                 if ( $this->mTrxDoneWrites ) {
3072                         $this->trxProfiler->transactionWritingOut(
3073                                 $this->mServer,
3074                                 $this->mDBname,
3075                                 $this->mTrxShortId
3076                         );
3077                 }
3078
3079                 $this->mTrxIdleCallbacks = []; // clear
3080                 $this->mTrxPreCommitCallbacks = []; // clear
3081                 $this->runOnTransactionIdleCallbacks( self::TRIGGER_ROLLBACK );
3082                 $this->runTransactionListenerCallbacks( self::TRIGGER_ROLLBACK );
3083         }
3084
3085         /**
3086          * Issues the ROLLBACK command to the database server.
3087          *
3088          * @see Database::rollback()
3089          * @param string $fname
3090          */
3091         protected function doRollback( $fname ) {
3092                 if ( $this->mTrxLevel ) {
3093                         # Disconnects cause rollback anyway, so ignore those errors
3094                         $ignoreErrors = true;
3095                         $this->query( 'ROLLBACK', $fname, $ignoreErrors );
3096                         $this->mTrxLevel = 0;
3097                 }
3098         }
3099
3100         public function flushSnapshot( $fname = __METHOD__ ) {
3101                 if ( $this->writesOrCallbacksPending() || $this->explicitTrxActive() ) {
3102                         // This only flushes transactions to clear snapshots, not to write data
3103                         $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
3104                         throw new DBUnexpectedError(
3105                                 $this,
3106                                 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
3107                         );
3108                 }
3109
3110                 $this->commit( $fname, self::FLUSHING_INTERNAL );
3111         }
3112
3113         public function explicitTrxActive() {
3114                 return $this->mTrxLevel && ( $this->mTrxAtomicLevels || !$this->mTrxAutomatic );
3115         }
3116
3117         public function duplicateTableStructure(
3118                 $oldName, $newName, $temporary = false, $fname = __METHOD__
3119         ) {
3120                 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
3121         }
3122
3123         public function listTables( $prefix = null, $fname = __METHOD__ ) {
3124                 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
3125         }
3126
3127         public function listViews( $prefix = null, $fname = __METHOD__ ) {
3128                 throw new RuntimeException( __METHOD__ . ' is not implemented in descendant class' );
3129         }
3130
3131         public function timestamp( $ts = 0 ) {
3132                 $t = new ConvertibleTimestamp( $ts );
3133                 // Let errors bubble up to avoid putting garbage in the DB
3134                 return $t->getTimestamp( TS_MW );
3135         }
3136
3137         public function timestampOrNull( $ts = null ) {
3138                 if ( is_null( $ts ) ) {
3139                         return null;
3140                 } else {
3141                         return $this->timestamp( $ts );
3142                 }
3143         }
3144
3145         /**
3146          * Take the result from a query, and wrap it in a ResultWrapper if
3147          * necessary. Boolean values are passed through as is, to indicate success
3148          * of write queries or failure.
3149          *
3150          * Once upon a time, Database::query() returned a bare MySQL result
3151          * resource, and it was necessary to call this function to convert it to
3152          * a wrapper. Nowadays, raw database objects are never exposed to external
3153          * callers, so this is unnecessary in external code.
3154          *
3155          * @param bool|ResultWrapper|resource|object $result
3156          * @return bool|ResultWrapper
3157          */
3158         protected function resultObject( $result ) {
3159                 if ( !$result ) {
3160                         return false;
3161                 } elseif ( $result instanceof ResultWrapper ) {
3162                         return $result;
3163                 } elseif ( $result === true ) {
3164                         // Successful write query
3165                         return $result;
3166                 } else {
3167                         return new ResultWrapper( $this, $result );
3168                 }
3169         }
3170
3171         public function ping( &$rtt = null ) {
3172                 // Avoid hitting the server if it was hit recently
3173                 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing ) < self::PING_TTL ) {
3174                         if ( !func_num_args() || $this->mRTTEstimate > 0 ) {
3175                                 $rtt = $this->mRTTEstimate;
3176                                 return true; // don't care about $rtt
3177                         }
3178                 }
3179
3180                 // This will reconnect if possible or return false if not
3181                 $this->clearFlag( self::DBO_TRX, self::REMEMBER_PRIOR );
3182                 $ok = ( $this->query( self::PING_QUERY, __METHOD__, true ) !== false );
3183                 $this->restoreFlags( self::RESTORE_PRIOR );
3184
3185                 if ( $ok ) {
3186                         $rtt = $this->mRTTEstimate;
3187                 }
3188
3189                 return $ok;
3190         }
3191
3192         /**
3193          * Close existing database connection and open a new connection
3194          *
3195          * @return bool True if new connection is opened successfully, false if error
3196          */
3197         protected function reconnect() {
3198                 $this->closeConnection();
3199                 $this->mOpened = false;
3200                 $this->mConn = false;
3201                 try {
3202                         $this->open( $this->mServer, $this->mUser, $this->mPassword, $this->mDBname );
3203                         $this->lastPing = microtime( true );
3204                         $ok = true;
3205                 } catch ( DBConnectionError $e ) {
3206                         $ok = false;
3207                 }
3208
3209                 return $ok;
3210         }
3211
3212         public function getSessionLagStatus() {
3213                 return $this->getTransactionLagStatus() ?: $this->getApproximateLagStatus();
3214         }
3215
3216         /**
3217          * Get the replica DB lag when the current transaction started
3218          *
3219          * This is useful when transactions might use snapshot isolation
3220          * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
3221          * is this lag plus transaction duration. If they don't, it is still
3222          * safe to be pessimistic. This returns null if there is no transaction.
3223          *
3224          * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
3225          * @since 1.27
3226          */
3227         protected function getTransactionLagStatus() {
3228                 return $this->mTrxLevel
3229                         ? [ 'lag' => $this->mTrxReplicaLag, 'since' => $this->trxTimestamp() ]
3230                         : null;
3231         }
3232
3233         /**
3234          * Get a replica DB lag estimate for this server
3235          *
3236          * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
3237          * @since 1.27
3238          */
3239         protected function getApproximateLagStatus() {
3240                 return [
3241                         'lag'   => $this->getLBInfo( 'replica' ) ? $this->getLag() : 0,
3242                         'since' => microtime( true )
3243                 ];
3244         }
3245
3246         /**
3247          * Merge the result of getSessionLagStatus() for several DBs
3248          * using the most pessimistic values to estimate the lag of
3249          * any data derived from them in combination
3250          *
3251          * This is information is useful for caching modules
3252          *
3253          * @see WANObjectCache::set()
3254          * @see WANObjectCache::getWithSetCallback()
3255          *
3256          * @param IDatabase $db1
3257          * @param IDatabase $dbs,...
3258          * @return array Map of values:
3259          *   - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
3260          *   - since: oldest UNIX timestamp of any of the DB lag estimates
3261          *   - pending: whether any of the DBs have uncommitted changes
3262          * @since 1.27
3263          */
3264         public static function getCacheSetOptions( IDatabase $db1 ) {
3265                 $res = [ 'lag' => 0, 'since' => INF, 'pending' => false ];
3266                 foreach ( func_get_args() as $db ) {
3267                         /** @var IDatabase $db */
3268                         $status = $db->getSessionLagStatus();
3269                         if ( $status['lag'] === false ) {
3270                                 $res['lag'] = false;
3271                         } elseif ( $res['lag'] !== false ) {
3272                                 $res['lag'] = max( $res['lag'], $status['lag'] );
3273                         }
3274                         $res['since'] = min( $res['since'], $status['since'] );
3275                         $res['pending'] = $res['pending'] ?: $db->writesPending();
3276                 }
3277
3278                 return $res;
3279         }
3280
3281         public function getLag() {
3282                 return 0;
3283         }
3284
3285         public function maxListLen() {
3286                 return 0;
3287         }
3288
3289         public function encodeBlob( $b ) {
3290                 return $b;
3291         }
3292
3293         public function decodeBlob( $b ) {
3294                 if ( $b instanceof Blob ) {
3295                         $b = $b->fetch();
3296                 }
3297                 return $b;
3298         }
3299
3300         public function setSessionOptions( array $options ) {
3301         }
3302
3303         public function sourceFile(
3304                 $filename,
3305                 callable $lineCallback = null,
3306                 callable $resultCallback = null,
3307                 $fname = false,
3308                 callable $inputCallback = null
3309         ) {
3310                 MediaWiki\suppressWarnings();
3311                 $fp = fopen( $filename, 'r' );
3312                 MediaWiki\restoreWarnings();
3313
3314                 if ( false === $fp ) {
3315                         throw new RuntimeException( "Could not open \"{$filename}\".\n" );
3316                 }
3317
3318                 if ( !$fname ) {
3319                         $fname = __METHOD__ . "( $filename )";
3320                 }
3321
3322                 try {
3323                         $error = $this->sourceStream(
3324                                 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3325                 } catch ( Exception $e ) {
3326                         fclose( $fp );
3327                         throw $e;
3328                 }
3329
3330                 fclose( $fp );
3331
3332                 return $error;
3333         }
3334
3335         public function setSchemaVars( $vars ) {
3336                 $this->mSchemaVars = $vars;
3337         }
3338
3339         public function sourceStream(
3340                 $fp,
3341                 callable $lineCallback = null,
3342                 callable $resultCallback = null,
3343                 $fname = __METHOD__,
3344                 callable $inputCallback = null
3345         ) {
3346                 $cmd = '';
3347
3348                 while ( !feof( $fp ) ) {
3349                         if ( $lineCallback ) {
3350                                 call_user_func( $lineCallback );
3351                         }
3352
3353                         $line = trim( fgets( $fp ) );
3354
3355                         if ( $line == '' ) {
3356                                 continue;
3357                         }
3358
3359                         if ( '-' == $line[0] && '-' == $line[1] ) {
3360                                 continue;
3361                         }
3362
3363                         if ( $cmd != '' ) {
3364                                 $cmd .= ' ';
3365                         }
3366
3367                         $done = $this->streamStatementEnd( $cmd, $line );
3368
3369                         $cmd .= "$line\n";
3370
3371                         if ( $done || feof( $fp ) ) {
3372                                 $cmd = $this->replaceVars( $cmd );
3373
3374                                 if ( !$inputCallback || call_user_func( $inputCallback, $cmd ) ) {
3375                                         $res = $this->query( $cmd, $fname );
3376
3377                                         if ( $resultCallback ) {
3378                                                 call_user_func( $resultCallback, $res, $this );
3379                                         }
3380
3381                                         if ( false === $res ) {
3382                                                 $err = $this->lastError();
3383
3384                                                 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3385                                         }
3386                                 }
3387                                 $cmd = '';
3388                         }
3389                 }
3390
3391                 return true;
3392         }
3393
3394         /**
3395          * Called by sourceStream() to check if we've reached a statement end
3396          *
3397          * @param string &$sql SQL assembled so far
3398          * @param string &$newLine New line about to be added to $sql
3399          * @return bool Whether $newLine contains end of the statement
3400          */
3401         public function streamStatementEnd( &$sql, &$newLine ) {
3402                 if ( $this->delimiter ) {
3403                         $prev = $newLine;
3404                         $newLine = preg_replace(
3405                                 '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine );
3406                         if ( $newLine != $prev ) {
3407                                 return true;
3408                         }
3409                 }
3410
3411                 return false;
3412         }
3413
3414         /**
3415          * Database independent variable replacement. Replaces a set of variables
3416          * in an SQL statement with their contents as given by $this->getSchemaVars().
3417          *
3418          * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3419          *
3420          * - '{$var}' should be used for text and is passed through the database's
3421          *   addQuotes method.
3422          * - `{$var}` should be used for identifiers (e.g. table and database names).
3423          *   It is passed through the database's addIdentifierQuotes method which
3424          *   can be overridden if the database uses something other than backticks.
3425          * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
3426          *   database's tableName method.
3427          * - / *i* / passes the name that follows through the database's indexName method.
3428          * - In all other cases, / *$var* / is left unencoded. Except for table options,
3429          *   its use should be avoided. In 1.24 and older, string encoding was applied.
3430          *
3431          * @param string $ins SQL statement to replace variables in
3432          * @return string The new SQL statement with variables replaced
3433          */
3434         protected function replaceVars( $ins ) {
3435                 $vars = $this->getSchemaVars();
3436                 return preg_replace_callback(
3437                         '!
3438                                 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
3439                                 \'\{\$ (\w+) }\'                  | # 3. addQuotes
3440                                 `\{\$ (\w+) }`                    | # 4. addIdentifierQuotes
3441                                 /\*\$ (\w+) \*/                     # 5. leave unencoded
3442                         !x',
3443                         function ( $m ) use ( $vars ) {
3444                                 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
3445                                 // check for both nonexistent keys *and* the empty string.
3446                                 if ( isset( $m[1] ) && $m[1] !== '' ) {
3447                                         if ( $m[1] === 'i' ) {
3448                                                 return $this->indexName( $m[2] );
3449                                         } else {
3450                                                 return $this->tableName( $m[2] );
3451                                         }
3452                                 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
3453                                         return $this->addQuotes( $vars[$m[3]] );
3454                                 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
3455                                         return $this->addIdentifierQuotes( $vars[$m[4]] );
3456                                 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
3457                                         return $vars[$m[5]];
3458                                 } else {
3459                                         return $m[0];
3460                                 }
3461                         },
3462                         $ins
3463                 );
3464         }
3465
3466         /**
3467          * Get schema variables. If none have been set via setSchemaVars(), then
3468          * use some defaults from the current object.
3469          *
3470          * @return array
3471          */
3472         protected function getSchemaVars() {
3473                 if ( $this->mSchemaVars ) {
3474                         return $this->mSchemaVars;
3475                 } else {
3476                         return $this->getDefaultSchemaVars();
3477                 }
3478         }
3479
3480         /**
3481          * Get schema variables to use if none have been set via setSchemaVars().
3482          *
3483          * Override this in derived classes to provide variables for tables.sql
3484          * and SQL patch files.
3485          *
3486          * @return array
3487          */
3488         protected function getDefaultSchemaVars() {
3489                 return [];
3490         }
3491
3492         public function lockIsFree( $lockName, $method ) {
3493                 return true;
3494         }
3495
3496         public function lock( $lockName, $method, $timeout = 5 ) {
3497                 $this->mNamedLocksHeld[$lockName] = 1;
3498
3499                 return true;
3500         }
3501
3502         public function unlock( $lockName, $method ) {
3503                 unset( $this->mNamedLocksHeld[$lockName] );
3504
3505                 return true;
3506         }
3507
3508         public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
3509                 if ( $this->writesOrCallbacksPending() ) {
3510                         // This only flushes transactions to clear snapshots, not to write data
3511                         $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
3512                         throw new DBUnexpectedError(
3513                                 $this,
3514                                 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
3515                         );
3516                 }
3517
3518                 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
3519                         return null;
3520                 }
3521
3522                 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
3523                         if ( $this->trxLevel() ) {
3524                                 // There is a good chance an exception was thrown, causing any early return
3525                                 // from the caller. Let any error handler get a chance to issue rollback().
3526                                 // If there isn't one, let the error bubble up and trigger server-side rollback.
3527                                 $this->onTransactionResolution(
3528                                         function () use ( $lockKey, $fname ) {
3529                                                 $this->unlock( $lockKey, $fname );
3530                                         },
3531                                         $fname
3532                                 );
3533                         } else {
3534                                 $this->unlock( $lockKey, $fname );
3535                         }
3536                 } );
3537
3538                 $this->commit( $fname, self::FLUSHING_INTERNAL );
3539
3540                 return $unlocker;
3541         }
3542
3543         public function namedLocksEnqueue() {
3544                 return false;
3545         }
3546
3547         public function tableLocksHaveTransactionScope() {
3548                 return true;
3549         }
3550
3551         final public function lockTables( array $read, array $write, $method ) {
3552                 if ( $this->writesOrCallbacksPending() ) {
3553                         throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
3554                 }
3555
3556                 if ( $this->tableLocksHaveTransactionScope() ) {
3557                         $this->startAtomic( $method );
3558                 }
3559
3560                 return $this->doLockTables( $read, $write, $method );
3561         }
3562
3563         /**
3564          * Helper function for lockTables() that handles the actual table locking
3565          *
3566          * @param array $read Array of tables to lock for read access
3567          * @param array $write Array of tables to lock for write access
3568          * @param string $method Name of caller
3569          * @return true
3570          */
3571         protected function doLockTables( array $read, array $write, $method ) {
3572                 return true;
3573         }
3574
3575         final public function unlockTables( $method ) {
3576                 if ( $this->tableLocksHaveTransactionScope() ) {
3577                         $this->endAtomic( $method );
3578
3579                         return true; // locks released on COMMIT/ROLLBACK
3580                 }
3581
3582                 return $this->doUnlockTables( $method );
3583         }
3584
3585         /**
3586          * Helper function for unlockTables() that handles the actual table unlocking
3587          *
3588          * @param string $method Name of caller
3589          * @return true
3590          */
3591         protected function doUnlockTables( $method ) {
3592                 return true;
3593         }
3594
3595         /**
3596          * Delete a table
3597          * @param string $tableName
3598          * @param string $fName
3599          * @return bool|ResultWrapper
3600          * @since 1.18
3601          */
3602         public function dropTable( $tableName, $fName = __METHOD__ ) {
3603                 if ( !$this->tableExists( $tableName, $fName ) ) {
3604                         return false;
3605                 }
3606                 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
3607
3608                 return $this->query( $sql, $fName );
3609         }
3610
3611         public function getInfinity() {
3612                 return 'infinity';
3613         }
3614
3615         public function encodeExpiry( $expiry ) {
3616                 return ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() )
3617                         ? $this->getInfinity()
3618                         : $this->timestamp( $expiry );
3619         }
3620
3621         public function decodeExpiry( $expiry, $format = TS_MW ) {
3622                 if ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() ) {
3623                         return 'infinity';
3624                 }
3625
3626                 return ConvertibleTimestamp::convert( $format, $expiry );
3627         }
3628
3629         public function setBigSelects( $value = true ) {
3630                 // no-op
3631         }
3632
3633         public function isReadOnly() {
3634                 return ( $this->getReadOnlyReason() !== false );
3635         }
3636
3637         /**
3638          * @return string|bool Reason this DB is read-only or false if it is not
3639          */
3640         protected function getReadOnlyReason() {
3641                 $reason = $this->getLBInfo( 'readOnlyReason' );
3642
3643                 return is_string( $reason ) ? $reason : false;
3644         }
3645
3646         public function setTableAliases( array $aliases ) {
3647                 $this->tableAliases = $aliases;
3648         }
3649
3650         /**
3651          * @return bool Whether a DB user is required to access the DB
3652          * @since 1.28
3653          */
3654         protected function requiresDatabaseUser() {
3655                 return true;
3656         }
3657
3658         /**
3659          * Get the underlying binding handle, mConn
3660          *
3661          * Makes sure that mConn is set (disconnects and ping() failure can unset it).
3662          * This catches broken callers than catch and ignore disconnection exceptions.
3663          * Unlike checking isOpen(), this is safe to call inside of open().
3664          *
3665          * @return resource|object
3666          * @throws DBUnexpectedError
3667          * @since 1.26
3668          */
3669         protected function getBindingHandle() {
3670                 if ( !$this->mConn ) {
3671                         throw new DBUnexpectedError(
3672                                 $this,
3673                                 'DB connection was already closed or the connection dropped.'
3674                         );
3675                 }
3676
3677                 return $this->mConn;
3678         }
3679
3680         /**
3681          * @since 1.19
3682          * @return string
3683          */
3684         public function __toString() {
3685                 return (string)$this->mConn;
3686         }
3687
3688         /**
3689          * Make sure that copies do not share the same client binding handle
3690          * @throws DBConnectionError
3691          */
3692         public function __clone() {
3693                 $this->connLogger->warning(
3694                         "Cloning " . static::class . " is not recomended; forking connection:\n" .
3695                         ( new RuntimeException() )->getTraceAsString()
3696                 );
3697
3698                 if ( $this->isOpen() ) {
3699                         // Open a new connection resource without messing with the old one
3700                         $this->mOpened = false;
3701                         $this->mConn = false;
3702                         $this->mTrxEndCallbacks = []; // don't copy
3703                         $this->handleSessionLoss(); // no trx or locks anymore
3704                         $this->open( $this->mServer, $this->mUser, $this->mPassword, $this->mDBname );
3705                         $this->lastPing = microtime( true );
3706                 }
3707         }
3708
3709         /**
3710          * Called by serialize. Throw an exception when DB connection is serialized.
3711          * This causes problems on some database engines because the connection is
3712          * not restored on unserialize.
3713          */
3714         public function __sleep() {
3715                 throw new RuntimeException( 'Database serialization may cause problems, since ' .
3716                         'the connection is not restored on wakeup.' );
3717         }
3718
3719         /**
3720          * Run a few simple sanity checks and close dangling connections
3721          */
3722         public function __destruct() {
3723                 if ( $this->mTrxLevel && $this->mTrxDoneWrites ) {
3724                         trigger_error( "Uncommitted DB writes (transaction from {$this->mTrxFname})." );
3725                 }
3726
3727                 $danglingWriters = $this->pendingWriteAndCallbackCallers();
3728                 if ( $danglingWriters ) {
3729                         $fnames = implode( ', ', $danglingWriters );
3730                         trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
3731                 }
3732
3733                 if ( $this->mConn ) {
3734                         // Avoid connection leaks for sanity. Normally, resources close at script completion.
3735                         // The connection might already be closed in zend/hhvm by now, so suppress warnings.
3736                         \MediaWiki\suppressWarnings();
3737                         $this->closeConnection();
3738                         \MediaWiki\restoreWarnings();
3739                         $this->mConn = false;
3740                         $this->mOpened = false;
3741                 }
3742         }
3743 }
3744
3745 class_alias( Database::class, 'DatabaseBase' ); // b/c for old name
3746 class_alias( Database::class, 'Database' ); // b/c global alias