<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Db

 * @subpackage Adapter

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Db2.php 23199 2010-10-21 14:27:06Z ralph $

 *

 */

/**

 * @see Zend_Db

 */

require_once 'Zend/Db.php';

/**

 * @see Zend_Db_Adapter_Abstract

 */

require_once 'Zend/Db/Adapter/Abstract.php';

/**

 * @see Zend_Db_Statement_Db2

 */

require_once 'Zend/Db/Statement/Db2.php';

/**

 * @package    Zend_Db

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Db_Adapter_Db2 extends Zend_Db_Adapter_Abstract

{

    /**

     * User-provided configuration.

     *

     * Basic keys are:

     *

     * username   => (string)  Connect to the database as this username.

     * password   => (string)  Password associated with the username.

     * host       => (string)  What host to connect to (default 127.0.0.1)

     * dbname     => (string)  The name of the database to user

     * protocol   => (string)  Protocol to use, defaults to "TCPIP"

     * port       => (integer) Port number to use for TCP/IP if protocol is "TCPIP"

     * persistent => (boolean) Set TRUE to use a persistent connection (db2_pconnect)

     * os         => (string)  This should be set to 'i5' if the db is on an os400/i5

     * schema     => (string)  The default schema the connection should use

     *

     * @var array

     */

    protected $_config = array(

        'dbname'       => null,

        'username'     => null,

        'password'     => null,

        'host'         => 'localhost',

        'port'         => '50000',

        'protocol'     => 'TCPIP',

        'persistent'   => false,

        'os'           => null,

        'schema'       => null

    );

    /**

     * Execution mode

     *

     * @var int execution flag (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)

     */

    protected $_execute_mode = DB2_AUTOCOMMIT_ON;

    /**

     * Default class name for a DB statement.

     *

     * @var string

     */

    protected $_defaultStmtClass = 'Zend_Db_Statement_Db2';

    protected $_isI5 = false;

    /**

     * Keys are UPPERCASE SQL datatypes or the constants

     * Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.

     *

     * Values are:

     * 0 = 32-bit integer

     * 1 = 64-bit integer

     * 2 = float or decimal

     *

     * @var array Associative array of datatypes to values 0, 1, or 2.

     */

    protected $_numericDataTypes = array(

        Zend_Db::INT_TYPE    => Zend_Db::INT_TYPE,

        Zend_Db::BIGINT_TYPE => Zend_Db::BIGINT_TYPE,

        Zend_Db::FLOAT_TYPE  => Zend_Db::FLOAT_TYPE,

        'INTEGER'            => Zend_Db::INT_TYPE,

        'SMALLINT'           => Zend_Db::INT_TYPE,

        'BIGINT'             => Zend_Db::BIGINT_TYPE,

        'DECIMAL'            => Zend_Db::FLOAT_TYPE,

        'NUMERIC'            => Zend_Db::FLOAT_TYPE

    );

    /**

     * Creates a connection resource.

     *

     * @return void

     */

    protected function _connect()

    {

        if (is_resource($this->_connection)) {

            // connection already exists

            return;

        }

        if (!extension_loaded('ibm_db2')) {

            /**

             * @see Zend_Db_Adapter_Db2_Exception

             */

            require_once 'Zend/Db/Adapter/Db2/Exception.php';

            throw new Zend_Db_Adapter_Db2_Exception('The IBM DB2 extension is required for this adapter but the extension is not loaded');

        }

        $this->_determineI5();

        if ($this->_config['persistent']) {

            // use persistent connection

            $conn_func_name = 'db2_pconnect';

        } else {

            // use "normal" connection

            $conn_func_name = 'db2_connect';

        }

        if (!isset($this->_config['driver_options']['autocommit'])) {

            // set execution mode

            $this->_config['driver_options']['autocommit'] = &$this->_execute_mode;

        }

        if (isset($this->_config['options'][Zend_Db::CASE_FOLDING])) {

            $caseAttrMap = array(

                Zend_Db::CASE_NATURAL => DB2_CASE_NATURAL,

                Zend_Db::CASE_UPPER   => DB2_CASE_UPPER,

                Zend_Db::CASE_LOWER   => DB2_CASE_LOWER

            );

            $this->_config['driver_options']['DB2_ATTR_CASE'] = $caseAttrMap[$this->_config['options'][Zend_Db::CASE_FOLDING]];

        }

        if ($this->_isI5 && isset($this->_config['driver_options']['i5_naming'])) {

            if ($this->_config['driver_options']['i5_naming']) {

                $this->_config['driver_options']['i5_naming'] = DB2_I5_NAMING_ON;

            } else {

                $this->_config['driver_options']['i5_naming'] = DB2_I5_NAMING_OFF;

            }

        }

        if ($this->_config['host'] !== 'localhost' && !$this->_isI5) {

            // if the host isn't localhost, use extended connection params

            $dbname = 'DRIVER={IBM DB2 ODBC DRIVER}' .

                     ';DATABASE=' . $this->_config['dbname'] .

                     ';HOSTNAME=' . $this->_config['host'] .

                     ';PORT='     . $this->_config['port'] .

                     ';PROTOCOL=' . $this->_config['protocol'] .

                     ';UID='      . $this->_config['username'] .

                     ';PWD='      . $this->_config['password'] .';';

            $this->_connection = $conn_func_name(

                $dbname,

                null,

                null,

                $this->_config['driver_options']

            );

        } else {

            // host is localhost, so use standard connection params

            $this->_connection = $conn_func_name(

                $this->_config['dbname'],

                $this->_config['username'],

                $this->_config['password'],

                $this->_config['driver_options']

            );

        }

        // check the connection

        if (!$this->_connection) {

            /**

             * @see Zend_Db_Adapter_Db2_Exception

             */

            require_once 'Zend/Db/Adapter/Db2/Exception.php';

            throw new Zend_Db_Adapter_Db2_Exception(db2_conn_errormsg(), db2_conn_error());

        }

    }

    /**

     * Test if a connection is active

     *

     * @return boolean

     */

    public function isConnected()

    {

        return ((bool) (is_resource($this->_connection)

                     && get_resource_type($this->_connection) == 'DB2 Connection'));

    }

    /**

     * Force the connection to close.

     *

     * @return void

     */

    public function closeConnection()

    {

        if ($this->isConnected()) {

            db2_close($this->_connection);

        }

        $this->_connection = null;

    }

    /**

     * Returns an SQL statement for preparation.

     *

     * @param string $sql The SQL statement with placeholders.

     * @return Zend_Db_Statement_Db2

     */

    public function prepare($sql)

    {

        $this->_connect();

        $stmtClass = $this->_defaultStmtClass;

        if (!class_exists($stmtClass)) {

            require_once 'Zend/Loader.php';

            Zend_Loader::loadClass($stmtClass);

        }

        $stmt = new $stmtClass($this, $sql);

        $stmt->setFetchMode($this->_fetchMode);

        return $stmt;

    }

    /**

     * Gets the execution mode

     *

     * @return int the execution mode (DB2_AUTOCOMMIT_ON or DB2_AUTOCOMMIT_OFF)

     */

    public function _getExecuteMode()

    {

        return $this->_execute_mode;

    }

    /**

     * @param integer $mode

     * @return void

     */

    public function _setExecuteMode($mode)

    {

        switch ($mode) {

            case DB2_AUTOCOMMIT_OFF:

            case DB2_AUTOCOMMIT_ON:

                $this->_execute_mode = $mode;

                db2_autocommit($this->_connection, $mode);

                break;

            default:

                /**

                 * @see Zend_Db_Adapter_Db2_Exception

                 */

                require_once 'Zend/Db/Adapter/Db2/Exception.php';

                throw new Zend_Db_Adapter_Db2_Exception("execution mode not supported");

                break;

        }

    }

    /**

     * Quote a raw string.

     *

     * @param string $value     Raw string

     * @return string           Quoted string

     */

    protected function _quote($value)

    {

        if (is_int($value) || is_float($value)) {

            return $value;

        }

        /**

         * Use db2_escape_string() if it is present in the IBM DB2 extension.

         * But some supported versions of PHP do not include this function,

         * so fall back to default quoting in the parent class.

         */

        if (function_exists('db2_escape_string')) {

            return "'" . db2_escape_string($value) . "'";

        }

        return parent::_quote($value);

    }

    /**

     * @return string

     */

    public function getQuoteIdentifierSymbol()

    {

        $this->_connect();

        $info = db2_server_info($this->_connection);

        if ($info) {

            $identQuote = $info->IDENTIFIER_QUOTE_CHAR;

        } else {

            // db2_server_info() does not return result on some i5 OS version

            if ($this->_isI5) {

                $identQuote ="'";

            }

        }

        return $identQuote;

    }

    /**

     * Returns a list of the tables in the database.

     * @param string $schema OPTIONAL

     * @return array

     */

    public function listTables($schema = null)

    {

        $this->_connect();

        if ($schema === null && $this->_config['schema'] != null) {

            $schema = $this->_config['schema'];

        }

        $tables = array();

        if (!$this->_isI5) {

            if ($schema) {

                $stmt = db2_tables($this->_connection, null, $schema);

            } else {

                $stmt = db2_tables($this->_connection);

            }

            while ($row = db2_fetch_assoc($stmt)) {

                $tables[] = $row['TABLE_NAME'];

            }

        } else {

            $tables = $this->_i5listTables($schema);

        }

        return $tables;

    }

    /**

     * Returns the column descriptions for a table.

     *

     * The return value is an associative array keyed by the column name,

     * as returned by the RDBMS.

     *

     * The value of each array element is an associative array

     * with the following keys:

     *

     * SCHEMA_NAME      => string; name of database or schema

     * TABLE_NAME       => string;

     * COLUMN_NAME      => string; column name

     * COLUMN_POSITION  => number; ordinal position of column in table

     * DATA_TYPE        => string; SQL datatype name of column

     * DEFAULT          => string; default expression of column, null if none

     * NULLABLE         => boolean; true if column can have nulls

     * LENGTH           => number; length of CHAR/VARCHAR

     * SCALE            => number; scale of NUMERIC/DECIMAL

     * PRECISION        => number; precision of NUMERIC/DECIMAL

     * UNSIGNED         => boolean; unsigned property of an integer type

     *                     DB2 not supports UNSIGNED integer.

     * PRIMARY          => boolean; true if column is part of the primary key

     * PRIMARY_POSITION => integer; position of column in primary key

     * IDENTITY         => integer; true if column is auto-generated with unique values

     *

     * @param string $tableName

     * @param string $schemaName OPTIONAL

     * @return array

     */

    public function describeTable($tableName, $schemaName = null)

    {

        // Ensure the connection is made so that _isI5 is set

        $this->_connect();

        if ($schemaName === null && $this->_config['schema'] != null) {

            $schemaName = $this->_config['schema'];

        }

        if (!$this->_isI5) {

            $sql = "SELECT DISTINCT c.tabschema, c.tabname, c.colname, c.colno,

                c.typename, c.default, c.nulls, c.length, c.scale,

                c.identity, tc.type AS tabconsttype, k.colseq

                FROM syscat.columns c

                LEFT JOIN (syscat.keycoluse k JOIN syscat.tabconst tc

                ON (k.tabschema = tc.tabschema

                    AND k.tabname = tc.tabname

                    AND tc.type = 'P'))

                ON (c.tabschema = k.tabschema

                    AND c.tabname = k.tabname

                    AND c.colname = k.colname)

                WHERE "

                . $this->quoteInto('UPPER(c.tabname) = UPPER(?)', $tableName);

            if ($schemaName) {

               $sql .= $this->quoteInto(' AND UPPER(c.tabschema) = UPPER(?)', $schemaName);

            }

            $sql .= " ORDER BY c.colno";

        } else {

            // DB2 On I5 specific query

            $sql = "SELECT DISTINCT C.TABLE_SCHEMA, C.TABLE_NAME, C.COLUMN_NAME, C.ORDINAL_POSITION,

                C.DATA_TYPE, C.COLUMN_DEFAULT, C.NULLS ,C.LENGTH, C.SCALE, LEFT(C.IDENTITY,1),

                LEFT(tc.TYPE, 1) AS tabconsttype, k.COLSEQ

                FROM QSYS2.SYSCOLUMNS C

                LEFT JOIN (QSYS2.syskeycst k JOIN QSYS2.SYSCST tc

                    ON (k.TABLE_SCHEMA = tc.TABLE_SCHEMA

                      AND k.TABLE_NAME = tc.TABLE_NAME

                      AND LEFT(tc.type,1) = 'P'))

                    ON (C.TABLE_SCHEMA = k.TABLE_SCHEMA

                       AND C.TABLE_NAME = k.TABLE_NAME

                       AND C.COLUMN_NAME = k.COLUMN_NAME)

                WHERE "

                . $this->quoteInto('UPPER(C.TABLE_NAME) = UPPER(?)', $tableName);

            if ($schemaName) {

                $sql .= $this->quoteInto(' AND UPPER(C.TABLE_SCHEMA) = UPPER(?)', $schemaName);

            }

            $sql .= " ORDER BY C.ORDINAL_POSITION FOR FETCH ONLY";

        }

        $desc = array();

        $stmt = $this->query($sql);

        /**

         * To avoid case issues, fetch using FETCH_NUM

         */

        $result = $stmt->fetchAll(Zend_Db::FETCH_NUM);

        /**

         * The ordering of columns is defined by the query so we can map

         * to variables to improve readability

         */

        $tabschema      = 0;

        $tabname        = 1;

        $colname        = 2;

        $colno          = 3;

        $typename       = 4;