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