PostgreSQL: Improve SQL error handling
[lhc/web/wiklou.git] / includes / db / DatabasePostgres.php
index 41e5f57..1f1d7ed 100644 (file)
@@ -10,7 +10,6 @@ class PostgresField implements Field {
        private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname;
 
        /**
-        * @static
         * @param $db DatabaseBase
         * @param  $table
         * @param  $field
@@ -40,7 +39,7 @@ AND relname=%s
 AND attname=%s;
 SQL;
 
-               $table = $db->tableName( $table );
+               $table = $db->tableName( $table, 'raw' );
                $res = $db->query(
                        sprintf( $q,
                                $db->addQuotes( $wgDBmwschema ),
@@ -146,6 +145,7 @@ class DatabasePostgres extends DatabaseBase {
 
        /**
         * Usually aborts on failure
+        * @return DatabaseBase|null
         */
        function open( $server, $user, $password, $dbName ) {
                # Test for Postgres support, to avoid suppressed fatal error
@@ -159,7 +159,6 @@ class DatabasePostgres extends DatabaseBase {
                        return;
                }
 
-               $this->close();
                $this->mServer = $server;
                $port = $wgDBport;
                $this->mUser = $user;
@@ -177,17 +176,21 @@ class DatabasePostgres extends DatabaseBase {
                if ( $port != false && $port != '' ) {
                        $connectVars['port'] = $port;
                }
-               $connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW );
+               $this->connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW );
+               $this->reOpen();
+       }
 
+       function reOpen() {
+               $this->close();
                $this->installErrorHandler();
-               $this->mConn = pg_connect( $connectString );
+               $this->mConn = pg_connect( $this->connectString );
                $phpError = $this->restoreErrorHandler();
 
                if ( !$this->mConn ) {
                        wfDebug( "DB connection error\n" );
                        wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
                        wfDebug( $this->lastError() . "\n" );
-                       throw new DBConnectionError( $this, $phpError );
+                       throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) );
                }
 
                $this->mOpened = true;
@@ -201,6 +204,7 @@ class DatabasePostgres extends DatabaseBase {
                $this->query( "SET client_encoding='UTF8'", __METHOD__ );
                $this->query( "SET datestyle = 'ISO, YMD'", __METHOD__ );
                $this->query( "SET timezone = 'GMT'", __METHOD__ );
+               $this->query( "SET standard_conforming_strings = on", __METHOD__ );
 
                global $wgDBmwschema;
                if ( $this->schemaExists( $wgDBmwschema ) ) {
@@ -219,7 +223,11 @@ class DatabasePostgres extends DatabaseBase {
         * @return
         */
        function selectDB( $db ) {
-               return (bool)$this->open( $this->mServer, $this->mUser, $this->mPassword, $db );
+               if ( $this->mDBname !== $db ) {
+                       return (bool)$this->open( $this->mServer, $this->mUser, $this->mPassword, $db );
+               } else {
+                       return true;
+               }
        }
 
        function makeConnectionString( $vars ) {
@@ -233,17 +241,13 @@ class DatabasePostgres extends DatabaseBase {
        /**
         * Closes a database connection, if it is open
         * Returns success, true if already closed
+        * @return bool
         */
-       function close() {
-               $this->mOpened = false;
-               if ( $this->mConn ) {
-                       return pg_close( $this->mConn );
-               } else {
-                       return true;
-               }
+       protected function closeConnection() {
+               return pg_close( $this->mConn );
        }
 
-       function doQuery( $sql ) {
+       protected function doQuery( $sql ) {
                if ( function_exists( 'mb_convert_encoding' ) ) {
                        $sql = mb_convert_encoding( $sql, 'UTF-8' );
                }
@@ -252,6 +256,13 @@ class DatabasePostgres extends DatabaseBase {
                return $this->mLastResult;
        }
 
+       function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
+               $this->rollback( __METHOD__ );
+               $this->reOpen();
+               parent::reportQueryError( $error, $errno, $sql, $fname, $tempIgnore );
+       }
+
+
        function queryIgnore( $sql, $fname = 'DatabasePostgres::queryIgnore' ) {
                return $this->query( $sql, $fname, true );
        }
@@ -260,7 +271,10 @@ class DatabasePostgres extends DatabaseBase {
                if ( $res instanceof ResultWrapper ) {
                        $res = $res->result;
                }
-               if ( !@pg_free_result( $res ) ) {
+               wfSuppressWarnings();
+               $ok = pg_free_result( $res );
+               wfRestoreWarnings();
+               if ( !$ok ) {
                        throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
                }
        }
@@ -269,11 +283,12 @@ class DatabasePostgres extends DatabaseBase {
                if ( $res instanceof ResultWrapper ) {
                        $res = $res->result;
                }
-               @$row = pg_fetch_object( $res );
-               # FIXME: HACK HACK HACK HACK debug
+               wfSuppressWarnings();
+               $row = pg_fetch_object( $res );
+               wfRestoreWarnings();
+               # @todo FIXME: HACK HACK HACK HACK debug
 
-               # TODO:
-               # hashar : not sure if the following test really trigger if the object
+               # @todo hashar: not sure if the following test really trigger if the object
                #          fetching failed.
                if( pg_last_error( $this->mConn ) ) {
                        throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
@@ -285,7 +300,9 @@ class DatabasePostgres extends DatabaseBase {
                if ( $res instanceof ResultWrapper ) {
                        $res = $res->result;
                }
-               @$row = pg_fetch_array( $res );
+               wfSuppressWarnings();
+               $row = pg_fetch_array( $res );
+               wfRestoreWarnings();
                if( pg_last_error( $this->mConn ) ) {
                        throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
                }
@@ -296,7 +313,9 @@ class DatabasePostgres extends DatabaseBase {
                if ( $res instanceof ResultWrapper ) {
                        $res = $res->result;
                }
-               @$n = pg_num_rows( $res );
+               wfSuppressWarnings();
+               $n = pg_num_rows( $res );
+               wfRestoreWarnings();
                if( pg_last_error( $this->mConn ) ) {
                        throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
                }
@@ -319,6 +338,7 @@ class DatabasePostgres extends DatabaseBase {
 
        /**
         * This must be called after nextSequenceVal
+        * @return null
         */
        function insertId() {
                return $this->mInsertId;
@@ -359,6 +379,7 @@ class DatabasePostgres extends DatabaseBase {
         * This is not necessarily an accurate estimate, so use sparingly
         * Returns -1 if count cannot be found
         * Takes same arguments as Database::select()
+        * @return int
         */
        function estimateRowCount( $table, $vars = '*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) {
                $options['EXPLAIN'] = true;
@@ -377,6 +398,7 @@ class DatabasePostgres extends DatabaseBase {
        /**
         * Returns information about an index
         * If errors are explicitly ignored, returns NULL on failure
+        * @return bool|null
         */
        function indexInfo( $table, $index, $fname = 'DatabasePostgres::indexInfo' ) {
                $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
@@ -449,7 +471,7 @@ class DatabasePostgres extends DatabaseBase {
                $didbegin = 0;
                if ( $ignore ) {
                        if ( !$this->mTrxLevel ) {
-                               $this->begin();
+                               $this->begin( __METHOD__ );
                                $didbegin = 1;
                        }
                        $olde = error_reporting( 0 );
@@ -523,7 +545,7 @@ class DatabasePostgres extends DatabaseBase {
                if ( $ignore ) {
                        $olde = error_reporting( $olde );
                        if ( $didbegin ) {
-                               $this->commit();
+                               $this->commit( __METHOD__ );
                        }
 
                        // Set the affected row count for the whole operation
@@ -542,7 +564,8 @@ class DatabasePostgres extends DatabaseBase {
         * Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes()
         * $conds may be "*" to copy the whole table
         * srcTable may be an array of tables.
-        * @todo FIXME: implement this a little better (seperate select/insert)?
+        * @todo FIXME: Implement this a little better (seperate select/insert)?
+        * @return bool
         */
        function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabasePostgres::insertSelect',
                $insertOptions = array(), $selectOptions = array() )
@@ -553,7 +576,7 @@ class DatabasePostgres extends DatabaseBase {
                $ignore = in_array( 'IGNORE', $insertOptions ) ? 'mw' : '';
 
                if( is_array( $insertOptions ) ) {
-                       $insertOptions = implode( ' ', $insertOptions );
+                       $insertOptions = implode( ' ', $insertOptions ); // FIXME: This is unused
                }
                if( !is_array( $selectOptions ) ) {
                        $selectOptions = array( $selectOptions );
@@ -569,7 +592,7 @@ class DatabasePostgres extends DatabaseBase {
                $didbegin = 0;
                if ( $ignore ) {
                        if( !$this->mTrxLevel ) {
-                               $this->begin();
+                               $this->begin( __METHOD__ );
                                $didbegin = 1;
                        }
                        $olde = error_reporting( 0 );
@@ -598,7 +621,7 @@ class DatabasePostgres extends DatabaseBase {
                        }
                        $olde = error_reporting( $olde );
                        if( $didbegin ) {
-                               $this->commit();
+                               $this->commit( __METHOD__ );
                        }
 
                        // Set the affected row count for the whole operation
@@ -611,7 +634,7 @@ class DatabasePostgres extends DatabaseBase {
                return $res;
        }
 
-       function tableName( $name ) {
+       function tableName( $name, $format = 'quoted' ) {
                # Replace reserved words with better ones
                switch( $name ) {
                        case 'user':
@@ -619,12 +642,13 @@ class DatabasePostgres extends DatabaseBase {
                        case 'text':
                                return 'pagecontent';
                        default:
-                               return $name;
+                               return parent::tableName( $name, $format );
                }
        }
 
        /**
         * Return the next in a sequence, save the value for retrieval via insertId()
+        * @return null
         */
        function nextSequenceValue( $seqName ) {
                $safeseq = str_replace( "'", "''", $seqName );
@@ -636,6 +660,7 @@ class DatabasePostgres extends DatabaseBase {
 
        /**
         * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
+        * @return
         */
        function currentSequenceValue( $seqName ) {
                $safeseq = str_replace( "'", "''", $seqName );
@@ -645,83 +670,6 @@ class DatabasePostgres extends DatabaseBase {
                return $currval;
        }
 
-       /**
-        * REPLACE query wrapper
-        * Postgres simulates this with a DELETE followed by INSERT
-        * $row is the row to insert, an associative array
-        * $uniqueIndexes is an array of indexes. Each element may be either a
-        * field name or an array of field names
-        *
-        * It may be more efficient to leave off unique indexes which are unlikely to collide.
-        * However if you do this, you run the risk of encountering errors which wouldn't have
-        * occurred in MySQL
-        */
-       function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabasePostgres::replace' ) {
-               $table = $this->tableName( $table );
-
-               if ( count( $rows ) == 0 ) {
-                       return;
-               }
-
-               # Single row case
-               if ( !is_array( reset( $rows ) ) ) {
-                       $rows = array( $rows );
-               }
-
-               foreach( $rows as $row ) {
-                       # Delete rows which collide
-                       if ( $uniqueIndexes ) {
-                               $sql = "DELETE FROM $table WHERE ";
-                               $first = true;
-                               foreach ( $uniqueIndexes as $index ) {
-                                       if ( $first ) {
-                                               $first = false;
-                                               $sql .= '(';
-                                       } else {
-                                               $sql .= ') OR (';
-                                       }
-                                       if ( is_array( $index ) ) {
-                                               $first2 = true;
-                                               foreach ( $index as $col ) {
-                                                       if ( $first2 ) {
-                                                               $first2 = false;
-                                                       } else {
-                                                               $sql .= ' AND ';
-                                                       }
-                                                       $sql .= $col.'=' . $this->addQuotes( $row[$col] );
-                                               }
-                                       } else {
-                                               $sql .= $index.'=' . $this->addQuotes( $row[$index] );
-                                       }
-                               }
-                               $sql .= ')';
-                               $this->query( $sql, $fname );
-                       }
-
-                       # Now insert the row
-                       $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES ) .') VALUES (' .
-                               $this->makeList( $row, LIST_COMMA ) . ')';
-                       $this->query( $sql, $fname );
-               }
-       }
-
-       # DELETE where the condition is a join
-       function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabasePostgres::deleteJoin' ) {
-               if ( !$conds ) {
-                       throw new DBUnexpectedError( $this, 'DatabasePostgres::deleteJoin() called with empty $conds' );
-               }
-
-               $delTable = $this->tableName( $delTable );
-               $joinTable = $this->tableName( $joinTable );
-               $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
-               if ( $conds != '*' ) {
-                       $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
-               }
-               $sql .= ')';
-
-               $this->query( $sql, $fname );
-       }
-
        # Returns the size of a text field, or -1 for "unlimited"
        function textFieldSize( $table, $field ) {
                $table = $this->tableName( $table );
@@ -748,9 +696,29 @@ class DatabasePostgres extends DatabaseBase {
        }
 
        function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabasePostgres::duplicateTableStructure' ) {
+               $newName = $this->addIdentifierQuotes( $newName );
+               $oldName = $this->addIdentifierQuotes( $oldName );
                return $this->query( 'CREATE ' . ( $temporary ? 'TEMPORARY ' : '' ) . " TABLE $newName (LIKE $oldName INCLUDING DEFAULTS)", $fname );
        }
 
+       function listTables( $prefix = null, $fname = 'DatabasePostgres::listTables' ) {
+               global $wgDBmwschema;
+               $eschema = $this->addQuotes( $wgDBmwschema );
+               $result = $this->query( "SELECT tablename FROM pg_tables WHERE schemaname = $eschema", $fname );
+
+               $endArray = array();
+
+               foreach( $result as $table ) {
+                       $vars = get_object_vars($table);
+                       $table = array_pop( $vars );
+                       if( !$prefix || strpos( $table, $prefix ) === 0 ) {
+                               $endArray[] = $table;
+                       }
+               }
+
+               return $endArray;
+       }
+
        function timestamp( $ts = 0 ) {
                return wfTimestamp( TS_POSTGRES, $ts );
        }
@@ -762,23 +730,6 @@ class DatabasePostgres extends DatabaseBase {
                return $valuedata;
        }
 
-       function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
-               // Ignore errors during error handling to avoid infinite recursion
-               $ignore = $this->ignoreErrors( true );
-               $this->mErrorCount++;
-
-               if ( $ignore || $tempIgnore ) {
-                       wfDebug( "SQL ERROR (ignored): $error\n" );
-                       $this->ignoreErrors( $ignore );
-               } else {
-                       $message = "A database error has occurred.  Did you forget to run maintenance/update.php after upgrading?  See: http://www.mediawiki.org/wiki/Manual:Upgrading#Run_the_update_script\n" .
-                               "Query: $sql\n" .
-                               "Function: $fname\n" .
-                               "Error: $errno $error\n";
-                       throw new DBUnexpectedError( $this, $message );
-               }
-       }
-
        /**
         * @return string wikitext of a link to the server software's web site
         */
@@ -809,6 +760,7 @@ class DatabasePostgres extends DatabaseBase {
        /**
         * Query whether a given relation exists (in the given schema, or the
         * default mw one if not given)
+        * @return bool
         */
        function relationExists( $table, $types, $schema = false ) {
                global $wgDBmwschema;
@@ -818,7 +770,7 @@ class DatabasePostgres extends DatabaseBase {
                if ( !$schema ) {
                        $schema = $wgDBmwschema;
                }
-               $table = $this->tableName( $table );
+               $table = $this->tableName( $table, 'raw' );
                $etable = $this->addQuotes( $table );
                $eschema = $this->addQuotes( $schema );
                $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
@@ -832,8 +784,9 @@ class DatabasePostgres extends DatabaseBase {
        /**
         * For backward compatibility, this function checks both tables and
         * views.
+        * @return bool
         */
-       function tableExists( $table, $schema = false ) {
+       function tableExists( $table, $fname = __METHOD__, $schema = false ) {
                return $this->relationExists( $table, array( 'r', 'v' ), $schema );
        }
 
@@ -847,8 +800,8 @@ class DatabasePostgres extends DatabaseBase {
                $q = <<<SQL
        SELECT 1 FROM pg_class, pg_namespace, pg_trigger
                WHERE relnamespace=pg_namespace.oid AND relkind='r'
-                     AND tgrelid=pg_class.oid
-                     AND nspname=%s AND relname=%s AND tgname=%s
+                         AND tgrelid=pg_class.oid
+                         AND nspname=%s AND relname=%s AND tgname=%s
 SQL;
                $res = $this->query(
                        sprintf(
@@ -894,20 +847,23 @@ SQL;
        }
 
        /**
-        * Query whether a given schema exists. Returns the name of the owner
+        * Query whether a given schema exists. Returns true if it does, false if it doesn't.
+        * @return bool
         */
        function schemaExists( $schema ) {
-               $eschema = str_replace( "'", "''", $schema );
-               $SQL = "SELECT rolname FROM pg_catalog.pg_namespace n, pg_catalog.pg_roles r "
-                               ."WHERE n.nspowner=r.oid AND n.nspname = '$eschema'";
-               $res = $this->query( $SQL );
-               if ( $res && $res->numRows() ) {
-                       $row = $res->fetchObject();
-                       $owner = $row->rolname;
-               } else {
-                       $owner = false;
-               }
-               return $owner;
+               $exists = $this->selectField( '"pg_catalog"."pg_namespace"', 1,
+                       array( 'nspname' => $schema ), __METHOD__ );
+               return (bool)$exists;
+       }
+
+       /**
+        * Returns true if a given role (i.e. user) exists, false otherwise.
+        * @return bool
+        */
+       function roleExists( $roleName ) {
+               $exists = $this->selectField( '"pg_catalog"."pg_roles"', 1,
+                       array( 'rolname' => $roleName ), __METHOD__ );
+               return (bool)$exists;
        }
 
        function fieldInfo( $table, $field ) {
@@ -916,6 +872,7 @@ SQL;
 
        /**
         * pg_field_type() wrapper
+        * @return string
         */
        function fieldType( $res, $index ) {
                if ( $res instanceof ResultWrapper ) {
@@ -929,6 +886,10 @@ SQL;
                return $sql;
        }
 
+       /**
+        * @param $b
+        * @return Blob
+        */
        function encodeBlob( $b ) {
                return new Blob( pg_escape_bytea( $this->mConn, $b ) );
        }
@@ -944,6 +905,10 @@ SQL;
                return pg_escape_string( $this->mConn, $s );
        }
 
+       /**
+        * @param $s null|bool|Blob
+        * @return int|string
+        */
        function addQuotes( $s ) {
                if ( is_null( $s ) ) {
                        return 'NULL';
@@ -1001,13 +966,21 @@ SQL;
                }
 
                if ( isset( $options['GROUP BY'] ) ) {
-                       $preLimitTail .= ' GROUP BY ' . $options['GROUP BY'];
+                       $gb = is_array( $options['GROUP BY'] )
+                               ? implode( ',', $options['GROUP BY'] )
+                               : $options['GROUP BY'];
+                       $preLimitTail .= " GROUP BY {$gb}";
                }
+
                if ( isset( $options['HAVING'] ) ) {
                        $preLimitTail .= " HAVING {$options['HAVING']}";
                }
+
                if ( isset( $options['ORDER BY'] ) ) {
-                       $preLimitTail .= ' ORDER BY ' . $options['ORDER BY'];
+                       $ob = is_array( $options['ORDER BY'] )
+                               ? implode( ',', $options['ORDER BY'] )
+                               : $options['ORDER BY'];
+                       $preLimitTail .= " ORDER BY {$ob}";
                }
 
                //if ( isset( $options['LIMIT'] ) ) {
@@ -1046,4 +1019,17 @@ SQL;
        public function getSearchEngine() {
                return 'SearchPostgres';
        }
+
+       public function streamStatementEnd( &$sql, &$newLine ) {
+               # Allow dollar quoting for function declarations
+               if ( substr( $newLine, 0, 4 ) == '$mw$' ) {
+                       if ( $this->delimiter ) {
+                               $this->delimiter = false;
+                       }
+                       else {
+                               $this->delimiter = ';';
+                       }
+               }
+               return parent::streamStatementEnd( $sql, $newLine );
+       }
 } // end DatabasePostgres class