includes/libs/rdbms/database/DatabasePostgres.php

   1 <?php
   2 /**
   3  * This is the Postgres 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 Wikimedia\Timestamp\ConvertibleTimestamp;
  26 use Wikimedia\WaitConditionLoop;
  27 use Wikimedia;
  28 use Exception;
  29
  30 /**
  31  * @ingroup Database
  32  */
  33 class DatabasePostgres extends Database {
  34         /** @var int|bool */
  35         protected $port;
  36
  37         /** @var resource */
  38         protected $lastResultHandle = null;
  39
  40         /** @var float|string */
  41         private $numericVersion = null;
  42         /** @var string Connect string to open a PostgreSQL connection */
  43         private $connectString;
  44         /** @var string */
  45         private $coreSchema;
  46         /** @var string */
  47         private $tempSchema;
  48         /** @var string[] Map of (reserved table name => alternate table name) */
  49         private $keywordTableMap = [];
  50
  51         /**
  52          * @see Database::__construct()
  53          * @param array $params Additional parameters include:
  54          *   - keywordTableMap : Map of reserved table names to alternative table names to use
  55          */
  56         public function __construct( array $params ) {
  57                 $this->port = $params['port'] ?? false;
  58                 $this->keywordTableMap = $params['keywordTableMap'] ?? [];
  59
  60                 parent::__construct( $params );
  61         }
  62
  63         public function getType() {
  64                 return 'postgres';
  65         }
  66
  67         public function implicitGroupby() {
  68                 return false;
  69         }
  70
  71         public function implicitOrderby() {
  72                 return false;
  73         }
  74
  75         public function hasConstraint( $name ) {
  76                 foreach ( $this->getCoreSchemas() as $schema ) {
  77                         $sql = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
  78                                 "WHERE c.connamespace = n.oid AND conname = " .
  79                                 $this->addQuotes( $name ) . " AND n.nspname = " .
  80                                 $this->addQuotes( $schema );
  81                         $res = $this->doQuery( $sql );
  82                         if ( $res && $this->numRows( $res ) ) {
  83                                 return true;
  84                         }
  85                 }
  86                 return false;
  87         }
  88
  89         protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix ) {
  90                 # Test for Postgres support, to avoid suppressed fatal error
  91                 if ( !function_exists( 'pg_connect' ) ) {
  92                         throw new DBConnectionError(
  93                                 $this,
  94                                 "Postgres functions missing, have you compiled PHP with the --with-pgsql\n" .
  95                                 "option? (Note: if you recently installed PHP, you may need to restart your\n" .
  96                                 "webserver and database)\n"
  97                         );
  98                 }
  99
 100                 $this->server = $server;
 101                 $this->user = $user;
 102                 $this->password = $password;
 103
 104                 $connectVars = [
 105                         // pg_connect() user $user as the default database. Since a database is *required*,
 106                         // at least pick a "don't care" database that is more likely to exist. This case
 107                         // arrises when LoadBalancer::getConnection( $i, [], '' ) is used.
 108                         'dbname' => strlen( $dbName ) ? $dbName : 'postgres',
 109                         'user' => $user,
 110                         'password' => $password
 111                 ];
 112                 if ( $server != false && $server != '' ) {
 113                         $connectVars['host'] = $server;
 114                 }
 115                 if ( (int)$this->port > 0 ) {
 116                         $connectVars['port'] = (int)$this->port;
 117                 }
 118                 if ( $this->flags & self::DBO_SSL ) {
 119                         $connectVars['sslmode'] = 1;
 120                 }
 121
 122                 $this->connectString = $this->makeConnectionString( $connectVars );
 123                 $this->close();
 124                 $this->installErrorHandler();
 125
 126                 try {
 127                         // Use new connections to let LoadBalancer/LBFactory handle reuse
 128                         $this->conn = pg_connect( $this->connectString, PGSQL_CONNECT_FORCE_NEW );
 129                 } catch ( Exception $ex ) {
 130                         $this->restoreErrorHandler();
 131                         throw $ex;
 132                 }
 133
 134                 $phpError = $this->restoreErrorHandler();
 135
 136                 if ( !$this->conn ) {
 137                         $this->queryLogger->debug(
 138                                 "DB connection error\n" .
 139                                 "Server: $server, Database: $dbName, User: $user, Password: " .
 140                                 substr( $password, 0, 3 ) . "...\n"
 141                         );
 142                         $this->queryLogger->debug( $this->lastError() . "\n" );
 143                         throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) );
 144                 }
 145
 146                 $this->opened = true;
 147
 148                 # If called from the command-line (e.g. importDump), only show errors
 149                 if ( $this->cliMode ) {
 150                         $this->doQuery( "SET client_min_messages = 'ERROR'" );
 151                 }
 152
 153                 $this->query( "SET client_encoding='UTF8'", __METHOD__ );
 154                 $this->query( "SET datestyle = 'ISO, YMD'", __METHOD__ );
 155                 $this->query( "SET timezone = 'GMT'", __METHOD__ );
 156                 $this->query( "SET standard_conforming_strings = on", __METHOD__ );
 157                 $this->query( "SET bytea_output = 'escape'", __METHOD__ ); // PHP bug 53127
 158
 159                 $this->determineCoreSchema( $schema );
 160                 $this->currentDomain = new DatabaseDomain( $dbName, $schema, $tablePrefix );
 161
 162                 return (bool)$this->conn;
 163         }
 164
 165         protected function relationSchemaQualifier() {
 166                 if ( $this->coreSchema === $this->currentDomain->getSchema() ) {
 167                         // The schema to be used is now in the search path; no need for explicit qualification
 168                         return '';
 169                 }
 170
 171                 return parent::relationSchemaQualifier();
 172         }
 173
 174         public function databasesAreIndependent() {
 175                 return true;
 176         }
 177
 178         public function doSelectDomain( DatabaseDomain $domain ) {
 179                 if ( $this->getDBname() !== $domain->getDatabase() ) {
 180                         // Postgres doesn't support selectDB in the same way MySQL does.
 181                         // So if the DB name doesn't match the open connection, open a new one
 182                         $this->open(
 183                                 $this->server,
 184                                 $this->user,
 185                                 $this->password,
 186                                 $domain->getDatabase(),
 187                                 $domain->getSchema(),
 188                                 $domain->getTablePrefix()
 189                         );
 190                 } else {
 191                         $this->currentDomain = $domain;
 192                 }
 193
 194                 return true;
 195         }
 196
 197         /**
 198          * @param string[] $vars
 199          * @return string
 200          */
 201         private function makeConnectionString( $vars ) {
 202                 $s = '';
 203                 foreach ( $vars as $name => $value ) {
 204                         $s .= "$name='" . str_replace( "'", "\\'", $value ) . "' ";
 205                 }
 206
 207                 return $s;
 208         }
 209
 210         protected function closeConnection() {
 211                 return $this->conn ? pg_close( $this->conn ) : true;
 212         }
 213
 214         protected function isTransactableQuery( $sql ) {
 215                 return parent::isTransactableQuery( $sql ) &&
 216                         !preg_match( '/^SELECT\s+pg_(try_|)advisory_\w+\(/', $sql );
 217         }
 218
 219         public function doQuery( $sql ) {
 220                 $conn = $this->getBindingHandle();
 221
 222                 $sql = mb_convert_encoding( $sql, 'UTF-8' );
 223                 // Clear previously left over PQresult
 224                 while ( $res = pg_get_result( $conn ) ) {
 225                         pg_free_result( $res );
 226                 }
 227                 if ( pg_send_query( $conn, $sql ) === false ) {
 228                         throw new DBUnexpectedError( $this, "Unable to post new query to PostgreSQL\n" );
 229                 }
 230                 $this->lastResultHandle = pg_get_result( $conn );
 231                 if ( pg_result_error( $this->lastResultHandle ) ) {
 232                         return false;
 233                 }
 234
 235                 return $this->lastResultHandle;
 236         }
 237
 238         protected function dumpError() {
 239                 $diags = [
 240                         PGSQL_DIAG_SEVERITY,
 241                         PGSQL_DIAG_SQLSTATE,
 242                         PGSQL_DIAG_MESSAGE_PRIMARY,
 243                         PGSQL_DIAG_MESSAGE_DETAIL,
 244                         PGSQL_DIAG_MESSAGE_HINT,
 245                         PGSQL_DIAG_STATEMENT_POSITION,
 246                         PGSQL_DIAG_INTERNAL_POSITION,
 247                         PGSQL_DIAG_INTERNAL_QUERY,
 248                         PGSQL_DIAG_CONTEXT,
 249                         PGSQL_DIAG_SOURCE_FILE,
 250                         PGSQL_DIAG_SOURCE_LINE,
 251                         PGSQL_DIAG_SOURCE_FUNCTION
 252                 ];
 253                 foreach ( $diags as $d ) {
 254                         $this->queryLogger->debug( sprintf( "PgSQL ERROR(%d): %s\n",
 255                                 $d, pg_result_error_field( $this->lastResultHandle, $d ) ) );
 256                 }
 257         }
 258
 259         public function freeResult( $res ) {
 260                 if ( $res instanceof ResultWrapper ) {
 261                         $res = $res->result;
 262                 }
 263                 Wikimedia\suppressWarnings();
 264                 $ok = pg_free_result( $res );
 265                 Wikimedia\restoreWarnings();
 266                 if ( !$ok ) {
 267                         throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
 268                 }
 269         }
 270
 271         public function fetchObject( $res ) {
 272                 if ( $res instanceof ResultWrapper ) {
 273                         $res = $res->result;
 274                 }
 275                 Wikimedia\suppressWarnings();
 276                 $row = pg_fetch_object( $res );
 277                 Wikimedia\restoreWarnings();
 278                 # @todo FIXME: HACK HACK HACK HACK debug
 279
 280                 # @todo hashar: not sure if the following test really trigger if the object
 281                 #          fetching failed.
 282                 $conn = $this->getBindingHandle();
 283                 if ( pg_last_error( $conn ) ) {
 284                         throw new DBUnexpectedError(
 285                                 $this,
 286                                 'SQL error: ' . htmlspecialchars( pg_last_error( $conn ) )
 287                         );
 288                 }
 289
 290                 return $row;
 291         }
 292
 293         public function fetchRow( $res ) {
 294                 if ( $res instanceof ResultWrapper ) {
 295                         $res = $res->result;
 296                 }
 297                 Wikimedia\suppressWarnings();
 298                 $row = pg_fetch_array( $res );
 299                 Wikimedia\restoreWarnings();
 300
 301                 $conn = $this->getBindingHandle();
 302                 if ( pg_last_error( $conn ) ) {
 303                         throw new DBUnexpectedError(
 304                                 $this,
 305                                 'SQL error: ' . htmlspecialchars( pg_last_error( $conn ) )
 306                         );
 307                 }
 308
 309                 return $row;
 310         }
 311
 312         public function numRows( $res ) {
 313                 if ( $res === false ) {
 314                         return 0;
 315                 }
 316
 317                 if ( $res instanceof ResultWrapper ) {
 318                         $res = $res->result;
 319                 }
 320                 Wikimedia\suppressWarnings();
 321                 $n = pg_num_rows( $res );
 322                 Wikimedia\restoreWarnings();
 323
 324                 $conn = $this->getBindingHandle();
 325                 if ( pg_last_error( $conn ) ) {
 326                         throw new DBUnexpectedError(
 327                                 $this,
 328                                 'SQL error: ' . htmlspecialchars( pg_last_error( $conn ) )
 329                         );
 330                 }
 331
 332                 return $n;
 333         }
 334
 335         public function numFields( $res ) {
 336                 if ( $res instanceof ResultWrapper ) {
 337                         $res = $res->result;
 338                 }
 339
 340                 return pg_num_fields( $res );
 341         }
 342
 343         public function fieldName( $res, $n ) {
 344                 if ( $res instanceof ResultWrapper ) {
 345                         $res = $res->result;
 346                 }
 347
 348                 return pg_field_name( $res, $n );
 349         }
 350
 351         public function insertId() {
 352                 $res = $this->query( "SELECT lastval()" );
 353                 $row = $this->fetchRow( $res );
 354                 return is_null( $row[0] ) ? null : (int)$row[0];
 355         }
 356
 357         public function dataSeek( $res, $row ) {
 358                 if ( $res instanceof ResultWrapper ) {
 359                         $res = $res->result;
 360                 }
 361
 362                 return pg_result_seek( $res, $row );
 363         }
 364
 365         public function lastError() {
 366                 if ( $this->conn ) {
 367                         if ( $this->lastResultHandle ) {
 368                                 return pg_result_error( $this->lastResultHandle );
 369                         } else {
 370                                 return pg_last_error();
 371                         }
 372                 }
 373
 374                 return $this->getLastPHPError() ?: 'No database connection';
 375         }
 376
 377         public function lastErrno() {
 378                 if ( $this->lastResultHandle ) {
 379                         return pg_result_error_field( $this->lastResultHandle, PGSQL_DIAG_SQLSTATE );
 380                 } else {
 381                         return false;
 382                 }
 383         }
 384
 385         protected function fetchAffectedRowCount() {
 386                 if ( !$this->lastResultHandle ) {
 387                         return 0;
 388                 }
 389
 390                 return pg_affected_rows( $this->lastResultHandle );
 391         }
 392
 393         /**
 394          * Estimate rows in dataset
 395          * Returns estimated count, based on EXPLAIN output
 396          * This is not necessarily an accurate estimate, so use sparingly
 397          * Returns -1 if count cannot be found
 398          * Takes same arguments as Database::select()
 399          *
 400          * @param string $table
 401          * @param string $var
 402          * @param string $conds
 403          * @param string $fname
 404          * @param array $options
 405          * @param array $join_conds
 406          * @return int
 407          */
 408         public function estimateRowCount( $table, $var = '*', $conds = '',
 409                 $fname = __METHOD__, $options = [], $join_conds = []
 410         ) {
 411                 $conds = $this->normalizeConditions( $conds, $fname );
 412                 $column = $this->extractSingleFieldFromList( $var );
 413                 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
 414                         $conds[] = "$column IS NOT NULL";
 415                 }
 416
 417                 $options['EXPLAIN'] = true;
 418                 $res = $this->select( $table, $var, $conds, $fname, $options, $join_conds );
 419                 $rows = -1;
 420                 if ( $res ) {
 421                         $row = $this->fetchRow( $res );
 422                         $count = [];
 423                         if ( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
 424                                 $rows = (int)$count[1];
 425                         }
 426                 }
 427
 428                 return $rows;
 429         }
 430
 431         public function indexInfo( $table, $index, $fname = __METHOD__ ) {
 432                 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
 433                 $res = $this->query( $sql, $fname );
 434                 if ( !$res ) {
 435                         return null;
 436                 }
 437                 foreach ( $res as $row ) {
 438                         if ( $row->indexname == $this->indexName( $index ) ) {
 439                                 return $row;
 440                         }
 441                 }
 442
 443                 return false;
 444         }
 445
 446         public function indexAttributes( $index, $schema = false ) {
 447                 if ( $schema === false ) {
 448                         $schemas = $this->getCoreSchemas();
 449                 } else {
 450                         $schemas = [ $schema ];
 451                 }
 452
 453                 $eindex = $this->addQuotes( $index );
 454
 455                 foreach ( $schemas as $schema ) {
 456                         $eschema = $this->addQuotes( $schema );
 457                         /*
 458                          * A subquery would be not needed if we didn't care about the order
 459                          * of attributes, but we do
 460                          */
 461                         $sql = <<<__INDEXATTR__
 462
 463                                 SELECT opcname,
 464                                         attname,
 465                                         i.indoption[s.g] as option,
 466                                         pg_am.amname
 467                                 FROM
 468                                         (SELECT generate_series(array_lower(isub.indkey,1), array_upper(isub.indkey,1)) AS g
 469                                                 FROM
 470                                                         pg_index isub
 471                                                 JOIN pg_class cis
 472                                                         ON cis.oid=isub.indexrelid
 473                                                 JOIN pg_namespace ns
 474                                                         ON cis.relnamespace = ns.oid
 475                                                 WHERE cis.relname=$eindex AND ns.nspname=$eschema) AS s,
 476                                         pg_attribute,
 477                                         pg_opclass opcls,
 478                                         pg_am,
 479                                         pg_class ci
 480                                         JOIN pg_index i
 481                                                 ON ci.oid=i.indexrelid
 482                                         JOIN pg_class ct
 483                                                 ON ct.oid = i.indrelid
 484                                         JOIN pg_namespace n
 485                                                 ON ci.relnamespace = n.oid
 486                                         WHERE
 487                                                 ci.relname=$eindex AND n.nspname=$eschema
 488                                                 AND     attrelid = ct.oid
 489                                                 AND     i.indkey[s.g] = attnum
 490                                                 AND     i.indclass[s.g] = opcls.oid
 491                                                 AND     pg_am.oid = opcls.opcmethod
 492 __INDEXATTR__;
 493                         $res = $this->query( $sql, __METHOD__ );
 494                         $a = [];
 495                         if ( $res ) {
 496                                 foreach ( $res as $row ) {
 497                                         $a[] = [
 498                                                 $row->attname,
 499                                                 $row->opcname,
 500                                                 $row->amname,
 501                                                 $row->option ];
 502                                 }
 503                                 return $a;
 504                         }
 505                 }
 506                 return null;
 507         }
 508
 509         public function indexUnique( $table, $index, $fname = __METHOD__ ) {
 510                 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'" .
 511                         " AND indexdef LIKE 'CREATE UNIQUE%(" .
 512                         $this->strencode( $this->indexName( $index ) ) .
 513                         ")'";
 514                 $res = $this->query( $sql, $fname );
 515                 if ( !$res ) {
 516                         return null;
 517                 }
 518
 519                 return $res->numRows() > 0;
 520         }
 521
 522         public function selectSQLText(
 523                 $table, $vars, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
 524         ) {
 525                 if ( is_string( $options ) ) {
 526                         $options = [ $options ];
 527                 }
 528
 529                 // Change the FOR UPDATE option as necessary based on the join conditions. Then pass
 530                 // to the parent function to get the actual SQL text.
 531                 // In Postgres when using FOR UPDATE, only the main table and tables that are inner joined
 532                 // can be locked. That means tables in an outer join cannot be FOR UPDATE locked. Trying to
 533                 // do so causes a DB error. This wrapper checks which tables can be locked and adjusts it
 534                 // accordingly.
 535                 // MySQL uses "ORDER BY NULL" as an optimization hint, but that is illegal in PostgreSQL.
 536                 if ( is_array( $options ) ) {
 537                         $forUpdateKey = array_search( 'FOR UPDATE', $options, true );
 538                         if ( $forUpdateKey !== false && $join_conds ) {
 539                                 unset( $options[$forUpdateKey] );
 540                                 $options['FOR UPDATE'] = [];
 541
 542                                 $toCheck = $table;
 543                                 reset( $toCheck );
 544                                 while ( $toCheck ) {
 545                                         $alias = key( $toCheck );
 546                                         $name = $toCheck[$alias];
 547                                         unset( $toCheck[$alias] );
 548
 549                                         $hasAlias = !is_numeric( $alias );
 550                                         if ( !$hasAlias && is_string( $name ) ) {
 551                                                 $alias = $name;
 552                                         }
 553
 554                                         if ( !isset( $join_conds[$alias] ) ||
 555                                                 !preg_match( '/^(?:LEFT|RIGHT|FULL)(?: OUTER)? JOIN$/i', $join_conds[$alias][0] )
 556                                         ) {
 557                                                 if ( is_array( $name ) ) {
 558                                                         // It's a parenthesized group, process all the tables inside the group.
 559                                                         $toCheck = array_merge( $toCheck, $name );
 560                                                 } else {
 561                                                         // Quote alias names so $this->tableName() won't mangle them
 562                                                         $options['FOR UPDATE'][] = $hasAlias ? $this->addIdentifierQuotes( $alias ) : $alias;
 563                                                 }
 564                                         }
 565                                 }
 566                         }
 567
 568                         if ( isset( $options['ORDER BY'] ) && $options['ORDER BY'] == 'NULL' ) {
 569                                 unset( $options['ORDER BY'] );
 570                         }
 571                 }
 572
 573                 return parent::selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
 574         }
 575
 576         /** @inheritDoc */
 577         public function insert( $table, $args, $fname = __METHOD__, $options = [] ) {
 578                 if ( !count( $args ) ) {
 579                         return true;
 580                 }
 581
 582                 $table = $this->tableName( $table );
 583                 if ( !isset( $this->numericVersion ) ) {
 584                         $this->getServerVersion();
 585                 }
 586
 587                 if ( !is_array( $options ) ) {
 588                         $options = [ $options ];
 589                 }
 590
 591                 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
 592                         $rows = $args;
 593                         $keys = array_keys( $args[0] );
 594                 } else {
 595                         $rows = [ $args ];
 596                         $keys = array_keys( $args );
 597                 }
 598
 599                 $ignore = in_array( 'IGNORE', $options );
 600
 601                 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
 602
 603                 if ( $this->numericVersion >= 9.5 || !$ignore ) {
 604                         // No IGNORE or our PG has "ON CONFLICT DO NOTHING"
 605                         $first = true;
 606                         foreach ( $rows as $row ) {
 607                                 if ( $first ) {
 608                                         $first = false;
 609                                 } else {
 610                                         $sql .= ',';
 611                                 }
 612                                 $sql .= '(' . $this->makeList( $row ) . ')';
 613                         }
 614                         if ( $ignore ) {
 615                                 $sql .= ' ON CONFLICT DO NOTHING';
 616                         }
 617                         $this->query( $sql, $fname );
 618                 } else {
 619                         // Emulate IGNORE by doing each row individually, with savepoints
 620                         // to roll back as necessary.
 621                         $numrowsinserted = 0;
 622
 623                         $tok = $this->startAtomic( "$fname (outer)", self::ATOMIC_CANCELABLE );
 624                         try {
 625                                 foreach ( $rows as $row ) {
 626                                         $tempsql = $sql;
 627                                         $tempsql .= '(' . $this->makeList( $row ) . ')';
 628
 629                                         $this->startAtomic( "$fname (inner)", self::ATOMIC_CANCELABLE );
 630                                         try {
 631                                                 $this->query( $tempsql, $fname );
 632                                                 $this->endAtomic( "$fname (inner)" );
 633                                                 $numrowsinserted++;
 634                                         } catch ( DBQueryError $e ) {
 635                                                 $this->cancelAtomic( "$fname (inner)" );
 636                                                 // Our IGNORE is supposed to ignore duplicate key errors, but not others.
 637                                                 // (even though MySQL's version apparently ignores all errors)
 638                                                 if ( $e->errno !== '23505' ) {
 639                                                         throw $e;
 640                                                 }
 641                                         }
 642                                 }
 643                         } catch ( Exception $e ) {
 644                                 $this->cancelAtomic( "$fname (outer)", $tok );
 645                                 throw $e;
 646                         }
 647                         $this->endAtomic( "$fname (outer)" );
 648
 649                         // Set the affected row count for the whole operation
 650                         $this->affectedRowCount = $numrowsinserted;
 651                 }
 652
 653                 return true;
 654         }
 655
 656         /**
 657          * INSERT SELECT wrapper
 658          * $varMap must be an associative array of the form [ 'dest1' => 'source1', ... ]
 659          * Source items may be literals rather then field names, but strings should
 660          * be quoted with Database::addQuotes()
 661          * $conds may be "*" to copy the whole table
 662          * srcTable may be an array of tables.
 663          * @todo FIXME: Implement this a little better (separate select/insert)?
 664          *
 665          * @param string $destTable
 666          * @param array|string $srcTable
 667          * @param array $varMap
 668          * @param array $conds
 669          * @param string $fname
 670          * @param array $insertOptions
 671          * @param array $selectOptions
 672          * @param array $selectJoinConds
 673          * @return bool
 674          */
 675         public function nativeInsertSelect(
 676                 $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
 677                 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
 678         ) {
 679                 if ( !is_array( $insertOptions ) ) {
 680                         $insertOptions = [ $insertOptions ];
 681                 }
 682
 683                 if ( in_array( 'IGNORE', $insertOptions ) ) {
 684                         if ( $this->getServerVersion() >= 9.5 ) {
 685                                 // Use ON CONFLICT DO NOTHING if we have it for IGNORE
 686                                 $destTable = $this->tableName( $destTable );
 687
 688                                 $selectSql = $this->selectSQLText(
 689                                         $srcTable,
 690                                         array_values( $varMap ),
 691                                         $conds,
 692                                         $fname,
 693                                         $selectOptions,
 694                                         $selectJoinConds
 695                                 );
 696
 697                                 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
 698                                         $selectSql . ' ON CONFLICT DO NOTHING';
 699
 700                                 return $this->query( $sql, $fname );
 701                         } else {
 702                                 // IGNORE and we don't have ON CONFLICT DO NOTHING, so just use the non-native version
 703                                 return $this->nonNativeInsertSelect(
 704                                         $destTable, $srcTable, $varMap, $conds, $fname,
 705                                         $insertOptions, $selectOptions, $selectJoinConds
 706                                 );
 707                         }
 708                 }
 709
 710                 return parent::nativeInsertSelect( $destTable, $srcTable, $varMap, $conds, $fname,
 711                         $insertOptions, $selectOptions, $selectJoinConds );
 712         }
 713
 714         public function tableName( $name, $format = 'quoted' ) {
 715                 // Replace reserved words with better ones
 716                 $name = $this->remappedTableName( $name );
 717
 718                 return parent::tableName( $name, $format );
 719         }
 720
 721         /**
 722          * @param string $name
 723          * @return string Value of $name or remapped name if $name is a reserved keyword
 724          */
 725         public function remappedTableName( $name ) {
 726                 return $this->keywordTableMap[$name] ?? $name;
 727         }
 728
 729         /**
 730          * @param string $name
 731          * @param string $format
 732          * @return string Qualified and encoded (if requested) table name
 733          */
 734         public function realTableName( $name, $format = 'quoted' ) {
 735                 return parent::tableName( $name, $format );
 736         }
 737
 738         public function nextSequenceValue( $seqName ) {
 739                 return new NextSequenceValue;
 740         }
 741
 742         /**
 743          * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
 744          *
 745          * @param string $seqName
 746          * @return int
 747          */
 748         public function currentSequenceValue( $seqName ) {
 749                 $safeseq = str_replace( "'", "''", $seqName );
 750                 $res = $this->query( "SELECT currval('$safeseq')" );
 751                 $row = $this->fetchRow( $res );
 752                 $currval = $row[0];
 753
 754                 return $currval;
 755         }
 756
 757         public function textFieldSize( $table, $field ) {
 758                 $table = $this->tableName( $table );
 759                 $sql = "SELECT t.typname as ftype,a.atttypmod as size
 760                         FROM pg_class c, pg_attribute a, pg_type t
 761                         WHERE relname='$table' AND a.attrelid=c.oid AND
 762                                 a.atttypid=t.oid and a.attname='$field'";
 763                 $res = $this->query( $sql );
 764                 $row = $this->fetchObject( $res );
 765                 if ( $row->ftype == 'varchar' ) {
 766                         $size = $row->size - 4;
 767                 } else {
 768                         $size = $row->size;
 769                 }
 770
 771                 return $size;
 772         }
 773
 774         public function limitResult( $sql, $limit, $offset = false ) {
 775                 return "$sql LIMIT $limit " . ( is_numeric( $offset ) ? " OFFSET {$offset} " : '' );
 776         }
 777
 778         public function wasDeadlock() {
 779                 // https://www.postgresql.org/docs/9.2/static/errcodes-appendix.html
 780                 return $this->lastErrno() === '40P01';
 781         }
 782
 783         public function wasLockTimeout() {
 784                 // https://www.postgresql.org/docs/9.2/static/errcodes-appendix.html
 785                 return $this->lastErrno() === '55P03';
 786         }
 787
 788         public function wasConnectionError( $errno ) {
 789                 // https://www.postgresql.org/docs/9.2/static/errcodes-appendix.html
 790                 static $codes = [ '08000', '08003', '08006', '08001', '08004', '57P01', '57P03', '53300' ];
 791
 792                 return in_array( $errno, $codes, true );
 793         }
 794
 795         protected function wasKnownStatementRollbackError() {
 796                 return false; // transaction has to be rolled-back from error state
 797         }
 798
 799         public function duplicateTableStructure(
 800                 $oldName, $newName, $temporary = false, $fname = __METHOD__
 801         ) {
 802                 $newNameE = $this->addIdentifierQuotes( $newName );
 803                 $oldNameE = $this->addIdentifierQuotes( $oldName );
 804
 805                 $temporary = $temporary ? 'TEMPORARY' : '';
 806
 807                 $ret = $this->query( "CREATE $temporary TABLE $newNameE " .
 808                         "(LIKE $oldNameE INCLUDING DEFAULTS INCLUDING INDEXES)", $fname );
 809                 if ( !$ret ) {
 810                         return $ret;
 811                 }
 812
 813                 $res = $this->query( 'SELECT attname FROM pg_class c'
 814                         . ' JOIN pg_namespace n ON (n.oid = c.relnamespace)'
 815                         . ' JOIN pg_attribute a ON (a.attrelid = c.oid)'
 816                         . ' JOIN pg_attrdef d ON (c.oid=d.adrelid and a.attnum=d.adnum)'
 817                         . ' WHERE relkind = \'r\''
 818                         . ' AND nspname = ' . $this->addQuotes( $this->getCoreSchema() )
 819                         . ' AND relname = ' . $this->addQuotes( $oldName )
 820                         . ' AND adsrc LIKE \'nextval(%\'',
 821                         $fname
 822                 );
 823                 $row = $this->fetchObject( $res );
 824                 if ( $row ) {
 825                         $field = $row->attname;
 826                         $newSeq = "{$newName}_{$field}_seq";
 827                         $fieldE = $this->addIdentifierQuotes( $field );
 828                         $newSeqE = $this->addIdentifierQuotes( $newSeq );
 829                         $newSeqQ = $this->addQuotes( $newSeq );
 830                         $this->query( "CREATE $temporary SEQUENCE $newSeqE OWNED BY $newNameE.$fieldE", $fname );
 831                         $this->query(
 832                                 "ALTER TABLE $newNameE ALTER COLUMN $fieldE SET DEFAULT nextval({$newSeqQ}::regclass)",
 833                                 $fname
 834                         );
 835                 }
 836
 837                 return $ret;
 838         }
 839
 840         public function resetSequenceForTable( $table, $fname = __METHOD__ ) {
 841                 $table = $this->tableName( $table, 'raw' );
 842                 foreach ( $this->getCoreSchemas() as $schema ) {
 843                         $res = $this->query(
 844                                 'SELECT c.oid FROM pg_class c JOIN pg_namespace n ON (n.oid = c.relnamespace)'
 845                                 . ' WHERE relkind = \'r\''
 846                                 . ' AND nspname = ' . $this->addQuotes( $schema )
 847                                 . ' AND relname = ' . $this->addQuotes( $table ),
 848                                 $fname
 849                         );
 850                         if ( !$res || !$this->numRows( $res ) ) {
 851                                 continue;
 852                         }
 853
 854                         $oid = $this->fetchObject( $res )->oid;
 855                         $res = $this->query( 'SELECT adsrc FROM pg_attribute a'
 856                                 . ' JOIN pg_attrdef d ON (a.attrelid=d.adrelid and a.attnum=d.adnum)'
 857                                 . " WHERE a.attrelid = $oid"
 858                                 . ' AND adsrc LIKE \'nextval(%\'',
 859                                 $fname
 860                         );
 861                         $row = $this->fetchObject( $res );
 862                         if ( $row ) {
 863                                 $this->query(
 864                                         'SELECT ' . preg_replace( '/^nextval\((.+)\)$/', 'setval($1,1,false)', $row->adsrc ),
 865                                         $fname
 866                                 );
 867                                 return true;
 868                         }
 869                         return false;
 870                 }
 871
 872                 return false;
 873         }
 874
 875         /**
 876          * @suppress SecurityCheck-SQLInjection array_map not recognized T204911
 877          */
 878         public function listTables( $prefix = null, $fname = __METHOD__ ) {
 879                 $eschemas = implode( ',', array_map( [ $this, 'addQuotes' ], $this->getCoreSchemas() ) );
 880                 $result = $this->query(
 881                         "SELECT DISTINCT tablename FROM pg_tables WHERE schemaname IN ($eschemas)", $fname );
 882                 $endArray = [];
 883
 884                 foreach ( $result as $table ) {
 885                         $vars = get_object_vars( $table );
 886                         $table = array_pop( $vars );
 887                         if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
 888                                 $endArray[] = $table;
 889                         }
 890                 }
 891
 892                 return $endArray;
 893         }
 894
 895         public function timestamp( $ts = 0 ) {
 896                 $ct = new ConvertibleTimestamp( $ts );
 897
 898                 return $ct->getTimestamp( TS_POSTGRES );
 899         }
 900
 901         /**
 902          * Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12
 903          * to https://secure.php.net/manual/en/ref.pgsql.php
 904          *
 905          * Parsing a postgres array can be a tricky problem, he's my
 906          * take on this, it handles multi-dimensional arrays plus
 907          * escaping using a nasty regexp to determine the limits of each
 908          * data-item.
 909          *
 910          * This should really be handled by PHP PostgreSQL module
 911          *
 912          * @since 1.19
 913          * @param string $text Postgreql array returned in a text form like {a,b}
 914          * @param string[] $output
 915          * @param int|bool $limit
 916          * @param int $offset
 917          * @return string[]
 918          */
 919         private function pg_array_parse( $text, &$output, $limit = false, $offset = 1 ) {
 920                 if ( false === $limit ) {
 921                         $limit = strlen( $text ) - 1;
 922                         $output = [];
 923                 }
 924                 if ( '{}' == $text ) {
 925                         return $output;
 926                 }
 927                 do {
 928                         if ( '{' != $text[$offset] ) {
 929                                 preg_match( "/(\\{?\"([^\"\\\\]|\\\\.)*\"|[^,{}]+)+([,}]+)/",
 930                                         $text, $match, 0, $offset );
 931                                 $offset += strlen( $match[0] );
 932                                 $output[] = ( '"' != $match[1][0]
 933                                         ? $match[1]
 934                                         : stripcslashes( substr( $match[1], 1, -1 ) ) );
 935                                 if ( '},' == $match[3] ) {
 936                                         return $output;
 937                                 }
 938                         } else {
 939                                 $offset = $this->pg_array_parse( $text, $output, $limit, $offset + 1 );
 940                         }
 941                 } while ( $limit > $offset );
 942
 943                 return $output;
 944         }
 945
 946         public function aggregateValue( $valuedata, $valuename = 'value' ) {
 947                 return $valuedata;
 948         }
 949
 950         public function getSoftwareLink() {
 951                 return '[{{int:version-db-postgres-url}} PostgreSQL]';
 952         }
 953
 954         /**
 955          * Return current schema (executes SELECT current_schema())
 956          * Needs transaction
 957          *
 958          * @since 1.19
 959          * @return string Default schema for the current session
 960          */
 961         public function getCurrentSchema() {
 962                 $res = $this->query( "SELECT current_schema()", __METHOD__ );
 963                 $row = $this->fetchRow( $res );
 964
 965                 return $row[0];
 966         }
 967
 968         /**
 969          * Return list of schemas which are accessible without schema name
 970          * This is list does not contain magic keywords like "$user"
 971          * Needs transaction
 972          *
 973          * @see getSearchPath()
 974          * @see setSearchPath()
 975          * @since 1.19
 976          * @return array List of actual schemas for the current sesson
 977          */
 978         public function getSchemas() {
 979                 $res = $this->query( "SELECT current_schemas(false)", __METHOD__ );
 980                 $row = $this->fetchRow( $res );
 981                 $schemas = [];
 982
 983                 /* PHP pgsql support does not support array type, "{a,b}" string is returned */
 984
 985                 return $this->pg_array_parse( $row[0], $schemas );
 986         }
 987
 988         /**
 989          * Return search patch for schemas
 990          * This is different from getSchemas() since it contain magic keywords
 991          * (like "$user").
 992          * Needs transaction
 993          *
 994          * @since 1.19
 995          * @return array How to search for table names schemas for the current user
 996          */
 997         public function getSearchPath() {
 998                 $res = $this->query( "SHOW search_path", __METHOD__ );
 999                 $row = $this->fetchRow( $res );
1000
1001                 /* PostgreSQL returns SHOW values as strings */
1002
1003                 return explode( ",", $row[0] );
1004         }
1005
1006         /**
1007          * Update search_path, values should already be sanitized
1008          * Values may contain magic keywords like "$user"
1009          * @since 1.19
1010          *
1011          * @param array $search_path List of schemas to be searched by default
1012          */
1013         private function setSearchPath( $search_path ) {
1014                 $this->query( "SET search_path = " . implode( ", ", $search_path ) );
1015         }
1016
1017         /**
1018          * Determine default schema for the current application
1019          * Adjust this session schema search path if desired schema exists
1020          * and is not alread there.
1021          *
1022          * We need to have name of the core schema stored to be able
1023          * to query database metadata.
1024          *
1025          * This will be also called by the installer after the schema is created
1026          *
1027          * @since 1.19
1028          *
1029          * @param string $desiredSchema
1030          */
1031         public function determineCoreSchema( $desiredSchema ) {
1032                 $this->begin( __METHOD__, self::TRANSACTION_INTERNAL );
1033                 if ( $this->schemaExists( $desiredSchema ) ) {
1034                         if ( in_array( $desiredSchema, $this->getSchemas() ) ) {
1035                                 $this->coreSchema = $desiredSchema;
1036                                 $this->queryLogger->debug(
1037                                         "Schema \"" . $desiredSchema . "\" already in the search path\n" );
1038                         } else {
1039                                 /**
1040                                  * Prepend our schema (e.g. 'mediawiki') in front
1041                                  * of the search path
1042                                  * Fixes T17816
1043                                  */
1044                                 $search_path = $this->getSearchPath();
1045                                 array_unshift( $search_path,
1046                                         $this->addIdentifierQuotes( $desiredSchema ) );
1047                                 $this->setSearchPath( $search_path );
1048                                 $this->coreSchema = $desiredSchema;
1049                                 $this->queryLogger->debug(
1050                                         "Schema \"" . $desiredSchema . "\" added to the search path\n" );
1051                         }
1052                 } else {
1053                         $this->coreSchema = $this->getCurrentSchema();
1054                         $this->queryLogger->debug(
1055                                 "Schema \"" . $desiredSchema . "\" not found, using current \"" .
1056                                 $this->coreSchema . "\"\n" );
1057                 }
1058                 /* Commit SET otherwise it will be rollbacked on error or IGNORE SELECT */
1059                 $this->commit( __METHOD__, self::FLUSHING_INTERNAL );
1060         }
1061
1062         /**
1063          * Return schema name for core application tables
1064          *
1065          * @since 1.19
1066          * @return string Core schema name
1067          */
1068         public function getCoreSchema() {
1069                 return $this->coreSchema;
1070         }
1071
1072         /**
1073          * Return schema names for temporary tables and core application tables
1074          *
1075          * @since 1.31
1076          * @return string[] schema names
1077          */
1078         public function getCoreSchemas() {
1079                 if ( $this->tempSchema ) {
1080                         return [ $this->tempSchema, $this->getCoreSchema() ];
1081                 }
1082
1083                 $res = $this->query(
1084                         "SELECT nspname FROM pg_catalog.pg_namespace n WHERE n.oid = pg_my_temp_schema()", __METHOD__
1085                 );
1086                 $row = $this->fetchObject( $res );
1087                 if ( $row ) {
1088                         $this->tempSchema = $row->nspname;
1089                         return [ $this->tempSchema, $this->getCoreSchema() ];
1090                 }
1091
1092                 return [ $this->getCoreSchema() ];
1093         }
1094
1095         public function getServerVersion() {
1096                 if ( !isset( $this->numericVersion ) ) {
1097                         $conn = $this->getBindingHandle();
1098                         $versionInfo = pg_version( $conn );
1099                         if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
1100                                 // Old client, abort install
1101                                 $this->numericVersion = '7.3 or earlier';
1102                         } elseif ( isset( $versionInfo['server'] ) ) {
1103                                 // Normal client
1104                                 $this->numericVersion = $versionInfo['server'];
1105                         } else {
1106                                 // T18937: broken pgsql extension from PHP<5.3
1107                                 $this->numericVersion = pg_parameter_status( $conn, 'server_version' );
1108                         }
1109                 }
1110
1111                 return $this->numericVersion;
1112         }
1113
1114         /**
1115          * Query whether a given relation exists (in the given schema, or the
1116          * default mw one if not given)
1117          * @param string $table
1118          * @param array|string $types
1119          * @param bool|string $schema
1120          * @return bool
1121          */
1122         private function relationExists( $table, $types, $schema = false ) {
1123                 if ( !is_array( $types ) ) {
1124                         $types = [ $types ];
1125                 }
1126                 if ( $schema === false ) {
1127                         $schemas = $this->getCoreSchemas();
1128                 } else {
1129                         $schemas = [ $schema ];
1130                 }
1131                 $table = $this->realTableName( $table, 'raw' );
1132                 $etable = $this->addQuotes( $table );
1133                 foreach ( $schemas as $schema ) {
1134                         $eschema = $this->addQuotes( $schema );
1135                         $sql = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
1136                                 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
1137                                 . "AND c.relkind IN ('" . implode( "','", $types ) . "')";
1138                         $res = $this->query( $sql );
1139                         if ( $res && $res->numRows() ) {
1140                                 return true;
1141                         }
1142                 }
1143
1144                 return false;
1145         }
1146
1147         /**
1148          * For backward compatibility, this function checks both tables and views.
1149          * @param string $table
1150          * @param string $fname
1151          * @param bool|string $schema
1152          * @return bool
1153          */
1154         public function tableExists( $table, $fname = __METHOD__, $schema = false ) {
1155                 return $this->relationExists( $table, [ 'r', 'v' ], $schema );
1156         }
1157
1158         public function sequenceExists( $sequence, $schema = false ) {
1159                 return $this->relationExists( $sequence, 'S', $schema );
1160         }
1161
1162         public function triggerExists( $table, $trigger ) {
1163                 $q = <<<SQL
1164         SELECT 1 FROM pg_class, pg_namespace, pg_trigger
1165                 WHERE relnamespace=pg_namespace.oid AND relkind='r'
1166                         AND tgrelid=pg_class.oid
1167                         AND nspname=%s AND relname=%s AND tgname=%s
1168 SQL;
1169                 foreach ( $this->getCoreSchemas() as $schema ) {
1170                         $res = $this->query(
1171                                 sprintf(
1172                                         $q,
1173                                         $this->addQuotes( $schema ),
1174                                         $this->addQuotes( $table ),
1175                                         $this->addQuotes( $trigger )
1176                                 )
1177                         );
1178                         if ( $res && $res->numRows() ) {
1179                                 return true;
1180                         }
1181                 }
1182
1183                 return false;
1184         }
1185
1186         public function ruleExists( $table, $rule ) {
1187                 $exists = $this->selectField( 'pg_rules', 'rulename',
1188                         [
1189                                 'rulename' => $rule,
1190                                 'tablename' => $table,
1191                                 'schemaname' => $this->getCoreSchemas()
1192                         ]
1193                 );
1194
1195                 return $exists === $rule;
1196         }
1197
1198         public function constraintExists( $table, $constraint ) {
1199                 foreach ( $this->getCoreSchemas() as $schema ) {
1200                         $sql = sprintf( "SELECT 1 FROM information_schema.table_constraints " .
1201                                 "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
1202                                 $this->addQuotes( $schema ),
1203                                 $this->addQuotes( $table ),
1204                                 $this->addQuotes( $constraint )
1205                         );
1206                         $res = $this->query( $sql );
1207                         if ( $res && $res->numRows() ) {
1208                                 return true;
1209                         }
1210                 }
1211                 return false;
1212         }
1213
1214         /**
1215          * Query whether a given schema exists. Returns true if it does, false if it doesn't.
1216          * @param string $schema
1217          * @return bool
1218          */
1219         public function schemaExists( $schema ) {
1220                 if ( !strlen( $schema ) ) {
1221                         return false; // short-circuit
1222                 }
1223
1224                 $exists = $this->selectField(
1225                         '"pg_catalog"."pg_namespace"', 1, [ 'nspname' => $schema ], __METHOD__ );
1226
1227                 return (bool)$exists;
1228         }
1229
1230         /**
1231          * Returns true if a given role (i.e. user) exists, false otherwise.
1232          * @param string $roleName
1233          * @return bool
1234          */
1235         public function roleExists( $roleName ) {
1236                 $exists = $this->selectField( '"pg_catalog"."pg_roles"', 1,
1237                         [ 'rolname' => $roleName ], __METHOD__ );
1238
1239                 return (bool)$exists;
1240         }
1241
1242         /**
1243          * @param string $table
1244          * @param string $field
1245          * @return PostgresField|null
1246          */
1247         public function fieldInfo( $table, $field ) {
1248                 return PostgresField::fromText( $this, $table, $field );
1249         }
1250
1251         /**
1252          * pg_field_type() wrapper
1253          * @param ResultWrapper|resource $res ResultWrapper or PostgreSQL query result resource
1254          * @param int $index Field number, starting from 0
1255          * @return string
1256          */
1257         public function fieldType( $res, $index ) {
1258                 if ( $res instanceof ResultWrapper ) {
1259                         $res = $res->result;
1260                 }
1261
1262                 return pg_field_type( $res, $index );
1263         }
1264
1265         public function encodeBlob( $b ) {
1266                 return new PostgresBlob( pg_escape_bytea( $b ) );
1267         }
1268
1269         public function decodeBlob( $b ) {
1270                 if ( $b instanceof PostgresBlob ) {
1271                         $b = $b->fetch();
1272                 } elseif ( $b instanceof Blob ) {
1273                         return $b->fetch();
1274                 }
1275
1276                 return pg_unescape_bytea( $b );
1277         }
1278
1279         public function strencode( $s ) {
1280                 // Should not be called by us
1281                 return pg_escape_string( $this->getBindingHandle(), (string)$s );
1282         }
1283
1284         public function addQuotes( $s ) {
1285                 $conn = $this->getBindingHandle();
1286
1287                 if ( is_null( $s ) ) {
1288                         return 'NULL';
1289                 } elseif ( is_bool( $s ) ) {
1290                         return intval( $s );
1291                 } elseif ( $s instanceof Blob ) {
1292                         if ( $s instanceof PostgresBlob ) {
1293                                 $s = $s->fetch();
1294                         } else {
1295                                 $s = pg_escape_bytea( $conn, $s->fetch() );
1296                         }
1297                         return "'$s'";
1298                 } elseif ( $s instanceof NextSequenceValue ) {
1299                         return 'DEFAULT';
1300                 }
1301
1302                 return "'" . pg_escape_string( $conn, (string)$s ) . "'";
1303         }
1304
1305         public function makeSelectOptions( $options ) {
1306                 $preLimitTail = $postLimitTail = '';
1307                 $startOpts = $useIndex = $ignoreIndex = '';
1308
1309                 $noKeyOptions = [];
1310                 foreach ( $options as $key => $option ) {
1311                         if ( is_numeric( $key ) ) {
1312                                 $noKeyOptions[$option] = true;
1313                         }
1314                 }
1315
1316                 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1317
1318                 $preLimitTail .= $this->makeOrderBy( $options );
1319
1320                 if ( isset( $options['FOR UPDATE'] ) ) {
1321                         $postLimitTail .= ' FOR UPDATE OF ' .
1322                                 implode( ', ', array_map( [ $this, 'tableName' ], $options['FOR UPDATE'] ) );
1323                 } elseif ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1324                         $postLimitTail .= ' FOR UPDATE';
1325                 }
1326
1327                 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1328                         $startOpts .= 'DISTINCT';
1329                 }
1330
1331                 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1332         }
1333
1334         public function getServer() {
1335                 return $this->server;
1336         }
1337
1338         public function buildConcat( $stringList ) {
1339                 return implode( ' || ', $stringList );
1340         }
1341
1342         public function buildGroupConcatField(
1343                 $delimiter, $table, $field, $conds = '', $options = [], $join_conds = []
1344         ) {
1345                 $fld = "array_to_string(array_agg($field)," . $this->addQuotes( $delimiter ) . ')';
1346
1347                 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1348         }
1349
1350         public function buildStringCast( $field ) {
1351                 return $field . '::text';
1352         }
1353
1354         public function streamStatementEnd( &$sql, &$newLine ) {
1355                 # Allow dollar quoting for function declarations
1356                 if ( substr( $newLine, 0, 4 ) == '$mw$' ) {
1357                         if ( $this->delimiter ) {
1358                                 $this->delimiter = false;
1359                         } else {
1360                                 $this->delimiter = ';';
1361                         }
1362                 }
1363
1364                 return parent::streamStatementEnd( $sql, $newLine );
1365         }
1366
1367         public function doLockTables( array $read, array $write, $method ) {
1368                 $tablesWrite = [];
1369                 foreach ( $write as $table ) {
1370                         $tablesWrite[] = $this->tableName( $table );
1371                 }
1372                 $tablesRead = [];
1373                 foreach ( $read as $table ) {
1374                         $tablesRead[] = $this->tableName( $table );
1375                 }
1376
1377                 // Acquire locks for the duration of the current transaction...
1378                 if ( $tablesWrite ) {
1379                         $this->query(
1380                                 'LOCK TABLE ONLY ' . implode( ',', $tablesWrite ) . ' IN EXCLUSIVE MODE',
1381                                 $method
1382                         );
1383                 }
1384                 if ( $tablesRead ) {
1385                         $this->query(
1386                                 'LOCK TABLE ONLY ' . implode( ',', $tablesRead ) . ' IN SHARE MODE',
1387                                 $method
1388                         );
1389                 }
1390
1391                 return true;
1392         }
1393
1394         public function lockIsFree( $lockName, $method ) {
1395                 if ( !parent::lockIsFree( $lockName, $method ) ) {
1396                         return false; // already held
1397                 }
1398                 // http://www.postgresql.org/docs/9.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1399                 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1400                 $result = $this->query( "SELECT (CASE(pg_try_advisory_lock($key))
1401                         WHEN 'f' THEN 'f' ELSE pg_advisory_unlock($key) END) AS lockstatus", $method );
1402                 $row = $this->fetchObject( $result );
1403
1404                 return ( $row->lockstatus === 't' );
1405         }
1406
1407         public function lock( $lockName, $method, $timeout = 5 ) {
1408                 // http://www.postgresql.org/docs/9.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1409                 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1410                 $loop = new WaitConditionLoop(
1411                         function () use ( $lockName, $key, $timeout, $method ) {
1412                                 $res = $this->query( "SELECT pg_try_advisory_lock($key) AS lockstatus", $method );
1413                                 $row = $this->fetchObject( $res );
1414                                 if ( $row->lockstatus === 't' ) {
1415                                         parent::lock( $lockName, $method, $timeout ); // record
1416                                         return true;
1417                                 }
1418
1419                                 return WaitConditionLoop::CONDITION_CONTINUE;
1420                         },
1421                         $timeout
1422                 );
1423
1424                 return ( $loop->invoke() === $loop::CONDITION_REACHED );
1425         }
1426
1427         public function unlock( $lockName, $method ) {
1428                 // http://www.postgresql.org/docs/9.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1429                 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1430                 $result = $this->query( "SELECT pg_advisory_unlock($key) as lockstatus", $method );
1431                 $row = $this->fetchObject( $result );
1432
1433                 if ( $row->lockstatus === 't' ) {
1434                         parent::unlock( $lockName, $method ); // record
1435                         return true;
1436                 }
1437
1438                 $this->queryLogger->debug( __METHOD__ . " failed to release lock\n" );
1439
1440                 return false;
1441         }
1442
1443         public function serverIsReadOnly() {
1444                 $res = $this->query( "SHOW default_transaction_read_only", __METHOD__ );
1445                 $row = $this->fetchObject( $res );
1446
1447                 return $row ? ( strtolower( $row->default_transaction_read_only ) === 'on' ) : false;
1448         }
1449
1450         /**
1451          * @param string $lockName
1452          * @return string Integer
1453          */
1454         private function bigintFromLockName( $lockName ) {
1455                 return \Wikimedia\base_convert( substr( sha1( $lockName ), 0, 15 ), 16, 10 );
1456         }
1457 }
1458
1459 /**
1460  * @deprecated since 1.29
1461  */
1462 class_alias( DatabasePostgres::class, 'DatabasePostgres' );