<?php/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: *//** * The PEAR DB driver for PHP's odbc extension * for interacting with databases via ODBC connections * * PHP versions 4 and 5 * * LICENSE: This source file is subject to version 3.0 of the PHP license * that is available through the world-wide-web at the following URI: * http://www.php.net/license/3_0.txt.  If you did not receive a copy of * the PHP License and are unable to obtain it through the web, please * send a note to license@php.net so we can mail you a copy immediately. * * @category   Database * @package    DB * @author     Stig Bakken <ssb@php.net> * @author     Daniel Convissor <danielc@php.net> * @copyright  1997-2005 The PHP Group * @license    http://www.php.net/license/3_0.txt  PHP License 3.0 * @version    CVS: $Id: odbc.php,v 1.78 2005/02/28 01:42:17 danielc Exp $ * @link       http://pear.php.net/package/DB *//** * Obtain the DB_common class so it can be extended from */require_once 'DB/common.php';/** * The methods PEAR DB uses to interact with PHP's odbc extension * for interacting with databases via ODBC connections * * These methods overload the ones declared in DB_common. * * More info on ODBC errors could be found here: * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/trblsql/tr_err_odbc_5stz.asp * * @category   Database * @package    DB * @author     Stig Bakken <ssb@php.net> * @author     Daniel Convissor <danielc@php.net> * @copyright  1997-2005 The PHP Group * @license    http://www.php.net/license/3_0.txt  PHP License 3.0 * @version    Release: 1.7.6 * @link       http://pear.php.net/package/DB */class DB_odbc extends DB_common{    // {{{ properties    /**     * The DB driver type (mysql, oci8, odbc, etc.)     * @var string     */    var $phptype = 'odbc';    /**     * The database syntax variant to be used (db2, access, etc.), if any     * @var string     */    var $dbsyntax = 'sql92';    /**     * The capabilities of this DB implementation     *     * The 'new_link' element contains the PHP version that first provided     * new_link support for this DBMS.  Contains false if it's unsupported.     *     * Meaning of the 'limit' element:     *   + 'emulate' = emulate with fetch row by number     *   + 'alter'   = alter the query     *   + false     = skip rows     *     * NOTE: The feature set of the following drivers are different than     * the default:     *   + solid: 'transactions' = true     *   + navision: 'limit' = false     *     * @var array     */    var $features = array(        'limit'         => 'emulate',        'new_link'      => false,        'numrows'       => true,        'pconnect'      => true,        'prepare'       => false,        'ssl'           => false,        'transactions'  => false,    );    /**     * A mapping of native error codes to DB error codes     * @var array     */    var $errorcode_map = array(        '01004' => DB_ERROR_TRUNCATED,        '07001' => DB_ERROR_MISMATCH,        '21S01' => DB_ERROR_VALUE_COUNT_ON_ROW,        '21S02' => DB_ERROR_MISMATCH,        '22001' => DB_ERROR_INVALID,        '22003' => DB_ERROR_INVALID_NUMBER,        '22005' => DB_ERROR_INVALID_NUMBER,        '22008' => DB_ERROR_INVALID_DATE,        '22012' => DB_ERROR_DIVZERO,        '23000' => DB_ERROR_CONSTRAINT,        '23502' => DB_ERROR_CONSTRAINT_NOT_NULL,        '23503' => DB_ERROR_CONSTRAINT,        '23504' => DB_ERROR_CONSTRAINT,        '23505' => DB_ERROR_CONSTRAINT,        '24000' => DB_ERROR_INVALID,        '34000' => DB_ERROR_INVALID,        '37000' => DB_ERROR_SYNTAX,        '42000' => DB_ERROR_SYNTAX,        '42601' => DB_ERROR_SYNTAX,        'IM001' => DB_ERROR_UNSUPPORTED,        'S0000' => DB_ERROR_NOSUCHTABLE,        'S0001' => DB_ERROR_ALREADY_EXISTS,        'S0002' => DB_ERROR_NOSUCHTABLE,        'S0011' => DB_ERROR_ALREADY_EXISTS,        'S0012' => DB_ERROR_NOT_FOUND,        'S0021' => DB_ERROR_ALREADY_EXISTS,        'S0022' => DB_ERROR_NOSUCHFIELD,        'S1009' => DB_ERROR_INVALID,        'S1090' => DB_ERROR_INVALID,        'S1C00' => DB_ERROR_NOT_CAPABLE,    );    /**     * The raw database connection created by PHP     * @var resource     */    var $connection;    /**     * The DSN information for connecting to a database     * @var array     */    var $dsn = array();    /**     * The number of rows affected by a data manipulation query     * @var integer     * @access private     */    var $affected = 0;    // }}}    // {{{ constructor    /**     * This constructor calls <kbd>$this->DB_common()</kbd>     *     * @return void     */    function DB_odbc()    {        $this->DB_common();    }    // }}}    // {{{ connect()    /**     * Connect to the database server, log in and open the database     *     * Don't call this method directly.  Use DB::connect() instead.     *     * PEAR DB's odbc driver supports the following extra DSN options:     *   + cursor  The type of cursor to be used for this connection.     *     * @param array $dsn         the data source name     * @param bool  $persistent  should the connection be persistent?     *     * @return int  DB_OK on success. A DB_Error object on failure.     */    function connect($dsn, $persistent = false)    {        if (!PEAR::loadExtension('odbc')) {            return $this->raiseError(DB_ERROR_EXTENSION_NOT_FOUND);        }        $this->dsn = $dsn;        if ($dsn['dbsyntax']) {            $this->dbsyntax = $dsn['dbsyntax'];        }        switch ($this->dbsyntax) {            case 'access':            case 'db2':            case 'solid':                $this->features['transactions'] = true;                break;            case 'navision':                $this->features['limit'] = false;        }        /*         * This is hear for backwards compatibility. Should have been using         * 'database' all along, but prior to 1.6.0RC3 'hostspec' was used.         */        if ($dsn['database']) {            $odbcdsn = $dsn['database'];        } elseif ($dsn['hostspec']) {            $odbcdsn = $dsn['hostspec'];        } else {            $odbcdsn = 'localhost';        }        $connect_function = $persistent ? 'odbc_pconnect' : 'odbc_connect';        if (empty($dsn['cursor'])) {            $this->connection = @$connect_function($odbcdsn, $dsn['username'],                                                   $dsn['password']);        } else {            $this->connection = @$connect_function($odbcdsn, $dsn['username'],                                                   $dsn['password'],                                                   $dsn['cursor']);        }        if (!is_resource($this->connection)) {            return $this->raiseError(DB_ERROR_CONNECT_FAILED,                                     null, null, null,                                     $this->errorNative());        }        return DB_OK;    }    // }}}    // {{{ disconnect()    /**     * Disconnects from the database server     *     * @return bool  TRUE on success, FALSE on failure     */    function disconnect()    {        $err = @odbc_close($this->connection);        $this->connection = null;        return $err;    }    // }}}    // {{{ simpleQuery()    /**     * Sends a query to the database server     *     * @param string  the SQL query string     *     * @return mixed  + a PHP result resrouce for successful SELECT queries     *                + the DB_OK constant for other successful queries     *                + a DB_Error object on failure     */    function simpleQuery($query)    {        $this->last_query = $query;        $query = $this->modifyQuery($query);        $result = @odbc_exec($this->connection, $query);        if (!$result) {            return $this->odbcRaiseError(); // XXX ERRORMSG        }        // Determine which queries that should return data, and which        // should return an error code only.        if (DB::isManip($query)) {            $this->affected = $result; // For affectedRows()            return DB_OK;        }        $this->affected = 0;        return $result;    }    // }}}    // {{{ nextResult()    /**     * Move the internal odbc result pointer to the next available result     *     * @param a valid fbsql result resource     *     * @access public     *     * @return true if a result is available otherwise return false     */    function nextResult($result)    {        return @odbc_next_result($result);    }    // }}}    // {{{ fetchInto()    /**     * Places a row from the result set into the given array     *     * Formating of the array and the data therein are configurable.     * See DB_result::fetchInto() for more information.     *     * This method is not meant to be called directly.  Use     * DB_result::fetchInto() instead.  It can't be declared "protected"     * because DB_result is a separate object.     *     * @param resource $result    the query result resource     * @param array    $arr       the referenced array to put the data in     * @param int      $fetchmode how the resulting array should be indexed     * @param int      $rownum    the row number to fetch (0 = first row)     *     * @return mixed  DB_OK on success, NULL when the end of a result set is     *                 reached or on failure     *     * @see DB_result::fetchInto()     */    function fetchInto($result, &$arr, $fetchmode, $rownum = null)    {        $arr = array();        if ($rownum !== null) {            $rownum++; // ODBC first row is 1            if (version_compare(phpversion(), '4.2.0', 'ge')) {                $cols = @odbc_fetch_into($result, $arr, $rownum);            } else {                $cols = @odbc_fetch_into($result, $rownum, $arr);            }        } else {            $cols = @odbc_fetch_into($result, $arr);        }        if (!$cols) {            return null;        }        if ($fetchmode !== DB_FETCHMODE_ORDERED) {            for ($i = 0; $i < count($arr); $i++) {                $colName = @odbc_field_name($result, $i+1);                $a[$colName] = $arr[$i];            }            if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE) {                $a = array_change_key_case($a, CASE_LOWER);            }            $arr = $a;        }        if ($this->options['portability'] & DB_PORTABILITY_RTRIM) {            $this->_rtrimArrayValues($arr);        }        if ($this->options['portability'] & DB_PORTABILITY_NULL_TO_EMPTY) {            $this->_convertNullArrayValuesToEmpty($arr);        }        return DB_OK;    }    // }}}    // {{{ freeResult()    /**     * Deletes the result set and frees the memory occupied by the result set     *     * This method is not meant to be called directly.  Use     * DB_result::free() instead.  It can't be declared "protected"     * because DB_result is a separate object.     *     * @param resource $result  PHP's query result resource     *     * @return bool  TRUE on success, FALSE if $result is invalid     *     * @see DB_result::free()     */    function freeResult($result)    {        return @odbc_free_result($result);    }    // }}}    // {{{ numCols()    /**     * Gets the number of columns in a result set     *     * This method is not meant to be called directly.  Use     * DB_result::numCols() instead.  It can't be declared "protected"     * because DB_result is a separate object.     *     * @param resource $result  PHP's query result resource     *     * @return int  the number of columns.  A DB_Error object on failure.     *     * @see DB_result::numCols()     */    function numCols($result)    {        $cols = @odbc_num_fields($result);        if (!$cols) {            return $this->odbcRaiseError();        }        return $cols;    }    // }}}    // {{{ affectedRows()    /**     * Determines the number of rows affected by a data maniuplation query     *     * 0 is returned for queries that don't manipulate data.     *     * @return int  the number of rows.  A DB_Error object on failure.     */    function affectedRows()    {        if (empty($this->affected)) {  // In case of SELECT stms            return 0;        }        $nrows = @odbc_num_rows($this->affected);        if ($nrows == -1) {            return $this->odbcRaiseError();        }        return $nrows;    }    // }}}    // {{{ numRows()    /**     * Gets the number of rows in a result set     *     * Not all ODBC drivers support this functionality.  If they don't     * a DB_Error object for DB_ERROR_UNSUPPORTED is returned.     *     * This method is not meant to be called directly.  Use     * DB_result::numRows() instead.  It can't be declared "protected"     * because DB_result is a separate object.     *     * @param resource $result  PHP's query result resource     *     * @return int  the number of rows.  A DB_Error object on failure.     *     * @see DB_result::numRows()     */    function numRows($result)    {        $nrows = @odbc_num_rows($result);        if ($nrows == -1) {