source: branches/rsr.v5.1.dev/web/punbb/include/dblayer/pgsql.php @ 3

<?php

/**
 * Copyright (C) 2008-2011 FluxBB
 * based on code by Rickard Andersson copyright (C) 2002-2008 PunBB
 * License: http://www.gnu.org/licenses/gpl.html GPL version 2 or higher
 */

// Make sure we have built in support for PostgreSQL
if (!function_exists('pg_connect'))
        exit('This PHP environment doesn\'t have PostgreSQL support built in. PostgreSQL support is required if you want to use a PostgreSQL database to run this forum. Consult the PHP documentation for further assistance.');


class DBLayer
{
        var $prefix;
        var $link_id;
        var $query_result;
        var $last_query_text = array();
        var $in_transaction = 0;

        var $saved_queries = array();
        var $num_queries = 0;

        var $error_no = false;
        var $error_msg = 'Unknown';

        var $datatype_transformations = array(
                '%^(TINY|SMALL)INT( )?(\\([0-9]+\\))?( )?(UNSIGNED)?$%i'                        =>      'SMALLINT',
                '%^(MEDIUM)?INT( )?(\\([0-9]+\\))?( )?(UNSIGNED)?$%i'                           =>      'INTEGER',
                '%^BIGINT( )?(\\([0-9]+\\))?( )?(UNSIGNED)?$%i'                                         =>      'BIGINT',
                '%^(TINY|MEDIUM|LONG)?TEXT$%i'                                                                          =>      'TEXT',
                '%^DOUBLE( )?(\\([0-9,]+\\))?( )?(UNSIGNED)?$%i'                                        =>      'DOUBLE PRECISION',
                '%^FLOAT( )?(\\([0-9]+\\))?( )?(UNSIGNED)?$%i'                                          =>      'REAL'
        );


        function DBLayer($db_host, $db_username, $db_password, $db_name, $db_prefix, $p_connect)
        {
                $this->prefix = $db_prefix;

                if ($db_host)
                {
                        if (strpos($db_host, ':') !== false)
                        {
                                list($db_host, $dbport) = explode(':', $db_host);
                                $connect_str[] = 'host='.$db_host.' port='.$dbport;
                        }
                        else
                                $connect_str[] = 'host='.$db_host;
                }

                if ($db_name)
                        $connect_str[] = 'dbname='.$db_name;

                if ($db_username)
                        $connect_str[] = 'user='.$db_username;

                if ($db_password)
                        $connect_str[] = 'password='.$db_password;

                if ($p_connect)
                        $this->link_id = @pg_pconnect(implode(' ', $connect_str));
                else
                        $this->link_id = @pg_connect(implode(' ', $connect_str));

                if (!$this->link_id)
                        error('Unable to connect to PostgreSQL server', __FILE__, __LINE__);

                // Setup the client-server character set (UTF-8)
                if (!defined('FORUM_NO_SET_NAMES'))
                        $this->set_names('utf8');

                return $this->link_id;
        }


        function start_transaction()
        {
                ++$this->in_transaction;

                return (@pg_query($this->link_id, 'BEGIN')) ? true : false;
        }


        function end_transaction()
        {
                --$this->in_transaction;

                if (@pg_query($this->link_id, 'COMMIT'))
                        return true;
                else
                {
                        @pg_query($this->link_id, 'ROLLBACK');
                        return false;
                }
        }


        function query($sql, $unbuffered = false) // $unbuffered is ignored since there is no pgsql_unbuffered_query()
        {
                if (strrpos($sql, 'LIMIT') !== false)
                        $sql = preg_replace('%LIMIT ([0-9]+),([ 0-9]+)%', 'LIMIT \\2 OFFSET \\1', $sql);

                if (defined('PUN_SHOW_QUERIES'))
                        $q_start = get_microtime();

                @pg_send_query($this->link_id, $sql);
                $this->query_result = @pg_get_result($this->link_id);

                if (pg_result_status($this->query_result) != PGSQL_FATAL_ERROR)
                {
                        if (defined('PUN_SHOW_QUERIES'))
                                $this->saved_queries[] = array($sql, sprintf('%.5f', get_microtime() - $q_start));

                        ++$this->num_queries;

                        $this->last_query_text[$this->query_result] = $sql;

                        return $this->query_result;
                }
                else
                {
                        if (defined('PUN_SHOW_QUERIES'))
                                $this->saved_queries[] = array($sql, 0);

                        $this->error_no = false;
                        $this->error_msg = @pg_result_error($this->query_result);

                        if ($this->in_transaction)
                                @pg_query($this->link_id, 'ROLLBACK');

                        --$this->in_transaction;

                        return false;
                }
        }


        function result($query_id = 0, $row = 0, $col = 0)
        {
                return ($query_id) ? @pg_fetch_result($query_id, $row, $col) : false;
        }


        function fetch_assoc($query_id = 0)
        {
                return ($query_id) ? @pg_fetch_assoc($query_id) : false;
        }


        function fetch_row($query_id = 0)
        {
                return ($query_id) ? @pg_fetch_row($query_id) : false;
        }


        function num_rows($query_id = 0)
        {
                return ($query_id) ? @pg_num_rows($query_id) : false;
        }


        function affected_rows()
        {
                return ($this->query_result) ? @pg_affected_rows($this->query_result) : false;
        }


        function insert_id()
        {
                $query_id = $this->query_result;

                if ($query_id && $this->last_query_text[$query_id] != '')
                {
                        if (preg_match('%^INSERT INTO ([a-z0-9\_\-]+)%is', $this->last_query_text[$query_id], $table_name))
                        {
                                // Hack (don't ask)
                                if (substr($table_name[1], -6) == 'groups')
                                        $table_name[1] .= '_g';

                                $temp_q_id = @pg_query($this->link_id, 'SELECT currval(\''.$table_name[1].'_id_seq\')');
                                return ($temp_q_id) ? intval(@pg_fetch_result($temp_q_id, 0)) : false;
                        }
                }

                return false;
        }


        function get_num_queries()
        {
                return $this->num_queries;
        }


        function get_saved_queries()
        {
                return $this->saved_queries;
        }


        function free_result($query_id = false)
        {
                if (!$query_id)
                        $query_id = $this->query_result;

                return ($query_id) ? @pg_free_result($query_id) : false;
        }


        function escape($str)
        {
                return is_array($str) ? '' : pg_escape_string($str);
        }


        function error()
        {
                $result['error_sql'] = @current(@end($this->saved_queries));
                $result['error_no'] = $this->error_no;
                $result['error_msg'] = $this->error_msg;

                return $result;
        }


        function close()
        {
                if ($this->link_id)
                {
                        if ($this->in_transaction)
                        {
                                if (defined('PUN_SHOW_QUERIES'))
                                        $this->saved_queries[] = array('COMMIT', 0);

                                @pg_query($this->link_id, 'COMMIT');
                        }

                        if ($this->query_result)
                                @pg_free_result($this->query_result);

                        return @pg_close($this->link_id);
                }
                else
                        return false;
        }


        function get_names()
        {
                $result = $this->query('SHOW client_encoding');
                return strtolower($this->result($result)); // MySQL returns lowercase so lets be consistent
        }


        function set_names($names)
        {
                return $this->query('SET NAMES \''.$this->escape($names).'\'');
        }


        function get_version()
        {
                $result = $this->query('SELECT VERSION()');

                return array(
                        'name'          => 'PostgreSQL',
                        'version'       => preg_replace('%^[^0-9]+([^\s,-]+).*$%', '\\1', $this->result($result))
                );
        }


        function table_exists($table_name, $no_prefix = false)
        {
                $result = $this->query('SELECT 1 FROM pg_class WHERE relname = \''.($no_prefix ? '' : $this->prefix).$this->escape($table_name).'\'');
                return $this->num_rows($result) > 0;
        }


        function field_exists($table_name, $field_name, $no_prefix = false)
        {
                $result = $this->query('SELECT 1 FROM pg_class c INNER JOIN pg_attribute a ON a.attrelid = c.oid WHERE c.relname = \''.($no_prefix ? '' : $this->prefix).$this->escape($table_name).'\' AND a.attname = \''.$this->escape($field_name).'\'');
                return $this->num_rows($result) > 0;
        }


        function index_exists($table_name, $index_name, $no_prefix = false)
        {
                $result = $this->query('SELECT 1 FROM pg_index i INNER JOIN pg_class c1 ON c1.oid = i.indrelid INNER JOIN pg_class c2 ON c2.oid = i.indexrelid WHERE c1.relname = \''.($no_prefix ? '' : $this->prefix).$this->escape($table_name).'\' AND c2.relname = \''.($no_prefix ? '' : $this->prefix).$this->escape($table_name).'_'.$this->escape($index_name).'\'');
                return $this->num_rows($result) > 0;
        }


        function create_table($table_name, $schema, $no_prefix = false)
        {
                if ($this->table_exists($table_name, $no_prefix))
                        return true;

                $query = 'CREATE TABLE '.($no_prefix ? '' : $this->prefix).$table_name." (\n";

                // Go through every schema element and add it to the query
                foreach ($schema['FIELDS'] as $field_name => $field_data)
                {
                        $field_data['datatype'] = preg_replace(array_keys($this->datatype_transformations), array_values($this->datatype_transformations), $field_data['datatype']);

                        $query .= $field_name.' '.$field_data['datatype'];

                        // The SERIAL datatype is a special case where we don't need to say not null
                        if (!$field_data['allow_null'] && $field_data['datatype'] != 'SERIAL')
                                $query .= ' NOT NULL';

                        if (isset($field_data['default']))
                                $query .= ' DEFAULT '.$field_data['default'];

                        $query .= ",\n";
                }

                // If we have a primary key, add it
                if (isset($schema['PRIMARY KEY']))
                        $query .= 'PRIMARY KEY ('.implode(',', $schema['PRIMARY KEY']).'),'."\n";

                // Add unique keys
                if (isset($schema['UNIQUE KEYS']))
                {
                        foreach ($schema['UNIQUE KEYS'] as $key_name => $key_fields)
                                $query .= 'UNIQUE ('.implode(',', $key_fields).'),'."\n";
                }

                // We remove the last two characters (a newline and a comma) and add on the ending
                $query = substr($query, 0, strlen($query) - 2)."\n".')';

                $result = $this->query($query) ? true : false;

                // Add indexes
                if (isset($schema['INDEXES']))
                {
                        foreach ($schema['INDEXES'] as $index_name => $index_fields)
                                $result &= $this->add_index($table_name, $index_name, $index_fields, false, $no_prefix);
                }

                return $result;
        }


        function drop_table($table_name, $no_prefix = false)
        {
                if (!$this->table_exists($table_name, $no_prefix))
                        return true;

                return $this->query('DROP TABLE '.($no_prefix ? '' : $this->prefix).$table_name) ? true : false;
        }


        function rename_table($old_table, $new_table, $no_prefix = false)
        {
                // If there new table exists and the old one doesn't, then we're happy
                if ($this->table_exists($new_table, $no_prefix) && !$this->table_exists($old_table, $no_prefix))
                        return true;

                return $this->query('ALTER TABLE '.($no_prefix ? '' : $this->prefix).$old_table.' RENAME TO '.($no_prefix ? '' : $this->prefix).$new_table) ? true : false;
        }


        function add_field($table_name, $field_name, $field_type, $allow_null, $default_value = null, $after_field = null, $no_prefix = false)
        {
                if ($this->field_exists($table_name, $field_name, $no_prefix))
                        return true;

                $field_type = preg_replace(array_keys($this->datatype_transformations), array_values($this->datatype_transformations), $field_type);

                $result = $this->query('ALTER TABLE '.($no_prefix ? '' : $this->prefix).$table_name.' ADD '.$field_name.' '.$field_type) ? true : false;

                if ($default_value !== null)
                {
                        if (!is_int($default_value) && !is_float($default_value))
                                $default_value = '\''.$this->escape($default_value).'\'';

                        $result &= $this->query('ALTER TABLE '.($no_prefix ? '' : $this->prefix).$table_name.' ALTER '.$field_name.' SET DEFAULT '.$default_value) ? true : false;
                        $result &= $this->query('UPDATE '.($no_prefix ? '' : $this->prefix).$table_name.' SET '.$field_name.'='.$default_value) ? true : false;
                }

                if (!$allow_null)
                        $result &= $this->query('ALTER TABLE '.($no_prefix ? '' : $this->prefix).$table_name.' ALTER '.$field_name.' SET NOT NULL') ? true : false;

                return $result;
        }


        function alter_field($table_name, $field_name, $field_type, $allow_null, $default_value = null, $after_field = null, $no_prefix = false)
        {
                if (!$this->field_exists($table_name, $field_name, $no_prefix))
                        return true;

                $field_type = preg_replace(array_keys($this->datatype_transformations), array_values($this->datatype_transformations), $field_type);

                $result = $this->add_field($table_name, 'tmp_'.$field_name, $field_type, $allow_null, $default_value, $after_field, $no_prefix);
                $result &= $this->query('UPDATE '.($no_prefix ? '' : $this->prefix).$table_name.' SET tmp_'.$field_name.' = '.$field_name) ? true : false;
                $result &= $this->drop_field($table_name, $field_name, $no_prefix);
                $result &= $this->query('ALTER TABLE '.($no_prefix ? '' : $this->prefix).$table_name.' RENAME COLUMN tmp_'.$field_name.' TO '.$field_name) ? true : false;

                return $result;
        }


        function drop_field($table_name, $field_name, $no_prefix = false)
        {
                if (!$this->field_exists($table_name, $field_name, $no_prefix))
                        return true;

                return $this->query('ALTER TABLE '.($no_prefix ? '' : $this->prefix).$table_name.' DROP '.$field_name) ? true : false;
        }


        function add_index($table_name, $index_name, $index_fields, $unique = false, $no_prefix = false)
        {
                if ($this->index_exists($table_name, $index_name, $no_prefix))
                        return true;

                return $this->query('CREATE '.($unique ? 'UNIQUE ' : '').'INDEX '.($no_prefix ? '' : $this->prefix).$table_name.'_'.$index_name.' ON '.($no_prefix ? '' : $this->prefix).$table_name.'('.implode(',', $index_fields).')') ? true : false;
        }


        function drop_index($table_name, $index_name, $no_prefix = false)
        {
                if (!$this->index_exists($table_name, $index_name, $no_prefix))
                        return true;

                return $this->query('DROP INDEX '.($no_prefix ? '' : $this->prefix).$table_name.'_'.$index_name) ? true : false;
        }

        function truncate_table($table_name, $no_prefix = false)
        {
                return $this->query('DELETE FROM '.($no_prefix ? '' : $this->prefix).$table_name) ? true : false;
        }
}