<?php
|
// vim: set et ts=4 sw=4 fdm=marker:
|
// +----------------------------------------------------------------------+
|
// | PHP versions 4 and 5 |
|
// +----------------------------------------------------------------------+
|
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
|
// | Stig. S. Bakken, Lukas Smith |
|
// | All rights reserved. |
|
// +----------------------------------------------------------------------+
|
// | MDB2 is a merge of PEAR DB and Metabases that provides a unified DB |
|
// | API as well as database abstraction for PHP applications. |
|
// | This LICENSE is in the BSD license style. |
|
// | |
|
// | Redistribution and use in source and binary forms, with or without |
|
// | modification, are permitted provided that the following conditions |
|
// | are met: |
|
// | |
|
// | Redistributions of source code must retain the above copyright |
|
// | notice, this list of conditions and the following disclaimer. |
|
// | |
|
// | Redistributions in binary form must reproduce the above copyright |
|
// | notice, this list of conditions and the following disclaimer in the |
|
// | documentation and/or other materials provided with the distribution. |
|
// | |
|
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
|
// | Lukas Smith nor the names of his contributors may be used to endorse |
|
// | or promote products derived from this software without specific prior|
|
// | written permission. |
|
// | |
|
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|
// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
|
// | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
|
// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
|
// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
// | POSSIBILITY OF SUCH DAMAGE. |
|
// +----------------------------------------------------------------------+
|
// | Author: Lukas Smith <smith@pooteeweet.org> |
|
// | Lorenzo Alberton <l.alberton@quipo.it> |
|
// +----------------------------------------------------------------------+
|
//
|
// $Id$
|
|
require_once 'MDB2/Driver/Datatype/Common.php';
|
|
/**
|
* MDB2 Firebird/Interbase driver
|
*
|
* @package MDB2
|
* @category Database
|
* @author Lukas Smith <smith@pooteeweet.org>
|
* @author Lorenzo Alberton <l.alberton@quipo.it>
|
*/
|
class MDB2_Driver_Datatype_ibase extends MDB2_Driver_Datatype_Common
|
{
|
// {{{ convertResult()
|
|
/**
|
* convert a value to a RDBMS independent MDB2 type
|
*
|
* @param mixed $value value to be converted
|
* @param int $type constant that specifies which type to convert to
|
* @return mixed converted value or a MDB2 error on failure
|
* @access public
|
*/
|
function convertResult($value, $type)
|
{
|
if (is_null($value)) {
|
return null;
|
}
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
switch ($type) {
|
case 'decimal':
|
return sprintf('%.'.$db->options['decimal_places'].'f', doubleval($value)/pow(10.0, $db->options['decimal_places']));
|
case 'timestamp':
|
return substr($value, 0, strlen('YYYY-MM-DD HH:MM:SS'));
|
default:
|
return $this->_baseConvertResult($value, $type);
|
}
|
}
|
|
// }}}
|
// {{{ getTypeDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an text type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the text
|
* field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* default
|
* Text value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access public
|
*/
|
function getTypeDeclaration($field)
|
{
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
switch ($field['type']) {
|
case 'text':
|
$length = (array_key_exists('length', $field) ? $field['length'] : (!PEAR::isError($length = $db->options['default_text_field_length']) ? $length : 4000));
|
return 'VARCHAR ('.$length.')';
|
case 'clob':
|
return 'BLOB SUB_TYPE 1';
|
case 'blob':
|
return 'BLOB SUB_TYPE 0';
|
case 'integer':
|
return 'INTEGER';
|
case 'boolean':
|
return 'CHAR (1)';
|
case 'date':
|
return 'DATE';
|
case 'time':
|
return 'TIME';
|
case 'timestamp':
|
return 'TIMESTAMP';
|
case 'float':
|
return 'DOUBLE PRECISION';
|
case 'decimal':
|
return 'DECIMAL(18,'.$db->options['decimal_places'].')';
|
}
|
return '';
|
}
|
|
// }}}
|
// {{{ _getIntegerDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an integer type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* unsigned
|
* Boolean flag that indicates whether the field should be
|
* declared as unsigned integer if possible.
|
*
|
* default
|
* Integer value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getIntegerDeclaration($name, $field)
|
{
|
if (array_key_exists('unsigned', $field) && $field['unsigned']) {
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
$db->warnings[] = "unsigned integer field \"$name\" is being declared as signed integer";
|
}
|
|
if (array_key_exists('autoincrement', $field) && $field['autoincrement']) {
|
return $name.' PRIMARY KEY';
|
}
|
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'integer') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' INT'.$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getTextDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a text type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the text
|
* field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* default
|
* Text value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getTextDeclaration($name, $field)
|
{
|
$type = $this->getTypeDeclaration($field);
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'text') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$type.$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getCLOBDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a character
|
* large object type field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the large
|
* object field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getCLOBDeclaration($name, $field)
|
{
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$notnull;
|
}
|
|
// }}}
|
// {{{ _getBLOBDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a binary large
|
* object type field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the large
|
* object field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getBLOBDeclaration($name, $field)
|
{
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$notnull;
|
}
|
|
// }}}
|
// {{{ _getDateDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a date type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Date value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getDateDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'date') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getTimeDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a time
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Time value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getTimeDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'time') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getTimestampDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a timestamp
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Timestamp value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getTimestampDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'timestamp') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getFloatDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a float type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Float value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getFloatDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'float') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getDecimalDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a decimal type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Decimal value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getDecimalDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'decimal') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _quoteLOB()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param $value
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteLOB($value)
|
{
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
if (PEAR::isError($connect = $db->connect())) {
|
return $connect;
|
}
|
$close = true;
|
if (is_resource($value)) {
|
$close = false;
|
} elseif (preg_match('/^(\w+:\/\/)(.*)$/', $value, $match)) {
|
if ($match[1] == 'file://') {
|
$value = $match[2];
|
}
|
$value = @fopen($value, 'r');
|
} else {
|
$fp = @tmpfile();
|
@fwrite($fp, $value);
|
@rewind($fp);
|
$value = $fp;
|
}
|
if ($db->in_transaction) {
|
$blob_id = @ibase_blob_import($db->transaction_id, $value);
|
} else {
|
$blob_id = @ibase_blob_import($db->connection, $value);
|
}
|
if ($close) {
|
@fclose($value);
|
}
|
return $blob_id;
|
}
|
|
// }}}
|
// {{{ _quoteDecimal()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param string $value text string value that is intended to be converted.
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteDecimal($value)
|
{
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return (strval(round($value*pow(10.0, $db->options['decimal_places']))));
|
}
|
|
// }}}
|
// {{{ _retrieveLOB()
|
|
/**
|
* retrieve LOB from the database
|
*
|
* @param resource $lob stream handle
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
* @access protected
|
*/
|
function _retrieveLOB(&$lob)
|
{
|
if (!array_key_exists('handle', $lob)) {
|
$lob['handle'] = @ibase_blob_open($lob['ressource']);
|
if (!$lob['handle']) {
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return $db->raiseError(MDB2_ERROR, null, null,
|
'_retrieveLOB: Could not open fetched large object field' . @ibase_errmsg());
|
}
|
}
|
return MDB2_OK;
|
}
|
|
// }}}
|
// {{{ _readLOB()
|
|
/**
|
* Read data from large object input stream.
|
*
|
* @param resource $lob stream handle
|
* @param blob $data reference to a variable that will hold data to be
|
* read from the large object input stream
|
* @param int $length integer value that indicates the largest ammount of
|
* data to be read from the large object input stream.
|
* @return mixed length on success, a MDB2 error on failure
|
* @access protected
|
*/
|
function _readLOB($lob, $length)
|
{
|
$data = ibase_blob_get($lob['handle'], $length);
|
if (!is_string($data)) {
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return $db->raiseError(MDB2_ERROR, null, null,
|
'Read Result LOB: ' . @ibase_errmsg());
|
}
|
return $data;
|
}
|
|
// }}}
|
// {{{ _destroyLOB()
|
|
/**
|
* Free any resources allocated during the lifetime of the large object
|
* handler object.
|
*
|
* @param resource $lob stream handle
|
* @access protected
|
*/
|
function _destroyLOB($lob_index)
|
{
|
if (isset($this->lobs[$lob_index]['handle'])) {
|
@ibase_blob_close($this->lobs[$lob_index]['handle']);
|
}
|
}
|
|
// }}}
|
// {{{ mapNativeDatatype()
|
|
/**
|
* Maps a native array description of a field to a MDB2 datatype and length
|
*
|
* @param array $field native field description
|
* @return array containing the various possible types and the length
|
* @access public
|
*/
|
function mapNativeDatatype($field)
|
{
|
$db_type = preg_replace('/\d/','', strtolower($field['typname']) );
|
$length = $field['attlen'];
|
if ($length == '-1') {
|
$length = $field['atttypmod']-4;
|
}
|
if ((int)$length <= 0) {
|
$length = null;
|
}
|
$type = array();
|
switch ($db_type) {
|
case 'smallint':
|
case 'integer':
|
$type[] = 'integer';
|
if ($length == '1') {
|
$type[] = 'boolean';
|
}
|
break;
|
case 'char':
|
case 'varchar':
|
$type[] = 'text';
|
if ($length == '1') {
|
$type[] = 'boolean';
|
}
|
break;
|
case 'date':
|
$type[] = 'date';
|
$length = null;
|
break;
|
case 'timestamp':
|
$type[] = 'timestamp';
|
$length = null;
|
break;
|
case 'time':
|
$type[] = 'time';
|
$length = null;
|
break;
|
case 'float':
|
case 'double precision':
|
$type[] = 'float';
|
break;
|
case 'decimal':
|
case 'numeric':
|
$type[] = 'decimal';
|
break;
|
case 'blob':
|
$type[] = 'blob';
|
$length = null;
|
break;
|
default:
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return $db->raiseError(MDB2_ERROR, null, null,
|
'getTableFieldDefinition: unknown database attribute type');
|
}
|
|
return array($type, $length);
|
}
|
|
// }}}
|
}
|
?>
|
