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