This is giving me a syntax error. It looks gross this way, but I can't think of any...
[lhc/web/wiklou.git] / includes / DatabasePostgres.php
index 9e7d8c6..edff892 100644 (file)
@@ -7,8 +7,8 @@
  * than MySQL ones, some of them should be moved to parent
  * Database class.
  *
+ * @addtogroup Database
  */
-
 class PostgresField {
        private $name, $tablename, $type, $nullable, $max_length;
 
@@ -16,7 +16,13 @@ class PostgresField {
        global $wgDBmwschema;
 
                $q = <<<END
-SELECT typname, attnotnull, attlen
+SELECT 
+CASE WHEN typname = 'int2' THEN 'smallint'
+WHEN typname = 'int4' THEN 'integer'
+WHEN typname = 'int8' THEN 'bigint'
+WHEN typname = 'bpchar' THEN 'char'
+ELSE typname END AS typname,
+attnotnull, attlen
 FROM pg_class, pg_namespace, pg_attribute, pg_type
 WHERE relnamespace=pg_namespace.oid
 AND relkind='r'
@@ -63,6 +69,9 @@ END;
        }
 }
 
+/**
+ * @addtogroup Database
+ */
 class DatabasePostgres extends Database {
        var $mInsertId = NULL;
        var $mLastResult = NULL;
@@ -99,9 +108,20 @@ class DatabasePostgres extends Database {
        function implicitGroupby() {
                return false;
        }
+       function implicitOrderby() {
+               return false;
+       }
        function searchableIPs() {
                return true;
        }
+       function functionalIndexes() {
+               return true;
+       }
+
+       function hasConstraint( $name ) {
+               $SQL = "SELECT 1 FROM pg_catalog.pg_constraint WHERE conname = '" . pg_escape_string( $name ) . "'";
+               return $this->numRows($res = $this->doQuery($SQL));
+       }
 
        static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0)
        {
@@ -152,9 +172,10 @@ class DatabasePostgres extends Database {
 
                $this->mOpened = true;
                ## If this is the initial connection, setup the schema stuff and possibly create the user
+               ## TODO: Move this out of open()
                if (defined('MEDIAWIKI_INSTALL')) {
                        global $wgDBname, $wgDBuser, $wgDBpassword, $wgDBsuperuser, $wgDBmwschema,
-                               $wgDBts2schema, $wgDBtimezone;
+                               $wgDBts2schema;
 
                        print "<li>Checking the version of Postgres...";
                        $version = $this->getServerVersion();
@@ -165,20 +186,6 @@ class DatabasePostgres extends Database {
                        }
                        print "version $this->numeric_version is OK.</li>\n";
 
-                       print "<li>Figuring out timezone the database is using...";
-                       ## Figure out what the local timezone is for this database
-                       $wgDBtimezone = 99;
-                       if ($this->doQuery("SET datestyle TO ISO")) {
-                               $res = $this->doQuery("SELECT substring(now() FROM E'-?\\\d\\\d\$')::int");
-                               if ($res) {
-                                       $wgDBtimezone = pg_fetch_result($res,0,0);
-                                       print "timezone is '$wgDBtimezone'</li>\n";
-                               }
-                       }
-                       if ($wgDBtimezone === 99) {
-                               print "<b>UNKNOWN</b>. Defaulting to '0'</li>\n";
-                       }
-
                        $safeuser = $this->quote_ident($wgDBuser);
                        ## Are we connecting as a superuser for the first time?
                        if ($wgDBsuperuser) {
@@ -389,7 +396,10 @@ class DatabasePostgres extends Database {
                                        "WHERE relname = 'pg_pltemplate' AND nspname='pg_catalog'";
                                $rows = $this->numRows($this->doQuery($SQL));
                                if ($rows >= 1) {
+                                       $olde = error_reporting(0);
+                                       error_reporting($olde - E_WARNING);
                                        $result = $this->doQuery("CREATE LANGUAGE plpgsql");
+                                       error_reporting($olde);
                                        if (!$result) {
                                                print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
                                                dieout("</ul>");
@@ -424,6 +434,39 @@ class DatabasePostgres extends Database {
                                print "<li>Schema \"$wgDBmwschema\" exists and is owned by \"$user\". Excellent.</li>\n";
                        }
 
+                       ## Always return GMT time to accomodate the existing integer-based timestamp assumption
+                       print "<li>Setting the timezone to GMT for user \"$user\" ...";
+                       $SQL = "ALTER USER $safeuser SET timezone = 'GMT'";
+                       $result = pg_query($this->mConn, $SQL);
+                       if (!$result) {
+                               print "<b>FAILED</b>.</li>\n";
+                               dieout("</ul>");
+                       }
+                       print "OK</li>\n";
+                       ## Set for the rest of this session
+                       $SQL = "SET timezone = 'GMT'";
+                       $result = pg_query($this->mConn, $SQL);
+                       if (!$result) {
+                               print "<li>Failed to set timezone</li>\n";
+                               dieout("</ul>");
+                       }
+
+                       print "<li>Setting the datestyle to ISO, YMD for user \"$user\" ...";
+                       $SQL = "ALTER USER $safeuser SET datestyle = 'ISO, YMD'";
+                       $result = pg_query($this->mConn, $SQL);
+                       if (!$result) {
+                               print "<b>FAILED</b>.</li>\n";
+                               dieout("</ul>");
+                       }
+                       print "OK</li>\n";
+                       ## Set for the rest of this session
+                       $SQL = "SET datestyle = 'ISO, YMD'";
+                       $result = pg_query($this->mConn, $SQL);
+                       if (!$result) {
+                               print "<li>Failed to set datestyle</li>\n";
+                               dieout("</ul>");
+                       }
+
                        ## Fix up the search paths if needed
                        print "<li>Setting the search path for user \"$user\" ...";
                        $path = $this->quote_ident($wgDBmwschema);
@@ -454,6 +497,15 @@ class DatabasePostgres extends Database {
                        $this->doQuery("SET client_min_messages = 'ERROR'");
                }
 
+               global $wgDBmwschema, $wgDBts2schema;
+               if (isset( $wgDBmwschema ) && isset( $wgDBts2schema )
+                       && $wgDBmwschema !== 'mediawiki'
+                       && preg_match( '/^\w+$/', $wgDBmwschema )
+                       && preg_match( '/^\w+$/', $wgDBts2schema )
+               ) {
+                       $this->doQuery("SET search_path = $wgDBmwschema, $wgDBts2schema, public");
+               }
+
                return $this->mConn;
        }
 
@@ -471,6 +523,9 @@ class DatabasePostgres extends Database {
        }
 
        function doQuery( $sql ) {
+               if (function_exists('mb_convert_encoding')) {
+                       return $this->mLastResult=pg_query( $this->mConn , mb_convert_encoding($sql,'UTF-8') );
+               }
                return $this->mLastResult=pg_query( $this->mConn , $sql);
        }
 
@@ -479,18 +534,24 @@ class DatabasePostgres extends Database {
        }
 
        function freeResult( $res ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
                if ( !@pg_free_result( $res ) ) {
                        throw new DBUnexpectedError($this,  "Unable to free Postgres result\n" );
                }
        }
 
        function fetchObject( $res ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
                @$row = pg_fetch_object( $res );
                # FIXME: HACK HACK HACK HACK debug
 
                # TODO:
                # hashar : not sure if the following test really trigger if the object
-               #          fetching failled.
+               #          fetching failed.
                if( pg_last_error($this->mConn) ) {
                        throw new DBUnexpectedError($this,  'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) );
                }
@@ -498,6 +559,9 @@ class DatabasePostgres extends Database {
        }
 
        function fetchRow( $res ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
                @$row = pg_fetch_array( $res );
                if( pg_last_error($this->mConn) ) {
                        throw new DBUnexpectedError($this,  'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) );
@@ -506,14 +570,27 @@ class DatabasePostgres extends Database {
        }
 
        function numRows( $res ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
                @$n = pg_num_rows( $res );
                if( pg_last_error($this->mConn) ) {
                        throw new DBUnexpectedError($this,  'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn) ) );
                }
                return $n;
        }
-       function numFields( $res ) { return pg_num_fields( $res ); }
-       function fieldName( $res, $n ) { return pg_field_name( $res, $n ); }
+       function numFields( $res ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
+               return pg_num_fields( $res );
+       }
+       function fieldName( $res, $n ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
+               return pg_field_name( $res, $n );
+       }
 
        /**
         * This must be called after nextSequenceVal
@@ -522,7 +599,13 @@ class DatabasePostgres extends Database {
                return $this->mInsertId;
        }
 
-       function dataSeek( $res, $row ) { return pg_result_seek( $res, $row ); }
+       function dataSeek( $res, $row ) {
+               if ( $res instanceof ResultWrapper ) {
+                       $res = $res->result;
+               }
+               return pg_result_seek( $res, $row );
+       }
+
        function lastError() {
                if ( $this->mConn ) {
                        return pg_last_error();
@@ -536,9 +619,36 @@ class DatabasePostgres extends Database {
        }
 
        function affectedRows() {
+               if( !isset( $this->mLastResult ) or ! $this->mLastResult )
+                       return 0;
+
                return pg_affected_rows( $this->mLastResult );
        }
 
+       /**
+        * Estimate rows in dataset
+        * Returns estimated count, based on EXPLAIN output
+        * This is not necessarily an accurate estimate, so use sparingly
+        * Returns -1 if count cannot be found
+        * Takes same arguments as Database::select()
+        */
+       
+       function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) {
+               $options['EXPLAIN'] = true;
+               $res = $this->select( $table, $vars, $conds, $fname, $options );
+               $rows = -1;
+               if ( $res ) {
+                       $row = $this->fetchRow( $res );
+                       $count = array();
+                       if( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
+                               $rows = $count[1];
+                       }
+                       $this->freeResult($res);
+               }
+               return $rows;
+       }
+
+
        /**
         * Returns information about an index
         * If errors are explicitly ignored, returns NULL on failure
@@ -549,13 +659,9 @@ class DatabasePostgres extends Database {
                if ( !$res ) {
                        return NULL;
                }
-
                while ( $row = $this->fetchObject( $res ) ) {
                        if ( $row->indexname == $index ) {
                                return $row;
-                               
-                               // BUG: !!!! This code needs to be synced up with database.php
-                               
                        }
                }
                return false;
@@ -573,33 +679,83 @@ class DatabasePostgres extends Database {
 
        }
 
-       function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
-               # Postgres doesn't support options
-               # We have a go at faking one of them
-               # TODO: DELAYED, LOW_PRIORITY
+       /**
+        * INSERT wrapper, inserts an array into a table
+        *
+        * $args may be a single associative array, or an array of these with numeric keys, 
+        * for multi-row insert (Postgres version 8.2 and above only).
+        *
+        * @param array $table   String: Name of the table to insert to.
+        * @param array $args    Array: Items to insert into the table.
+        * @param array $fname   String: Name of the function, for profiling
+        * @param mixed $options String or Array. Valid options: IGNORE
+        *
+        * @return bool Success of insert operation. IGNORE always returns true.
+        */
+       function insert( $table, $args, $fname = 'DatabasePostgres::insert', $options = array() ) {
+               global $wgDBversion;
+
+               $table = $this->tableName( $table );
+               if (! isset( $wgDBversion ) ) {
+                       $this->getServerVersion();
+                       $wgDBversion = $this->numeric_version;
+               }
 
-               if ( !is_array($options))
-                       $options = array($options);
+               if ( !is_array( $options ) )
+                       $options = array( $options );
 
-               if ( in_array( 'IGNORE', $options ) )
-                       $oldIgnore = $this->ignoreErrors( true );
+               if ( isset( $args[0] ) && is_array( $args[0] ) ) {
+                       $multi = true;
+                       $keys = array_keys( $args[0] );
+               }
+               else {
+                       $multi = false;
+                       $keys = array_keys( $args );
+               }
 
-               # IGNORE is performed using single-row inserts, ignoring errors in each
-               # FIXME: need some way to distiguish between key collision and other types of error
-               $oldIgnore = $this->ignoreErrors( true );
-               if ( !is_array( reset( $a ) ) ) {
-                       $a = array( $a );
+               $ignore = in_array( 'IGNORE', $options ) ? 1 : 0;
+               if ( $ignore )
+                       $olde = error_reporting( 0 );
+
+               $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
+
+               if ( $multi ) {
+                       if ( $wgDBversion >= 8.2 ) {
+                               $first = true;
+                               foreach ( $args as $row ) {
+                                       if ( $first ) {
+                                               $first = false;
+                                       } else {
+                                               $sql .= ',';
+                                       }
+                                       $sql .= '(' . $this->makeList( $row ) . ')';
+                               }
+                               $res = (bool)$this->query( $sql, $fname, $ignore );
+                       }
+                       else {
+                               $res = true;
+                               $origsql = $sql;
+                               foreach ( $args as $row ) {
+                                       $tempsql = $origsql;
+                                       $tempsql .= '(' . $this->makeList( $row ) . ')';
+                                       $tempres = (bool)$this->query( $tempsql, $fname, $ignore );
+                                       if (! $tempres)
+                                               $res = false;
+                               }
+                       }
+               }
+               else {
+                       $sql .= '(' . $this->makeList( $args ) . ')';
+                       $res = (bool)$this->query( $sql, $fname, $ignore );
                }
-               foreach ( $a as $row ) {
-                       parent::insert( $table, $row, $fname, array() );
+
+               if ( $ignore ) {
+                       $olde = error_reporting( $olde );
+                       return true;
                }
-               $this->ignoreErrors( $oldIgnore );
-               $retVal = true;
 
-               if ( in_array( 'IGNORE', $options ) )
-                       $this->ignoreErrors( $oldIgnore );
+               return $res;
 
-               return $retVal;
        }
 
        function tableName( $name ) {
@@ -818,10 +974,10 @@ class DatabasePostgres extends Database {
                        . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
                        . "AND c.relkind IN ('" . implode("','", $types) . "')";
                $res = $this->query( $SQL );
-               $count = $res ? pg_num_rows($res) : 0;
+               $count = $res ? $res->numRows() : 0;
                if ($res)
                        $this->freeResult( $res );
-               return $count;
+               return $count ? true : false;
        }
 
        /*
@@ -837,7 +993,7 @@ class DatabasePostgres extends Database {
        }
 
        function triggerExists($table, $trigger) {
-       global $wgDBmwschema;
+               global $wgDBmwschema;
 
                $q = <<<END
        SELECT 1 FROM pg_class, pg_namespace, pg_trigger
@@ -849,14 +1005,15 @@ END;
                                $this->addQuotes($wgDBmwschema),
                                $this->addQuotes($table),
                                $this->addQuotes($trigger)));
-               $row = $this->fetchRow($res);
-               $exists = !!$row;
+               if (!$res)
+                       return NULL;
+               $rows = $res->numRows();
                $this->freeResult($res);
-               return $exists;
+               return $rows;
        }
 
        function ruleExists($table, $rule) {
-       global $wgDBmwschema;
+               global $wgDBmwschema;
                $exists = $this->selectField("pg_rules", "rulename",
                                array(  "rulename" => $rule,
                                        "tablename" => $table,
@@ -864,6 +1021,21 @@ END;
                return $exists === $rule;
        }
 
+       function constraintExists($table, $constraint) {
+               global $wgDBmwschema;
+               $SQL = sprintf("SELECT 1 FROM information_schema.table_constraints ".
+                          "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
+                       $this->addQuotes($wgDBmwschema),        
+                       $this->addQuotes($table),       
+                       $this->addQuotes($constraint));
+               $res = $this->query($SQL);
+               if (!$res)
+                       return NULL;
+               $rows = $res->numRows();
+               $this->freeResult($res);
+               return $rows;
+       }
+
        /**
         * Query whether a given schema exists. Returns the name of the owner
         */
@@ -872,7 +1044,12 @@ END;
                $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 );
-               $owner = $res ? pg_num_rows($res) ? pg_fetch_result($res, 0, 0) : false : false;
+               if ( $res && $res->numRows() ) {
+                       $row = $res->fetchObject();
+                       $owner = $row->rolname;
+               } else {
+                       $owner = false;
+               }
                if ($res)
                        $this->freeResult($res);
                return $owner;
@@ -890,7 +1067,7 @@ END;
                        . "WHERE c.relnamespace = n.oid AND c.relname = '$etable' AND n.nspname = '$eschema' "
                        . "AND a.attrelid = c.oid AND a.attname = '$ecol'";
                $res = $this->query( $SQL, $fname );
-               $count = $res ? pg_num_rows($res) : 0;
+               $count = $res ? $res->numRows() : 0;
                if ($res)
                        $this->freeResult( $res );
                return $count;
@@ -927,9 +1104,9 @@ END;
                        $this->doQuery("DROP TABLE $wgDBmwschema.$ctest");
                }
                $SQL = "CREATE TABLE $wgDBmwschema.$ctest(a int)";
-               error_reporting( 0 );
+               $olde = error_reporting( 0 );
                $res = $this->doQuery($SQL);
-               error_reporting( E_ALL );
+               error_reporting( $olde );
                if (!$res) {
                        print "<b>FAILED</b>. Make sure that the user \"$wgDBuser\" can write to the schema \"$wgDBmwschema\"</li>\n";
                        dieout("</ul>");
@@ -984,10 +1161,14 @@ END;
                $this->doQuery("COMMIT");
        }
 
-       function encodeBlob($b) {
-               return array('bytea',pg_escape_bytea($b));
+       function encodeBlob( $b ) {
+               return new Blob ( pg_escape_bytea( $b ) ) ;
        }
-       function decodeBlob($b) {
+
+       function decodeBlob( $b ) {
+               if ($b instanceof Blob) {
+                       $b = $b->fetch();
+               }
                return pg_unescape_bytea( $b );
        }
 
@@ -998,11 +1179,10 @@ END;
        function addQuotes( $s ) {
                if ( is_null( $s ) ) {
                        return 'NULL';
-               } else if (is_array( $s )) { ## Assume it is bytea data
-                       return "E'$s[1]'";
+               } else if ($s instanceof Blob) {
+                       return "'".$s->fetch($s)."'";
                }
                return "'" . pg_escape_string($s) . "'";
-               // Unreachable: return "E'" . pg_escape_string($s) . "'";
        }
 
        function quote_ident( $s ) {
@@ -1015,8 +1195,7 @@ END;
        }
 
        /**
-        * Returns an optional USE INDEX clause to go after the table, and a
-        * string to go at the end of the query
+        * Various select options
         *
         * @private
         *
@@ -1026,7 +1205,7 @@ END;
         */
        function makeSelectOptions( $options ) {
                $preLimitTail = $postLimitTail = '';
-               $startOpts = '';
+               $startOpts = $useIndex = '';
 
                $noKeyOptions = array();
                foreach ( $options as $key => $option ) {
@@ -1036,6 +1215,7 @@ END;
                }
 
                if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY " . $options['GROUP BY'];
+               if ( isset( $options['HAVING'] ) ) $preLimitTail .= " HAVING {$options['HAVING']}";
                if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY " . $options['ORDER BY'];
                
                //if (isset($options['LIMIT'])) {
@@ -1046,27 +1226,33 @@ END;
 
                if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $postLimitTail .= ' FOR UPDATE';
                if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $postLimitTail .= ' 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 = '';
-               }
+               if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
                
                return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
        }
 
        public function setTimeout( $timeout ) {
-               /// @fixme no-op
+               // @todo fixme no-op
        }
 
        function ping() {
                wfDebug( "Function ping() not written for DatabasePostgres.php yet");
                return true;
        }
+       
+       /**
+        * How lagged is this slave?
+        *
+        */
+       public function getLag() {
+               # Not implemented for PostgreSQL
+               return false;
+       }
 
+       function buildConcat( $stringList ) {
+               return implode( ' || ', $stringList );
+       }
 
 } // end DatabasePostgres class
 
-?>
+