includes/DatabasePostgres.php

   1 <?php
   2
   3 /**
   4  * This is the Postgres database abstraction layer.
   5  *
   6  * As it includes more generic version for DB functions,
   7  * than MySQL ones, some of them should be moved to parent
   8  * Database class.
   9  *
  10  */
  11
  12 class PostgresField {
  13         private $name, $tablename, $type, $nullable, $max_length;
  14
  15         static function fromText($db, $table, $field) {
  16         global $wgDBmwschema;
  17
  18                 $q = <<<END
  19 SELECT typname, attnotnull, attlen
  20 FROM pg_class, pg_namespace, pg_attribute, pg_type
  21 WHERE relnamespace=pg_namespace.oid
  22 AND relkind='r'
  23 AND attrelid=pg_class.oid
  24 AND atttypid=pg_type.oid
  25 AND nspname=%s
  26 AND relname=%s
  27 AND attname=%s;
  28 END;
  29                 $res = $db->query(sprintf($q,
  30                                 $db->addQuotes($wgDBmwschema),
  31                                 $db->addQuotes($table),
  32                                 $db->addQuotes($field)));
  33                 $row = $db->fetchObject($res);
  34                 if (!$row)
  35                         return null;
  36                 $n = new PostgresField;
  37                 $n->type = $row->typname;
  38                 $n->nullable = ($row->attnotnull == 'f');
  39                 $n->name = $field;
  40                 $n->tablename = $table;
  41                 $n->max_length = $row->attlen;
  42                 return $n;
  43         }
  44
  45         function name() {
  46                 return $this->name;
  47         }
  48
  49         function tableName() {
  50                 return $this->tablename;
  51         }
  52
  53         function type() {
  54                 return $this->type;
  55         }
  56
  57         function nullable() {
  58                 return $this->nullable;
  59         }
  60
  61         function maxLength() {
  62                 return $this->max_length;
  63         }
  64 }
  65
  66 class DatabasePostgres extends Database {
  67         var $mInsertId = NULL;
  68         var $mLastResult = NULL;
  69         var $numeric_version = NULL;
  70
  71         function DatabasePostgres($server = false, $user = false, $password = false, $dbName = false,
  72                 $failFunction = false, $flags = 0 )
  73         {
  74
  75                 global $wgOut;
  76                 # Can't get a reference if it hasn't been set yet
  77                 if ( !isset( $wgOut ) ) {
  78                         $wgOut = NULL;
  79                 }
  80                 $this->mOut =& $wgOut;
  81                 $this->mFailFunction = $failFunction;
  82                 $this->mFlags = $flags;
  83                 $this->open( $server, $user, $password, $dbName);
  84
  85         }
  86
  87         function cascadingDeletes() {
  88                 return true;
  89         }
  90         function cleanupTriggers() {
  91                 return true;
  92         }
  93         function strictIPs() {
  94                 return true;
  95         }
  96         function realTimestamps() {
  97                 return true;
  98         }
  99         function implicitGroupby() {
 100                 return false;
 101         }
 102         function searchableIPs() {
 103                 return true;
 104         }
 105
 106         static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0)
 107         {
 108                 return new DatabasePostgres( $server, $user, $password, $dbName, $failFunction, $flags );
 109         }
 110
 111         /**
 112          * Usually aborts on failure
 113          * If the failFunction is set to a non-zero integer, returns success
 114          */
 115         function open( $server, $user, $password, $dbName ) {
 116                 # Test for Postgres support, to avoid suppressed fatal error
 117                 if ( !function_exists( 'pg_connect' ) ) {
 118                         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" );
 119                 }
 120
 121                 global $wgDBport;
 122
 123                 if (!strlen($user)) { ## e.g. the class is being loaded
 124                         return;
 125                 }
 126
 127                 $this->close();
 128                 $this->mServer = $server;
 129                 $port = $wgDBport;
 130                 $this->mUser = $user;
 131                 $this->mPassword = $password;
 132                 $this->mDBname = $dbName;
 133
 134                 $hstring="";
 135                 if ($server!=false && $server!="") {
 136                         $hstring="host=$server ";
 137                 }
 138                 if ($port!=false && $port!="") {
 139                         $hstring .= "port=$port ";
 140                 }
 141
 142
 143                 error_reporting( E_ALL );
 144                 @$this->mConn = pg_connect("$hstring dbname=$dbName user=$user password=$password");
 145
 146                 if ( $this->mConn == false ) {
 147                         wfDebug( "DB connection error\n" );
 148                         wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
 149                         wfDebug( $this->lastError()."\n" );
 150                         return false;
 151                 }
 152
 153                 $this->mOpened = true;
 154                 ## If this is the initial connection, setup the schema stuff and possibly create the user
 155                 if (defined('MEDIAWIKI_INSTALL')) {
 156                         global $wgDBname, $wgDBuser, $wgDBpassword, $wgDBsuperuser, $wgDBmwschema,
 157                                 $wgDBts2schema;
 158
 159                         print "<li>Checking the version of Postgres...";
 160                         $version = $this->getServerVersion();
 161                         $PGMINVER = "8.1";
 162                         if ($this->numeric_version < $PGMINVER) {
 163                                 print "<b>FAILED</b>. Required version is $PGMINVER. You have $this->numeric_version ($version)</li>\n";
 164                                 dieout("</ul>");
 165                         }
 166                         print "version $this->numeric_version is OK.</li>\n";
 167
 168                         $safeuser = $this->quote_ident($wgDBuser);
 169                         ## Are we connecting as a superuser for the first time?
 170                         if ($wgDBsuperuser) {
 171                                 ## Are we really a superuser? Check out our rights
 172                                 $SQL = "SELECT
 173                                                 CASE WHEN usesuper IS TRUE THEN
 174                                                         CASE WHEN usecreatedb IS TRUE THEN 3 ELSE 1 END
 175                                                         ELSE CASE WHEN usecreatedb IS TRUE THEN 2 ELSE 0 END
 176                         END AS rights
 177                                                 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes($wgDBsuperuser);
 178                                 $rows = $this->numRows($res = $this->doQuery($SQL));
 179                                 if (!$rows) {
 180                                         print "<li>ERROR: Could not read permissions for user \"$wgDBsuperuser\"</li>\n";
 181                                         dieout('</ul>');
 182                                 }
 183                                 $perms = pg_fetch_result($res, 0, 0);
 184
 185                                 $SQL = "SELECT 1 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes($wgDBuser);
 186                                 $rows = $this->numRows($this->doQuery($SQL));
 187                                 if ($rows) {
 188                                         print "<li>User \"$wgDBuser\" already exists, skipping account creation.</li>";
 189                                 }
 190                                 else {
 191                                         if ($perms != 1 and $perms != 3) {
 192                                                 print "<li>ERROR: the user \"$wgDBsuperuser\" cannot create other users. ";
 193                                                 print 'Please use a different Postgres user.</li>';
 194                                                 dieout('</ul>');
 195                                         }
 196                                         print "<li>Creating user <b>$wgDBuser</b>...";
 197                                         $safepass = $this->addQuotes($wgDBpassword);
 198                                         $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass";
 199                                         $this->doQuery($SQL);
 200                                         print "OK</li>\n";
 201                                 }
 202                                 ## User now exists, check out the database
 203                                 if ($dbName != $wgDBname) {
 204                                         $SQL = "SELECT 1 FROM pg_catalog.pg_database WHERE datname = " . $this->addQuotes($wgDBname);
 205                                         $rows = $this->numRows($this->doQuery($SQL));
 206                                         if ($rows) {
 207                                                 print "<li>Database \"$wgDBname\" already exists, skipping database creation.</li>";
 208                                         }
 209                                         else {
 210                                                 if ($perms < 2) {
 211                                                         print "<li>ERROR: the user \"$wgDBsuperuser\" cannot create databases. ";
 212                                                         print 'Please use a different Postgres user.</li>';
 213                                                         dieout('</ul>');
 214                                                 }
 215                                                 print "<li>Creating database <b>$wgDBname</b>...";
 216                                                 $safename = $this->quote_ident($wgDBname);
 217                                                 $SQL = "CREATE DATABASE $safename OWNER $safeuser ";
 218                                                 $this->doQuery($SQL);
 219                                                 print "OK</li>\n";
 220                                                 ## Hopefully tsearch2 and plpgsql are in template1...
 221                                         }
 222
 223                                         ## Reconnect to check out tsearch2 rights for this user
 224                                         print "<li>Connecting to \"$wgDBname\" as superuser \"$wgDBsuperuser\" to check rights...";
 225                                         @$this->mConn = pg_connect("$hstring dbname=$wgDBname user=$user password=$password");
 226                                         if ( $this->mConn == false ) {
 227                                                 print "<b>FAILED TO CONNECT!</b></li>";
 228                                                 dieout("</ul>");
 229                                         }
 230                                         print "OK</li>\n";
 231                                 }
 232
 233                                 ## Tsearch2 checks
 234                                 print "<li>Checking that tsearch2 is installed in the database \"$wgDBname\"...";
 235                                 if (! $this->tableExists("pg_ts_cfg", $wgDBts2schema)) {
 236                                         print "<b>FAILED</b>. tsearch2 must be installed in the database \"$wgDBname\".";
 237                                         print "Please see <a href='http://www.devx.com/opensource/Article/21674/0/page/2'>this article</a>";
 238                                         print " for instructions or ask on #postgresql on irc.freenode.net</li>\n";
 239                                         dieout("</ul>");
 240                                 }
 241                                 print "OK</li>\n";
 242                                 print "<li>Ensuring that user \"$wgDBuser\" has select rights on the tsearch2 tables...";
 243                                 foreach (array('cfg','cfgmap','dict','parser') as $table) {
 244                                         $SQL = "GRANT SELECT ON pg_ts_$table TO $safeuser";
 245                                         $this->doQuery($SQL);
 246                                 }
 247                                 print "OK</li>\n";
 248
 249
 250                                 ## Setup the schema for this user if needed
 251                                 $result = $this->schemaExists($wgDBmwschema);
 252                                 $safeschema = $this->quote_ident($wgDBmwschema);
 253                                 if (!$result) {
 254                                         print "<li>Creating schema <b>$wgDBmwschema</b> ...";
 255                                         $result = $this->doQuery("CREATE SCHEMA $safeschema AUTHORIZATION $safeuser");
 256                                         if (!$result) {
 257                                                 print "<b>FAILED</b>.</li>\n";
 258                                                 dieout("</ul>");
 259                                         }
 260                                         print "OK</li>\n";
 261                                 }
 262                                 else {
 263                                         print "<li>Schema already exists, explicitly granting rights...\n";
 264                                         $safeschema2 = $this->addQuotes($wgDBmwschema);
 265                                         $SQL = "SELECT 'GRANT ALL ON '||pg_catalog.quote_ident(relname)||' TO $safeuser;'\n".
 266                                                         "FROM pg_catalog.pg_class p, pg_catalog.pg_namespace n\n".
 267                                                         "WHERE relnamespace = n.oid AND n.nspname = $safeschema2\n".
 268                                                         "AND p.relkind IN ('r','S','v')\n";
 269                                         $SQL .= "UNION\n";
 270                                         $SQL .= "SELECT 'GRANT ALL ON FUNCTION '||pg_catalog.quote_ident(proname)||'('||\n".
 271                                                         "pg_catalog.oidvectortypes(p.proargtypes)||') TO $safeuser;'\n".
 272                                                         "FROM pg_catalog.pg_proc p, pg_catalog.pg_namespace n\n".
 273                                                         "WHERE p.pronamespace = n.oid AND n.nspname = $safeschema2";
 274                                         $res = $this->doQuery($SQL);
 275                                         if (!$res) {
 276                                                 print "<b>FAILED</b>. Could not set rights for the user.</li>\n";
 277                                                 dieout("</ul>");
 278                                         }
 279                                         $this->doQuery("SET search_path = $safeschema");
 280                                         $rows = $this->numRows($res);
 281                                         while ($rows) {
 282                                                 $rows--;
 283                                                 $this->doQuery(pg_fetch_result($res, $rows, 0));
 284                                         }
 285                                         print "OK</li>";
 286                                 }
 287
 288                                 $wgDBsuperuser = '';
 289                                 return true; ## Reconnect as regular user
 290
 291                         } ## end superuser
 292
 293                 if (!defined('POSTGRES_SEARCHPATH')) {
 294
 295                         ## Do we have the basic tsearch2 table?
 296                         print "<li>Checking for tsearch2 in the schema \"$wgDBts2schema\"...";
 297                         if (! $this->tableExists("pg_ts_dict", $wgDBts2schema)) {
 298                                 print "<b>FAILED</b>. Make sure tsearch2 is installed. See <a href=";
 299                                 print "'http://www.devx.com/opensource/Article/21674/0/page/2'>this article</a>";
 300                                 print " for instructions.</li>\n";
 301                                 dieout("</ul>");
 302                         }
 303                         print "OK</li>\n";
 304
 305                         ## Does this user have the rights to the tsearch2 tables?
 306                         $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0);
 307                         print "<li>Checking tsearch2 permissions...";
 308                         ## Let's check all four, just to be safe
 309                         error_reporting( 0 );
 310                         $ts2tables = array('cfg','cfgmap','dict','parser');
 311                         foreach ( $ts2tables AS $tname ) {
 312                                 $SQL = "SELECT count(*) FROM $wgDBts2schema.pg_ts_$tname";
 313                                 $res = $this->doQuery($SQL);
 314                                 if (!$res) {
 315                                         print "<b>FAILED</b> to access pg_ts_$tname. Make sure that the user ".
 316                                         "\"$wgDBuser\" has SELECT access to all four tsearch2 tables</li>\n";
 317                                         dieout("</ul>");
 318                                 }
 319                         }
 320                         $SQL = "SELECT ts_name FROM $wgDBts2schema.pg_ts_cfg WHERE locale = '$ctype'";
 321                         $SQL .= " ORDER BY CASE WHEN ts_name <> 'default' THEN 1 ELSE 0 END";
 322                         $res = $this->doQuery($SQL);
 323                         error_reporting( E_ALL );
 324                         if (!$res) {
 325                                 print "<b>FAILED</b>. Could not determine the tsearch2 locale information</li>\n";
 326                                 dieout("</ul>");
 327                         }
 328                         print "OK</li>";
 329
 330                         ## Will the current locale work? Can we force it to?
 331                         print "<li>Verifying tsearch2 locale with $ctype...";
 332                         $rows = $this->numRows($res);
 333                         $resetlocale = 0;
 334                         if (!$rows) {
 335                                 print "<b>not found</b></li>\n";
 336                                 print "<li>Attempting to set default tsearch2 locale to \"$ctype\"...";
 337                                 $resetlocale = 1;
 338                         }
 339                         else {
 340                                 $tsname = pg_fetch_result($res, 0, 0);
 341                                 if ($tsname != 'default') {
 342                                         print "<b>not set to default ($tsname)</b>";
 343                                         print "<li>Attempting to change tsearch2 default locale to \"$ctype\"...";
 344                                         $resetlocale = 1;
 345                                 }
 346                         }
 347                         if ($resetlocale) {
 348                                 $SQL = "UPDATE $wgDBts2schema.pg_ts_cfg SET locale = '$ctype' WHERE ts_name = 'default'";
 349                                 $res = $this->doQuery($SQL);
 350                                 if (!$res) {
 351                                         print "<b>FAILED</b>. ";
 352                                         print "Please make sure that the locale in pg_ts_cfg for \"default\" is set to \"$ctype\"</li>\n";
 353                                         dieout("</ul>");
 354                                 }
 355                                 print "OK</li>";
 356                         }
 357
 358                         ## Final test: try out a simple tsearch2 query
 359                         $SQL = "SELECT $wgDBts2schema.to_tsvector('default','MediaWiki tsearch2 testing')";
 360                         $res = $this->doQuery($SQL);
 361                         if (!$res) {
 362                                 print "<b>FAILED</b>. Specifically, \"$SQL\" did not work.</li>";
 363                                 dieout("</ul>");
 364                         }
 365                         print "OK</li>";
 366
 367                         ## Do we have plpgsql installed?
 368                         print "<li>Checking for Pl/Pgsql ...";
 369                         $SQL = "SELECT 1 FROM pg_catalog.pg_language WHERE lanname = 'plpgsql'";
 370                         $rows = $this->numRows($this->doQuery($SQL));
 371                         if ($rows < 1) {
 372                                 // plpgsql is not installed, but if we have a pg_pltemplate table, we should be able to create it
 373                                 print "not installed. Attempting to install Pl/Pgsql ...";
 374                                 $SQL = "SELECT 1 FROM pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace) ".
 375                                         "WHERE relname = 'pg_pltemplate' AND nspname='pg_catalog'";
 376                                 $rows = $this->numRows($this->doQuery($SQL));
 377                                 if ($rows >= 1) {
 378                                         $result = $this->doQuery("CREATE LANGUAGE plpgsql");
 379                                         if (!$result) {
 380                                                 print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
 381                                                 dieout("</ul>");
 382                                         }
 383                                 }
 384                                 else {
 385                                         print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
 386                                         dieout("</ul>");
 387                                 }
 388                         }
 389                         print "OK</li>\n";
 390
 391                         ## Does the schema already exist? Who owns it?
 392                         $result = $this->schemaExists($wgDBmwschema);
 393                         if (!$result) {
 394                                 print "<li>Creating schema <b>$wgDBmwschema</b> ...";
 395                                 error_reporting( 0 );
 396                                 $result = $this->doQuery("CREATE SCHEMA $wgDBmwschema");
 397                                 error_reporting( E_ALL );
 398                                 if (!$result) {
 399                                         print "<b>FAILED</b>. The user \"$wgDBuser\" must be able to access the schema. ".
 400                                         "You can try making them the owner of the database, or try creating the schema with a ".
 401                                         "different user, and then grant access to the \"$wgDBuser\" user.</li>\n";
 402                                         dieout("</ul>");
 403                                 }
 404                                 print "OK</li>\n";
 405                         }
 406                         else if ($result != $user) {
 407                                 print "<li>Schema \"$wgDBmwschema\" exists but is not owned by \"$user\". Not ideal.</li>\n";
 408                         }
 409                         else {
 410                                 print "<li>Schema \"$wgDBmwschema\" exists and is owned by \"$user\". Excellent.</li>\n";
 411                         }
 412
 413                         ## Always return GMT time to accomodate the existing integer-based timestamp assumption
 414                         print "<li>Setting the timezone to GMT for user \"$user\" ...";
 415                         $SQL = "ALTER USER $safeuser SET timezone = 'GMT'";
 416                         $result = pg_query($this->mConn, $SQL);
 417                         if (!$result) {
 418                                 print "<b>FAILED</b>.</li>\n";
 419                                 dieout("</ul>");
 420                         }
 421                         print "OK</li>\n";
 422                         ## Set for the rest of this session
 423                         $SQL = "SET timezone = 'GMT'";
 424                         $result = pg_query($this->mConn, $SQL);
 425                         if (!$result) {
 426                                 print "<li>Failed to set timezone</li>\n";
 427                                 dieout("</ul>");
 428                         }
 429
 430                         print "<li>Setting the datestyle to ISO, YMD for user \"$user\" ...";
 431                         $SQL = "ALTER USER $safeuser SET datestyle = 'ISO, YMD'";
 432                         $result = pg_query($this->mConn, $SQL);
 433                         if (!$result) {
 434                                 print "<b>FAILED</b>.</li>\n";
 435                                 dieout("</ul>");
 436                         }
 437                         print "OK</li>\n";
 438                         ## Set for the rest of this session
 439                         $SQL = "SET datestyle = 'ISO, YMD'";
 440                         $result = pg_query($this->mConn, $SQL);
 441                         if (!$result) {
 442                                 print "<li>Failed to set datestyle</li>\n";
 443                                 dieout("</ul>");
 444                         }
 445
 446                         ## Fix up the search paths if needed
 447                         print "<li>Setting the search path for user \"$user\" ...";
 448                         $path = $this->quote_ident($wgDBmwschema);
 449                         if ($wgDBts2schema !== $wgDBmwschema)
 450                                 $path .= ", ". $this->quote_ident($wgDBts2schema);
 451                         if ($wgDBmwschema !== 'public' and $wgDBts2schema !== 'public')
 452                                 $path .= ", public";
 453                         $SQL = "ALTER USER $safeuser SET search_path = $path";
 454                         $result = pg_query($this->mConn, $SQL);
 455                         if (!$result) {
 456                                 print "<b>FAILED</b>.</li>\n";
 457                                 dieout("</ul>");
 458                         }
 459                         print "OK</li>\n";
 460                         ## Set for the rest of this session
 461                         $SQL = "SET search_path = $path";
 462                         $result = pg_query($this->mConn, $SQL);
 463                         if (!$result) {
 464                                 print "<li>Failed to set search_path</li>\n";
 465                                 dieout("</ul>");
 466                         }
 467                         define( "POSTGRES_SEARCHPATH", $path );
 468                 }}
 469
 470                 global $wgCommandLineMode;
 471                 ## If called from the command-line (e.g. importDump), only show errors
 472                 if ($wgCommandLineMode) {
 473                         $this->doQuery("SET client_min_messages = 'ERROR'");
 474                 }
 475
 476                 return $this->mConn;
 477         }
 478
 479         /**
 480          * Closes a database connection, if it is open
 481          * Returns success, true if already closed
 482          */
 483         function close() {
 484                 $this->mOpened = false;
 485                 if ( $this->mConn ) {
 486                         return pg_close( $this->mConn );
 487                 } else {
 488                         return true;
 489                 }
 490         }
 491
 492         function doQuery( $sql ) {
 493                 return $this->mLastResult=pg_query( $this->mConn , $sql);
 494         }
 495
 496         function queryIgnore( $sql, $fname = '' ) {
 497                 return $this->query( $sql, $fname, true );
 498         }
 499
 500         function freeResult( $res ) {
 501                 if ( !@pg_free_result( $res ) ) {
 502                         throw new DBUnexpectedError($this,  "Unable to free Postgres result\n" );
 503                 }
 504         }
 505
 506         function fetchObject( $res ) {
 507                 @$row = pg_fetch_object( $res );
 508                 # FIXME: HACK HACK HACK HACK debug
 509
 510                 # TODO:
 511                 # hashar : not sure if the following test really trigger if the object
 512                 #          fetching failled.
 513                 if( pg_last_error($this->mConn) ) {
 514                         throw new DBUnexpectedError($this,  'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) );
 515                 }
 516                 return $row;
 517         }
 518
 519         function fetchRow( $res ) {
 520                 @$row = pg_fetch_array( $res );
 521                 if( pg_last_error($this->mConn) ) {
 522                         throw new DBUnexpectedError($this,  'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) );
 523                 }
 524                 return $row;
 525         }
 526
 527         function numRows( $res ) {
 528                 @$n = pg_num_rows( $res );
 529                 if( pg_last_error($this->mConn) ) {
 530                         throw new DBUnexpectedError($this,  'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) );
 531                 }
 532                 return $n;
 533         }
 534         function numFields( $res ) { return pg_num_fields( $res ); }
 535         function fieldName( $res, $n ) { return pg_field_name( $res, $n ); }
 536
 537         /**
 538          * This must be called after nextSequenceVal
 539          */
 540         function insertId() {
 541                 return $this->mInsertId;
 542         }
 543
 544         function dataSeek( $res, $row ) { return pg_result_seek( $res, $row ); }
 545         function lastError() {
 546                 if ( $this->mConn ) {
 547                         return pg_last_error();
 548                 }
 549                 else {
 550                         return "No database connection";
 551                 }
 552         }
 553         function lastErrno() {
 554                 return pg_last_error() ? 1 : 0;
 555         }
 556
 557         function affectedRows() {
 558                 return pg_affected_rows( $this->mLastResult );
 559         }
 560
 561         /**
 562          * Returns information about an index
 563          * If errors are explicitly ignored, returns NULL on failure
 564          */
 565         function indexInfo( $table, $index, $fname = 'Database::indexExists' ) {
 566                 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
 567                 $res = $this->query( $sql, $fname );
 568                 if ( !$res ) {
 569                         return NULL;
 570                 }
 571
 572                 while ( $row = $this->fetchObject( $res ) ) {
 573                         if ( $row->indexname == $index ) {
 574                                 return $row;
 575
 576                                 // BUG: !!!! This code needs to be synced up with database.php
 577
 578                         }
 579                 }
 580                 return false;
 581         }
 582
 583         function indexUnique ($table, $index, $fname = 'Database::indexUnique' ) {
 584                 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'".
 585                         " AND indexdef LIKE 'CREATE UNIQUE%({$index})'";
 586                 $res = $this->query( $sql, $fname );
 587                 if ( !$res )
 588                         return NULL;
 589                 while ($row = $this->fetchObject( $res ))
 590                         return true;
 591                 return false;
 592
 593         }
 594
 595         function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
 596                 # Postgres doesn't support options
 597                 # We have a go at faking one of them
 598                 # TODO: DELAYED, LOW_PRIORITY
 599
 600                 if ( !is_array($options))
 601                         $options = array($options);
 602
 603                 if ( in_array( 'IGNORE', $options ) )
 604                         $oldIgnore = $this->ignoreErrors( true );
 605
 606                 # IGNORE is performed using single-row inserts, ignoring errors in each
 607                 # FIXME: need some way to distiguish between key collision and other types of error
 608                 $oldIgnore = $this->ignoreErrors( true );
 609                 if ( !is_array( reset( $a ) ) ) {
 610                         $a = array( $a );
 611                 }
 612                 foreach ( $a as $row ) {
 613                         parent::insert( $table, $row, $fname, array() );
 614                 }
 615                 $this->ignoreErrors( $oldIgnore );
 616                 $retVal = true;
 617
 618                 if ( in_array( 'IGNORE', $options ) )
 619                         $this->ignoreErrors( $oldIgnore );
 620
 621                 return $retVal;
 622         }
 623
 624         function tableName( $name ) {
 625                 # Replace reserved words with better ones
 626                 switch( $name ) {
 627                         case 'user':
 628                                 return 'mwuser';
 629                         case 'text':
 630                                 return 'pagecontent';
 631                         default:
 632                                 return $name;
 633                 }
 634         }
 635
 636         /**
 637          * Return the next in a sequence, save the value for retrieval via insertId()
 638          */
 639         function nextSequenceValue( $seqName ) {
 640                 $safeseq = preg_replace( "/'/", "''", $seqName );
 641                 $res = $this->query( "SELECT nextval('$safeseq')" );
 642                 $row = $this->fetchRow( $res );
 643                 $this->mInsertId = $row[0];
 644                 $this->freeResult( $res );
 645                 return $this->mInsertId;
 646         }
 647
 648         /**
 649          * Postgres does not have a "USE INDEX" clause, so return an empty string
 650          */
 651         function useIndexClause( $index ) {
 652                 return '';
 653         }
 654
 655         # REPLACE query wrapper
 656         # Postgres simulates this with a DELETE followed by INSERT
 657         # $row is the row to insert, an associative array
 658         # $uniqueIndexes is an array of indexes. Each element may be either a
 659         # field name or an array of field names
 660         #
 661         # It may be more efficient to leave off unique indexes which are unlikely to collide.
 662         # However if you do this, you run the risk of encountering errors which wouldn't have
 663         # occurred in MySQL
 664         function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
 665                 $table = $this->tableName( $table );
 666
 667                 if (count($rows)==0) {
 668                         return;
 669                 }
 670
 671                 # Single row case
 672                 if ( !is_array( reset( $rows ) ) ) {
 673                         $rows = array( $rows );
 674                 }
 675
 676                 foreach( $rows as $row ) {
 677                         # Delete rows which collide
 678                         if ( $uniqueIndexes ) {
 679                                 $sql = "DELETE FROM $table WHERE ";
 680                                 $first = true;
 681                                 foreach ( $uniqueIndexes as $index ) {
 682                                         if ( $first ) {
 683                                                 $first = false;
 684                                                 $sql .= "(";
 685                                         } else {
 686                                                 $sql .= ') OR (';
 687                                         }
 688                                         if ( is_array( $index ) ) {
 689                                                 $first2 = true;
 690                                                 foreach ( $index as $col ) {
 691                                                         if ( $first2 ) {
 692                                                                 $first2 = false;
 693                                                         } else {
 694                                                                 $sql .= ' AND ';
 695                                                         }
 696                                                         $sql .= $col.'=' . $this->addQuotes( $row[$col] );
 697                                                 }
 698                                         } else {
 699                                                 $sql .= $index.'=' . $this->addQuotes( $row[$index] );
 700                                         }
 701                                 }
 702                                 $sql .= ')';
 703                                 $this->query( $sql, $fname );
 704                         }
 705
 706                         # Now insert the row
 707                         $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES ) .') VALUES (' .
 708                                 $this->makeList( $row, LIST_COMMA ) . ')';
 709                         $this->query( $sql, $fname );
 710                 }
 711         }
 712
 713         # DELETE where the condition is a join
 714         function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = "Database::deleteJoin" ) {
 715                 if ( !$conds ) {
 716                         throw new DBUnexpectedError($this,  'Database::deleteJoin() called with empty $conds' );
 717                 }
 718
 719                 $delTable = $this->tableName( $delTable );
 720                 $joinTable = $this->tableName( $joinTable );
 721                 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
 722                 if ( $conds != '*' ) {
 723                         $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
 724                 }
 725                 $sql .= ')';
 726
 727                 $this->query( $sql, $fname );
 728         }
 729
 730         # Returns the size of a text field, or -1 for "unlimited"
 731         function textFieldSize( $table, $field ) {
 732                 $table = $this->tableName( $table );
 733                 $sql = "SELECT t.typname as ftype,a.atttypmod as size
 734                         FROM pg_class c, pg_attribute a, pg_type t
 735                         WHERE relname='$table' AND a.attrelid=c.oid AND
 736                                 a.atttypid=t.oid and a.attname='$field'";
 737                 $res =$this->query($sql);
 738                 $row=$this->fetchObject($res);
 739                 if ($row->ftype=="varchar") {
 740                         $size=$row->size-4;
 741                 } else {
 742                         $size=$row->size;
 743                 }
 744                 $this->freeResult( $res );
 745                 return $size;
 746         }
 747
 748         function lowPriorityOption() {
 749                 return '';
 750         }
 751
 752         function limitResult($sql, $limit,$offset=false) {
 753                 return "$sql LIMIT $limit ".(is_numeric($offset)?" OFFSET {$offset} ":"");
 754         }
 755
 756         /**
 757          * Returns an SQL expression for a simple conditional.
 758          * Uses CASE on Postgres
 759          *
 760          * @param string $cond SQL expression which will result in a boolean value
 761          * @param string $trueVal SQL expression to return if true
 762          * @param string $falseVal SQL expression to return if false
 763          * @return string SQL fragment
 764          */
 765         function conditional( $cond, $trueVal, $falseVal ) {
 766                 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
 767         }
 768
 769         function wasDeadlock() {
 770                 return $this->lastErrno() == '40P01';
 771         }
 772
 773         function timestamp( $ts=0 ) {
 774                 return wfTimestamp(TS_POSTGRES,$ts);
 775         }
 776
 777         /**
 778          * Return aggregated value function call
 779          */
 780         function aggregateValue ($valuedata,$valuename='value') {
 781                 return $valuedata;
 782         }
 783
 784
 785         function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
 786                 # Ignore errors during error handling to avoid infinite recursion
 787                 $ignore = $this->ignoreErrors( true );
 788                 ++$this->mErrorCount;
 789
 790                 if ($ignore || $tempIgnore) {
 791                         wfDebug("SQL ERROR (ignored): $error\n");
 792                         $this->ignoreErrors( $ignore );
 793                 }
 794                 else {
 795                         $message = "A database error has occurred\n" .
 796                                 "Query: $sql\n" .
 797                                 "Function: $fname\n" .
 798                                 "Error: $errno $error\n";
 799                         throw new DBUnexpectedError($this, $message);
 800                 }
 801         }
 802
 803         /**
 804          * @return string wikitext of a link to the server software's web site
 805          */
 806         function getSoftwareLink() {
 807                 return "[http://www.postgresql.org/ PostgreSQL]";
 808         }
 809
 810         /**
 811          * @return string Version information from the database
 812          */
 813         function getServerVersion() {
 814                 $version = pg_fetch_result($this->doQuery("SELECT version()"),0,0);
 815                 $thisver = array();
 816                 if (!preg_match('/PostgreSQL (\d+\.\d+)(\S+)/', $version, $thisver)) {
 817                         die("Could not determine the numeric version from $version!");
 818                 }
 819                 $this->numeric_version = $thisver[1];
 820                 return $version;
 821         }
 822
 823
 824         /**
 825          * Query whether a given relation exists (in the given schema, or the
 826          * default mw one if not given)
 827          */
 828         function relationExists( $table, $types, $schema = false ) {
 829                 global $wgDBmwschema;
 830                 if (!is_array($types))
 831                         $types = array($types);
 832                 if (! $schema )
 833                         $schema = $wgDBmwschema;
 834                 $etable = $this->addQuotes($table);
 835                 $eschema = $this->addQuotes($schema);
 836                 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
 837                         . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
 838                         . "AND c.relkind IN ('" . implode("','", $types) . "')";
 839                 $res = $this->query( $SQL );
 840                 $count = $res ? pg_num_rows($res) : 0;
 841                 if ($res)
 842                         $this->freeResult( $res );
 843                 return $count;
 844         }
 845
 846         /*
 847          * For backward compatibility, this function checks both tables and
 848          * views.
 849          */
 850         function tableExists ($table, $schema = false) {
 851                 return $this->relationExists($table, array('r', 'v'), $schema);
 852         }
 853
 854         function sequenceExists ($sequence, $schema = false) {
 855                 return $this->relationExists($sequence, 'S', $schema);
 856         }
 857
 858         function triggerExists($table, $trigger) {
 859         global $wgDBmwschema;
 860
 861                 $q = <<<END
 862         SELECT 1 FROM pg_class, pg_namespace, pg_trigger
 863                 WHERE relnamespace=pg_namespace.oid AND relkind='r'
 864                       AND tgrelid=pg_class.oid
 865                       AND nspname=%s AND relname=%s AND tgname=%s
 866 END;
 867                 $res = $this->query(sprintf($q,
 868                                 $this->addQuotes($wgDBmwschema),
 869                                 $this->addQuotes($table),
 870                                 $this->addQuotes($trigger)));
 871                 $row = $this->fetchRow($res);
 872                 $exists = !!$row;
 873                 $this->freeResult($res);
 874                 return $exists;
 875         }
 876
 877         function ruleExists($table, $rule) {
 878         global $wgDBmwschema;
 879                 $exists = $this->selectField("pg_rules", "rulename",
 880                                 array(  "rulename" => $rule,
 881                                         "tablename" => $table,
 882                                         "schemaname" => $wgDBmwschema));
 883                 return $exists === $rule;
 884         }
 885
 886         /**
 887          * Query whether a given schema exists. Returns the name of the owner
 888          */
 889         function schemaExists( $schema ) {
 890                 $eschema = preg_replace("/'/", "''", $schema);
 891                 $SQL = "SELECT rolname FROM pg_catalog.pg_namespace n, pg_catalog.pg_roles r "
 892                                 ."WHERE n.nspowner=r.oid AND n.nspname = '$eschema'";
 893                 $res = $this->query( $SQL );
 894                 $owner = $res ? pg_num_rows($res) ? pg_fetch_result($res, 0, 0) : false : false;
 895                 if ($res)
 896                         $this->freeResult($res);
 897                 return $owner;
 898         }
 899
 900         /**
 901          * Query whether a given column exists in the mediawiki schema
 902          */
 903         function fieldExists( $table, $field, $fname = 'DatabasePostgres::fieldExists' ) {
 904                 global $wgDBmwschema;
 905                 $etable = preg_replace("/'/", "''", $table);
 906                 $eschema = preg_replace("/'/", "''", $wgDBmwschema);
 907                 $ecol = preg_replace("/'/", "''", $field);
 908                 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n, pg_catalog.pg_attribute a "
 909                         . "WHERE c.relnamespace = n.oid AND c.relname = '$etable' AND n.nspname = '$eschema' "
 910                         . "AND a.attrelid = c.oid AND a.attname = '$ecol'";
 911                 $res = $this->query( $SQL, $fname );
 912                 $count = $res ? pg_num_rows($res) : 0;
 913                 if ($res)
 914                         $this->freeResult( $res );
 915                 return $count;
 916         }
 917
 918         function fieldInfo( $table, $field ) {
 919                 return PostgresField::fromText($this, $table, $field);
 920         }
 921
 922         function begin( $fname = 'DatabasePostgres::begin' ) {
 923                 $this->query( 'BEGIN', $fname );
 924                 $this->mTrxLevel = 1;
 925         }
 926         function immediateCommit( $fname = 'DatabasePostgres::immediateCommit' ) {
 927                 return true;
 928         }
 929         function commit( $fname = 'DatabasePostgres::commit' ) {
 930                 $this->query( 'COMMIT', $fname );
 931                 $this->mTrxLevel = 0;
 932         }
 933
 934         /* Not even sure why this is used in the main codebase... */
 935         function limitResultForUpdate($sql, $num) {
 936                 return $sql;
 937         }
 938
 939         function setup_database() {
 940                 global $wgVersion, $wgDBmwschema, $wgDBts2schema, $wgDBport, $wgDBuser;
 941
 942                 ## Make sure that we can write to the correct schema
 943                 ## If not, Postgres will happily and silently go to the next search_path item
 944                 $ctest = "mw_test_table";
 945                 if ($this->tableExists($ctest, $wgDBmwschema)) {
 946                         $this->doQuery("DROP TABLE $wgDBmwschema.$ctest");
 947                 }
 948                 $SQL = "CREATE TABLE $wgDBmwschema.$ctest(a int)";
 949                 error_reporting( 0 );
 950                 $res = $this->doQuery($SQL);
 951                 error_reporting( E_ALL );
 952                 if (!$res) {
 953                         print "<b>FAILED</b>. Make sure that the user \"$wgDBuser\" can write to the schema \"$wgDBmwschema\"</li>\n";
 954                         dieout("</ul>");
 955                 }
 956                 $this->doQuery("DROP TABLE $wgDBmwschema.mw_test_table");
 957
 958                 dbsource( "../maintenance/postgres/tables.sql", $this);
 959
 960                 ## Version-specific stuff
 961                 if ($this->numeric_version == 8.1) {
 962                         $this->doQuery("CREATE INDEX ts2_page_text ON pagecontent USING gist(textvector)");
 963                         $this->doQuery("CREATE INDEX ts2_page_title ON page USING gist(titlevector)");
 964                 }
 965                 else {
 966                         $this->doQuery("CREATE INDEX ts2_page_text ON pagecontent USING gin(textvector)");
 967                         $this->doQuery("CREATE INDEX ts2_page_title ON page USING gin(titlevector)");
 968                 }
 969
 970                 ## Update version information
 971                 $mwv = $this->addQuotes($wgVersion);
 972                 $pgv = $this->addQuotes($this->getServerVersion());
 973                 $pgu = $this->addQuotes($this->mUser);
 974                 $mws = $this->addQuotes($wgDBmwschema);
 975                 $tss = $this->addQuotes($wgDBts2schema);
 976                 $pgp = $this->addQuotes($wgDBport);
 977                 $dbn = $this->addQuotes($this->mDBname);
 978                 $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0);
 979
 980                 $SQL = "UPDATE mediawiki_version SET mw_version=$mwv, pg_version=$pgv, pg_user=$pgu, ".
 981                                 "mw_schema = $mws, ts2_schema = $tss, pg_port=$pgp, pg_dbname=$dbn, ".
 982                                 "ctype = '$ctype' ".
 983                                 "WHERE type = 'Creation'";
 984                 $this->query($SQL);
 985
 986                 ## Avoid the non-standard "REPLACE INTO" syntax
 987                 $f = fopen( "../maintenance/interwiki.sql", 'r' );
 988                 if ($f == false ) {
 989                         dieout( "<li>Could not find the interwiki.sql file");
 990                 }
 991                 ## We simply assume it is already empty as we have just created it
 992                 $SQL = "INSERT INTO interwiki(iw_prefix,iw_url,iw_local) VALUES ";
 993                 while ( ! feof( $f ) ) {
 994                         $line = fgets($f,1024);
 995                         $matches = array();
 996                         if (!preg_match('/^\s*(\(.+?),(\d)\)/', $line, $matches)) {
 997                                 continue;
 998                         }
 999                         $this->query("$SQL $matches[1],$matches[2])");
1000                 }
1001                 print " (table interwiki successfully populated)...\n";
1002
1003                 $this->doQuery("COMMIT");
1004         }
1005
1006         function encodeBlob($b) {
1007                 return array('bytea',pg_escape_bytea($b));
1008         }
1009         function decodeBlob($b) {
1010                 return pg_unescape_bytea( $b );
1011         }
1012
1013         function strencode( $s ) { ## Should not be called by us
1014                 return pg_escape_string( $s );
1015         }
1016
1017         function addQuotes( $s ) {
1018                 if ( is_null( $s ) ) {
1019                         return 'NULL';
1020                 } else if (is_array( $s )) { ## Assume it is bytea data
1021                         return "E'$s[1]'";
1022                 }
1023                 return "'" . pg_escape_string($s) . "'";
1024                 // Unreachable: return "E'" . pg_escape_string($s) . "'";
1025         }
1026
1027         function quote_ident( $s ) {
1028                 return '"' . preg_replace( '/"/', '""', $s) . '"';
1029         }
1030
1031         /* For now, does nothing */
1032         function selectDB( $db ) {
1033                 return true;
1034         }
1035
1036         /**
1037          * Returns an optional USE INDEX clause to go after the table, and a
1038          * string to go at the end of the query
1039          *
1040          * @private
1041          *
1042          * @param array $options an associative array of options to be turned into
1043          *              an SQL query, valid keys are listed in the function.
1044          * @return array
1045          */
1046         function makeSelectOptions( $options ) {
1047                 $preLimitTail = $postLimitTail = '';
1048                 $startOpts = '';
1049
1050                 $noKeyOptions = array();
1051                 foreach ( $options as $key => $option ) {
1052                         if ( is_numeric( $key ) ) {
1053                                 $noKeyOptions[$option] = true;
1054                         }
1055                 }
1056
1057                 if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY " . $options['GROUP BY'];
1058                 if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY " . $options['ORDER BY'];
1059
1060                 //if (isset($options['LIMIT'])) {
1061                 //      $tailOpts .= $this->limitResult('', $options['LIMIT'],
1062                 //              isset($options['OFFSET']) ? $options['OFFSET']
1063                 //              : false);
1064                 //}
1065
1066                 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $postLimitTail .= ' FOR UPDATE';
1067                 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $postLimitTail .= ' LOCK IN SHARE MODE';
1068                 if ( isset( $noKeyOptions['DISTINCT'] ) && isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
1069
1070                 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1071                         $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1072                 } else {
1073                         $useIndex = '';
1074                 }
1075
1076                 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1077         }
1078
1079         public function setTimeout( $timeout ) {
1080                 /// @fixme no-op
1081         }
1082
1083         function ping() {
1084                 wfDebug( "Function ping() not written for DatabasePostgres.php yet");
1085                 return true;
1086         }
1087
1088
1089 } // end DatabasePostgres class
1090
1091 ?>