| // | Lorenzo Alberton | // +----------------------------------------------------------------------+ // // $Id$ // require_once 'MDB2/Driver/Manager/Common.php'; /** * MDB2 SQLite driver for the management modules * * @package MDB2 * @category Database * @author Lukas Smith * @author Lorenzo Alberton */ class MDB2_Driver_Manager_sqlite extends MDB2_Driver_Manager_Common { // {{{ 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($name) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $database_file = $db->_getDatabaseFile($name); if (file_exists($database_file)) { return $db->raiseError(MDB2_ERROR_ALREADY_EXISTS, null, null, 'database already exists', __FUNCTION__); } $php_errormsg = ''; $handle = @sqlite_open($database_file, $db->dsn['mode'], $php_errormsg); if (!$handle) { return $db->raiseError(MDB2_ERROR_CANNOT_CREATE, null, null, (isset($php_errormsg) ? $php_errormsg : 'could not create the database file'), __FUNCTION__); } @sqlite_close($handle); return MDB2_OK; } // }}} // {{{ 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($name) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $database_file = $db->_getDatabaseFile($name); if (!@file_exists($database_file)) { return $db->raiseError(MDB2_ERROR_CANNOT_DROP, null, null, 'database does not exist', __FUNCTION__); } $result = @unlink($database_file); if (!$result) { return $db->raiseError(MDB2_ERROR_CANNOT_DROP, null, null, (isset($php_errormsg) ? $php_errormsg : 'could not remove the database file'), __FUNCTION__); } return MDB2_OK; } // }}} // {{{ 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 MDB2 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 MDB2 parser. * * Example * array( * 'name' => 'userlist', * 'add' => array( * 'quota' => array( * 'type' => 'integer', * 'unsigned' => 1 * ) * ), * 'remove' => array( * 'file_limit' => array(), * 'time_limit' => array() * ), * 'change' => array( * 'name' => array( * 'length' => '20', * 'definition' => array( * 'type' => 'text', * 'length' => 20, * ), * ) * ), * 'rename' => array( * 'sex' => array( * 'name' => 'gender', * 'definition' => array( * 'type' => 'text', * 'length' => 1, * 'default' => 'M', * ), * ) * ) * ) * * @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. * @access public * * @return mixed MDB2_OK on success, a MDB2 error on failure */ function alterTable($name, $changes, $check, $options = array()) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } foreach ($changes as $change_name => $change) { switch ($change_name) { case 'add': case 'remove': case 'change': case 'name': case 'rename': break; default: return $db->raiseError(MDB2_ERROR_CANNOT_ALTER, null, null, 'change type "'.$change_name.'" not yet supported', __FUNCTION__); } } if ($check) { return MDB2_OK; } $db->loadModule('Reverse', null, true); // actually sqlite 2.x supports no ALTER TABLE at all .. so we emulate it $fields = $db->manager->listTableFields($name); if (PEAR::isError($fields)) { return $fields; } $fields = array_flip($fields); foreach ($fields as $field => $value) { $definition = $db->reverse->getTableFieldDefinition($name, $field); if (PEAR::isError($definition)) { return $definition; } $fields[$field] = $definition[0]; } $indexes = $db->manager->listTableIndexes($name); if (PEAR::isError($indexes)) { return $indexes; } $indexes = array_flip($indexes); foreach ($indexes as $index => $value) { $definition = $db->reverse->getTableIndexDefinition($name, $index); if (PEAR::isError($definition)) { return $definition; } $indexes[$index] = $definition; } $constraints = $db->manager->listTableConstraints($name); if (PEAR::isError($constraints)) { return $constraints; } $constraints = array_flip($constraints); foreach ($constraints as $constraint => $value) { if (!empty($definition['primary'])) { if (!array_key_exists('primary', $options)) { $options['primary'] = $definition['fields']; } } else { $definition = $db->reverse->getTableConstraintDefinition($name, $constraint); if (PEAR::isError($definition)) { return $definition; } $constraints[$constraint] = $definition; } } $name_new = $name; $create_order = $select_fields = array_keys($fields); foreach ($changes as $change_name => $change) { switch ($change_name) { case 'add': foreach ($change as $field_name => $field) { $fields[$field_name] = $field; $create_order[] = $field_name; } break; case 'remove': foreach ($change as $field_name => $field) { unset($fields[$field_name]); $select_fields = array_diff($select_fields, array($field_name)); $create_order = array_diff($create_order, array($field_name)); } break; case 'change': foreach ($change as $field_name => $field) { $fields[$field_name] = $field['definition']; } break; case 'name': $name_new = $change; break; case 'rename': foreach ($change as $field_name => $field) { unset($fields[$field_name]); $fields[$field['name']] = $field['definition']; $create_order[array_search($field_name, $create_order)] = $field['name']; } break; default: return $db->raiseError(MDB2_ERROR_CANNOT_ALTER, null, null, 'change type "'.$change_name.'" not yet supported', __FUNCTION__); } } $data = null; if (!empty($select_fields)) { $query = 'SELECT '.implode(', ', $select_fields).' FROM '.$db->quoteIdentifier($name, true); $data = $db->queryAll($query, null, MDB2_FETCHMODE_ORDERED); } $result = $this->dropTable($name); if (PEAR::isError($result)) { return $result; } $result = $this->createTable($name_new, $fields, $options); if (PEAR::isError($result)) { return $result; } foreach ($indexes as $index => $definition) { $this->createIndex($name_new, $index, $definition); } foreach ($constraints as $constraint => $definition) { $this->createConstraint($name_new, $constraint, $definition); } if (!empty($select_fields) && !empty($data)) { $query = 'INSERT INTO '.$db->quoteIdentifier($name_new, true); $query.= '('.implode(', ', array_slice(array_keys($fields), 0, count($select_fields))).')'; $query.=' VALUES (?'.str_repeat(', ?', (count($select_fields) - 1)).')'; $stmt =& $db->prepare($query, null, MDB2_PREPARE_MANIP); if (PEAR::isError($stmt)) { return $stmt; } foreach ($data as $row) { $result = $stmt->execute($row); if (PEAR::isError($result)) { return $result; } } } return MDB2_OK; } // }}} // {{{ listDatabases() /** * list all databases * * @return mixed array of database names 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, 'list databases is not supported', __FUNCTION__); } // }}} // {{{ listUsers() /** * list all users * * @return mixed array of user names 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, 'list databases is not supported', __FUNCTION__); } // }}} // {{{ listViews() /** * list all views in the current database * * @return mixed array of view names on success, a MDB2 error on failure * @access public */ function listViews() { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $query = "SELECT name FROM sqlite_master WHERE type='view' AND sql NOT NULL"; $result = $db->queryCol($query); if (PEAR::isError($result)) { return $result; } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_map(($db->options['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result); } return $result; } // }}} // {{{ listTableViews() /** * list the views in the database that reference a given table * * @param string table for which all referenced views should be found * @return mixed array of view names on success, a MDB2 error on failure * @access public */ function listTableViews($table) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $query = "SELECT name, sql FROM sqlite_master WHERE type='view' AND sql NOT NULL"; $views = $db->queryAll($query, array('text', 'text'), MDB2_FETCHMODE_ASSOC); if (PEAR::isError($views)) { return $views; } $result = array(); foreach ($views as $row) { if (preg_match("/^create view .* \bfrom\b\s+\b{$table}\b /i", $row['sql'])) { if (!empty($row['name'])) { $result[$row['name']] = true; } } } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_change_key_case($result, $db->options['field_case']); } return array_keys($result); } // }}} // {{{ listTables() /** * list all tables in the current database * * @return mixed array of table names on success, a MDB2 error on failure * @access public */ function listTables() { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $query = "SELECT name FROM sqlite_master WHERE type='table' AND sql NOT NULL ORDER BY name"; $table_names = $db->queryCol($query); if (PEAR::isError($table_names)) { return $table_names; } $result = array(); foreach ($table_names as $table_name) { if (!$this->_fixSequenceName($table_name, true)) { $result[] = $table_name; } } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_map(($db->options['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result); } return $result; } // }}} // {{{ listTableFields() /** * list all fields in a table in the current database * * @param string $table name of table that should be used in method * @return mixed array of field names on success, a MDB2 error on failure * @access public */ function listTableFields($table) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $result = $db->loadModule('Reverse', null, true); if (PEAR::isError($result)) { return $result; } $query = "SELECT sql FROM sqlite_master WHERE type='table' AND "; if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $query.= 'LOWER(name)='.$db->quote(strtolower($table), 'text'); } else { $query.= 'name='.$db->quote($table, 'text'); } $sql = $db->queryOne($query); if (PEAR::isError($sql)) { return $sql; } $columns = $db->reverse->_getTableColumns($sql); $fields = array(); foreach ($columns as $column) { if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { if ($db->options['field_case'] == CASE_LOWER) { $column['name'] = strtolower($column['name']); } else { $column['name'] = strtoupper($column['name']); } } else { $column = array_change_key_case($column, $db->options['field_case']); } $fields[] = $column['name']; } return $fields; } // }}} // {{{ listTableTriggers() /** * list all triggers in the database that reference a given table * * @param string table for which all referenced triggers should be found * @return mixed array of trigger names on success, a MDB2 error on failure * @access public */ function listTableTriggers($table = null) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $query = "SELECT name FROM sqlite_master WHERE type='trigger' AND sql NOT NULL"; if (!is_null($table)) { if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $query.= ' AND LOWER(tbl_name)='.$db->quote(strtolower($table), 'text'); } else { $query.= ' AND tbl_name='.$db->quote($table, 'text'); } } $result = $db->queryCol($query); if (PEAR::isError($result)) { return $result; } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_map(($db->options['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result); } return $result; } // }}} // {{{ 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 support() 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; } $table = $db->quoteIdentifier($table, true); $name = $db->getIndexName($name); $query = "CREATE INDEX $name ON $table"; $fields = array(); foreach ($definition['fields'] as $field_name => $field) { $field_string = $field_name; if (!empty($field['sorting'])) { switch ($field['sorting']) { case 'ascending': $field_string.= ' ASC'; break; case 'descending': $field_string.= ' DESC'; break; } } $fields[] = $field_string; } $query .= ' ('.implode(', ', $fields) . ')'; return $db->exec($query); } // }}} // {{{ 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; } $name = $db->getIndexName($name); return $db->exec("DROP INDEX $name"); } // }}} // {{{ listTableIndexes() /** * list all indexes in a table * * @param string $table name of table that should be used in method * @return mixed array of index names on success, a MDB2 error on failure * @access public */ function listTableIndexes($table) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $table = $db->quote($table, 'text'); $query = "SELECT sql FROM sqlite_master WHERE type='index' AND "; if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $query.= 'LOWER(tbl_name)='.strtolower($table); } else { $query.= "tbl_name=$table"; } $query.= " AND sql NOT NULL ORDER BY name"; $indexes = $db->queryCol($query, 'text'); if (PEAR::isError($indexes)) { return $indexes; } $result = array(); foreach ($indexes as $sql) { if (preg_match("/^create index ([^ ]+) on /i", $sql, $tmp)) { $index = $this->_fixIndexName($tmp[1]); if (!empty($index)) { $result[$index] = true; } } } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_change_key_case($result, $db->options['field_case']); } return array_keys($result); } // }}} // {{{ createConstraint() /** * create a constraint on a table * * @param string $table name of the table on which the constraint is to be created * @param string $name name of the constraint to be created * @param array $definition associative array that defines properties of the constraint to be created. * Currently, only one property named FIELDS is supported. This property * is also an associative with the names of the constraint fields as array * constraints. Each entry of this array is set to another type of associative * array that specifies properties of the constraint that are specific to * each field. * * Example * array( * 'fields' => array( * 'user_name' => array(), * 'last_login' => array() * ) * ) * @return mixed MDB2_OK on success, a MDB2 error on failure * @access public */ function createConstraint($table, $name, $definition) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } if (!empty($definition['primary'])) { return $db->manager->alterTable($table, array(), false, array('primary' => $definition['fields'])); } $table = $db->quoteIdentifier($table, true); $name = $db->getIndexName($name); $query = "CREATE UNIQUE INDEX $name ON $table"; $fields = array(); foreach ($definition['fields'] as $field_name => $field) { $field_string = $field_name; if (!empty($field['sorting'])) { switch ($field['sorting']) { case 'ascending': $field_string.= ' ASC'; break; case 'descending': $field_string.= ' DESC'; break; } } $fields[] = $field_string; } $query .= ' ('.implode(', ', $fields) . ')'; return $db->exec($query); } // }}} // {{{ dropConstraint() /** * drop existing constraint * * @param string $table name of table that should be used in method * @param string $name name of the constraint to be dropped * @param string $primary hint if the constraint is primary * @return mixed MDB2_OK on success, a MDB2 error on failure * @access public */ function dropConstraint($table, $name, $primary = false) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } if ($primary || $name == 'PRIMARY') { return $db->manager->alterTable($table, array(), false, array('primary' => null)); } $name = $db->getIndexName($name); return $db->exec("DROP INDEX $name"); } // }}} // {{{ listTableConstraints() /** * list all constraints in a table * * @param string $table name of table that should be used in method * @return mixed array of constraint names on success, a MDB2 error on failure * @access public */ function listTableConstraints($table) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $table = $db->quote($table, 'text'); $query = "SELECT sql FROM sqlite_master WHERE type='index' AND "; if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $query.= 'LOWER(tbl_name)='.strtolower($table); } else { $query.= "tbl_name=$table"; } $query.= " AND sql NOT NULL ORDER BY name"; $indexes = $db->queryCol($query, 'text'); if (PEAR::isError($indexes)) { return $indexes; } $result = array(); foreach ($indexes as $sql) { if (preg_match("/^create unique index ([^ ]+) on /i", $sql, $tmp)) { $index = $this->_fixIndexName($tmp[1]); if (!empty($index)) { $result[$index] = true; } } } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_change_key_case($result, $db->options['field_case']); } return array_keys($result); } // }}} // {{{ 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; } $sequence_name = $db->quoteIdentifier($db->getSequenceName($seq_name), true); $seqcol_name = $db->quoteIdentifier($db->options['seqcol_name'], true); $query = "CREATE TABLE $sequence_name ($seqcol_name INTEGER PRIMARY KEY DEFAULT 0 NOT NULL)"; $res = $db->exec($query); if (PEAR::isError($res)) { return $res; } if ($start == 1) { return MDB2_OK; } $res = $db->exec("INSERT INTO $sequence_name ($seqcol_name) VALUES (".($start-1).')'); if (!PEAR::isError($res)) { return MDB2_OK; } // Handle error $result = $db->exec("DROP TABLE $sequence_name"); if (PEAR::isError($result)) { return $db->raiseError($result, null, null, 'could not drop inconsistent sequence table', __FUNCTION__); } return $db->raiseError($res, null, null, 'could not create sequence table', __FUNCTION__); } // }}} // {{{ 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($seq_name) { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $sequence_name = $db->quoteIdentifier($db->getSequenceName($seq_name), true); return $db->exec("DROP TABLE $sequence_name"); } // }}} // {{{ listSequences() /** * list all sequences in the current database * * @return mixed array of sequence names on success, a MDB2 error on failure * @access public */ function listSequences() { $db =& $this->getDBInstance(); if (PEAR::isError($db)) { return $db; } $query = "SELECT name FROM sqlite_master WHERE type='table' AND sql NOT NULL ORDER BY name"; $table_names = $db->queryCol($query); if (PEAR::isError($table_names)) { return $table_names; } $result = array(); foreach ($table_names as $table_name) { if ($sqn = $this->_fixSequenceName($table_name, true)) { $result[] = $sqn; } } if ($db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) { $result = array_map(($db->options['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result); } return $result; } // }}} } ?>