* (bug 8437) Make Title::loadRestrictions() initialise $mRestrictions properly
[lhc/web/wiklou.git] / includes / DatabasePostgres.php
index 602900e..b78e6d5 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This is PostgreSQL database abstraction layer.
+ * This is the Postgres database abstraction layer.
  *
  * As it includes more generic version for DB functions,
  * than MySQL ones, some of them should be moved to parent
  * @package MediaWiki
  */
 
-/**
- * Depends on database
- */
-require_once( 'Database.php' );
-
 class DatabasePostgres extends Database {
        var $mInsertId = NULL;
        var $mLastResult = NULL;
@@ -23,7 +18,7 @@ class DatabasePostgres extends Database {
                $failFunction = false, $flags = 0 )
        {
 
-               global $wgOut, $wgDBprefix, $wgCommandLineMode;
+               global $wgOut;
                # Can't get a reference if it hasn't been set yet
                if ( !isset( $wgOut ) ) {
                        $wgOut = NULL;
@@ -32,11 +27,16 @@ class DatabasePostgres extends Database {
                $this->mFailFunction = $failFunction;
                $this->mCascadingDeletes = true;
                $this->mCleanupTriggers = true;
+               $this->mStrictIPs = true;
                $this->mFlags = $flags;
                $this->open( $server, $user, $password, $dbName);
 
        }
 
+       function realTimestamps() {
+               return true;
+       }
+
        static function newFromParams( $server = false, $user = false, $password = false, $dbName = false,
                $failFunction = false, $flags = 0)
        {
@@ -48,9 +48,9 @@ class DatabasePostgres extends Database {
         * If the failFunction is set to a non-zero integer, returns success
         */
        function open( $server, $user, $password, $dbName ) {
-               # Test for PostgreSQL support, to avoid suppressed fatal error
+               # Test for Postgres support, to avoid suppressed fatal error
                if ( !function_exists( 'pg_connect' ) ) {
-                       throw new DBConnectionError( $this, "PostgreSQL functions missing, have you compiled PHP with the --with-pgsql option?\n" );
+                       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" );
                }
 
 
@@ -63,7 +63,6 @@ class DatabasePostgres extends Database {
                $this->mPassword = $password;
                $this->mDBname = $dbName;
 
-               $success = false;
                $hstring="";
                if ($server!=false && $server!="") {
                        $hstring="host=$server ";
@@ -89,9 +88,24 @@ class DatabasePostgres extends Database {
                $this->mOpened = true;
                ## If this is the initial connection, setup the schema stuff and possibly create the user
                if (defined('MEDIAWIKI_INSTALL')) {
-                       global $wgDBname, $wgDBuser, $wgDBpass, $wgDBsuperuser, $wgDBmwschema, $wgDBts2schema;
+                       global $wgDBname, $wgDBuser, $wgDBpassword, $wgDBsuperuser, $wgDBmwschema,
+                               $wgDBts2schema;
                        print "OK</li>\n";
 
+                       print "<li>Checking the version of Postgres...";
+                       $version = pg_fetch_result($this->doQuery("SELECT version()"),0,0);
+                       $thisver = array();
+                       if (!preg_match('/PostgreSQL (\d+\.\d+)(\S+)/', $version, $thisver)) {
+                               print "<b>FAILED</b> (could not determine the version)</li>\n";
+                               dieout("</ul>");
+                       }
+                       $PGMINVER = "8.1";
+                       if ($thisver[1] < $PGMINVER) {
+                               print "<b>FAILED</b>. Required version is $PGMINVER. You have $thisver[1]$thisver[2]</li>\n";
+                               dieout("</ul>");
+                       }
+                       print "version $thisver[1]$thisver[2] is OK.</li>\n";
+
                        $safeuser = $this->quote_ident($wgDBuser);
                        ## Are we connecting as a superuser for the first time?
                        if ($wgDBsuperuser) {
@@ -121,7 +135,7 @@ class DatabasePostgres extends Database {
                                                dieout('</ul>');
                                        }
                                        print "<li>Creating user <b>$wgDBuser</b>...";
-                                       $safepass = $this->addQuotes($wgDBpass);
+                                       $safepass = $this->addQuotes($wgDBpassword);
                                        $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass";
                                        $this->doQuery($SQL);
                                        print "OK</li>\n";
@@ -152,7 +166,7 @@ class DatabasePostgres extends Database {
                                        @$this->mConn = pg_connect("$hstring dbname=$wgDBname user=$user password=$password");
                                        if ( $this->mConn == false ) {
                                                print "<b>FAILED TO CONNECT!</b></li>";
-                                               dieout("</uL>");
+                                               dieout("</ul>");
                                        }
                                        print "OK</li>\n";
                                }
@@ -161,7 +175,7 @@ class DatabasePostgres extends Database {
                                print "<li>Checking that tsearch2 is installed in the database \"$wgDBname\"...";
                                if (! $this->tableExists("pg_ts_cfg", $wgDBts2schema)) {
                                        print "<b>FAILED</b>. tsearch2 must be installed in the database \"$wgDBname\".";
-                                       print "Please see 'http://www.devx.com/opensource/Article/21674/0/page/2'>this article</a>";
+                                       print "Please see <a href='http://www.devx.com/opensource/Article/21674/0/page/2'>this article</a>";
                                        print " for instructions or ask on #postgresql on irc.freenode.net</li>\n";
                                        dieout("</ul>");
                                }                               
@@ -176,9 +190,9 @@ class DatabasePostgres extends Database {
 
                                ## Setup the schema for this user if needed
                                $result = $this->schemaExists($wgDBmwschema);
+                               $safeschema = $this->quote_ident($wgDBmwschema);
                                if (!$result) {
                                        print "<li>Creating schema <b>$wgDBmwschema</b> ...";
-                                       $safeschema = $this->quote_ident($wgDBmwschema);
                                        $result = $this->doQuery("CREATE SCHEMA $safeschema AUTHORIZATION $safeuser");
                                        if (!$result) {
                                                print "<b>FAILED</b>.</li>\n";
@@ -186,6 +200,31 @@ class DatabasePostgres extends Database {
                                        }
                                        print "OK</li>\n";
                                }
+                               else {
+                                       print "<li>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 "<b>FAILED</b>. Could not set rights for the user.</li>\n";
+                                               dieout("</ul>");
+                                       }
+                                       $this->doQuery("SET search_path = $safeschema");
+                                       $rows = $this->numRows($res);
+                                       while ($rows) {
+                                               $rows--;
+                                               $this->doQuery(pg_fetch_result($res, $rows, 0));
+                                       }
+                                       print "OK</li>";
+                               }
 
                                $wgDBsuperuser = '';
                                return true; ## Reconnect as regular user
@@ -204,14 +243,53 @@ class DatabasePostgres extends Database {
                        print "OK</li>\n";
 
                        ## Does this user have the rights to the tsearch2 tables?
+                       $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0);
                        print "<li>Checking tsearch2 permissions...";
-                       $SQL = "SELECT 1 FROM $wgDBts2schema.pg_ts_cfg";
+                       $SQL = "SELECT ts_name FROM $wgDBts2schema.pg_ts_cfg WHERE locale = '$ctype'";
+                       $SQL .= " ORDER BY CASE WHEN ts_name <> 'default' THEN 1 ELSE 0 END";
                        error_reporting( 0 );
                        $res = $this->doQuery($SQL);
                        error_reporting( E_ALL );
                        if (!$res) {
                                print "<b>FAILED</b>. Make sure that the user \"$wgDBuser\" has SELECT access to the tsearch2 tables</li>\n";
-                               dieout("</uL>");
+                               dieout("</ul>");
+                       }
+                       print "OK</li>";
+
+                       ## Will the current locale work? Can we force it to?
+                       print "<li>Verifying tsearch2 locale with $ctype...";
+                       $rows = $this->numRows($res);
+                       $resetlocale = 0;
+                       if (!$rows) {
+                               print "<b>not found</b></li>\n";
+                               print "<li>Attempting to set default tsearch2 locale to \"$ctype\"...";
+                               $resetlocale = 1;
+                       }
+                       else {
+                               $tsname = pg_fetch_result($res, 0, 0);
+                               if ($tsname != 'default') {
+                                       print "<b>not set to default ($tsname)</b>";
+                                       print "<li>Attempting to change tsearch2 default locale to \"$ctype\"...";
+                                       $resetlocale = 1;
+                               }
+                       }
+                       if ($resetlocale) {
+                               $SQL = "UPDATE $wgDBts2schema.pg_ts_cfg SET locale = '$ctype' WHERE ts_name = 'default'";
+                               $res = $this->doQuery($SQL);
+                               if (!$res) {
+                                       print "<b>FAILED</b>. ";
+                                       print "Please make sure that the locale in pg_ts_cfg for \"default\" is set to \"ctype\"</li>\n";
+                                       dieout("</ul>");
+                               }
+                               print "OK</li>";
+                       }
+
+                       ## Final test: try out a simple tsearch2 query
+                       $SQL = "SELECT $wgDBts2schema.to_tsvector('default','MediaWiki tsearch2 testing')";
+                       $res = $this->doQuery($SQL);
+                       if (!$res) {
+                               print "<b>FAILED</b>. Specifically, \"$SQL\" did not work.</li>";
+                               dieout("</ul>");
                        }
                        print "OK</li>";
 
@@ -220,8 +298,22 @@ class DatabasePostgres extends Database {
                        $SQL = "SELECT 1 FROM pg_catalog.pg_language WHERE lanname = 'plpgsql'";
                        $rows = $this->numRows($this->doQuery($SQL));
                        if ($rows < 1) {
-                               print "<b>FAILED</b>. Make sure the language plpgsql is installed for the database <tt>$wgDBname</tt></li>";
-                               dieout("</ul>");
+                               // 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));
+                               if ($rows >= 1) {
+                                       $result = $this->doQuery("CREATE LANGUAGE plpgsql");
+                                       if (!$result) {
+                                               print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
+                                               dieout("</ul>");
+                                       }
+                               }
+                               else {
+                                       print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
+                                       dieout("</ul>");
+                               }
                        }
                        print "OK</li>\n";
 
@@ -267,6 +359,12 @@ class DatabasePostgres extends Database {
                        define( "POSTGRES_SEARCHPATH", $path );
                }}
 
+               global $wgCommandLineMode;
+               ## If called from the command-line (e.g. importDump), only show errors
+               if ($wgCommandLineMode) {
+                       $this->doQuery("SET client_min_messages = 'ERROR'");
+               }
+
                return $this->mConn;
        }
 
@@ -293,7 +391,7 @@ class DatabasePostgres extends Database {
 
        function freeResult( $res ) {
                if ( !@pg_free_result( $res ) ) {
-                       throw new DBUnexpectedError($this,  "Unable to free PostgreSQL result\n" );
+                       throw new DBUnexpectedError($this,  "Unable to free Postgres result\n" );
                }
        }
 
@@ -366,6 +464,9 @@ class DatabasePostgres extends Database {
                while ( $row = $this->fetchObject( $res ) ) {
                        if ( $row->indexname == $index ) {
                                return $row;
+                               
+                               // BUG: !!!! This code needs to be synced up with database.php
+                               
                        }
                }
                return false;
@@ -384,7 +485,7 @@ class DatabasePostgres extends Database {
        }
 
        function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
-               # PostgreSQL doesn't support options
+               # Postgres doesn't support options
                # We have a go at faking one of them
                # TODO: DELAYED, LOW_PRIORITY
 
@@ -437,15 +538,14 @@ class DatabasePostgres extends Database {
        }
 
        /**
-        * USE INDEX clause
-        * PostgreSQL doesn't have them and returns ""
+        * Postgres does not have a "USE INDEX" clause, so return an empty string
         */
        function useIndexClause( $index ) {
                return '';
        }
 
        # REPLACE query wrapper
-       # PostgreSQL simulates this with a DELETE followed by INSERT
+       # 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
@@ -547,7 +647,7 @@ class DatabasePostgres extends Database {
 
        /**
         * Returns an SQL expression for a simple conditional.
-        * Uses CASE on PostgreSQL.
+        * Uses CASE on Postgres
         *
         * @param string $cond SQL expression which will result in a boolean value
         * @param string $trueVal SQL expression to return if true
@@ -558,9 +658,8 @@ class DatabasePostgres extends Database {
                return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
        }
 
-       # FIXME: actually detecting deadlocks might be nice
        function wasDeadlock() {
-               return false;
+               return $this->lastErrno() == '40P01';
        }
 
        function timestamp( $ts=0 ) {
@@ -576,11 +675,21 @@ class DatabasePostgres extends Database {
 
 
        function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
-               $message = "A database error has occurred\n" .
-                       "Query: $sql\n" .
-                       "Function: $fname\n" .
-                       "Error: $errno $error\n";
-               throw new DBUnexpectedError($this, $message);
+               # 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);
+               }
        }
 
        /**
@@ -612,7 +721,8 @@ class DatabasePostgres extends Database {
                $etable = preg_replace("/'/", "''", $table);
                $eschema = preg_replace("/'/", "''", $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'";
+                       . "WHERE c.relnamespace = n.oid AND c.relname = '$etable' AND n.nspname = '$eschema' "
+                       . "AND c.relkind IN ('r','v')";
                $res = $this->query( $SQL );
                $count = $res ? pg_num_rows($res) : 0;
                if ($res)
@@ -689,9 +799,11 @@ class DatabasePostgres extends Database {
                $tss = $this->addQuotes($wgDBts2schema);
                $pgp = $this->addQuotes($wgDBport);
                $dbn = $this->addQuotes($this->mDBname);
+               $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0);
 
                $SQL = "UPDATE mediawiki_version SET mw_version=$mwv, pg_version=$pgv, pg_user=$pgu, ".
-                               "mw_schema = $mws, ts2_schema = $tss, pg_port=$pgp, pg_dbname=$dbn ".
+                               "mw_schema = $mws, ts2_schema = $tss, pg_port=$pgp, pg_dbname=$dbn, ".
+                               "ctype = '$ctype' ".
                                "WHERE type = 'Creation'";
                $this->query($SQL);
 
@@ -704,10 +816,10 @@ class DatabasePostgres extends Database {
                $SQL = "INSERT INTO interwiki(iw_prefix,iw_url,iw_local) VALUES ";
                while ( ! feof( $f ) ) {
                        $line = fgets($f,1024);
-                       if (!preg_match("/^\s*(\(.+?),(\d)\)/", $line, $matches)) {
+                       $matches = array();
+                       if (!preg_match('/^\s*(\(.+?),(\d)\)/', $line, $matches)) {
                                continue;
                        }
-                       $yesno = $matches[2]; ## ? "'true'" : "'false'";
                        $this->query("$SQL $matches[1],$matches[2])");
                }
                print " (table interwiki successfully populated)...\n";
@@ -731,13 +843,66 @@ class DatabasePostgres extends Database {
                        return "E'$s[1]'";
                }
                return "'" . pg_escape_string($s) . "'";
-               return "E'" . pg_escape_string($s) . "'";
+               // Unreachable: return "E'" . pg_escape_string($s) . "'";
        }
 
        function quote_ident( $s ) {
                return '"' . preg_replace( '/"/', '""', $s) . '"';
        }
 
-}
+       /* For now, does nothing */
+       function selectDB( $db ) {
+               return true;
+       }
+
+       /**
+        * Returns an optional USE INDEX clause to go after the table, and a
+        * string to go at the end of the query
+        *
+        * @private
+        *
+        * @param array $options an associative array of options to be turned into
+        *              an SQL query, valid keys are listed in the function.
+        * @return array
+        */
+       function makeSelectOptions( $options ) {
+               $tailOpts = '';
+               $startOpts = '';
+
+               $noKeyOptions = array();
+               foreach ( $options as $key => $option ) {
+                       if ( is_numeric( $key ) ) {
+                               $noKeyOptions[$option] = true;
+                       }
+               }
+
+               if ( isset( $options['GROUP BY'] ) ) $tailOpts .= " GROUP BY {$options['GROUP BY']}";
+               if ( isset( $options['ORDER BY'] ) ) $tailOpts .= " ORDER BY {$options['ORDER BY']}";
+               
+               if (isset($options['LIMIT'])) {
+                       $tailOpts .= $this->limitResult('', $options['LIMIT'],
+                               isset($options['OFFSET']) ? $options['OFFSET'] : false);
+               }
+
+               if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $tailOpts .= ' FOR UPDATE';
+               if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $tailOpts .= ' LOCK IN SHARE MODE';
+               if ( isset( $noKeyOptions['DISTINCT'] ) && isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
+
+               if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
+                       $useIndex = $this->useIndexClause( $options['USE INDEX'] );
+               } else {
+                       $useIndex = '';
+               }
+               
+               return array( $startOpts, $useIndex, $tailOpts );
+       }
+
+       function ping() {
+               wfDebug( "Function ping() not written for DatabasePostgres.php yet");
+               return true;
+       }
+
+
+} // end DatabasePostgres class
 
 ?>