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