includes/libs/rdbms/database/DatabaseMysqlBase.php

   1 <?php
   2 /**
   3  * This is the MySQL database abstraction layer.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Database
  22  */
  23 namespace Wikimedia\Rdbms;
  24
  25 use DateTime;
  26 use DateTimeZone;
  27 use Wikimedia;
  28 use InvalidArgumentException;
  29 use Exception;
  30 use RuntimeException;
  31 use stdClass;
  32
  33 /**
  34  * Database abstraction object for MySQL.
  35  * Defines methods independent on used MySQL extension.
  36  *
  37  * @ingroup Database
  38  * @since 1.22
  39  * @see Database
  40  */
  41 abstract class DatabaseMysqlBase extends Database {
  42         /** @var MysqlMasterPos */
  43         protected $lastKnownReplicaPos;
  44         /** @var string Method to detect replica DB lag */
  45         protected $lagDetectionMethod;
  46         /** @var array Method to detect replica DB lag */
  47         protected $lagDetectionOptions = [];
  48         /** @var bool bool Whether to use GTID methods */
  49         protected $useGTIDs = false;
  50         /** @var string|null */
  51         protected $sslKeyPath;
  52         /** @var string|null */
  53         protected $sslCertPath;
  54         /** @var string|null */
  55         protected $sslCAFile;
  56         /** @var string|null */
  57         protected $sslCAPath;
  58         /** @var string[]|null */
  59         protected $sslCiphers;
  60         /** @var string sql_mode value to send on connection */
  61         protected $sqlMode;
  62         /** @var bool Use experimental UTF-8 transmission encoding */
  63         protected $utf8Mode;
  64         /** @var bool|null */
  65         protected $defaultBigSelects = null;
  66
  67         /** @var string|null */
  68         private $serverVersion = null;
  69         /** @var bool|null */
  70         private $insertSelectIsSafe = null;
  71         /** @var stdClass|null */
  72         private $replicationInfoRow = null;
  73
  74         // Cache getServerId() for 24 hours
  75         const SERVER_ID_CACHE_TTL = 86400;
  76
  77         /** @var float Warn if lag estimates are made for transactions older than this many seconds */
  78         const LAG_STALE_WARN_THRESHOLD = 0.100;
  79
  80         /**
  81          * Additional $params include:
  82          *   - lagDetectionMethod : set to one of (Seconds_Behind_Master,pt-heartbeat).
  83          *       pt-heartbeat assumes the table is at heartbeat.heartbeat
  84          *       and uses UTC timestamps in the heartbeat.ts column.
  85          *       (https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html)
  86          *   - lagDetectionOptions : if using pt-heartbeat, this can be set to an array map to change
  87          *       the default behavior. Normally, the heartbeat row with the server
  88          *       ID of this server's master will be used. Set the "conds" field to
  89          *       override the query conditions, e.g. ['shard' => 's1'].
  90          *   - useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible.
  91          *   - insertSelectIsSafe : force that native INSERT SELECT is or is not safe [default: null]
  92          *   - sslKeyPath : path to key file [default: null]
  93          *   - sslCertPath : path to certificate file [default: null]
  94          *   - sslCAFile: path to a single certificate authority PEM file [default: null]
  95          *   - sslCAPath : parth to certificate authority PEM directory [default: null]
  96          *   - sslCiphers : array list of allowable ciphers [default: null]
  97          * @param array $params
  98          */
  99         function __construct( array $params ) {
 100                 $this->lagDetectionMethod = $params['lagDetectionMethod'] ?? 'Seconds_Behind_Master';
 101                 $this->lagDetectionOptions = $params['lagDetectionOptions'] ?? [];
 102                 $this->useGTIDs = !empty( $params['useGTIDs' ] );
 103                 foreach ( [ 'KeyPath', 'CertPath', 'CAFile', 'CAPath', 'Ciphers' ] as $name ) {
 104                         $var = "ssl{$name}";
 105                         if ( isset( $params[$var] ) ) {
 106                                 $this->$var = $params[$var];
 107                         }
 108                 }
 109                 $this->sqlMode = $params['sqlMode'] ?? null;
 110                 $this->utf8Mode = !empty( $params['utf8Mode'] );
 111                 $this->insertSelectIsSafe = isset( $params['insertSelectIsSafe'] )
 112                         ? (bool)$params['insertSelectIsSafe'] : null;
 113
 114                 parent::__construct( $params );
 115         }
 116
 117         /**
 118          * @return string
 119          */
 120         public function getType() {
 121                 return 'mysql';
 122         }
 123
 124         protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix ) {
 125                 $this->close();
 126
 127                 if ( $schema !== null ) {
 128                         throw new DBExpectedError( $this, __CLASS__ . ": domain schemas are not supported." );
 129                 }
 130
 131                 $this->server = $server;
 132                 $this->user = $user;
 133                 $this->password = $password;
 134
 135                 $this->installErrorHandler();
 136                 try {
 137                         $this->conn = $this->mysqlConnect( $this->server, $dbName );
 138                 } catch ( Exception $ex ) {
 139                         $this->restoreErrorHandler();
 140                         throw $ex;
 141                 }
 142                 $error = $this->restoreErrorHandler();
 143
 144                 # Always log connection errors
 145                 if ( !$this->conn ) {
 146                         $error = $error ?: $this->lastError();
 147                         $this->connLogger->error(
 148                                 "Error connecting to {db_server}: {error}",
 149                                 $this->getLogContext( [ 'method' => __METHOD__, 'error' => $error ] )
 150                         );
 151                         $this->connLogger->debug( "DB connection error\n" .
 152                                 "Server: $server, User: $user, Password: " .
 153                                 substr( $password, 0, 3 ) . "..., error: " . $error . "\n" );
 154                         throw new DBConnectionError( $this, $error );
 155                 }
 156
 157                 try {
 158                         $this->currentDomain = new DatabaseDomain(
 159                                 strlen( $dbName ) ? $dbName : null,
 160                                 null,
 161                                 $tablePrefix
 162                         );
 163
 164                         // Abstract over any insane MySQL defaults
 165                         $set = [ 'group_concat_max_len = 262144' ];
 166                         // Set SQL mode, default is turning them all off, can be overridden or skipped with null
 167                         if ( is_string( $this->sqlMode ) ) {
 168                                 $set[] = 'sql_mode = ' . $this->addQuotes( $this->sqlMode );
 169                         }
 170                         // Set any custom settings defined by site config
 171                         // (e.g. https://dev.mysql.com/doc/refman/4.1/en/innodb-parameters.html)
 172                         foreach ( $this->connectionVariables as $var => $val ) {
 173                                 // Escape strings but not numbers to avoid MySQL complaining
 174                                 if ( !is_int( $val ) && !is_float( $val ) ) {
 175                                         $val = $this->addQuotes( $val );
 176                                 }
 177                                 $set[] = $this->addIdentifierQuotes( $var ) . ' = ' . $val;
 178                         }
 179
 180                         if ( $set ) {
 181                                 $this->query(
 182                                         'SET ' . implode( ', ', $set ),
 183                                         __METHOD__,
 184                                         self::QUERY_IGNORE_DBO_TRX | self::QUERY_NO_RETRY
 185                                 );
 186                         }
 187                 } catch ( Exception $e ) {
 188                         // Connection was not fully initialized and is not safe for use
 189                         $this->conn = false;
 190                 }
 191
 192                 return true;
 193         }
 194
 195         protected function doSelectDomain( DatabaseDomain $domain ) {
 196                 if ( $domain->getSchema() !== null ) {
 197                         throw new DBExpectedError( $this, __CLASS__ . ": domain schemas are not supported." );
 198                 }
 199
 200                 $database = $domain->getDatabase();
 201                 // A null database means "don't care" so leave it as is and update the table prefix
 202                 if ( $database === null ) {
 203                         $this->currentDomain = new DatabaseDomain(
 204                                 $this->currentDomain->getDatabase(),
 205                                 null,
 206                                 $domain->getTablePrefix()
 207                         );
 208
 209                         return true;
 210                 }
 211
 212                 if ( $database !== $this->getDBname() ) {
 213                         $sql = 'USE ' . $this->addIdentifierQuotes( $database );
 214                         list( $res, $err, $errno ) =
 215                                 $this->executeQuery( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
 216
 217                         if ( $res === false ) {
 218                                 $this->reportQueryError( $err, $errno, $sql, __METHOD__ );
 219                                 return false; // unreachable
 220                         }
 221                 }
 222
 223                 // Update that domain fields on success (no exception thrown)
 224                 $this->currentDomain = $domain;
 225
 226                 return true;
 227         }
 228
 229         /**
 230          * Open a connection to a MySQL server
 231          *
 232          * @param string $realServer
 233          * @param string|null $dbName
 234          * @return mixed Raw connection
 235          * @throws DBConnectionError
 236          */
 237         abstract protected function mysqlConnect( $realServer, $dbName );
 238
 239         /**
 240          * @param IResultWrapper|resource $res
 241          * @throws DBUnexpectedError
 242          */
 243         public function freeResult( $res ) {
 244                 if ( $res instanceof ResultWrapper ) {
 245                         $res = $res->result;
 246                 }
 247                 Wikimedia\suppressWarnings();
 248                 $ok = $this->mysqlFreeResult( $res );
 249                 Wikimedia\restoreWarnings();
 250                 if ( !$ok ) {
 251                         throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
 252                 }
 253         }
 254
 255         /**
 256          * Free result memory
 257          *
 258          * @param resource $res Raw result
 259          * @return bool
 260          */
 261         abstract protected function mysqlFreeResult( $res );
 262
 263         /**
 264          * @param IResultWrapper|resource $res
 265          * @return stdClass|bool
 266          * @throws DBUnexpectedError
 267          */
 268         public function fetchObject( $res ) {
 269                 if ( $res instanceof ResultWrapper ) {
 270                         $res = $res->result;
 271                 }
 272                 Wikimedia\suppressWarnings();
 273                 $row = $this->mysqlFetchObject( $res );
 274                 Wikimedia\restoreWarnings();
 275
 276                 $errno = $this->lastErrno();
 277                 // Unfortunately, mysql_fetch_object does not reset the last errno.
 278                 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
 279                 // these are the only errors mysql_fetch_object can cause.
 280                 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
 281                 if ( $errno == 2000 || $errno == 2013 ) {
 282                         throw new DBUnexpectedError(
 283                                 $this,
 284                                 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() )
 285                         );
 286                 }
 287
 288                 return $row;
 289         }
 290
 291         /**
 292          * Fetch a result row as an object
 293          *
 294          * @param resource $res Raw result
 295          * @return stdClass
 296          */
 297         abstract protected function mysqlFetchObject( $res );
 298
 299         /**
 300          * @param IResultWrapper|resource $res
 301          * @return array|bool
 302          * @throws DBUnexpectedError
 303          */
 304         public function fetchRow( $res ) {
 305                 if ( $res instanceof ResultWrapper ) {
 306                         $res = $res->result;
 307                 }
 308                 Wikimedia\suppressWarnings();
 309                 $row = $this->mysqlFetchArray( $res );
 310                 Wikimedia\restoreWarnings();
 311
 312                 $errno = $this->lastErrno();
 313                 // Unfortunately, mysql_fetch_array does not reset the last errno.
 314                 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
 315                 // these are the only errors mysql_fetch_array can cause.
 316                 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
 317                 if ( $errno == 2000 || $errno == 2013 ) {
 318                         throw new DBUnexpectedError(
 319                                 $this,
 320                                 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() )
 321                         );
 322                 }
 323
 324                 return $row;
 325         }
 326
 327         /**
 328          * Fetch a result row as an associative and numeric array
 329          *
 330          * @param resource $res Raw result
 331          * @return array|false
 332          */
 333         abstract protected function mysqlFetchArray( $res );
 334
 335         /**
 336          * @throws DBUnexpectedError
 337          * @param IResultWrapper|resource $res
 338          * @return int
 339          */
 340         function numRows( $res ) {
 341                 if ( $res instanceof ResultWrapper ) {
 342                         $res = $res->result;
 343                 }
 344                 Wikimedia\suppressWarnings();
 345                 $n = !is_bool( $res ) ? $this->mysqlNumRows( $res ) : 0;
 346                 Wikimedia\restoreWarnings();
 347
 348                 // Unfortunately, mysql_num_rows does not reset the last errno.
 349                 // We are not checking for any errors here, since
 350                 // there are no errors mysql_num_rows can cause.
 351                 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
 352                 // See https://phabricator.wikimedia.org/T44430
 353                 return $n;
 354         }
 355
 356         /**
 357          * Get number of rows in result
 358          *
 359          * @param resource $res Raw result
 360          * @return int
 361          */
 362         abstract protected function mysqlNumRows( $res );
 363
 364         /**
 365          * @param IResultWrapper|resource $res
 366          * @return int
 367          */
 368         public function numFields( $res ) {
 369                 if ( $res instanceof ResultWrapper ) {
 370                         $res = $res->result;
 371                 }
 372
 373                 return $this->mysqlNumFields( $res );
 374         }
 375
 376         /**
 377          * Get number of fields in result
 378          *
 379          * @param resource $res Raw result
 380          * @return int
 381          */
 382         abstract protected function mysqlNumFields( $res );
 383
 384         /**
 385          * @param IResultWrapper|resource $res
 386          * @param int $n
 387          * @return string
 388          */
 389         public function fieldName( $res, $n ) {
 390                 if ( $res instanceof ResultWrapper ) {
 391                         $res = $res->result;
 392                 }
 393
 394                 return $this->mysqlFieldName( $res, $n );
 395         }
 396
 397         /**
 398          * Get the name of the specified field in a result
 399          *
 400          * @param IResultWrapper|resource $res
 401          * @param int $n
 402          * @return string
 403          */
 404         abstract protected function mysqlFieldName( $res, $n );
 405
 406         /**
 407          * mysql_field_type() wrapper
 408          * @param IResultWrapper|resource $res
 409          * @param int $n
 410          * @return string
 411          */
 412         public function fieldType( $res, $n ) {
 413                 if ( $res instanceof ResultWrapper ) {
 414                         $res = $res->result;
 415                 }
 416
 417                 return $this->mysqlFieldType( $res, $n );
 418         }
 419
 420         /**
 421          * Get the type of the specified field in a result
 422          *
 423          * @param IResultWrapper|resource $res
 424          * @param int $n
 425          * @return string
 426          */
 427         abstract protected function mysqlFieldType( $res, $n );
 428
 429         /**
 430          * @param IResultWrapper|resource $res
 431          * @param int $row
 432          * @return bool
 433          */
 434         public function dataSeek( $res, $row ) {
 435                 if ( $res instanceof ResultWrapper ) {
 436                         $res = $res->result;
 437                 }
 438
 439                 return $this->mysqlDataSeek( $res, $row );
 440         }
 441
 442         /**
 443          * Move internal result pointer
 444          *
 445          * @param IResultWrapper|resource $res
 446          * @param int $row
 447          * @return bool
 448          */
 449         abstract protected function mysqlDataSeek( $res, $row );
 450
 451         /**
 452          * @return string
 453          */
 454         public function lastError() {
 455                 if ( $this->conn ) {
 456                         # Even if it's non-zero, it can still be invalid
 457                         Wikimedia\suppressWarnings();
 458                         $error = $this->mysqlError( $this->conn );
 459                         if ( !$error ) {
 460                                 $error = $this->mysqlError();
 461                         }
 462                         Wikimedia\restoreWarnings();
 463                 } else {
 464                         $error = $this->mysqlError();
 465                 }
 466                 if ( $error ) {
 467                         $error .= ' (' . $this->server . ')';
 468                 }
 469
 470                 return $error;
 471         }
 472
 473         /**
 474          * Returns the text of the error message from previous MySQL operation
 475          *
 476          * @param resource|null $conn Raw connection
 477          * @return string
 478          */
 479         abstract protected function mysqlError( $conn = null );
 480
 481         protected function wasQueryTimeout( $error, $errno ) {
 482                 // https://dev.mysql.com/doc/refman/8.0/en/client-error-reference.html
 483                 // https://phabricator.wikimedia.org/T170638
 484                 return in_array( $errno, [ 2062, 3024 ] );
 485         }
 486
 487         public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
 488                 $this->nativeReplace( $table, $rows, $fname );
 489         }
 490
 491         protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
 492                 $row = $this->getReplicationSafetyInfo();
 493                 // For row-based-replication, the resulting changes will be relayed, not the query
 494                 if ( $row->binlog_format === 'ROW' ) {
 495                         return true;
 496                 }
 497                 // LIMIT requires ORDER BY on a unique key or it is non-deterministic
 498                 if ( isset( $selectOptions['LIMIT'] ) ) {
 499                         return false;
 500                 }
 501                 // In MySQL, an INSERT SELECT is only replication safe with row-based
 502                 // replication or if innodb_autoinc_lock_mode is 0. When those
 503                 // conditions aren't met, use non-native mode.
 504                 // While we could try to determine if the insert is safe anyway by
 505                 // checking if the target table has an auto-increment column that
 506                 // isn't set in $varMap, that seems unlikely to be worth the extra
 507                 // complexity.
 508                 return (
 509                         in_array( 'NO_AUTO_COLUMNS', $insertOptions ) ||
 510                         (int)$row->innodb_autoinc_lock_mode === 0
 511                 );
 512         }
 513
 514         /**
 515          * @return stdClass Process cached row
 516          */
 517         protected function getReplicationSafetyInfo() {
 518                 if ( $this->replicationInfoRow === null ) {
 519                         $this->replicationInfoRow = $this->selectRow(
 520                                 false,
 521                                 [
 522                                         'innodb_autoinc_lock_mode' => '@@innodb_autoinc_lock_mode',
 523                                         'binlog_format' => '@@binlog_format',
 524                                 ],
 525                                 [],
 526                                 __METHOD__
 527                         );
 528                 }
 529
 530                 return $this->replicationInfoRow;
 531         }
 532
 533         /**
 534          * Estimate rows in dataset
 535          * Returns estimated count, based on EXPLAIN output
 536          * Takes same arguments as Database::select()
 537          *
 538          * @param string|array $table
 539          * @param string|array $var
 540          * @param string|array $conds
 541          * @param string $fname
 542          * @param string|array $options
 543          * @param array $join_conds
 544          * @return bool|int
 545          */
 546         public function estimateRowCount( $table, $var = '*', $conds = '',
 547                 $fname = __METHOD__, $options = [], $join_conds = []
 548         ) {
 549                 $conds = $this->normalizeConditions( $conds, $fname );
 550                 $column = $this->extractSingleFieldFromList( $var );
 551                 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
 552                         $conds[] = "$column IS NOT NULL";
 553                 }
 554
 555                 $options['EXPLAIN'] = true;
 556                 $res = $this->select( $table, $var, $conds, $fname, $options, $join_conds );
 557                 if ( $res === false ) {
 558                         return false;
 559                 }
 560                 if ( !$this->numRows( $res ) ) {
 561                         return 0;
 562                 }
 563
 564                 $rows = 1;
 565                 foreach ( $res as $plan ) {
 566                         $rows *= $plan->rows > 0 ? $plan->rows : 1; // avoid resetting to zero
 567                 }
 568
 569                 return (int)$rows;
 570         }
 571
 572         public function tableExists( $table, $fname = __METHOD__ ) {
 573                 // Split database and table into proper variables as Database::tableName() returns
 574                 // shared tables prefixed with their database, which do not work in SHOW TABLES statements
 575                 list( $database, , $prefix, $table ) = $this->qualifiedTableComponents( $table );
 576                 $tableName = "{$prefix}{$table}";
 577
 578                 if ( isset( $this->sessionTempTables[$tableName] ) ) {
 579                         return true; // already known to exist and won't show in SHOW TABLES anyway
 580                 }
 581
 582                 // We can't use buildLike() here, because it specifies an escape character
 583                 // other than the backslash, which is the only one supported by SHOW TABLES
 584                 $encLike = $this->escapeLikeInternal( $tableName, '\\' );
 585
 586                 // If the database has been specified (such as for shared tables), use "FROM"
 587                 if ( $database !== '' ) {
 588                         $encDatabase = $this->addIdentifierQuotes( $database );
 589                         $query = "SHOW TABLES FROM $encDatabase LIKE '$encLike'";
 590                 } else {
 591                         $query = "SHOW TABLES LIKE '$encLike'";
 592                 }
 593
 594                 return $this->query( $query, $fname )->numRows() > 0;
 595         }
 596
 597         /**
 598          * @param string $table
 599          * @param string $field
 600          * @return bool|MySQLField
 601          */
 602         public function fieldInfo( $table, $field ) {
 603                 $table = $this->tableName( $table );
 604                 $flags = self::QUERY_SILENCE_ERRORS;
 605                 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__, $flags );
 606                 if ( !$res ) {
 607                         return false;
 608                 }
 609                 $n = $this->mysqlNumFields( $res->result );
 610                 for ( $i = 0; $i < $n; $i++ ) {
 611                         $meta = $this->mysqlFetchField( $res->result, $i );
 612                         if ( $field == $meta->name ) {
 613                                 return new MySQLField( $meta );
 614                         }
 615                 }
 616
 617                 return false;
 618         }
 619
 620         /**
 621          * Get column information from a result
 622          *
 623          * @param resource $res Raw result
 624          * @param int $n
 625          * @return stdClass
 626          */
 627         abstract protected function mysqlFetchField( $res, $n );
 628
 629         /**
 630          * Get information about an index into an object
 631          * Returns false if the index does not exist
 632          *
 633          * @param string $table
 634          * @param string $index
 635          * @param string $fname
 636          * @return bool|array|null False or null on failure
 637          */
 638         public function indexInfo( $table, $index, $fname = __METHOD__ ) {
 639                 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
 640                 # SHOW INDEX should work for 3.x and up:
 641                 # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
 642                 $table = $this->tableName( $table );
 643                 $index = $this->indexName( $index );
 644
 645                 $sql = 'SHOW INDEX FROM ' . $table;
 646                 $res = $this->query( $sql, $fname );
 647
 648                 if ( !$res ) {
 649                         return null;
 650                 }
 651
 652                 $result = [];
 653
 654                 foreach ( $res as $row ) {
 655                         if ( $row->Key_name == $index ) {
 656                                 $result[] = $row;
 657                         }
 658                 }
 659
 660                 return $result ?: false;
 661         }
 662
 663         /**
 664          * @param string $s
 665          * @return string
 666          */
 667         public function strencode( $s ) {
 668                 return $this->mysqlRealEscapeString( $s );
 669         }
 670
 671         /**
 672          * @param string $s
 673          * @return mixed
 674          */
 675         abstract protected function mysqlRealEscapeString( $s );
 676
 677         public function addQuotes( $s ) {
 678                 if ( is_bool( $s ) ) {
 679                         // Parent would transform to int, which does not play nice with MySQL type juggling.
 680                         // When searching for an int in a string column, the strings are cast to int, which
 681                         // means false would match any string not starting with a number.
 682                         $s = (string)(int)$s;
 683                 }
 684                 return parent::addQuotes( $s );
 685         }
 686
 687         /**
 688          * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
 689          *
 690          * @param string $s
 691          * @return string
 692          */
 693         public function addIdentifierQuotes( $s ) {
 694                 // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
 695                 // Remove NUL bytes and escape backticks by doubling
 696                 return '`' . str_replace( [ "\0", '`' ], [ '', '``' ], $s ) . '`';
 697         }
 698
 699         /**
 700          * @param string $name
 701          * @return bool
 702          */
 703         public function isQuotedIdentifier( $name ) {
 704                 return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
 705         }
 706
 707         protected function doGetLag() {
 708                 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
 709                         return $this->getLagFromPtHeartbeat();
 710                 } else {
 711                         return $this->getLagFromSlaveStatus();
 712                 }
 713         }
 714
 715         /**
 716          * @return string
 717          */
 718         protected function getLagDetectionMethod() {
 719                 return $this->lagDetectionMethod;
 720         }
 721
 722         /**
 723          * @return bool|int
 724          */
 725         protected function getLagFromSlaveStatus() {
 726                 $flags = self::QUERY_SILENCE_ERRORS | self::QUERY_IGNORE_DBO_TRX;
 727                 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__, $flags );
 728                 $row = $res ? $res->fetchObject() : false;
 729                 // If the server is not replicating, there will be no row
 730                 if ( $row && strval( $row->Seconds_Behind_Master ) !== '' ) {
 731                         return intval( $row->Seconds_Behind_Master );
 732                 }
 733
 734                 return false;
 735         }
 736
 737         /**
 738          * @return bool|float
 739          */
 740         protected function getLagFromPtHeartbeat() {
 741                 $options = $this->lagDetectionOptions;
 742
 743                 $currentTrxInfo = $this->getRecordedTransactionLagStatus();
 744                 if ( $currentTrxInfo ) {
 745                         // There is an active transaction and the initial lag was already queried
 746                         $staleness = microtime( true ) - $currentTrxInfo['since'];
 747                         if ( $staleness > self::LAG_STALE_WARN_THRESHOLD ) {
 748                                 // Avoid returning higher and higher lag value due to snapshot age
 749                                 // given that the isolation level will typically be REPEATABLE-READ
 750                                 $this->queryLogger->warning(
 751                                         "Using cached lag value for {db_server} due to active transaction",
 752                                         $this->getLogContext( [
 753                                                 'method' => __METHOD__,
 754                                                 'age' => $staleness,
 755                                                 'trace' => ( new RuntimeException() )->getTraceAsString()
 756                                         ] )
 757                                 );
 758                         }
 759
 760                         return $currentTrxInfo['lag'];
 761                 }
 762
 763                 if ( isset( $options['conds'] ) ) {
 764                         // Best method for multi-DC setups: use logical channel names
 765                         $data = $this->getHeartbeatData( $options['conds'] );
 766                 } else {
 767                         // Standard method: use master server ID (works with stock pt-heartbeat)
 768                         $masterInfo = $this->getMasterServerInfo();
 769                         if ( !$masterInfo ) {
 770                                 $this->queryLogger->error(
 771                                         "Unable to query master of {db_server} for server ID",
 772                                         $this->getLogContext( [
 773                                                 'method' => __METHOD__
 774                                         ] )
 775                                 );
 776
 777                                 return false; // could not get master server ID
 778                         }
 779
 780                         $conds = [ 'server_id' => intval( $masterInfo['serverId'] ) ];
 781                         $data = $this->getHeartbeatData( $conds );
 782                 }
 783
 784                 list( $time, $nowUnix ) = $data;
 785                 if ( $time !== null ) {
 786                         // @time is in ISO format like "2015-09-25T16:48:10.000510"
 787                         $dateTime = new DateTime( $time, new DateTimeZone( 'UTC' ) );
 788                         $timeUnix = (int)$dateTime->format( 'U' ) + $dateTime->format( 'u' ) / 1e6;
 789
 790                         return max( $nowUnix - $timeUnix, 0.0 );
 791                 }
 792
 793                 $this->queryLogger->error(
 794                         "Unable to find pt-heartbeat row for {db_server}",
 795                         $this->getLogContext( [
 796                                 'method' => __METHOD__
 797                         ] )
 798                 );
 799
 800                 return false;
 801         }
 802
 803         protected function getMasterServerInfo() {
 804                 $cache = $this->srvCache;
 805                 $key = $cache->makeGlobalKey(
 806                         'mysql',
 807                         'master-info',
 808                         // Using one key for all cluster replica DBs is preferable
 809                         $this->getLBInfo( 'clusterMasterHost' ) ?: $this->getServer()
 810                 );
 811                 $fname = __METHOD__;
 812
 813                 return $cache->getWithSetCallback(
 814                         $key,
 815                         $cache::TTL_INDEFINITE,
 816                         function () use ( $cache, $key, $fname ) {
 817                                 // Get and leave a lock key in place for a short period
 818                                 if ( !$cache->lock( $key, 0, 10 ) ) {
 819                                         return false; // avoid master connection spike slams
 820                                 }
 821
 822                                 $conn = $this->getLazyMasterHandle();
 823                                 if ( !$conn ) {
 824                                         return false; // something is misconfigured
 825                                 }
 826
 827                                 // Connect to and query the master; catch errors to avoid outages
 828                                 try {
 829                                         $flags = self::QUERY_SILENCE_ERRORS | self::QUERY_IGNORE_DBO_TRX;
 830                                         $res = $conn->query( 'SELECT @@server_id AS id', $fname, $flags );
 831                                         $row = $res ? $res->fetchObject() : false;
 832                                         $id = $row ? (int)$row->id : 0;
 833                                 } catch ( DBError $e ) {
 834                                         $id = 0;
 835                                 }
 836
 837                                 // Cache the ID if it was retrieved
 838                                 return $id ? [ 'serverId' => $id, 'asOf' => time() ] : false;
 839                         }
 840                 );
 841         }
 842
 843         /**
 844          * @param array $conds WHERE clause conditions to find a row
 845          * @return array (heartbeat `ts` column value or null, UNIX timestamp) for the newest beat
 846          * @see https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html
 847          */
 848         protected function getHeartbeatData( array $conds ) {
 849                 // Query time and trip time are not counted
 850                 $nowUnix = microtime( true );
 851                 // Do not bother starting implicit transactions here
 852                 $this->clearFlag( self::DBO_TRX, self::REMEMBER_PRIOR );
 853                 try {
 854                         $whereSQL = $this->makeList( $conds, self::LIST_AND );
 855                         // Use ORDER BY for channel based queries since that field might not be UNIQUE.
 856                         // Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
 857                         // percision field is not supported in MySQL <= 5.5.
 858                         $res = $this->query(
 859                                 "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1",
 860                                 __METHOD__,
 861                                 self::QUERY_SILENCE_ERRORS | self::QUERY_IGNORE_DBO_TRX
 862                         );
 863                         $row = $res ? $res->fetchObject() : false;
 864                 } finally {
 865                         $this->restoreFlags();
 866                 }
 867
 868                 return [ $row ? $row->ts : null, $nowUnix ];
 869         }
 870
 871         protected function getApproximateLagStatus() {
 872                 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
 873                         // Disable caching since this is fast enough and we don't wan't
 874                         // to be *too* pessimistic by having both the cache TTL and the
 875                         // pt-heartbeat interval count as lag in getSessionLagStatus()
 876                         return parent::getApproximateLagStatus();
 877                 }
 878
 879                 $key = $this->srvCache->makeGlobalKey( 'mysql-lag', $this->getServer() );
 880                 $approxLag = $this->srvCache->get( $key );
 881                 if ( !$approxLag ) {
 882                         $approxLag = parent::getApproximateLagStatus();
 883                         $this->srvCache->set( $key, $approxLag, 1 );
 884                 }
 885
 886                 return $approxLag;
 887         }
 888
 889         public function masterPosWait( DBMasterPos $pos, $timeout ) {
 890                 if ( !( $pos instanceof MySQLMasterPos ) ) {
 891                         throw new InvalidArgumentException( "Position not an instance of MySQLMasterPos" );
 892                 }
 893
 894                 if ( $this->getLBInfo( 'is static' ) === true ) {
 895                         return 0; // this is a copy of a read-only dataset with no master DB
 896                 } elseif ( $this->lastKnownReplicaPos && $this->lastKnownReplicaPos->hasReached( $pos ) ) {
 897                         return 0; // already reached this point for sure
 898                 }
 899
 900                 // Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
 901                 if ( $pos->getGTIDs() ) {
 902                         // Ignore GTIDs from domains exclusive to the master DB (presumably inactive)
 903                         $rpos = $this->getReplicaPos();
 904                         $gtidsWait = $rpos ? MySQLMasterPos::getCommonDomainGTIDs( $pos, $rpos ) : [];
 905                         if ( !$gtidsWait ) {
 906                                 $this->queryLogger->error(
 907                                         "No GTIDs with the same domain between master ($pos) and replica ($rpos)",
 908                                         $this->getLogContext( [
 909                                                 'method' => __METHOD__,
 910                                         ] )
 911                                 );
 912
 913                                 return -1; // $pos is from the wrong cluster?
 914                         }
 915                         // Wait on the GTID set (MariaDB only)
 916                         $gtidArg = $this->addQuotes( implode( ',', $gtidsWait ) );
 917                         if ( strpos( $gtidArg, ':' ) !== false ) {
 918                                 // MySQL GTIDs, e.g "source_id:transaction_id"
 919                                 $sql = "SELECT WAIT_FOR_EXECUTED_GTID_SET($gtidArg, $timeout)";
 920                         } else {
 921                                 // MariaDB GTIDs, e.g."domain:server:sequence"
 922                                 $sql = "SELECT MASTER_GTID_WAIT($gtidArg, $timeout)";
 923                         }
 924                 } else {
 925                         // Wait on the binlog coordinates
 926                         $encFile = $this->addQuotes( $pos->getLogFile() );
 927                         $encPos = intval( $pos->getLogPosition()[$pos::CORD_EVENT] );
 928                         $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
 929                 }
 930
 931                 list( $res, $err ) = $this->executeQuery( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
 932                 $row = $res ? $this->fetchRow( $res ) : false;
 933                 if ( !$row ) {
 934                         throw new DBExpectedError( $this, "Replication wait failed: {$err}" );
 935                 }
 936
 937                 // Result can be NULL (error), -1 (timeout), or 0+ per the MySQL manual
 938                 $status = ( $row[0] !== null ) ? intval( $row[0] ) : null;
 939                 if ( $status === null ) {
 940                         if ( !$pos->getGTIDs() ) {
 941                                 // T126436: jobs programmed to wait on master positions might be referencing
 942                                 // binlogs with an old master hostname; this makes MASTER_POS_WAIT() return null.
 943                                 // Try to detect this case and treat the replica DB as having reached the given
 944                                 // position (any master switchover already requires that the new master be caught
 945                                 // up before the switch).
 946                                 $replicationPos = $this->getReplicaPos();
 947                                 if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
 948                                         $this->lastKnownReplicaPos = $replicationPos;
 949                                         $status = 0;
 950                                 }
 951                         }
 952                 } elseif ( $status >= 0 ) {
 953                         // Remember that this position was reached to save queries next time
 954                         $this->lastKnownReplicaPos = $pos;
 955                 }
 956
 957                 return $status;
 958         }
 959
 960         /**
 961          * Get the position of the master from SHOW SLAVE STATUS
 962          *
 963          * @return MySQLMasterPos|bool
 964          */
 965         public function getReplicaPos() {
 966                 $now = microtime( true ); // as-of-time *before* fetching GTID variables
 967
 968                 if ( $this->useGTIDs() ) {
 969                         // Try to use GTIDs, fallbacking to binlog positions if not possible
 970                         $data = $this->getServerGTIDs( __METHOD__ );
 971                         // Use gtid_slave_pos for MariaDB and gtid_executed for MySQL
 972                         foreach ( [ 'gtid_slave_pos', 'gtid_executed' ] as $name ) {
 973                                 if ( isset( $data[$name] ) && strlen( $data[$name] ) ) {
 974                                         return new MySQLMasterPos( $data[$name], $now );
 975                                 }
 976                         }
 977                 }
 978
 979                 $data = $this->getServerRoleStatus( 'SLAVE', __METHOD__ );
 980                 if ( $data && strlen( $data['Relay_Master_Log_File'] ) ) {
 981                         return new MySQLMasterPos(
 982                                 "{$data['Relay_Master_Log_File']}/{$data['Exec_Master_Log_Pos']}",
 983                                 $now
 984                         );
 985                 }
 986
 987                 return false;
 988         }
 989
 990         /**
 991          * Get the position of the master from SHOW MASTER STATUS
 992          *
 993          * @return MySQLMasterPos|bool
 994          */
 995         public function getMasterPos() {
 996                 $now = microtime( true ); // as-of-time *before* fetching GTID variables
 997
 998                 $pos = false;
 999                 if ( $this->useGTIDs() ) {
1000                         // Try to use GTIDs, fallbacking to binlog positions if not possible
1001                         $data = $this->getServerGTIDs( __METHOD__ );
1002                         // Use gtid_binlog_pos for MariaDB and gtid_executed for MySQL
1003                         foreach ( [ 'gtid_binlog_pos', 'gtid_executed' ] as $name ) {
1004                                 if ( isset( $data[$name] ) && strlen( $data[$name] ) ) {
1005                                         $pos = new MySQLMasterPos( $data[$name], $now );
1006                                         break;
1007                                 }
1008                         }
1009                         // Filter domains that are inactive or not relevant to the session
1010                         if ( $pos ) {
1011                                 $pos->setActiveOriginServerId( $this->getServerId() );
1012                                 $pos->setActiveOriginServerUUID( $this->getServerUUID() );
1013                                 if ( isset( $data['gtid_domain_id'] ) ) {
1014                                         $pos->setActiveDomain( $data['gtid_domain_id'] );
1015                                 }
1016                         }
1017                 }
1018
1019                 if ( !$pos ) {
1020                         $data = $this->getServerRoleStatus( 'MASTER', __METHOD__ );
1021                         if ( $data && strlen( $data['File'] ) ) {
1022                                 $pos = new MySQLMasterPos( "{$data['File']}/{$data['Position']}", $now );
1023                         }
1024                 }
1025
1026                 return $pos;
1027         }
1028
1029         /**
1030          * @return int
1031          * @throws DBQueryError If the variable doesn't exist for some reason
1032          */
1033         protected function getServerId() {
1034                 $fname = __METHOD__;
1035                 return $this->srvCache->getWithSetCallback(
1036                         $this->srvCache->makeGlobalKey( 'mysql-server-id', $this->getServer() ),
1037                         self::SERVER_ID_CACHE_TTL,
1038                         function () use ( $fname ) {
1039                                 $flags = self::QUERY_IGNORE_DBO_TRX;
1040                                 $res = $this->query( "SELECT @@server_id AS id", $fname, $flags );
1041
1042                                 return intval( $this->fetchObject( $res )->id );
1043                         }
1044                 );
1045         }
1046
1047         /**
1048          * @return string|null
1049          */
1050         protected function getServerUUID() {
1051                 $fname = __METHOD__;
1052                 return $this->srvCache->getWithSetCallback(
1053                         $this->srvCache->makeGlobalKey( 'mysql-server-uuid', $this->getServer() ),
1054                         self::SERVER_ID_CACHE_TTL,
1055                         function () use ( $fname ) {
1056                                 $flags = self::QUERY_IGNORE_DBO_TRX;
1057                                 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'server_uuid'", $fname, $flags );
1058                                 $row = $this->fetchObject( $res );
1059
1060                                 return $row ? $row->Value : null;
1061                         }
1062                 );
1063         }
1064
1065         /**
1066          * @param string $fname
1067          * @return string[]
1068          */
1069         protected function getServerGTIDs( $fname = __METHOD__ ) {
1070                 $map = [];
1071
1072                 $flags = self::QUERY_IGNORE_DBO_TRX;
1073                 // Get global-only variables like gtid_executed
1074                 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_%'", $fname, $flags );
1075                 foreach ( $res as $row ) {
1076                         $map[$row->Variable_name] = $row->Value;
1077                 }
1078                 // Get session-specific (e.g. gtid_domain_id since that is were writes will log)
1079                 $res = $this->query( "SHOW SESSION VARIABLES LIKE 'gtid_%'", $fname, $flags );
1080                 foreach ( $res as $row ) {
1081                         $map[$row->Variable_name] = $row->Value;
1082                 }
1083
1084                 return $map;
1085         }
1086
1087         /**
1088          * @param string $role One of "MASTER"/"SLAVE"
1089          * @param string $fname
1090          * @return string[] Latest available server status row
1091          */
1092         protected function getServerRoleStatus( $role, $fname = __METHOD__ ) {
1093                 $flags = self::QUERY_IGNORE_DBO_TRX;
1094
1095                 return $this->query( "SHOW $role STATUS", $fname, $flags )->fetchRow() ?: [];
1096         }
1097
1098         public function serverIsReadOnly() {
1099                 $flags = self::QUERY_IGNORE_DBO_TRX;
1100                 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__, $flags );
1101                 $row = $this->fetchObject( $res );
1102
1103                 return $row ? ( strtolower( $row->Value ) === 'on' ) : false;
1104         }
1105
1106         /**
1107          * @param string $index
1108          * @return string
1109          */
1110         function useIndexClause( $index ) {
1111                 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
1112         }
1113
1114         /**
1115          * @param string $index
1116          * @return string
1117          */
1118         function ignoreIndexClause( $index ) {
1119                 return "IGNORE INDEX (" . $this->indexName( $index ) . ")";
1120         }
1121
1122         /**
1123          * @return string
1124          */
1125         function lowPriorityOption() {
1126                 return 'LOW_PRIORITY';
1127         }
1128
1129         /**
1130          * @return string
1131          */
1132         public function getSoftwareLink() {
1133                 // MariaDB includes its name in its version string; this is how MariaDB's version of
1134                 // the mysql command-line client identifies MariaDB servers (see mariadb_connection()
1135                 // in libmysql/libmysql.c).
1136                 $version = $this->getServerVersion();
1137                 if ( strpos( $version, 'MariaDB' ) !== false || strpos( $version, '-maria-' ) !== false ) {
1138                         return '[{{int:version-db-mariadb-url}} MariaDB]';
1139                 }
1140
1141                 // Percona Server's version suffix is not very distinctive, and @@version_comment
1142                 // doesn't give the necessary info for source builds, so assume the server is MySQL.
1143                 // (Even Percona's version of mysql doesn't try to make the distinction.)
1144                 return '[{{int:version-db-mysql-url}} MySQL]';
1145         }
1146
1147         /**
1148          * @return string
1149          */
1150         public function getServerVersion() {
1151                 // Not using mysql_get_server_info() or similar for consistency: in the handshake,
1152                 // MariaDB 10 adds the prefix "5.5.5-", and only some newer client libraries strip
1153                 // it off (see RPL_VERSION_HACK in include/mysql_com.h).
1154                 if ( $this->serverVersion === null ) {
1155                         $this->serverVersion = $this->selectField( '', 'VERSION()', '', __METHOD__ );
1156                 }
1157                 return $this->serverVersion;
1158         }
1159
1160         /**
1161          * @param array $options
1162          */
1163         public function setSessionOptions( array $options ) {
1164                 if ( isset( $options['connTimeout'] ) ) {
1165                         $flags = self::QUERY_IGNORE_DBO_TRX;
1166                         $timeout = (int)$options['connTimeout'];
1167                         $this->query( "SET net_read_timeout=$timeout", __METHOD__, $flags );
1168                         $this->query( "SET net_write_timeout=$timeout", __METHOD__, $flags );
1169                 }
1170         }
1171
1172         /**
1173          * @param string &$sql
1174          * @param string &$newLine
1175          * @return bool
1176          */
1177         public function streamStatementEnd( &$sql, &$newLine ) {
1178                 if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
1179                         preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
1180                         $this->delimiter = $m[1];
1181                         $newLine = '';
1182                 }
1183
1184                 return parent::streamStatementEnd( $sql, $newLine );
1185         }
1186
1187         /**
1188          * Check to see if a named lock is available. This is non-blocking.
1189          *
1190          * @param string $lockName Name of lock to poll
1191          * @param string $method Name of method calling us
1192          * @return bool
1193          * @since 1.20
1194          */
1195         public function lockIsFree( $lockName, $method ) {
1196                 if ( !parent::lockIsFree( $lockName, $method ) ) {
1197                         return false; // already held
1198                 }
1199
1200                 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1201
1202                 $flags = self::QUERY_IGNORE_DBO_TRX;
1203                 $res = $this->query( "SELECT IS_FREE_LOCK($encName) AS lockstatus", $method, $flags );
1204                 $row = $this->fetchObject( $res );
1205
1206                 return ( $row->lockstatus == 1 );
1207         }
1208
1209         /**
1210          * @param string $lockName
1211          * @param string $method
1212          * @param int $timeout
1213          * @return bool
1214          */
1215         public function lock( $lockName, $method, $timeout = 5 ) {
1216                 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1217
1218                 $flags = self::QUERY_IGNORE_DBO_TRX;
1219                 $res = $this->query( "SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method, $flags );
1220                 $row = $this->fetchObject( $res );
1221
1222                 if ( $row->lockstatus == 1 ) {
1223                         parent::lock( $lockName, $method, $timeout ); // record
1224                         return true;
1225                 }
1226
1227                 $this->queryLogger->info( __METHOD__ . " failed to acquire lock '{lockname}'",
1228                         [ 'lockname' => $lockName ] );
1229
1230                 return false;
1231         }
1232
1233         /**
1234          * FROM MYSQL DOCS:
1235          * https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
1236          * @param string $lockName
1237          * @param string $method
1238          * @return bool
1239          */
1240         public function unlock( $lockName, $method ) {
1241                 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1242
1243                 $flags = self::QUERY_IGNORE_DBO_TRX;
1244                 $res = $this->query( "SELECT RELEASE_LOCK($encName) as lockstatus", $method, $flags );
1245                 $row = $this->fetchObject( $res );
1246
1247                 if ( $row->lockstatus == 1 ) {
1248                         parent::unlock( $lockName, $method ); // record
1249                         return true;
1250                 }
1251
1252                 $this->queryLogger->warning( __METHOD__ . " failed to release lock '$lockName'\n" );
1253
1254                 return false;
1255         }
1256
1257         private function makeLockName( $lockName ) {
1258                 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1259                 // Newer version enforce a 64 char length limit.
1260                 return ( strlen( $lockName ) > 64 ) ? sha1( $lockName ) : $lockName;
1261         }
1262
1263         public function namedLocksEnqueue() {
1264                 return true;
1265         }
1266
1267         public function tableLocksHaveTransactionScope() {
1268                 return false; // tied to TCP connection
1269         }
1270
1271         protected function doLockTables( array $read, array $write, $method ) {
1272                 $items = [];
1273                 foreach ( $write as $table ) {
1274                         $items[] = $this->tableName( $table ) . ' WRITE';
1275                 }
1276                 foreach ( $read as $table ) {
1277                         $items[] = $this->tableName( $table ) . ' READ';
1278                 }
1279
1280                 $sql = "LOCK TABLES " . implode( ',', $items );
1281                 $this->query( $sql, $method, self::QUERY_IGNORE_DBO_TRX );
1282
1283                 return true;
1284         }
1285
1286         protected function doUnlockTables( $method ) {
1287                 $this->query( "UNLOCK TABLES", $method, self::QUERY_IGNORE_DBO_TRX );
1288
1289                 return true;
1290         }
1291
1292         /**
1293          * @param bool $value
1294          */
1295         public function setBigSelects( $value = true ) {
1296                 if ( $value === 'default' ) {
1297                         if ( $this->defaultBigSelects === null ) {
1298                                 # Function hasn't been called before so it must already be set to the default
1299                                 return;
1300                         } else {
1301                                 $value = $this->defaultBigSelects;
1302                         }
1303                 } elseif ( $this->defaultBigSelects === null ) {
1304                         $this->defaultBigSelects =
1305                                 (bool)$this->selectField( false, '@@sql_big_selects', '', __METHOD__ );
1306                 }
1307                 $encValue = $value ? '1' : '0';
1308                 $this->query( "SET sql_big_selects=$encValue", __METHOD__, self::QUERY_IGNORE_DBO_TRX );
1309         }
1310
1311         /**
1312          * DELETE where the condition is a join. MySql uses multi-table deletes.
1313          * @param string $delTable
1314          * @param string $joinTable
1315          * @param string $delVar
1316          * @param string $joinVar
1317          * @param array|string $conds
1318          * @param bool|string $fname
1319          * @throws DBUnexpectedError
1320          */
1321         public function deleteJoin(
1322                 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
1323         ) {
1324                 if ( !$conds ) {
1325                         throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
1326                 }
1327
1328                 $delTable = $this->tableName( $delTable );
1329                 $joinTable = $this->tableName( $joinTable );
1330                 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1331
1332                 if ( $conds != '*' ) {
1333                         $sql .= ' AND ' . $this->makeList( $conds, self::LIST_AND );
1334                 }
1335
1336                 $this->query( $sql, $fname );
1337         }
1338
1339         public function upsert(
1340                 $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
1341         ) {
1342                 if ( $rows === [] ) {
1343                         return true; // nothing to do
1344                 }
1345
1346                 if ( !is_array( reset( $rows ) ) ) {
1347                         $rows = [ $rows ];
1348                 }
1349
1350                 $table = $this->tableName( $table );
1351                 $columns = array_keys( $rows[0] );
1352
1353                 $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
1354                 $rowTuples = [];
1355                 foreach ( $rows as $row ) {
1356                         $rowTuples[] = '(' . $this->makeList( $row ) . ')';
1357                 }
1358                 $sql .= implode( ',', $rowTuples );
1359                 $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self::LIST_SET );
1360
1361                 $this->query( $sql, $fname );
1362
1363                 return true;
1364         }
1365
1366         /**
1367          * Determines how long the server has been up
1368          *
1369          * @return int
1370          */
1371         public function getServerUptime() {
1372                 $vars = $this->getMysqlStatus( 'Uptime' );
1373
1374                 return (int)$vars['Uptime'];
1375         }
1376
1377         /**
1378          * Determines if the last failure was due to a deadlock
1379          *
1380          * @return bool
1381          */
1382         public function wasDeadlock() {
1383                 return $this->lastErrno() == 1213;
1384         }
1385
1386         /**
1387          * Determines if the last failure was due to a lock timeout
1388          *
1389          * @return bool
1390          */
1391         public function wasLockTimeout() {
1392                 return $this->lastErrno() == 1205;
1393         }
1394
1395         /**
1396          * Determines if the last failure was due to the database being read-only.
1397          *
1398          * @return bool
1399          */
1400         public function wasReadOnlyError() {
1401                 return $this->lastErrno() == 1223 ||
1402                         ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1403         }
1404
1405         public function wasConnectionError( $errno ) {
1406                 return $errno == 2013 || $errno == 2006;
1407         }
1408
1409         protected function wasKnownStatementRollbackError() {
1410                 $errno = $this->lastErrno();
1411
1412                 if ( $errno === 1205 ) { // lock wait timeout
1413                         // Note that this is uncached to avoid stale values of SET is used
1414                         $row = $this->selectRow(
1415                                 false,
1416                                 [ 'innodb_rollback_on_timeout' => '@@innodb_rollback_on_timeout' ],
1417                                 [],
1418                                 __METHOD__
1419                         );
1420                         // https://dev.mysql.com/doc/refman/5.7/en/innodb-error-handling.html
1421                         // https://dev.mysql.com/doc/refman/5.5/en/innodb-parameters.html
1422                         return $row->innodb_rollback_on_timeout ? false : true;
1423                 }
1424
1425                 // See https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
1426                 return in_array( $errno, [ 1022, 1062, 1216, 1217, 1137, 1146, 1051, 1054 ], true );
1427         }
1428
1429         /**
1430          * @param string $oldName
1431          * @param string $newName
1432          * @param bool $temporary
1433          * @param string $fname
1434          * @return bool
1435          */
1436         public function duplicateTableStructure(
1437                 $oldName, $newName, $temporary = false, $fname = __METHOD__
1438         ) {
1439                 $tmp = $temporary ? 'TEMPORARY ' : '';
1440                 $newName = $this->addIdentifierQuotes( $newName );
1441                 $oldName = $this->addIdentifierQuotes( $oldName );
1442                 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1443
1444                 return $this->query( $query, $fname, $this::QUERY_PSEUDO_PERMANENT );
1445         }
1446
1447         /**
1448          * List all tables on the database
1449          *
1450          * @param string|null $prefix Only show tables with this prefix, e.g. mw_
1451          * @param string $fname Calling function name
1452          * @return array
1453          */
1454         public function listTables( $prefix = null, $fname = __METHOD__ ) {
1455                 $result = $this->query( "SHOW TABLES", $fname );
1456
1457                 $endArray = [];
1458
1459                 foreach ( $result as $table ) {
1460                         $vars = get_object_vars( $table );
1461                         $table = array_pop( $vars );
1462
1463                         if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
1464                                 $endArray[] = $table;
1465                         }
1466                 }
1467
1468                 return $endArray;
1469         }
1470
1471         /**
1472          * @param string $tableName
1473          * @param string $fName
1474          * @return bool|IResultWrapper
1475          */
1476         public function dropTable( $tableName, $fName = __METHOD__ ) {
1477                 if ( !$this->tableExists( $tableName, $fName ) ) {
1478                         return false;
1479                 }
1480
1481                 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1482         }
1483
1484         /**
1485          * Get status information from SHOW STATUS in an associative array
1486          *
1487          * @param string $which
1488          * @return array
1489          */
1490         private function getMysqlStatus( $which = "%" ) {
1491                 $flags = self::QUERY_IGNORE_DBO_TRX;
1492                 $res = $this->query( "SHOW STATUS LIKE '{$which}'", __METHOD__, $flags );
1493                 $status = [];
1494
1495                 foreach ( $res as $row ) {
1496                         $status[$row->Variable_name] = $row->Value;
1497                 }
1498
1499                 return $status;
1500         }
1501
1502         /**
1503          * Lists VIEWs in the database
1504          *
1505          * @param string|null $prefix Only show VIEWs with this prefix, eg.
1506          * unit_test_, or $wgDBprefix. Default: null, would return all views.
1507          * @param string $fname Name of calling function
1508          * @return array
1509          * @since 1.22
1510          */
1511         public function listViews( $prefix = null, $fname = __METHOD__ ) {
1512                 // The name of the column containing the name of the VIEW
1513                 $propertyName = 'Tables_in_' . $this->getDBname();
1514
1515                 // Query for the VIEWS
1516                 $res = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1517                 $allViews = [];
1518                 foreach ( $res as $row ) {
1519                         array_push( $allViews, $row->$propertyName );
1520                 }
1521
1522                 if ( is_null( $prefix ) || $prefix === '' ) {
1523                         return $allViews;
1524                 }
1525
1526                 $filteredViews = [];
1527                 foreach ( $allViews as $viewName ) {
1528                         // Does the name of this VIEW start with the table-prefix?
1529                         if ( strpos( $viewName, $prefix ) === 0 ) {
1530                                 array_push( $filteredViews, $viewName );
1531                         }
1532                 }
1533
1534                 return $filteredViews;
1535         }
1536
1537         /**
1538          * Differentiates between a TABLE and a VIEW.
1539          *
1540          * @param string $name Name of the TABLE/VIEW to test
1541          * @param string|null $prefix
1542          * @return bool
1543          * @since 1.22
1544          */
1545         public function isView( $name, $prefix = null ) {
1546                 return in_array( $name, $this->listViews( $prefix ) );
1547         }
1548
1549         protected function isTransactableQuery( $sql ) {
1550                 return parent::isTransactableQuery( $sql ) &&
1551                         !preg_match( '/^SELECT\s+(GET|RELEASE|IS_FREE)_LOCK\(/', $sql );
1552         }
1553
1554         public function buildStringCast( $field ) {
1555                 return "CAST( $field AS BINARY )";
1556         }
1557
1558         /**
1559          * @param string $field Field or column to cast
1560          * @return string
1561          */
1562         public function buildIntegerCast( $field ) {
1563                 return 'CAST( ' . $field . ' AS SIGNED )';
1564         }
1565
1566         /*
1567          * @return bool Whether GTID support is used (mockable for testing)
1568          */
1569         protected function useGTIDs() {
1570                 return $this->useGTIDs;
1571         }
1572 }
1573
1574 /**
1575  * @deprecated since 1.29
1576  */
1577 class_alias( DatabaseMysqlBase::class, 'DatabaseMysqlBase' );