begin cleanup on magnus' url upload thingy
[lhc/web/wiklou.git] / includes / DatabasePostgres.php
index 2fe2c79..50097b8 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This is PostgreSQL database abstraction layer.
+ * This is Postgres database abstraction layer.
  *
  * As it includes more generic version for DB functions,
  * than MySQL ones, some of them should be moved to parent
@@ -32,6 +32,7 @@ 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);
 
@@ -48,9 +49,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" );
                }
 
 
@@ -92,52 +93,72 @@ class DatabasePostgres extends Database {
                        global $wgDBname, $wgDBuser, $wgDBpass, $wgDBsuperuser, $wgDBmwschema, $wgDBts2schema;
                        print "OK</li>\n";
 
+                       $safeuser = $this->quote_ident($wgDBuser);
                        ## Are we connecting as a superuser for the first time?
                        if ($wgDBsuperuser) {
+                               ## 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($wgDBsuperuser);
+                               $rows = $this->numRows($res = $this->doQuery($SQL));
+                               if (!$rows) {
+                                       print "<li>ERROR: Could not read permissions for user \"$wgDBsuperuser\"</li>\n";
+                                       dieout('</ul>');
+                               }
+                               $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 "<li>User \"$wgDBuser\" already exists, skipping account creation.</li>";
                                }
                                else {
-                                       ## Can we create users?
-                                       $SQL = "SELECT 1 FROM pg_catalog.pg_user WHERE usesuper IS TRUE AND ".
-                                               "usename = " . $this->addQuotes($wgDBsuperuser);
-                                       $rows = $this->numRows($this->doQuery($SQL));
-                                       if (!$rows) {
+                                       if ($perms != 1 and $perms != 3) {
                                                print "<li>ERROR: the user \"$wgDBsuperuser\" cannot create other users. ";
                                                print 'Please use a different Postgres user.</li>';
                                                dieout('</ul>');
                                        }
                                        print "<li>Creating user <b>$wgDBuser</b>...";
                                        $safepass = $this->addQuotes($wgDBpass);
-                                       $SQL = "CREATE USER \"$wgDBuser\" NOCREATEDB PASSWORD $safepass";
+                                       $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass";
                                        $this->doQuery($SQL);
                                        print "OK</li>\n";
                                }
                                ## User now exists, check out the database
-                               $safename = $this->addQuotes($wgDBname);
-                               $SQL = "SELECT 1 FROM pg_catalog.pg_database WHERE datname = $safename";
-                               $rows = $this->numRows($this->doQuery($SQL));
-                               if ($rows) {
-                                       print "<li>Database \"$wgDBname\" already exists, skipping database creation.</li>";
-                               }
-                               else {
-                                       print "<li>Creating database <b>$wgDBname</b>...";
-                                       $SQL = "CREATE DATABASE \"$wgDBname\" OWNER \"$wgDBuser\" ";
-                                       $this->doQuery($SQL);
+                               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 "<li>Database \"$wgDBname\" already exists, skipping database creation.</li>";
+                                       }
+                                       else {
+                                               if ($perms < 2) {
+                                                       print "<li>ERROR: the user \"$wgDBsuperuser\" cannot create databases. ";
+                                                       print 'Please use a different Postgres user.</li>';
+                                                       dieout('</ul>');
+                                               }
+                                               print "<li>Creating database <b>$wgDBname</b>...";
+                                               $safename = $this->quote_ident($wgDBname);
+                                               $SQL = "CREATE DATABASE $safename OWNER $safeuser ";
+                                               $this->doQuery($SQL);
+                                               print "OK</li>\n";
+                                               ## Hopefully tsearch2 and plpgsql are in template1...
+                                       }
+
+                                       ## Reconnect to check out tsearch2 rights for this user
+                                       print "<li>Connecting to \"$wgDBname\" as superuser \"$wgDBsuperuser\" to check rights...";
+                                       @$this->mConn = pg_connect("$hstring dbname=$wgDBname user=$user password=$password");
+                                       if ( $this->mConn == false ) {
+                                               print "<b>FAILED TO CONNECT!</b></li>";
+                                               dieout("</ul>");
+                                       }
                                        print "OK</li>\n";
-                                       ## Hopefully tsearch2 and plpgsql are in template1...
                                }
 
-                               ## Reconnect to check out tsearch2 rights for this user
-                               print "<li>Connecting to \"$wgDBname\" as superuser \"$wgDBsuperuser\" to check rights...";
-                               @$this->mConn = pg_connect("$hstring dbname=$wgDBname user=$user password=$password");
-                               if ( $this->mConn == false ) {
-                                       print "<b>FAILED TO CONNECT!</b></li>";
-                                       dieout("</uL>");
-                               }
-                               print "OK!";
+                               ## Tsearch2 checks
                                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\".";
@@ -146,11 +167,51 @@ class DatabasePostgres extends Database {
                                        dieout("</ul>");
                                }                               
                                print "OK</li>\n";
-                               print "Ensuring that user \"$wgDBuser\" has select rights on the tsearch2 tables...";
+                               print "<li>Ensuring that user \"$wgDBuser\" has select rights on the tsearch2 tables...";
                                foreach (array('cfg','cfgmap','dict','parser') as $table) {
-                                       $SQL = "GRANT SELECT ON pg_ts_$table TO \"$wgDBuser\"";
+                                       $SQL = "GRANT SELECT ON pg_ts_$table TO $safeuser";
                                        $this->doQuery($SQL);
                                }
+                               print "OK</li>\n";
+
+
+                               ## 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> ...";
+                                       $result = $this->doQuery("CREATE SCHEMA $safeschema AUTHORIZATION $safeuser");
+                                       if (!$result) {
+                                               print "<b>FAILED</b>.</li>\n";
+                                               dieout("</ul>");
+                                       }
+                                       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
@@ -176,17 +237,31 @@ class DatabasePostgres extends Database {
                        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>";
 
                        ## Do we have plpgsql installed?
-                       print "<li>Checking for plpgsql ...";
+                       print "<li>Checking for Pl/Pgsql ...";
                        $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";
 
@@ -197,9 +272,9 @@ class DatabasePostgres extends Database {
                                $result = $this->doQuery("CREATE SCHEMA $wgDBmwschema");
                                if (!$result) {
                                        print "<b>FAILED</b>.</li>\n";
-                                       return false;
+                                       dieout("</ul>");
                                }
-                               print "ok</li>\n";
+                               print "OK</li>\n";
                        }
                        else if ($result != $user) {
                                print "<li>Schema \"$wgDBmwschema\" exists but is not owned by \"$user\". Not ideal.</li>\n";
@@ -210,28 +285,34 @@ class DatabasePostgres extends Database {
 
                        ## Fix up the search paths if needed
                        print "<li>Setting the search path for user \"$user\" ...";
-                       $path = "$wgDBmwschema";
+                       $path = $this->quote_ident($wgDBmwschema);
                        if ($wgDBts2schema !== $wgDBmwschema)
-                               $path .= ", $wgDBts2schema";
+                               $path .= ", ". $this->quote_ident($wgDBts2schema);
                        if ($wgDBmwschema !== 'public' and $wgDBts2schema !== 'public')
                                $path .= ", public";
-                       $SQL = "ALTER USER $user SET search_path = $path";
+                       $SQL = "ALTER USER $safeuser SET search_path = $path";
                        $result = pg_query($this->mConn, $SQL);
                        if (!$result) {
                                print "<b>FAILED</b>.</li>\n";
-                               return false;
+                               dieout("</ul>");
                        }
-                       print "ok</li>\n";
+                       print "OK</li>\n";
                        ## Set for the rest of this session
                        $SQL = "SET search_path = $path";
                        $result = pg_query($this->mConn, $SQL);
                        if (!$result) {
                                print "<li>Failed to set search_path</li>\n";
-                               return false;
+                               dieout("</ul>");
                        }
                        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;
        }
 
@@ -258,7 +339,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" );
                }
        }
 
@@ -349,7 +430,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
 
@@ -402,15 +483,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
@@ -512,7 +592,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
@@ -699,6 +779,10 @@ class DatabasePostgres extends Database {
                return "E'" . pg_escape_string($s) . "'";
        }
 
+       function quote_ident( $s ) {
+               return '"' . preg_replace( '/"/', '""', $s) . '"';
+       }
+
 }
 
 ?>