X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fdb%2FDatabasePostgres.php;h=1f1d7ed1b4c3eb3a77375473aee1217faf6b5ca2;hb=94633ff448e9253c5503124df6748be1fc26b8e2;hp=88535e73d45e074298dcd5941a7578ced556b4dc;hpb=9e6c7cc8efda090a5fa292b37eb20ba7c2ad0c87;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/db/DatabasePostgres.php b/includes/db/DatabasePostgres.php index 88535e73d4..1f1d7ed1b4 100644 --- a/includes/db/DatabasePostgres.php +++ b/includes/db/DatabasePostgres.php @@ -6,14 +6,20 @@ * @ingroup Database */ -class PostgresField { +class PostgresField implements Field { private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname; - static function fromText($db, $table, $field) { - global $wgDBmwschema; + /** + * @param $db DatabaseBase + * @param $table + * @param $field + * @return null|PostgresField + */ + static function fromText( $db, $table, $field ) { + global $wgDBmwschema; $q = <<tableName( $table ); - $res = $db->query(sprintf($q, - $db->addQuotes($wgDBmwschema), - $db->addQuotes($table), - $db->addQuotes($field))); - $row = $db->fetchObject($res); - if (!$row) + $table = $db->tableName( $table, 'raw' ); + $res = $db->query( + sprintf( $q, + $db->addQuotes( $wgDBmwschema ), + $db->addQuotes( $table ), + $db->addQuotes( $field ) + ) + ); + $row = $db->fetchObject( $res ); + if ( !$row ) { return null; + } $n = new PostgresField; $n->type = $row->typname; - $n->nullable = ($row->attnotnull == 'f'); + $n->nullable = ( $row->attnotnull == 'f' ); $n->name = $field; $n->tablename = $table; $n->max_length = $row->attlen; - $n->deferrable = ($row->deferrable == 't'); - $n->deferred = ($row->deferred == 't'); + $n->deferrable = ( $row->deferrable == 't' ); + $n->deferred = ( $row->deferred == 't' ); $n->conname = $row->conname; return $n; } @@ -65,7 +75,7 @@ SQL; return $this->type; } - function nullable() { + function isNullable() { return $this->nullable; } @@ -96,16 +106,6 @@ class DatabasePostgres extends DatabaseBase { var $numeric_version = null; var $mAffectedRows = null; - function __construct($server = false, $user = false, $password = false, $dbName = false, - $failFunction = false, $flags = 0 ) - { - - $this->mFailFunction = $failFunction; - $this->mFlags = $flags; - $this->open( $server, $user, $password, $dbName); - - } - function getType() { return 'postgres'; } @@ -137,18 +137,15 @@ class DatabasePostgres extends DatabaseBase { function hasConstraint( $name ) { global $wgDBmwschema; - $SQL = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n WHERE c.connamespace = n.oid AND conname = '" . pg_escape_string( $name ) . "' AND n.nspname = '" . pg_escape_string($wgDBmwschema) ."'"; - return $this->numRows($res = $this->doQuery($SQL)); - } - - static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0) - { - return new DatabasePostgres( $server, $user, $password, $dbName, $failFunction, $flags ); + $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 - * If the failFunction is set to a non-zero integer, returns success + * @return DatabaseBase|null */ function open( $server, $user, $password, $dbName ) { # Test for Postgres support, to avoid suppressed fatal error @@ -158,12 +155,12 @@ class DatabasePostgres extends DatabaseBase { global $wgDBport; - if (!strlen($user)) { ## e.g. the class is being loaded + if ( !strlen( $user ) ) { # e.g. the class is being loaded return; } - $this->close(); + $this->mServer = $server; - $this->mPort = $port = $wgDBport; + $port = $wgDBport; $this->mUser = $user; $this->mPassword = $password; $this->mDBname = $dbName; @@ -171,54 +168,68 @@ class DatabasePostgres extends DatabaseBase { $connectVars = array( 'dbname' => $dbName, 'user' => $user, - 'password' => $password ); - if ($server!=false && $server!="") { + 'password' => $password + ); + if ( $server != false && $server != '' ) { $connectVars['host'] = $server; } - if ($port!=false && $port!="") { + if ( $port != false && $port != '' ) { $connectVars['port'] = $port; } - $connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW ); + $this->connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW ); + $this->reOpen(); + } + function reOpen() { + $this->close(); $this->installErrorHandler(); - $this->mConn = pg_connect( $connectString ); + $this->mConn = pg_connect( $this->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" ); - wfDebug( $this->lastError()."\n" ); - if ( !$this->mFailFunction ) { - throw new DBConnectionError( $this, $phpError ); - } else { - return false; - } + wfDebug( $this->lastError() . "\n" ); + throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) ); } $this->mOpened = true; global $wgCommandLineMode; - ## If called from the command-line (e.g. importDump), only show errors - if ($wgCommandLineMode) { + # If called from the command-line (e.g. importDump), only show errors + if ( $wgCommandLineMode ) { $this->doQuery( "SET client_min_messages = 'ERROR'" ); } - $this->doQuery( "SET client_encoding='UTF8'" ); + $this->query( "SET client_encoding='UTF8'", __METHOD__ ); + $this->query( "SET datestyle = 'ISO, YMD'", __METHOD__ ); + $this->query( "SET timezone = 'GMT'", __METHOD__ ); + $this->query( "SET standard_conforming_strings = on", __METHOD__ ); - global $wgDBmwschema, $wgDBts2schema; - if (isset( $wgDBmwschema ) && isset( $wgDBts2schema ) - && $wgDBmwschema !== 'mediawiki' - && preg_match( '/^\w+$/', $wgDBmwschema ) - && preg_match( '/^\w+$/', $wgDBts2schema ) - ) { - $safeschema = $this->quote_ident($wgDBmwschema); - $safeschema2 = $this->quote_ident($wgDBts2schema); - $this->doQuery( "SET search_path = $safeschema, $wgDBts2schema, public" ); + 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; } + /** + * 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 ) { + 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 ) { @@ -227,389 +238,32 @@ class DatabasePostgres extends DatabaseBase { return $s; } - - function initial_setup($superuser, $password, $dbName) { - // If this is the initial connection, setup the schema stuff and possibly create the user - global $wgDBname, $wgDBuser, $wgDBpassword, $wgDBmwschema, $wgDBts2schema; - - print "
  • Checking the version of Postgres..."; - $version = $this->getServerVersion(); - $PGMINVER = '8.1'; - if ($version < $PGMINVER) { - print "FAILED. Required version is $PGMINVER. You have " . htmlspecialchars( $version ) . "
  • \n"; - dieout(""); - } - print "version " . htmlspecialchars( $this->numeric_version ) . " is OK.\n"; - - $safeuser = $this->quote_ident($wgDBuser); - // Are we connecting as a superuser for the first time? - if ($superuser) { - // Are we really a superuser? Check out our rights - $SQL = "SELECT - CASE WHEN usesuper IS TRUE THEN - CASE WHEN usecreatedb IS TRUE THEN 3 ELSE 1 END - ELSE CASE WHEN usecreatedb IS TRUE THEN 2 ELSE 0 END - END AS rights - FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes($superuser); - $rows = $this->numRows($res = $this->doQuery($SQL)); - if (!$rows) { - print "
  • ERROR: Could not read permissions for user \"" . htmlspecialchars( $superuser ) . "\"
  • \n"; - dieout(''); - } - $perms = pg_fetch_result($res, 0, 0); - - $SQL = "SELECT 1 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes($wgDBuser); - $rows = $this->numRows($this->doQuery($SQL)); - if ($rows) { - print "
  • User \"" . htmlspecialchars( $wgDBuser ) . "\" already exists, skipping account creation.
  • "; - } - else { - if ($perms != 1 and $perms != 3) { - print "
  • ERROR: the user \"" . htmlspecialchars( $superuser ) . "\" cannot create other users. "; - print 'Please use a different Postgres user.
  • '; - dieout(''); - } - print "
  • Creating user " . htmlspecialchars( $wgDBuser ) . "..."; - $safepass = $this->addQuotes($wgDBpassword); - $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass"; - $this->doQuery($SQL); - print "OK
  • \n"; - } - // User now exists, check out the database - if ($dbName != $wgDBname) { - $SQL = "SELECT 1 FROM pg_catalog.pg_database WHERE datname = " . $this->addQuotes($wgDBname); - $rows = $this->numRows($this->doQuery($SQL)); - if ($rows) { - print "
  • Database \"" . htmlspecialchars( $wgDBname ) . "\" already exists, skipping database creation.
  • "; - } - else { - if ($perms < 1) { - print "
  • ERROR: the user \"" . htmlspecialchars( $superuser ) . "\" cannot create databases. "; - print 'Please use a different Postgres user.
  • '; - dieout(''); - } - print "
  • Creating database " . htmlspecialchars( $wgDBname ) . "..."; - $safename = $this->quote_ident($wgDBname); - $SQL = "CREATE DATABASE $safename OWNER $safeuser "; - $this->doQuery($SQL); - print "OK
  • \n"; - // Hopefully tsearch2 and plpgsql are in template1... - } - - // Reconnect to check out tsearch2 rights for this user - print "
  • Connecting to \"" . htmlspecialchars( $wgDBname ) . "\" as superuser \"" . - htmlspecialchars( $superuser ) . "\" to check rights..."; - - $connectVars = array(); - if ($this->mServer!=false && $this->mServer!="") { - $connectVars['host'] = $this->mServer; - } - if ($this->mPort!=false && $this->mPort!="") { - $connectVars['port'] = $this->mPort; - } - $connectVars['dbname'] = $wgDBname; - $connectVars['user'] = $superuser; - $connectVars['password'] = $password; - - @$this->mConn = pg_connect( $this->makeConnectionString( $connectVars ) ); - if ( !$this->mConn ) { - print "FAILED TO CONNECT!
  • "; - dieout(""); - } - print "OK\n"; - } - - if ($this->numeric_version < 8.3) { - // Tsearch2 checks - print "
  • Checking that tsearch2 is installed in the database \"" . - htmlspecialchars( $wgDBname ) . "\"..."; - if (! $this->tableExists("pg_ts_cfg", $wgDBts2schema)) { - print "FAILED. tsearch2 must be installed in the database \"" . - htmlspecialchars( $wgDBname ) . "\"."; - print "Please see this article"; - print " for instructions or ask on #postgresql on irc.freenode.net
  • \n"; - dieout(""); - } - print "OK\n"; - print "
  • Ensuring that user \"" . htmlspecialchars( $wgDBuser ) . - "\" has select rights on the tsearch2 tables..."; - foreach (array('cfg','cfgmap','dict','parser') as $table) { - $SQL = "GRANT SELECT ON pg_ts_$table TO $safeuser"; - $this->doQuery($SQL); - } - print "OK
  • \n"; - } - - // Setup the schema for this user if needed - $result = $this->schemaExists($wgDBmwschema); - $safeschema = $this->quote_ident($wgDBmwschema); - if (!$result) { - print "
  • Creating schema " . htmlspecialchars( $wgDBmwschema ) . " ..."; - $result = $this->doQuery("CREATE SCHEMA $safeschema AUTHORIZATION $safeuser"); - if (!$result) { - print "FAILED.
  • \n"; - dieout(""); - } - print "OK\n"; - } - else { - print "
  • Schema already exists, explicitly granting rights...\n"; - $safeschema2 = $this->addQuotes($wgDBmwschema); - $SQL = "SELECT 'GRANT ALL ON '||pg_catalog.quote_ident(relname)||' TO $safeuser;'\n". - "FROM pg_catalog.pg_class p, pg_catalog.pg_namespace n\n". - "WHERE relnamespace = n.oid AND n.nspname = $safeschema2\n". - "AND p.relkind IN ('r','S','v')\n"; - $SQL .= "UNION\n"; - $SQL .= "SELECT 'GRANT ALL ON FUNCTION '||pg_catalog.quote_ident(proname)||'('||\n". - "pg_catalog.oidvectortypes(p.proargtypes)||') TO $safeuser;'\n". - "FROM pg_catalog.pg_proc p, pg_catalog.pg_namespace n\n". - "WHERE p.pronamespace = n.oid AND n.nspname = $safeschema2"; - $res = $this->doQuery($SQL); - if (!$res) { - print "FAILED. Could not set rights for the user.
  • \n"; - dieout(""); - } - $this->doQuery("SET search_path = $safeschema"); - $rows = $this->numRows($res); - while ($rows) { - $rows--; - $this->doQuery(pg_fetch_result($res, $rows, 0)); - } - print "OK"; - } - - // Install plpgsql if needed - $this->setup_plpgsql(); - - $superuser = ''; - return true; // Reconnect as regular user - - } // end superuser - - if (!defined('POSTGRES_SEARCHPATH')) { - - if ($this->numeric_version < 8.3) { - // Do we have the basic tsearch2 table? - print "
  • Checking for tsearch2 in the schema \"" . htmlspecialchars( $wgDBts2schema ) . "\"..."; - if (! $this->tableExists("pg_ts_dict", $wgDBts2schema)) { - print "FAILED. Make sure tsearch2 is installed. See this article"; - print " for instructions.
  • \n"; - dieout(""); - } - print "OK\n"; - - // Does this user have the rights to the tsearch2 tables? - $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0); - print "
  • Checking tsearch2 permissions..."; - // Let's check all four, just to be safe - error_reporting( 0 ); - $ts2tables = array('cfg','cfgmap','dict','parser'); - $safetsschema = $this->quote_ident($wgDBts2schema); - foreach ( $ts2tables AS $tname ) { - $SQL = "SELECT count(*) FROM $safetsschema.pg_ts_$tname"; - $res = $this->doQuery($SQL); - if (!$res) { - print "FAILED to access " . htmlspecialchars( "pg_ts_$tname" ) . - ". Make sure that the user \"". htmlspecialchars( $wgDBuser ) . - "\" has SELECT access to all four tsearch2 tables
  • \n"; - dieout(""); - } - } - $SQL = "SELECT ts_name FROM $safetsschema.pg_ts_cfg WHERE locale = " . $this->addQuotes( $ctype ) ; - $SQL .= " ORDER BY CASE WHEN ts_name <> 'default' THEN 1 ELSE 0 END"; - $res = $this->doQuery($SQL); - error_reporting( E_ALL ); - if (!$res) { - print "FAILED. Could not determine the tsearch2 locale information\n"; - dieout(""); - } - print "OK"; - - // Will the current locale work? Can we force it to? - print "
  • Verifying tsearch2 locale with " . htmlspecialchars( $ctype ) . "..."; - $rows = $this->numRows($res); - $resetlocale = 0; - if (!$rows) { - print "not found
  • \n"; - print "
  • Attempting to set default tsearch2 locale to \"" . htmlspecialchars( $ctype ) . "\"..."; - $resetlocale = 1; - } - else { - $tsname = pg_fetch_result($res, 0, 0); - if ($tsname != 'default') { - print "not set to default (" . htmlspecialchars( $tsname ) . ")"; - print "
  • Attempting to change tsearch2 default locale to \"" . - htmlspecialchars( $ctype ) . "\"..."; - $resetlocale = 1; - } - } - if ($resetlocale) { - $SQL = "UPDATE $safetsschema.pg_ts_cfg SET locale = " . $this->addQuotes( $ctype ) . " WHERE ts_name = 'default'"; - $res = $this->doQuery($SQL); - if (!$res) { - print "FAILED. "; - print "Please make sure that the locale in pg_ts_cfg for \"default\" is set to \"" . - htmlspecialchars( $ctype ) . "\"
  • \n"; - dieout(""); - } - print "OK"; - } - - // Final test: try out a simple tsearch2 query - $SQL = "SELECT $safetsschema.to_tsvector('default','MediaWiki tsearch2 testing')"; - $res = $this->doQuery($SQL); - if (!$res) { - print "FAILED. Specifically, \"" . htmlspecialchars( $SQL ) . "\" did not work."; - dieout(""); - } - print "OK"; - } - - // Install plpgsql if needed - $this->setup_plpgsql(); - - // Does the schema already exist? Who owns it? - $result = $this->schemaExists($wgDBmwschema); - if (!$result) { - print "
  • Creating schema " . htmlspecialchars( $wgDBmwschema ) . " ..."; - error_reporting( 0 ); - $safeschema = $this->quote_ident($wgDBmwschema); - $result = $this->doQuery("CREATE SCHEMA $safeschema"); - error_reporting( E_ALL ); - if (!$result) { - print "FAILED. The user \"" . htmlspecialchars( $wgDBuser ) . - "\" must be able to access the schema. ". - "You can try making them the owner of the database, or try creating the schema with a ". - "different user, and then grant access to the \"" . - htmlspecialchars( $wgDBuser ) . "\" user.
  • \n"; - dieout(""); - } - print "OK\n"; - } - else if ($result != $wgDBuser) { - print "
  • Schema \"" . htmlspecialchars( $wgDBmwschema ) . "\" exists but is not owned by \"" . - htmlspecialchars( $wgDBuser ) . "\". Not ideal.
  • \n"; - } - else { - print "
  • Schema \"" . htmlspecialchars( $wgDBmwschema ) . "\" exists and is owned by \"" . - htmlspecialchars( $wgDBuser ) . "\". Excellent.
  • \n"; - } - - // Always return GMT time to accomodate the existing integer-based timestamp assumption - print "
  • Setting the timezone to GMT for user \"" . htmlspecialchars( $wgDBuser ) . "\" ..."; - $SQL = "ALTER USER $safeuser SET timezone = 'GMT'"; - $result = pg_query($this->mConn, $SQL); - if (!$result) { - print "FAILED.
  • \n"; - dieout(""); - } - print "OK\n"; - // Set for the rest of this session - $SQL = "SET timezone = 'GMT'"; - $result = pg_query($this->mConn, $SQL); - if (!$result) { - print "
  • Failed to set timezone
  • \n"; - dieout(""); - } - - print "
  • Setting the datestyle to ISO, YMD for user \"" . htmlspecialchars( $wgDBuser ) . "\" ..."; - $SQL = "ALTER USER $safeuser SET datestyle = 'ISO, YMD'"; - $result = pg_query($this->mConn, $SQL); - if (!$result) { - print "FAILED.
  • \n"; - dieout(""); - } - print "OK\n"; - // Set for the rest of this session - $SQL = "SET datestyle = 'ISO, YMD'"; - $result = pg_query($this->mConn, $SQL); - if (!$result) { - print "
  • Failed to set datestyle
  • \n"; - dieout(""); - } - - // Fix up the search paths if needed - print "
  • Setting the search path for user \"" . htmlspecialchars( $wgDBuser ) . "\" ..."; - $path = $this->quote_ident($wgDBmwschema); - if ($wgDBts2schema !== $wgDBmwschema) - $path .= ", ". $this->quote_ident($wgDBts2schema); - if ($wgDBmwschema !== 'public' and $wgDBts2schema !== 'public') - $path .= ", public"; - $SQL = "ALTER USER $safeuser SET search_path = $path"; - $result = pg_query($this->mConn, $SQL); - if (!$result) { - print "FAILED.
  • \n"; - dieout(""); - } - print "OK\n"; - // Set for the rest of this session - $SQL = "SET search_path = $path"; - $result = pg_query($this->mConn, $SQL); - if (!$result) { - print "
  • Failed to set search_path
  • \n"; - dieout(""); - } - define( "POSTGRES_SEARCHPATH", $path ); - } - } - - - function setup_plpgsql() { - print "
  • Checking for PL/pgSQL ..."; - $SQL = "SELECT 1 FROM pg_catalog.pg_language WHERE lanname = 'plpgsql'"; - $rows = $this->numRows($this->doQuery($SQL)); - if ($rows < 1) { - // plpgsql is not installed, but if we have a pg_pltemplate table, we should be able to create it - print "not installed. Attempting to install PL/pgSQL ..."; - $SQL = "SELECT 1 FROM pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace) ". - "WHERE relname = 'pg_pltemplate' AND nspname='pg_catalog'"; - $rows = $this->numRows($this->doQuery($SQL)); - global $wgDBname; - if ($rows >= 1) { - $olde = error_reporting(0); - error_reporting($olde - E_WARNING); - $result = $this->doQuery("CREATE LANGUAGE plpgsql"); - error_reporting($olde); - if (!$result) { - print "FAILED. You need to install the language PL/pgSQL in the database " . - htmlspecialchars( $wgDBname ) . "
  • "; - dieout(""); - } - } - else { - print "FAILED. You need to install the language PL/pgSQL in the database " . - htmlspecialchars( $wgDBname ) . ""; - dieout(""); - } - } - print "OK\n"; - } - - /** * Closes a database connection, if it is open * Returns success, true if already closed + * @return bool */ - function close() { - $this->mOpened = false; - if ( $this->mConn ) { - return pg_close( $this->mConn ); - } else { - return true; - } + protected function closeConnection() { + return pg_close( $this->mConn ); } - function doQuery( $sql ) { - if (function_exists('mb_convert_encoding')) { - $sql = mb_convert_encoding($sql,'UTF-8'); + protected function doQuery( $sql ) { + if ( function_exists( 'mb_convert_encoding' ) ) { + $sql = mb_convert_encoding( $sql, 'UTF-8' ); } - $this->mLastResult = pg_query( $this->mConn, $sql); + $this->mLastResult = pg_query( $this->mConn, $sql ); $this->mAffectedRows = null; // use pg_affected_rows(mLastResult) return $this->mLastResult; } - function queryIgnore( $sql, $fname = '' ) { + function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) { + $this->rollback( __METHOD__ ); + $this->reOpen(); + parent::reportQueryError( $error, $errno, $sql, $fname, $tempIgnore ); + } + + + function queryIgnore( $sql, $fname = 'DatabasePostgres::queryIgnore' ) { return $this->query( $sql, $fname, true ); } @@ -617,8 +271,11 @@ class DatabasePostgres extends DatabaseBase { if ( $res instanceof ResultWrapper ) { $res = $res->result; } - if ( !@pg_free_result( $res ) ) { - throw new DBUnexpectedError($this, "Unable to free Postgres result\n" ); + wfSuppressWarnings(); + $ok = pg_free_result( $res ); + wfRestoreWarnings(); + if ( !$ok ) { + throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" ); } } @@ -626,14 +283,15 @@ class DatabasePostgres extends DatabaseBase { if ( $res instanceof ResultWrapper ) { $res = $res->result; } - @$row = pg_fetch_object( $res ); - # FIXME: HACK HACK HACK HACK debug + wfSuppressWarnings(); + $row = pg_fetch_object( $res ); + wfRestoreWarnings(); + # @todo FIXME: HACK HACK HACK HACK debug - # TODO: - # hashar : not sure if the following test really trigger if the object + # @todo hashar: not sure if the following test really trigger if the object # fetching failed. - if( pg_last_error($this->mConn) ) { - throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) ); + if( pg_last_error( $this->mConn ) ) { + throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) ); } return $row; } @@ -642,9 +300,11 @@ class DatabasePostgres extends DatabaseBase { if ( $res instanceof ResultWrapper ) { $res = $res->result; } - @$row = pg_fetch_array( $res ); - if( pg_last_error($this->mConn) ) { - throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) ); + wfSuppressWarnings(); + $row = pg_fetch_array( $res ); + wfRestoreWarnings(); + if( pg_last_error( $this->mConn ) ) { + throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) ); } return $row; } @@ -653,18 +313,22 @@ class DatabasePostgres extends DatabaseBase { if ( $res instanceof ResultWrapper ) { $res = $res->result; } - @$n = pg_num_rows( $res ); - if( pg_last_error($this->mConn) ) { - throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) ); + wfSuppressWarnings(); + $n = pg_num_rows( $res ); + wfRestoreWarnings(); + if( pg_last_error( $this->mConn ) ) { + throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) ); } return $n; } + function numFields( $res ) { if ( $res instanceof ResultWrapper ) { $res = $res->result; } return pg_num_fields( $res ); } + function fieldName( $res, $n ) { if ( $res instanceof ResultWrapper ) { $res = $res->result; @@ -674,6 +338,7 @@ class DatabasePostgres extends DatabaseBase { /** * This must be called after nextSequenceVal + * @return null */ function insertId() { return $this->mInsertId; @@ -689,9 +354,8 @@ class DatabasePostgres extends DatabaseBase { function lastError() { if ( $this->mConn ) { return pg_last_error(); - } - else { - return "No database connection"; + } else { + return 'No database connection'; } } function lastErrno() { @@ -703,8 +367,9 @@ class DatabasePostgres extends DatabaseBase { // Forced result for simulated queries return $this->mAffectedRows; } - if( empty( $this->mLastResult ) ) + if( empty( $this->mLastResult ) ) { return 0; + } return pg_affected_rows( $this->mLastResult ); } @@ -714,9 +379,9 @@ class DatabasePostgres extends DatabaseBase { * This is not necessarily an accurate estimate, so use sparingly * Returns -1 if count cannot be found * Takes same arguments as Database::select() + * @return int */ - - function estimateRowCount( $table, $vars='*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) { + function estimateRowCount( $table, $vars = '*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) { $options['EXPLAIN'] = true; $res = $this->select( $table, $vars, $conds, $fname, $options ); $rows = -1; @@ -730,10 +395,10 @@ class DatabasePostgres extends DatabaseBase { return $rows; } - /** * Returns information about an index * If errors are explicitly ignored, returns NULL on failure + * @return bool|null */ function indexInfo( $table, $index, $fname = 'DatabasePostgres::indexInfo' ) { $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'"; @@ -741,7 +406,7 @@ class DatabasePostgres extends DatabaseBase { if ( !$res ) { return null; } - while ( $row = $this->fetchObject( $res ) ) { + foreach ( $res as $row ) { if ( $row->indexname == $this->indexName( $index ) ) { return $row; } @@ -749,18 +414,19 @@ class DatabasePostgres extends DatabaseBase { return false; } - function indexUnique ($table, $index, $fname = 'DatabasePostgres::indexUnique' ) { + function indexUnique( $table, $index, $fname = 'DatabasePostgres::indexUnique' ) { $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'". - " AND indexdef LIKE 'CREATE UNIQUE%(" . + " AND indexdef LIKE 'CREATE UNIQUE%(" . $this->strencode( $this->indexName( $index ) ) . ")'"; $res = $this->query( $sql, $fname ); - if ( !$res ) + if ( !$res ) { return null; - while ($row = $this->fetchObject( $res )) + } + foreach ( $res as $row ) { return true; + } return false; - } /** @@ -786,14 +452,14 @@ class DatabasePostgres extends DatabaseBase { $this->getServerVersion(); } - if ( !is_array( $options ) ) + if ( !is_array( $options ) ) { $options = array( $options ); + } if ( isset( $args[0] ) && is_array( $args[0] ) ) { $multi = true; $keys = array_keys( $args[0] ); - } - else { + } else { $multi = false; $keys = array_keys( $args ); } @@ -804,8 +470,8 @@ class DatabasePostgres extends DatabaseBase { // If we are not in a transaction, we need to be for savepoint trickery $didbegin = 0; if ( $ignore ) { - if (! $this->mTrxLevel) { - $this->begin(); + if ( !$this->mTrxLevel ) { + $this->begin( __METHOD__ ); $didbegin = 1; } $olde = error_reporting( 0 ); @@ -828,8 +494,7 @@ class DatabasePostgres extends DatabaseBase { $sql .= '(' . $this->makeList( $row ) . ')'; } $res = (bool)$this->query( $sql, $fname, $ignore ); - } - else { + } else { $res = true; $origsql = $sql; foreach ( $args as $row ) { @@ -837,17 +502,16 @@ class DatabasePostgres extends DatabaseBase { $tempsql .= '(' . $this->makeList( $row ) . ')'; if ( $ignore ) { - pg_query($this->mConn, "SAVEPOINT $ignore"); + pg_query( $this->mConn, "SAVEPOINT $ignore" ); } $tempres = (bool)$this->query( $tempsql, $fname, $ignore ); if ( $ignore ) { $bar = pg_last_error(); - if ($bar != false) { + if ( $bar != false ) { pg_query( $this->mConn, "ROLLBACK TO $ignore" ); - } - else { + } else { pg_query( $this->mConn, "RELEASE $ignore" ); $numrowsinserted++; } @@ -855,12 +519,12 @@ class DatabasePostgres extends DatabaseBase { // If any of them fail, we fail overall for this function call // Note that this will be ignored if IGNORE is set - if (! $tempres) + if ( !$tempres ) { $res = false; + } } } - } - else { + } else { // Not multi, just a lone insert if ( $ignore ) { pg_query($this->mConn, "SAVEPOINT $ignore"); @@ -870,10 +534,9 @@ class DatabasePostgres extends DatabaseBase { $res = (bool)$this->query( $sql, $fname, $ignore ); if ( $ignore ) { $bar = pg_last_error(); - if ($bar != false) { + if ( $bar != false ) { pg_query( $this->mConn, "ROLLBACK TO $ignore" ); - } - else { + } else { pg_query( $this->mConn, "RELEASE $ignore" ); $numrowsinserted++; } @@ -881,8 +544,8 @@ class DatabasePostgres extends DatabaseBase { } if ( $ignore ) { $olde = error_reporting( $olde ); - if ($didbegin) { - $this->commit(); + if ( $didbegin ) { + $this->commit( __METHOD__ ); } // Set the affected row count for the whole operation @@ -892,9 +555,7 @@ class DatabasePostgres extends DatabaseBase { return true; } - return $res; - } /** @@ -903,8 +564,9 @@ class DatabasePostgres extends DatabaseBase { * 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)? - */ + * @todo FIXME: Implement this a little better (seperate select/insert)? + * @return bool + */ function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabasePostgres::insertSelect', $insertOptions = array(), $selectOptions = array() ) { @@ -914,7 +576,7 @@ class DatabasePostgres extends DatabaseBase { $ignore = in_array( 'IGNORE', $insertOptions ) ? 'mw' : ''; if( is_array( $insertOptions ) ) { - $insertOptions = implode( ' ', $insertOptions ); + $insertOptions = implode( ' ', $insertOptions ); // FIXME: This is unused } if( !is_array( $selectOptions ) ) { $selectOptions = array( $selectOptions ); @@ -930,7 +592,7 @@ class DatabasePostgres extends DatabaseBase { $didbegin = 0; if ( $ignore ) { if( !$this->mTrxLevel ) { - $this->begin(); + $this->begin( __METHOD__ ); $didbegin = 1; } $olde = error_reporting( 0 ); @@ -942,7 +604,7 @@ class DatabasePostgres extends DatabaseBase { " SELECT $startOpts " . implode( ',', $varMap ) . " FROM $srcTable $useIndex"; - if ( $conds != '*') { + if ( $conds != '*' ) { $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND ); } @@ -959,7 +621,7 @@ class DatabasePostgres extends DatabaseBase { } $olde = error_reporting( $olde ); if( $didbegin ) { - $this->commit(); + $this->commit( __METHOD__ ); } // Set the affected row count for the whole operation @@ -971,8 +633,8 @@ class DatabasePostgres extends DatabaseBase { return $res; } - - function tableName( $name ) { + + function tableName( $name, $format = 'quoted' ) { # Replace reserved words with better ones switch( $name ) { case 'user': @@ -980,15 +642,16 @@ class DatabasePostgres extends DatabaseBase { case 'text': return 'pagecontent'; default: - return $name; + return parent::tableName( $name, $format ); } } /** * Return the next in a sequence, save the value for retrieval via insertId() + * @return null */ function nextSequenceValue( $seqName ) { - $safeseq = preg_replace( "/'/", "''", $seqName ); + $safeseq = str_replace( "'", "''", $seqName ); $res = $this->query( "SELECT nextval('$safeseq')" ); $row = $this->fetchRow( $res ); $this->mInsertId = $row[0]; @@ -997,90 +660,16 @@ class DatabasePostgres extends DatabaseBase { /** * Return the current value of a sequence. Assumes it has been nextval'ed in this session. + * @return */ function currentSequenceValue( $seqName ) { - $safeseq = preg_replace( "/'/", "''", $seqName ); + $safeseq = str_replace( "'", "''", $seqName ); $res = $this->query( "SELECT currval('$safeseq')" ); $row = $this->fetchRow( $res ); $currval = $row[0]; return $currval; } - # REPLACE query wrapper - # Postgres simulates this with a DELETE followed by INSERT - # $row is the row to insert, an associative array - # $uniqueIndexes is an array of indexes. Each element may be either a - # field name or an array of field names - # - # It may be more efficient to leave off unique indexes which are unlikely to collide. - # However if you do this, you run the risk of encountering errors which wouldn't have - # occurred in MySQL - function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabasePostgres::replace' ) { - $table = $this->tableName( $table ); - - if (count($rows)==0) { - return; - } - - # Single row case - if ( !is_array( reset( $rows ) ) ) { - $rows = array( $rows ); - } - - foreach( $rows as $row ) { - # Delete rows which collide - if ( $uniqueIndexes ) { - $sql = "DELETE FROM $table WHERE "; - $first = true; - foreach ( $uniqueIndexes as $index ) { - if ( $first ) { - $first = false; - $sql .= "("; - } else { - $sql .= ') OR ('; - } - if ( is_array( $index ) ) { - $first2 = true; - foreach ( $index as $col ) { - if ( $first2 ) { - $first2 = false; - } else { - $sql .= ' AND '; - } - $sql .= $col.'=' . $this->addQuotes( $row[$col] ); - } - } else { - $sql .= $index.'=' . $this->addQuotes( $row[$index] ); - } - } - $sql .= ')'; - $this->query( $sql, $fname ); - } - - # Now insert the row - $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES ) .') VALUES (' . - $this->makeList( $row, LIST_COMMA ) . ')'; - $this->query( $sql, $fname ); - } - } - - # DELETE where the condition is a join - function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabasePostgres::deleteJoin' ) { - if ( !$conds ) { - throw new DBUnexpectedError($this, 'Database::deleteJoin() called with empty $conds' ); - } - - $delTable = $this->tableName( $delTable ); - $joinTable = $this->tableName( $joinTable ); - $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable "; - if ( $conds != '*' ) { - $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND ); - } - $sql .= ')'; - - $this->query( $sql, $fname ); - } - # Returns the size of a text field, or -1 for "unlimited" function textFieldSize( $table, $field ) { $table = $this->tableName( $table ); @@ -1088,18 +677,18 @@ class DatabasePostgres extends DatabaseBase { 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'"; - $res =$this->query($sql); - $row=$this->fetchObject($res); - if ($row->ftype=="varchar") { - $size=$row->size-4; + $res =$this->query( $sql ); + $row = $this->fetchObject( $res ); + if ( $row->ftype == 'varchar' ) { + $size = $row->size - 4; } else { - $size=$row->size; + $size = $row->size; } return $size; } - function limitResult($sql, $limit, $offset=false) { - return "$sql LIMIT $limit ".(is_numeric($offset)?" OFFSET {$offset} ":""); + function limitResult( $sql, $limit, $offset = false ) { + return "$sql LIMIT $limit " . ( is_numeric( $offset ) ? " OFFSET {$offset} " : '' ); } function wasDeadlock() { @@ -1107,44 +696,45 @@ class DatabasePostgres extends DatabaseBase { } 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 ); } - function timestamp( $ts=0 ) { - return wfTimestamp(TS_POSTGRES,$ts); + function listTables( $prefix = null, $fname = 'DatabasePostgres::listTables' ) { + global $wgDBmwschema; + $eschema = $this->addQuotes( $wgDBmwschema ); + $result = $this->query( "SELECT tablename FROM pg_tables WHERE schemaname = $eschema", $fname ); + + $endArray = array(); + + foreach( $result as $table ) { + $vars = get_object_vars($table); + $table = array_pop( $vars ); + if( !$prefix || strpos( $table, $prefix ) === 0 ) { + $endArray[] = $table; + } + } + + return $endArray; + } + + function timestamp( $ts = 0 ) { + return wfTimestamp( TS_POSTGRES, $ts ); } /** * Return aggregated value function call */ - function aggregateValue ($valuedata,$valuename='value') { + function aggregateValue( $valuedata, $valuename = 'value' ) { return $valuedata; } - - function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) { - // Ignore errors during error handling to avoid infinite recursion - $ignore = $this->ignoreErrors( true ); - $this->mErrorCount++; - - if ($ignore || $tempIgnore) { - wfDebug("SQL ERROR (ignored): $error\n"); - $this->ignoreErrors( $ignore ); - } - else { - $message = "A database error has occurred\n" . - "Query: $sql\n" . - "Function: $fname\n" . - "Error: $errno $error\n"; - throw new DBUnexpectedError($this, $message); - } - } - /** * @return string wikitext of a link to the server software's web site */ public static function getSoftwareLink() { - return "[http://www.postgresql.org/ PostgreSQL]"; + return '[http://www.postgresql.org/ PostgreSQL]'; } /** @@ -1170,28 +760,33 @@ class DatabasePostgres extends DatabaseBase { /** * Query whether a given relation exists (in the given schema, or the * default mw one if not given) + * @return bool */ function relationExists( $table, $types, $schema = false ) { global $wgDBmwschema; - if ( !is_array( $types ) ) + if ( !is_array( $types ) ) { $types = array( $types ); - if ( !$schema ) + } + if ( !$schema ) { $schema = $wgDBmwschema; + } + $table = $this->tableName( $table, 'raw' ); $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 " - . "AND c.relkind IN ('" . implode("','", $types) . "')"; + . "AND c.relkind IN ('" . implode( "','", $types ) . "')"; $res = $this->query( $SQL ); $count = $res ? $res->numRows() : 0; - return $count ? true : false; + return (bool)$count; } - /* + /** * For backward compatibility, this function checks both tables and * views. + * @return bool */ - function tableExists( $table, $schema = false ) { + function tableExists( $table, $fname = __METHOD__, $schema = false ) { return $this->relationExists( $table, array( 'r', 'v' ), $schema ); } @@ -1205,65 +800,79 @@ class DatabasePostgres extends DatabaseBase { $q = <<query(sprintf($q, - $this->addQuotes($wgDBmwschema), - $this->addQuotes($table), - $this->addQuotes($trigger))); - if (!$res) + $res = $this->query( + sprintf( + $q, + $this->addQuotes( $wgDBmwschema ), + $this->addQuotes( $table ), + $this->addQuotes( $trigger ) + ) + ); + if ( !$res ) { return null; + } $rows = $res->numRows(); return $rows; } function ruleExists( $table, $rule ) { global $wgDBmwschema; - $exists = $this->selectField("pg_rules", "rulename", - array( "rulename" => $rule, - "tablename" => $table, - "schemaname" => $wgDBmwschema ) ); + $exists = $this->selectField( 'pg_rules', 'rulename', + array( + 'rulename' => $rule, + 'tablename' => $table, + 'schemaname' => $wgDBmwschema + ) + ); return $exists === $rule; } function constraintExists( $table, $constraint ) { global $wgDBmwschema; - $SQL = sprintf("SELECT 1 FROM information_schema.table_constraints ". + $SQL = sprintf( "SELECT 1 FROM information_schema.table_constraints ". "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s", - $this->addQuotes($wgDBmwschema), - $this->addQuotes($table), - $this->addQuotes($constraint)); - $res = $this->query($SQL); - if (!$res) + $this->addQuotes( $wgDBmwschema ), + $this->addQuotes( $table ), + $this->addQuotes( $constraint ) + ); + $res = $this->query( $SQL ); + if ( !$res ) { return null; + } $rows = $res->numRows(); return $rows; } /** - * Query whether a given schema exists. Returns the name of the owner + * Query whether a given schema exists. Returns true if it does, false if it doesn't. + * @return bool */ function schemaExists( $schema ) { - $eschema = preg_replace("/'/", "''", $schema); - $SQL = "SELECT rolname FROM pg_catalog.pg_namespace n, pg_catalog.pg_roles r " - ."WHERE n.nspowner=r.oid AND n.nspname = '$eschema'"; - $res = $this->query( $SQL ); - if ( $res && $res->numRows() ) { - $row = $res->fetchObject(); - $owner = $row->rolname; - } else { - $owner = false; - } - return $owner; + $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. + * @return bool + */ + function roleExists( $roleName ) { + $exists = $this->selectField( '"pg_catalog"."pg_roles"', 1, + array( 'rolname' => $roleName ), __METHOD__ ); + return (bool)$exists; } function fieldInfo( $table, $field ) { - return PostgresField::fromText($this, $table, $field); + return PostgresField::fromText( $this, $table, $field ); } - + /** * pg_field_type() wrapper + * @return string */ function fieldType( $res, $index ) { if ( $res instanceof ResultWrapper ) { @@ -1277,95 +886,38 @@ SQL; return $sql; } - function setup_database() { - global $wgVersion, $wgDBmwschema, $wgDBts2schema, $wgDBport, $wgDBuser; - - // Make sure that we can write to the correct schema - // If not, Postgres will happily and silently go to the next search_path item - $ctest = "mediawiki_test_table"; - $safeschema = $this->quote_ident($wgDBmwschema); - if ($this->tableExists($ctest, $wgDBmwschema)) { - $this->doQuery("DROP TABLE $safeschema.$ctest"); - } - $SQL = "CREATE TABLE $safeschema.$ctest(a int)"; - $olde = error_reporting( 0 ); - $res = $this->doQuery($SQL); - error_reporting( $olde ); - if (!$res) { - print "FAILED. Make sure that the user \"" . htmlspecialchars( $wgDBuser ) . - "\" can write to the schema \"" . htmlspecialchars( $wgDBmwschema ) . "\"\n"; - dieout(""); # Will close the main list