wiki.techinc.nl/includes/db/DatabasePostgres.php

977 lines
25 KiB
PHP
Raw Normal View History

<?php
/**
2006-12-25 22:54:01 +00:00
* This is the Postgres database abstraction layer.
2006-01-07 13:09:30 +00:00
*
2010-08-01 21:13:44 +00:00
* @file
* @ingroup Database
*/
2010-08-01 21:13:44 +00:00
class PostgresField implements Field {
private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname;
/**
* @param $db DatabaseBase
* @param $table
* @param $field
* @return null|PostgresField
*/
static function fromText( $db, $table, $field ) {
global $wgDBmwschema;
$q = <<<SQL
2010-09-05 18:00:33 +00:00
SELECT
attnotnull, attlen, COALESCE(conname, '') AS conname,
COALESCE(condeferred, 'f') AS deferred,
COALESCE(condeferrable, 'f') AS deferrable,
CASE WHEN typname = 'int2' THEN 'smallint'
WHEN typname = 'int4' THEN 'integer'
WHEN typname = 'int8' THEN 'bigint'
WHEN typname = 'bpchar' THEN 'char'
ELSE typname END AS typname
FROM pg_class c
JOIN pg_namespace n ON (n.oid = c.relnamespace)
JOIN pg_attribute a ON (a.attrelid = c.oid)
JOIN pg_type t ON (t.oid = a.atttypid)
LEFT JOIN pg_constraint o ON (o.conrelid = c.oid AND a.attnum = ANY(o.conkey) AND o.contype = 'f')
WHERE relkind = 'r'
2007-03-25 23:53:36 +00:00
AND nspname=%s
AND relname=%s
AND attname=%s;
SQL;
$table = $db->tableName( $table, false );
2010-09-05 18:35:34 +00:00
$res = $db->query(
sprintf( $q,
$db->addQuotes( $wgDBmwschema ),
$db->addQuotes( $table ),
$db->addQuotes( $field )
)
);
$row = $db->fetchObject( $res );
if ( !$row ) {
return null;
2010-09-05 18:35:34 +00:00
}
$n = new PostgresField;
$n->type = $row->typname;
2010-09-05 18:35:34 +00:00
$n->nullable = ( $row->attnotnull == 'f' );
$n->name = $field;
$n->tablename = $table;
$n->max_length = $row->attlen;
2010-09-05 18:35:34 +00:00
$n->deferrable = ( $row->deferrable == 't' );
$n->deferred = ( $row->deferred == 't' );
$n->conname = $row->conname;
return $n;
}
function name() {
return $this->name;
}
function tableName() {
return $this->tablename;
}
function type() {
return $this->type;
}
function isNullable() {
return $this->nullable;
}
function maxLength() {
return $this->max_length;
}
function is_deferrable() {
return $this->deferrable;
}
function is_deferred() {
return $this->deferred;
}
function conname() {
return $this->conname;
}
}
/**
* @ingroup Database
*/
class DatabasePostgres extends DatabaseBase {
var $mInsertId = null;
var $mLastResult = null;
var $numeric_version = null;
var $mAffectedRows = null;
function getType() {
return 'postgres';
}
function cascadingDeletes() {
return true;
}
function cleanupTriggers() {
return true;
}
function strictIPs() {
return true;
}
function realTimestamps() {
return true;
}
function implicitGroupby() {
return false;
}
function implicitOrderby() {
return false;
}
2007-01-23 14:47:12 +00:00
function searchableIPs() {
return true;
}
function functionalIndexes() {
return true;
}
2007-01-23 14:47:12 +00:00
function hasConstraint( $name ) {
global $wgDBmwschema;
2010-10-14 20:53:04 +00:00
$SQL = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n WHERE c.connamespace = n.oid AND conname = '" .
pg_escape_string( $this->mConn, $name ) . "' AND n.nspname = '" . pg_escape_string( $this->mConn, $wgDBmwschema ) ."'";
$res = $this->doQuery( $SQL );
return $this->numRows( $res );
}
/**
* Usually aborts on failure
*/
function open( $server, $user, $password, $dbName ) {
# Test for Postgres support, to avoid suppressed fatal error
if ( !function_exists( 'pg_connect' ) ) {
throw new DBConnectionError( $this, "Postgres functions missing, have you compiled PHP with the --with-pgsql option?\n (Note: if you recently installed PHP, you may need to restart your webserver and database)\n" );
}
global $wgDBport;
2010-09-05 18:35:34 +00:00
if ( !strlen( $user ) ) { # e.g. the class is being loaded
return;
}
$this->close();
$this->mServer = $server;
2011-02-23 13:53:47 +00:00
$port = $wgDBport;
$this->mUser = $user;
$this->mPassword = $password;
$this->mDBname = $dbName;
2006-01-07 13:31:29 +00:00
$connectVars = array(
'dbname' => $dbName,
'user' => $user,
2010-09-05 18:35:34 +00:00
'password' => $password
);
if ( $server != false && $server != '' ) {
$connectVars['host'] = $server;
}
2010-09-05 18:35:34 +00:00
if ( $port != false && $port != '' ) {
$connectVars['port'] = $port;
}
$connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW );
$this->installErrorHandler();
$this->mConn = pg_connect( $connectString );
$phpError = $this->restoreErrorHandler();
if ( !$this->mConn ) {
wfDebug( "DB connection error\n" );
wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
2010-09-05 18:35:34 +00:00
wfDebug( $this->lastError() . "\n" );
PostgreSQL install fixes: * Made PG throw a DBQueryError when it gets a query error, instead of DBUnexpectedError. Apparently this mistake goes back to r14625, when exceptions were first introduced. Did it by removing reportQueryError(), the DatabaseBase version works fine. * Fixed several places where there was an attempt to check for a query error by checking if the result of query() was false. This never worked. Used try/catch instead. * Made the DBConnectionError messages go on one line so that they don't mess up the formatting in the installer. * In DatabasePostgres::selectDB(), only disconnect and reconnect if the DB name is actually changing. * Made DatabasePostgres::schemaExists() less weird and scary. * Added DatabasePostgres::roleExists() for use by the installer. * Removed the PostgreSQL-specific hack to make _InstallUser have a default other than "root". Made _InstallUser into a proper DBMS-specific internal variable instead, since every DBMS we support so far needs a different default. * Removed the $dbName parameters from openConnection/getConnection, and got rid of $this->useAdmin. Implemented a more sophisticated caching scheme instead. Partial revert of r89389 and r81440. * When connecting as the install user before DB creation, and when testing the web user's credentials, try a few different database names and use whichever one works. * Instead of connecting as the web user to create tables, I used SET ROLE. It seems cleaner and more like what the other DBMSes do during installation. "SET ROLE wikiuser" requires the same privileges as "CREATE SCHEMA ... AUTHORIZATION wikiuser", so it's unlikely to break anything. * In the area of web account creation, fixed various minor logic errors and introduced more informative error messages at the submit stage, pre-install. Show a helpful error message if the web user exists already and the install user can't do the relevant SET ROLE. * Split schema creation out to a separate install step. * When creating an account as a non-superuser, add the administrative account to the new account's group. This is necessary to avoid a fatal error during installation (bug 28845). * Removed code which alters an existing web user to have appropriate search paths and permissions. This may break other apps and is not necessary. As in other DBMSes, If the web user exists, it is the responsibility of the sysadmin to ensure that it has appropriate permissions. * Rewrote setupPLpgSQL() to use the query builder functions.
2011-06-10 11:32:57 +00:00
throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) );
}
$this->mOpened = true;
2006-08-18 16:24:48 +00:00
global $wgCommandLineMode;
2010-09-05 18:35:34 +00:00
# If called from the command-line (e.g. importDump), only show errors
if ( $wgCommandLineMode ) {
$this->doQuery( "SET client_min_messages = 'ERROR'" );
2006-08-18 16:24:48 +00:00
}
$this->query( "SET client_encoding='UTF8'", __METHOD__ );
$this->query( "SET datestyle = 'ISO, YMD'", __METHOD__ );
$this->query( "SET timezone = 'GMT'", __METHOD__ );
global $wgDBmwschema;
if ( $this->schemaExists( $wgDBmwschema ) ) {
$safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
$this->doQuery( "SET search_path = $safeschema" );
} else {
$this->doQuery( "SET search_path = public" );
}
return $this->mConn;
}
2006-01-07 13:31:29 +00:00
/**
* Postgres doesn't support selectDB in the same way MySQL does. So if the
* DB name doesn't match the open connection, open a new one
* @return
*/
function selectDB( $db ) {
PostgreSQL install fixes: * Made PG throw a DBQueryError when it gets a query error, instead of DBUnexpectedError. Apparently this mistake goes back to r14625, when exceptions were first introduced. Did it by removing reportQueryError(), the DatabaseBase version works fine. * Fixed several places where there was an attempt to check for a query error by checking if the result of query() was false. This never worked. Used try/catch instead. * Made the DBConnectionError messages go on one line so that they don't mess up the formatting in the installer. * In DatabasePostgres::selectDB(), only disconnect and reconnect if the DB name is actually changing. * Made DatabasePostgres::schemaExists() less weird and scary. * Added DatabasePostgres::roleExists() for use by the installer. * Removed the PostgreSQL-specific hack to make _InstallUser have a default other than "root". Made _InstallUser into a proper DBMS-specific internal variable instead, since every DBMS we support so far needs a different default. * Removed the $dbName parameters from openConnection/getConnection, and got rid of $this->useAdmin. Implemented a more sophisticated caching scheme instead. Partial revert of r89389 and r81440. * When connecting as the install user before DB creation, and when testing the web user's credentials, try a few different database names and use whichever one works. * Instead of connecting as the web user to create tables, I used SET ROLE. It seems cleaner and more like what the other DBMSes do during installation. "SET ROLE wikiuser" requires the same privileges as "CREATE SCHEMA ... AUTHORIZATION wikiuser", so it's unlikely to break anything. * In the area of web account creation, fixed various minor logic errors and introduced more informative error messages at the submit stage, pre-install. Show a helpful error message if the web user exists already and the install user can't do the relevant SET ROLE. * Split schema creation out to a separate install step. * When creating an account as a non-superuser, add the administrative account to the new account's group. This is necessary to avoid a fatal error during installation (bug 28845). * Removed code which alters an existing web user to have appropriate search paths and permissions. This may break other apps and is not necessary. As in other DBMSes, If the web user exists, it is the responsibility of the sysadmin to ensure that it has appropriate permissions. * Rewrote setupPLpgSQL() to use the query builder functions.
2011-06-10 11:32:57 +00:00
if ( $this->mDBname !== $db ) {
return (bool)$this->open( $this->mServer, $this->mUser, $this->mPassword, $db );
} else {
return true;
}
}
function makeConnectionString( $vars ) {
$s = '';
foreach ( $vars as $name => $value ) {
$s .= "$name='" . str_replace( "'", "\\'", $value ) . "' ";
}
return $s;
}
/**
* Closes a database connection, if it is open
* Returns success, true if already closed
*/
function close() {
$this->mOpened = false;
if ( $this->mConn ) {
return pg_close( $this->mConn );
} else {
return true;
}
}
2006-01-07 13:31:29 +00:00
protected function doQuery( $sql ) {
2010-09-05 18:35:34 +00:00
if ( function_exists( 'mb_convert_encoding' ) ) {
$sql = mb_convert_encoding( $sql, 'UTF-8' );
}
$this->mLastResult = pg_query( $this->mConn, $sql );
$this->mAffectedRows = null; // use pg_affected_rows(mLastResult)
return $this->mLastResult;
}
2006-01-07 13:31:29 +00:00
2010-11-26 12:06:50 +00:00
function queryIgnore( $sql, $fname = 'DatabasePostgres::queryIgnore' ) {
return $this->query( $sql, $fname, true );
}
2006-01-07 13:31:29 +00:00
function freeResult( $res ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
if ( !@pg_free_result( $res ) ) {
2010-09-05 18:35:34 +00:00
throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
}
}
2006-01-07 13:31:29 +00:00
function fetchObject( $res ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
@$row = pg_fetch_object( $res );
# @todo FIXME: HACK HACK HACK HACK debug
2006-01-07 13:31:29 +00:00
# @todo hashar: not sure if the following test really trigger if the object
# fetching failed.
2010-09-05 18:35:34 +00:00
if( pg_last_error( $this->mConn ) ) {
throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
}
return $row;
}
function fetchRow( $res ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
@$row = pg_fetch_array( $res );
2010-09-05 18:35:34 +00:00
if( pg_last_error( $this->mConn ) ) {
throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
}
return $row;
}
function numRows( $res ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
2006-01-07 13:09:30 +00:00
@$n = pg_num_rows( $res );
2010-09-05 18:35:34 +00:00
if( pg_last_error( $this->mConn ) ) {
throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
}
return $n;
}
2010-09-05 18:35:34 +00:00
function numFields( $res ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
return pg_num_fields( $res );
}
2010-09-05 18:35:34 +00:00
function fieldName( $res, $n ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
return pg_field_name( $res, $n );
}
2006-01-07 13:31:29 +00:00
/**
* This must be called after nextSequenceVal
*/
2006-01-07 13:09:30 +00:00
function insertId() {
return $this->mInsertId;
}
function dataSeek( $res, $row ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
return pg_result_seek( $res, $row );
}
function lastError() {
if ( $this->mConn ) {
return pg_last_error();
2010-09-05 18:35:34 +00:00
} else {
return 'No database connection';
}
}
function lastErrno() {
return pg_last_error() ? 1 : 0;
}
2006-01-07 13:09:30 +00:00
function affectedRows() {
if ( !is_null( $this->mAffectedRows ) ) {
// Forced result for simulated queries
return $this->mAffectedRows;
}
2010-09-05 18:35:34 +00:00
if( empty( $this->mLastResult ) ) {
return 0;
2010-09-05 18:35:34 +00:00
}
return pg_affected_rows( $this->mLastResult );
}
2006-01-07 13:31:29 +00:00
/**
* Estimate rows in dataset
* Returns estimated count, based on EXPLAIN output
* This is not necessarily an accurate estimate, so use sparingly
* Returns -1 if count cannot be found
* Takes same arguments as Database::select()
*/
2010-09-05 18:35:34 +00:00
function estimateRowCount( $table, $vars = '*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) {
$options['EXPLAIN'] = true;
$res = $this->select( $table, $vars, $conds, $fname, $options );
$rows = -1;
if ( $res ) {
$row = $this->fetchRow( $res );
$count = array();
if( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
$rows = $count[1];
}
}
return $rows;
}
/**
* Returns information about an index
* If errors are explicitly ignored, returns NULL on failure
*/
function indexInfo( $table, $index, $fname = 'DatabasePostgres::indexInfo' ) {
$sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
$res = $this->query( $sql, $fname );
if ( !$res ) {
return null;
}
foreach ( $res as $row ) {
if ( $row->indexname == $this->indexName( $index ) ) {
return $row;
}
}
return false;
}
2010-09-05 18:35:34 +00:00
function indexUnique( $table, $index, $fname = 'DatabasePostgres::indexUnique' ) {
2004-09-09 07:12:11 +00:00
$sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'".
2010-09-05 18:00:33 +00:00
" AND indexdef LIKE 'CREATE UNIQUE%(" .
$this->strencode( $this->indexName( $index ) ) .
")'";
2004-09-09 07:12:11 +00:00
$res = $this->query( $sql, $fname );
2010-09-05 18:35:34 +00:00
if ( !$res ) {
return null;
2010-09-05 18:35:34 +00:00
}
foreach ( $res as $row ) {
2004-09-09 07:12:11 +00:00
return true;
2010-09-05 18:35:34 +00:00
}
2004-09-09 07:12:11 +00:00
return false;
}
/**
* INSERT wrapper, inserts an array into a table
*
* $args may be a single associative array, or an array of these with numeric keys,
* for multi-row insert (Postgres version 8.2 and above only).
*
* @param $table String: Name of the table to insert to.
* @param $args Array: Items to insert into the table.
* @param $fname String: Name of the function, for profiling
* @param $options String or Array. Valid options: IGNORE
*
* @return bool Success of insert operation. IGNORE always returns true.
*/
function insert( $table, $args, $fname = 'DatabasePostgres::insert', $options = array() ) {
if ( !count( $args ) ) {
return true;
}
$table = $this->tableName( $table );
2010-07-25 22:09:34 +00:00
if (! isset( $this->numeric_version ) ) {
$this->getServerVersion();
}
2010-09-05 18:35:34 +00:00
if ( !is_array( $options ) ) {
$options = array( $options );
2010-09-05 18:35:34 +00:00
}
if ( isset( $args[0] ) && is_array( $args[0] ) ) {
$multi = true;
$keys = array_keys( $args[0] );
2010-09-05 18:35:34 +00:00
} else {
$multi = false;
$keys = array_keys( $args );
}
// If IGNORE is set, we use savepoints to emulate mysql's behavior
$ignore = in_array( 'IGNORE', $options ) ? 'mw' : '';
// If we are not in a transaction, we need to be for savepoint trickery
$didbegin = 0;
if ( $ignore ) {
2010-09-05 18:35:34 +00:00
if ( !$this->mTrxLevel ) {
$this->begin();
$didbegin = 1;
}
$olde = error_reporting( 0 );
// For future use, we may want to track the number of actual inserts
// Right now, insert (all writes) simply return true/false
$numrowsinserted = 0;
}
$sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
if ( $multi ) {
2010-07-25 22:09:34 +00:00
if ( $this->numeric_version >= 8.2 && !$ignore ) {
$first = true;
foreach ( $args as $row ) {
if ( $first ) {
$first = false;
} else {
$sql .= ',';
}
$sql .= '(' . $this->makeList( $row ) . ')';
}
$res = (bool)$this->query( $sql, $fname, $ignore );
2010-09-05 18:35:34 +00:00
} else {
$res = true;
$origsql = $sql;
foreach ( $args as $row ) {
$tempsql = $origsql;
$tempsql .= '(' . $this->makeList( $row ) . ')';
if ( $ignore ) {
2010-09-05 18:35:34 +00:00
pg_query( $this->mConn, "SAVEPOINT $ignore" );
}
$tempres = (bool)$this->query( $tempsql, $fname, $ignore );
if ( $ignore ) {
$bar = pg_last_error();
2010-09-05 18:35:34 +00:00
if ( $bar != false ) {
pg_query( $this->mConn, "ROLLBACK TO $ignore" );
2010-09-05 18:35:34 +00:00
} else {
pg_query( $this->mConn, "RELEASE $ignore" );
$numrowsinserted++;
}
}
// If any of them fail, we fail overall for this function call
// Note that this will be ignored if IGNORE is set
2010-09-05 18:35:34 +00:00
if ( !$tempres ) {
$res = false;
2010-09-05 18:35:34 +00:00
}
}
}
2010-09-05 18:35:34 +00:00
} else {
// Not multi, just a lone insert
if ( $ignore ) {
pg_query($this->mConn, "SAVEPOINT $ignore");
}
$sql .= '(' . $this->makeList( $args ) . ')';
$res = (bool)$this->query( $sql, $fname, $ignore );
if ( $ignore ) {
$bar = pg_last_error();
2010-09-05 18:35:34 +00:00
if ( $bar != false ) {
pg_query( $this->mConn, "ROLLBACK TO $ignore" );
2010-09-05 18:35:34 +00:00
} else {
pg_query( $this->mConn, "RELEASE $ignore" );
$numrowsinserted++;
}
}
}
if ( $ignore ) {
$olde = error_reporting( $olde );
2010-09-05 18:35:34 +00:00
if ( $didbegin ) {
$this->commit();
}
// Set the affected row count for the whole operation
$this->mAffectedRows = $numrowsinserted;
// IGNORE always returns true
return true;
}
return $res;
}
2006-01-07 13:31:29 +00:00
/**
* INSERT SELECT wrapper
* $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
* Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes()
* $conds may be "*" to copy the whole table
* srcTable may be an array of tables.
* @todo FIXME: Implement this a little better (seperate select/insert)?
2010-09-05 18:35:34 +00:00
*/
function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabasePostgres::insertSelect',
$insertOptions = array(), $selectOptions = array() )
{
$destTable = $this->tableName( $destTable );
// If IGNORE is set, we use savepoints to emulate mysql's behavior
$ignore = in_array( 'IGNORE', $insertOptions ) ? 'mw' : '';
if( is_array( $insertOptions ) ) {
$insertOptions = implode( ' ', $insertOptions );
}
if( !is_array( $selectOptions ) ) {
$selectOptions = array( $selectOptions );
}
list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
if( is_array( $srcTable ) ) {
$srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
} else {
$srcTable = $this->tableName( $srcTable );
}
// If we are not in a transaction, we need to be for savepoint trickery
$didbegin = 0;
if ( $ignore ) {
if( !$this->mTrxLevel ) {
$this->begin();
$didbegin = 1;
}
$olde = error_reporting( 0 );
$numrowsinserted = 0;
pg_query( $this->mConn, "SAVEPOINT $ignore");
}
$sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
" SELECT $startOpts " . implode( ',', $varMap ) .
" FROM $srcTable $useIndex";
2010-09-05 18:35:34 +00:00
if ( $conds != '*' ) {
$sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
}
$sql .= " $tailOpts";
$res = (bool)$this->query( $sql, $fname, $ignore );
if( $ignore ) {
$bar = pg_last_error();
if( $bar != false ) {
pg_query( $this->mConn, "ROLLBACK TO $ignore" );
} else {
pg_query( $this->mConn, "RELEASE $ignore" );
$numrowsinserted++;
}
$olde = error_reporting( $olde );
if( $didbegin ) {
$this->commit();
}
// Set the affected row count for the whole operation
$this->mAffectedRows = $numrowsinserted;
// IGNORE always returns true
return true;
}
return $res;
}
2010-09-05 18:00:33 +00:00
function tableName( $name, $quoted = true ) {
# Replace reserved words with better ones
switch( $name ) {
case 'user':
return 'mwuser';
case 'text':
return 'pagecontent';
default:
return parent::tableName( $name, $quoted );
}
}
/**
* Return the next in a sequence, save the value for retrieval via insertId()
*/
function nextSequenceValue( $seqName ) {
$safeseq = str_replace( "'", "''", $seqName );
$res = $this->query( "SELECT nextval('$safeseq')" );
$row = $this->fetchRow( $res );
$this->mInsertId = $row[0];
return $this->mInsertId;
}
2007-12-18 15:44:18 +00:00
/**
2009-11-27 15:19:05 +00:00
* Return the current value of a sequence. Assumes it has been nextval'ed in this session.
2007-12-18 15:44:18 +00:00
*/
function currentSequenceValue( $seqName ) {
$safeseq = str_replace( "'", "''", $seqName );
2007-12-18 15:44:18 +00:00
$res = $this->query( "SELECT currval('$safeseq')" );
$row = $this->fetchRow( $res );
$currval = $row[0];
return $currval;
}
# Returns the size of a text field, or -1 for "unlimited"
function textFieldSize( $table, $field ) {
$table = $this->tableName( $table );
$sql = "SELECT t.typname as ftype,a.atttypmod as size
2006-01-07 13:09:30 +00:00
FROM pg_class c, pg_attribute a, pg_type t
WHERE relname='$table' AND a.attrelid=c.oid AND
a.atttypid=t.oid and a.attname='$field'";
2010-09-05 18:35:34 +00:00
$res =$this->query( $sql );
$row = $this->fetchObject( $res );
if ( $row->ftype == 'varchar' ) {
$size = $row->size - 4;
} else {
2010-09-05 18:35:34 +00:00
$size = $row->size;
}
return $size;
}
2006-01-07 13:31:29 +00:00
2010-09-05 18:35:34 +00:00
function limitResult( $sql, $limit, $offset = false ) {
return "$sql LIMIT $limit " . ( is_numeric( $offset ) ? " OFFSET {$offset} " : '' );
}
2006-01-07 13:31:29 +00:00
function wasDeadlock() {
2006-12-25 22:54:01 +00:00
return $this->lastErrno() == '40P01';
}
function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabasePostgres::duplicateTableStructure' ) {
$newName = $this->addIdentifierQuotes( $newName );
$oldName = $this->addIdentifierQuotes( $oldName );
return $this->query( 'CREATE ' . ( $temporary ? 'TEMPORARY ' : '' ) . " TABLE $newName (LIKE $oldName INCLUDING DEFAULTS)", $fname );
}
2010-09-05 18:35:34 +00:00
function timestamp( $ts = 0 ) {
return wfTimestamp( TS_POSTGRES, $ts );
}
/**
* Return aggregated value function call
*/
2010-09-05 18:35:34 +00:00
function aggregateValue( $valuedata, $valuename = 'value' ) {
return $valuedata;
}
/**
* @return string wikitext of a link to the server software's web site
*/
public static function getSoftwareLink() {
2010-09-05 18:35:34 +00:00
return '[http://www.postgresql.org/ PostgreSQL]';
}
2006-01-07 13:31:29 +00:00
/**
* @return string Version information from the database
*/
function getServerVersion() {
if ( !isset( $this->numeric_version ) ) {
2010-07-25 22:09:34 +00:00
$versionInfo = pg_version( $this->mConn );
if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
// Old client, abort install
$this->numeric_version = '7.3 or earlier';
} elseif ( isset( $versionInfo['server'] ) ) {
// Normal client
$this->numeric_version = $versionInfo['server'];
} else {
// Bug 16937: broken pgsql extension from PHP<5.3
$this->numeric_version = pg_parameter_status( $this->mConn, 'server_version' );
}
}
return $this->numeric_version;
}
/**
* Query whether a given relation exists (in the given schema, or the
* default mw one if not given)
*/
function relationExists( $table, $types, $schema = false ) {
global $wgDBmwschema;
2010-09-05 18:35:34 +00:00
if ( !is_array( $types ) ) {
$types = array( $types );
2010-09-05 18:35:34 +00:00
}
if ( !$schema ) {
$schema = $wgDBmwschema;
2010-09-05 18:35:34 +00:00
}
$table = $this->tableName( $table, false );
$etable = $this->addQuotes( $table );
$eschema = $this->addQuotes( $schema );
$SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
. "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
2010-09-05 18:35:34 +00:00
. "AND c.relkind IN ('" . implode( "','", $types ) . "')";
$res = $this->query( $SQL );
$count = $res ? $res->numRows() : 0;
return (bool)$count;
}
2010-09-05 18:35:34 +00:00
/**
* For backward compatibility, this function checks both tables and
* views.
*/
function tableExists( $table, $schema = false ) {
return $this->relationExists( $table, array( 'r', 'v' ), $schema );
}
function sequenceExists( $sequence, $schema = false ) {
return $this->relationExists( $sequence, 'S', $schema );
}
function triggerExists( $table, $trigger ) {
global $wgDBmwschema;
$q = <<<SQL
SELECT 1 FROM pg_class, pg_namespace, pg_trigger
WHERE relnamespace=pg_namespace.oid AND relkind='r'
AND tgrelid=pg_class.oid
AND nspname=%s AND relname=%s AND tgname=%s
SQL;
2010-09-05 18:35:34 +00:00
$res = $this->query(
sprintf(
$q,
$this->addQuotes( $wgDBmwschema ),
$this->addQuotes( $table ),
$this->addQuotes( $trigger )
)
);
if ( !$res ) {
return null;
2010-09-05 18:35:34 +00:00
}
$rows = $res->numRows();
return $rows;
}
function ruleExists( $table, $rule ) {
global $wgDBmwschema;
2010-09-05 18:35:34 +00:00
$exists = $this->selectField( 'pg_rules', 'rulename',
array(
'rulename' => $rule,
'tablename' => $table,
'schemaname' => $wgDBmwschema
)
);
return $exists === $rule;
}
function constraintExists( $table, $constraint ) {
global $wgDBmwschema;
2010-09-05 18:35:34 +00:00
$SQL = sprintf( "SELECT 1 FROM information_schema.table_constraints ".
"WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
2010-09-05 18:35:34 +00:00
$this->addQuotes( $wgDBmwschema ),
$this->addQuotes( $table ),
$this->addQuotes( $constraint )
);
$res = $this->query( $SQL );
if ( !$res ) {
return null;
2010-09-05 18:35:34 +00:00
}
$rows = $res->numRows();
return $rows;
}
/**
PostgreSQL install fixes: * Made PG throw a DBQueryError when it gets a query error, instead of DBUnexpectedError. Apparently this mistake goes back to r14625, when exceptions were first introduced. Did it by removing reportQueryError(), the DatabaseBase version works fine. * Fixed several places where there was an attempt to check for a query error by checking if the result of query() was false. This never worked. Used try/catch instead. * Made the DBConnectionError messages go on one line so that they don't mess up the formatting in the installer. * In DatabasePostgres::selectDB(), only disconnect and reconnect if the DB name is actually changing. * Made DatabasePostgres::schemaExists() less weird and scary. * Added DatabasePostgres::roleExists() for use by the installer. * Removed the PostgreSQL-specific hack to make _InstallUser have a default other than "root". Made _InstallUser into a proper DBMS-specific internal variable instead, since every DBMS we support so far needs a different default. * Removed the $dbName parameters from openConnection/getConnection, and got rid of $this->useAdmin. Implemented a more sophisticated caching scheme instead. Partial revert of r89389 and r81440. * When connecting as the install user before DB creation, and when testing the web user's credentials, try a few different database names and use whichever one works. * Instead of connecting as the web user to create tables, I used SET ROLE. It seems cleaner and more like what the other DBMSes do during installation. "SET ROLE wikiuser" requires the same privileges as "CREATE SCHEMA ... AUTHORIZATION wikiuser", so it's unlikely to break anything. * In the area of web account creation, fixed various minor logic errors and introduced more informative error messages at the submit stage, pre-install. Show a helpful error message if the web user exists already and the install user can't do the relevant SET ROLE. * Split schema creation out to a separate install step. * When creating an account as a non-superuser, add the administrative account to the new account's group. This is necessary to avoid a fatal error during installation (bug 28845). * Removed code which alters an existing web user to have appropriate search paths and permissions. This may break other apps and is not necessary. As in other DBMSes, If the web user exists, it is the responsibility of the sysadmin to ensure that it has appropriate permissions. * Rewrote setupPLpgSQL() to use the query builder functions.
2011-06-10 11:32:57 +00:00
* Query whether a given schema exists. Returns true if it does, false if it doesn't.
*/
function schemaExists( $schema ) {
PostgreSQL install fixes: * Made PG throw a DBQueryError when it gets a query error, instead of DBUnexpectedError. Apparently this mistake goes back to r14625, when exceptions were first introduced. Did it by removing reportQueryError(), the DatabaseBase version works fine. * Fixed several places where there was an attempt to check for a query error by checking if the result of query() was false. This never worked. Used try/catch instead. * Made the DBConnectionError messages go on one line so that they don't mess up the formatting in the installer. * In DatabasePostgres::selectDB(), only disconnect and reconnect if the DB name is actually changing. * Made DatabasePostgres::schemaExists() less weird and scary. * Added DatabasePostgres::roleExists() for use by the installer. * Removed the PostgreSQL-specific hack to make _InstallUser have a default other than "root". Made _InstallUser into a proper DBMS-specific internal variable instead, since every DBMS we support so far needs a different default. * Removed the $dbName parameters from openConnection/getConnection, and got rid of $this->useAdmin. Implemented a more sophisticated caching scheme instead. Partial revert of r89389 and r81440. * When connecting as the install user before DB creation, and when testing the web user's credentials, try a few different database names and use whichever one works. * Instead of connecting as the web user to create tables, I used SET ROLE. It seems cleaner and more like what the other DBMSes do during installation. "SET ROLE wikiuser" requires the same privileges as "CREATE SCHEMA ... AUTHORIZATION wikiuser", so it's unlikely to break anything. * In the area of web account creation, fixed various minor logic errors and introduced more informative error messages at the submit stage, pre-install. Show a helpful error message if the web user exists already and the install user can't do the relevant SET ROLE. * Split schema creation out to a separate install step. * When creating an account as a non-superuser, add the administrative account to the new account's group. This is necessary to avoid a fatal error during installation (bug 28845). * Removed code which alters an existing web user to have appropriate search paths and permissions. This may break other apps and is not necessary. As in other DBMSes, If the web user exists, it is the responsibility of the sysadmin to ensure that it has appropriate permissions. * Rewrote setupPLpgSQL() to use the query builder functions.
2011-06-10 11:32:57 +00:00
$exists = $this->selectField( '"pg_catalog"."pg_namespace"', 1,
array( 'nspname' => $schema ), __METHOD__ );
return (bool)$exists;
}
/**
* Returns true if a given role (i.e. user) exists, false otherwise.
*/
function roleExists( $roleName ) {
$exists = $this->selectField( '"pg_catalog"."pg_roles"', 1,
array( 'rolname' => $roleName ), __METHOD__ );
return (bool)$exists;
}
function fieldInfo( $table, $field ) {
2010-09-05 18:35:34 +00:00
return PostgresField::fromText( $this, $table, $field );
}
2010-09-05 18:00:33 +00:00
/**
* pg_field_type() wrapper
*/
function fieldType( $res, $index ) {
if ( $res instanceof ResultWrapper ) {
$res = $res->result;
}
return pg_field_type( $res, $index );
}
/* Not even sure why this is used in the main codebase... */
function limitResultForUpdate( $sql, $num ) {
return $sql;
}
2011-05-28 14:52:55 +00:00
/**
* @param $b
* @return Blob
*/
function encodeBlob( $b ) {
2010-09-05 18:35:34 +00:00
return new Blob( pg_escape_bytea( $this->mConn, $b ) );
}
function decodeBlob( $b ) {
2010-09-05 18:35:34 +00:00
if ( $b instanceof Blob ) {
$b = $b->fetch();
}
return pg_unescape_bytea( $b );
}
2010-09-05 18:35:34 +00:00
function strencode( $s ) { # Should not be called by us
return pg_escape_string( $this->mConn, $s );
}
2011-05-28 14:52:55 +00:00
/**
* @param $s null|bool|Blob
* @return int|string
*/
function addQuotes( $s ) {
if ( is_null( $s ) ) {
return 'NULL';
2010-09-05 18:35:34 +00:00
} elseif ( is_bool( $s ) ) {
return intval( $s );
2010-09-05 18:35:34 +00:00
} elseif ( $s instanceof Blob ) {
return "'" . $s->fetch( $s ) . "'";
}
return "'" . pg_escape_string( $this->mConn, $s ) . "'";
}
/**
* Postgres specific version of replaceVars.
* Calls the parent version in Database.php
*
* @private
*
* @param $ins String: SQL string, read from a stream (usually tables.sql)
*
* @return string SQL string
*/
protected function replaceVars( $ins ) {
$ins = parent::replaceVars( $ins );
2010-09-05 18:35:34 +00:00
if ( $this->numeric_version >= 8.3 ) {
// Thanks for not providing backwards-compatibility, 8.3
$ins = preg_replace( "/to_tsvector\s*\(\s*'default'\s*,/", 'to_tsvector(', $ins );
}
2010-09-05 18:35:34 +00:00
if ( $this->numeric_version <= 8.1 ) { // Our minimum version
$ins = str_replace( 'USING gin', 'USING gist', $ins );
}
return $ins;
}
2006-12-25 22:54:01 +00:00
/**
2007-05-02 17:35:50 +00:00
* Various select options
2006-12-25 22:54:01 +00:00
*
* @private
*
* @param $options Array: an associative array of options to be turned into
2006-12-25 22:54:01 +00:00
* an SQL query, valid keys are listed in the function.
* @return array
*/
function makeSelectOptions( $options ) {
$preLimitTail = $postLimitTail = '';
2007-05-02 17:35:50 +00:00
$startOpts = $useIndex = '';
2006-12-25 22:54:01 +00:00
$noKeyOptions = array();
foreach ( $options as $key => $option ) {
if ( is_numeric( $key ) ) {
$noKeyOptions[$option] = true;
}
}
2010-09-05 18:35:34 +00:00
if ( isset( $options['GROUP BY'] ) ) {
$gb = is_array( $options['GROUP BY'] )
? implode( ',', $options['GROUP BY'] )
: $options['GROUP BY'];
$preLimitTail .= " GROUP BY {$gb}";
2010-09-05 18:35:34 +00:00
}
2010-09-05 18:35:34 +00:00
if ( isset( $options['HAVING'] ) ) {
$preLimitTail .= " HAVING {$options['HAVING']}";
}
2010-09-05 18:35:34 +00:00
if ( isset( $options['ORDER BY'] ) ) {
$ob = is_array( $options['ORDER BY'] )
? implode( ',', $options['ORDER BY'] )
: $options['ORDER BY'];
$preLimitTail .= " ORDER BY {$ob}";
2010-09-05 18:35:34 +00:00
}
2010-09-05 18:35:34 +00:00
//if ( isset( $options['LIMIT'] ) ) {
// $tailOpts .= $this->limitResult( '', $options['LIMIT'],
// isset( $options['OFFSET'] ) ? $options['OFFSET']
// : false );
//}
2006-12-25 22:54:01 +00:00
2010-09-05 18:35:34 +00:00
if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
$postLimitTail .= ' FOR UPDATE';
}
if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
$postLimitTail .= ' LOCK IN SHARE MODE';
}
if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
$startOpts .= 'DISTINCT';
}
return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
2006-12-25 22:54:01 +00:00
}
function setFakeMaster( $enabled = true ) {}
function getDBname() {
return $this->mDBname;
}
function getServer() {
return $this->mServer;
}
function buildConcat( $stringList ) {
return implode( ' || ', $stringList );
}
public function getSearchEngine() {
2010-09-05 18:35:34 +00:00
return 'SearchPostgres';
}
2006-12-25 17:25:18 +00:00
} // end DatabasePostgres class