You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
617 lines
22 KiB
PHP
617 lines
22 KiB
PHP
<?php
|
|
// +----------------------------------------------------------------------+
|
|
// | 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> |
|
|
// +----------------------------------------------------------------------+
|
|
//
|
|
// $Id$
|
|
//
|
|
|
|
/**
|
|
* @package MDB2
|
|
* @category Database
|
|
* @author Lukas Smith <smith@pooteeweet.org>
|
|
*/
|
|
|
|
/**
|
|
* Base class for the management modules that is extended by each MDB2 driver
|
|
*
|
|
* @package MDB2
|
|
* @category Database
|
|
* @author Lukas Smith <smith@pooteeweet.org>
|
|
*/
|
|
class MDB2_Driver_Manager_Common extends MDB2_Module_Common
|
|
{
|
|
// }}}
|
|
// {{{ getFieldDeclarationList()
|
|
|
|
/**
|
|
* get declaration of a number of field in bulk
|
|
*
|
|
* @param string $fields a multidimensional associative array.
|
|
* The first dimension determines the field name, while the second
|
|
* dimension is keyed 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
|
|
* Boolean 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 mixed string on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function getFieldDeclarationList($fields)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
if (is_array($fields)) {
|
|
foreach ($fields as $field_name => $field) {
|
|
$query = $db->getDeclaration($field['type'], $field_name, $field);
|
|
if (PEAR::isError($query)) {
|
|
return $query;
|
|
}
|
|
$query_fields[] = $query;
|
|
}
|
|
return implode(',', $query_fields);
|
|
}
|
|
return $db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
|
|
'getFieldDeclarationList: the definition of the table "'.$table_name.'" does not contain any fields');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ _isSequenceName()
|
|
|
|
/**
|
|
* list all tables in the current database
|
|
*
|
|
* @param string $sqn string that containts name of a potential sequence
|
|
* @return mixed name of the sequence if $sqn is a name of a sequence, else false
|
|
* @access protected
|
|
*/
|
|
function _isSequenceName($sqn)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
$seq_pattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $db->options['seqname_format']).'$/i';
|
|
$seq_name = preg_replace($seq_pattern, '\\1', $sqn);
|
|
if ($seq_name && $sqn == $db->getSequenceName($seq_name)) {
|
|
return $seq_name;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// }}}
|
|
// {{{ createDatabase()
|
|
|
|
/**
|
|
* create a new database
|
|
*
|
|
* @param string $name name of the database that should be created
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function createDatabase($database)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'createDatabase: database creation is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ dropDatabase()
|
|
|
|
/**
|
|
* drop an existing database
|
|
*
|
|
* @param string $name name of the database that should be dropped
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function dropDatabase($database)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'dropDatabase: database dropping is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ createTable()
|
|
|
|
/**
|
|
* create a new table
|
|
*
|
|
* @param string $name Name of the database that should be created
|
|
* @param array $fields Associative array that contains the definition of each field of the new table
|
|
* The indexes of the array entries are the names of the fields of the table an
|
|
* the array entry values are associative arrays like those that are meant to be
|
|
* passed with the field definitions to get[Type]Declaration() functions.
|
|
*
|
|
* Example
|
|
* array(
|
|
*
|
|
* 'id' => array(
|
|
* 'type' => 'integer',
|
|
* 'unsigned' => 1
|
|
* 'notnull' => 1
|
|
* 'default' => 0
|
|
* ),
|
|
* 'name' => array(
|
|
* 'type' => 'text',
|
|
* 'length' => 12
|
|
* ),
|
|
* 'password' => array(
|
|
* 'type' => 'text',
|
|
* 'length' => 12
|
|
* )
|
|
* );
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function createTable($name, $fields)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
if (!$name) {
|
|
return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
|
|
'createTable: no valid table name specified');
|
|
}
|
|
if (empty($fields)) {
|
|
return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
|
|
'createTable: no fields specified for table "'.$name.'"');
|
|
}
|
|
$query_fields = $this->getFieldDeclarationList($fields);
|
|
if (PEAR::isError($query_fields)) {
|
|
return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null,
|
|
'createTable: unkown error');
|
|
}
|
|
$query = "CREATE TABLE $name ($query_fields)";
|
|
return $db->query($query);
|
|
}
|
|
|
|
// }}}
|
|
// {{{ dropTable()
|
|
|
|
/**
|
|
* drop an existing table
|
|
*
|
|
* @param string $name name of the table that should be dropped
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function dropTable($name)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->query("DROP TABLE $name");
|
|
}
|
|
|
|
// }}}
|
|
// {{{ alterTable()
|
|
|
|
/**
|
|
* alter an existing table
|
|
*
|
|
* @param string $name name of the table that is intended to be changed.
|
|
* @param array $changes associative array that contains the details of each type
|
|
* of change that is intended to be performed. The types of
|
|
* changes that are currently supported are defined as follows:
|
|
*
|
|
* name
|
|
*
|
|
* New name for the table.
|
|
*
|
|
* add
|
|
*
|
|
* Associative array with the names of fields to be added as
|
|
* indexes of the array. The value of each entry of the array
|
|
* should be set to another associative array with the properties
|
|
* of the fields to be added. The properties of the fields should
|
|
* be the same as defined by the Metabase parser.
|
|
*
|
|
*
|
|
* remove
|
|
*
|
|
* Associative array with the names of fields to be removed as indexes
|
|
* of the array. Currently the values assigned to each entry are ignored.
|
|
* An empty array should be used for future compatibility.
|
|
*
|
|
* rename
|
|
*
|
|
* Associative array with the names of fields to be renamed as indexes
|
|
* of the array. The value of each entry of the array should be set to
|
|
* another associative array with the entry named name with the new
|
|
* field name and the entry named Declaration that is expected to contain
|
|
* the portion of the field declaration already in DBMS specific SQL code
|
|
* as it is used in the CREATE TABLE statement.
|
|
*
|
|
* change
|
|
*
|
|
* Associative array with the names of the fields to be changed as indexes
|
|
* of the array. Keep in mind that if it is intended to change either the
|
|
* name of a field and any other properties, the change array entries
|
|
* should have the new names of the fields as array indexes.
|
|
*
|
|
* The value of each entry of the array should be set to another associative
|
|
* array with the properties of the fields to that are meant to be changed as
|
|
* array entries. These entries should be assigned to the new values of the
|
|
* respective properties. The properties of the fields should be the same
|
|
* as defined by the Metabase parser.
|
|
*
|
|
* Example
|
|
* array(
|
|
* 'name' => 'userlist',
|
|
* 'add' => array(
|
|
* 'quota' => array(
|
|
* 'type' => 'integer',
|
|
* 'unsigned' => 1
|
|
* )
|
|
* ),
|
|
* 'remove' => array(
|
|
* 'file_limit' => array(),
|
|
* 'time_limit' => array()
|
|
* ),
|
|
* 'change' => array(
|
|
* 'gender' => array(
|
|
* 'default' => 'M',
|
|
* )
|
|
* ),
|
|
* 'rename' => array(
|
|
* 'sex' => array(
|
|
* 'name' => 'gender',
|
|
* )
|
|
* )
|
|
* )
|
|
* @param boolean $check indicates whether the function should just check if the DBMS driver
|
|
* can perform the requested table alterations if the value is true or
|
|
* actually perform them otherwise.
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function alterTable($name, $changes, $check)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'alterTable: database table alterations are not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listDatabases()
|
|
|
|
/**
|
|
* list all databases
|
|
*
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listDatabases()
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listDatabases: list databases is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listUsers()
|
|
|
|
/**
|
|
* list all users
|
|
*
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listUsers()
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listUsers: list user is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listViews()
|
|
|
|
/**
|
|
* list all views in the current database
|
|
*
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listViews()
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listViews: list view is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listFunctions()
|
|
|
|
/**
|
|
* list all functions in the current database
|
|
*
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listFunctions()
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listFunctions: list function is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listTables()
|
|
|
|
/**
|
|
* list all tables in the current database
|
|
*
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listTables()
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listTables: list tables is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listTableFields()
|
|
|
|
/**
|
|
* list all fields in a tables in the current database
|
|
*
|
|
* @param string $table name of table that should be used in method
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listTableFields($table)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listTableFields: list table fields is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ createIndex()
|
|
|
|
/**
|
|
* get the stucture of a field into an array
|
|
*
|
|
* @param string $table name of the table on which the index is to be created
|
|
* @param string $name name of the index to be created
|
|
* @param array $definition associative array that defines properties of the index to be created.
|
|
* Currently, only one property named FIELDS is supported. This property
|
|
* is also an associative with the names of the index fields as array
|
|
* indexes. Each entry of this array is set to another type of associative
|
|
* array that specifies properties of the index that are specific to
|
|
* each field.
|
|
*
|
|
* Currently, only the sorting property is supported. It should be used
|
|
* to define the sorting direction of the index. It may be set to either
|
|
* ascending or descending.
|
|
*
|
|
* Not all DBMS support index sorting direction configuration. The DBMS
|
|
* drivers of those that do not support it ignore this property. Use the
|
|
* function supports() to determine whether the DBMS driver can manage indexes.
|
|
*
|
|
* Example
|
|
* array(
|
|
* 'fields' => array(
|
|
* 'user_name' => array(
|
|
* 'sorting' => 'ascending'
|
|
* ),
|
|
* 'last_login' => array()
|
|
* )
|
|
* )
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function createIndex($table, $name, $definition)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'createIndex: Creating Indexes is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ dropIndex()
|
|
|
|
/**
|
|
* drop existing index
|
|
*
|
|
* @param string $table name of table that should be used in method
|
|
* @param string $name name of the index to be dropped
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function dropIndex($table, $name)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->query("DROP INDEX $name");
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listTableIndexes()
|
|
|
|
/**
|
|
* list all indexes in a table
|
|
*
|
|
* @param string $table name of table that should be used in method
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listTableIndexes($table)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listTableIndexes: List Indexes is not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ createSequence()
|
|
|
|
/**
|
|
* create sequence
|
|
*
|
|
* @param string $seq_name name of the sequence to be created
|
|
* @param string $start start value of the sequence; default is 1
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function createSequence($seq_name, $start = 1)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'createSequence: sequence creation not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ dropSequence()
|
|
|
|
/**
|
|
* drop existing sequence
|
|
*
|
|
* @param string $seq_name name of the sequence to be dropped
|
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function dropSequence($name)
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'dropSequence: sequence dropping not supported');
|
|
}
|
|
|
|
// }}}
|
|
// {{{ listSequences()
|
|
|
|
/**
|
|
* list all sequences in the current database
|
|
*
|
|
* @return mixed data array on success, a MDB2 error on failure
|
|
* @access public
|
|
*/
|
|
function listSequences()
|
|
{
|
|
$db =& $this->getDBInstance();
|
|
if (PEAR::isError($db)) {
|
|
return $db;
|
|
}
|
|
|
|
return $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
|
|
'listSequences: List sequences is not supported');
|
|
}
|
|
}
|
|
|
|
?>
|