tonyair/silverstripe-sqlite3
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-sqlite3 synced 2024-10-22 17:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Converted to PSR-2

Browse Source
This commit is contained in:
helpfulrobot 2015-12-18 07:11:01 +13:00
parent 7daf437e24
commit b2d40ed61e
6 changed files with 1672 additions and 1497 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
code/SQLite3Connector.php
View File

@ -5,7 +5,8 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3Connector extends DBConnector { class SQLite3Connector extends DBConnector
{
/** /**
* The name of the database. * The name of the database.
@ -21,7 +22,8 @@ class SQLite3Connector extends DBConnector {
*/ */
protected $dbConn; protected $dbConn;
public function connect($parameters, $selectDB = false) { public function connect($parameters, $selectDB = false)
{
$file = $parameters['filepath']; $file = $parameters['filepath'];
$this->dbConn = empty($parameters['key']) $this->dbConn = empty($parameters['key'])
? new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE) ? new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE)
@ -30,29 +32,35 @@ class SQLite3Connector extends DBConnector {
$this->databaseName = $parameters['database']; $this->databaseName = $parameters['database'];
} }
public function affectedRows() { public function affectedRows()
{
return $this->dbConn->changes(); return $this->dbConn->changes();
} }
public function getGeneratedID($table) { public function getGeneratedID($table)
{
return $this->dbConn->lastInsertRowID(); return $this->dbConn->lastInsertRowID();
} }
public function getLastError() { public function getLastError()
{
$message = $this->dbConn->lastErrorMsg(); $message = $this->dbConn->lastErrorMsg();
return $message === 'not an error' ? null : $message; return $message === 'not an error' ? null : $message;
} }
public function getSelectedDatabase() { public function getSelectedDatabase()
{
return $this->databaseName; return $this->databaseName;
} }
public function getVersion() { public function getVersion()
{
$version = SQLite3::version(); $version = SQLite3::version();
return trim($version['versionString']); return trim($version['versionString']);
} }
public function isActive() { public function isActive()
{
return $this->databaseName && $this->dbConn; return $this->databaseName && $this->dbConn;
} }
@ -62,7 +70,8 @@ class SQLite3Connector extends DBConnector {
* @param array $parameters List of parameters * @param array $parameters List of parameters
* @return array List of parameters types and values * @return array List of parameters types and values
*/ */
public function parsePreparedParameters($parameters) { public function parsePreparedParameters($parameters)
{
$values = array(); $values = array();
foreach ($parameters as $value) { foreach ($parameters as $value) {
$phpType = gettype($value); $phpType = gettype($value);
@ -110,7 +119,8 @@ class SQLite3Connector extends DBConnector {
return $values; return $values;
} }
public function preparedQuery($sql, $parameters, $errorLevel = E_USER_ERROR) { public function preparedQuery($sql, $parameters, $errorLevel = E_USER_ERROR)
{
// Type check, identify, and prepare parameters for passing to the statement bind function // Type check, identify, and prepare parameters for passing to the statement bind function
$parsedParameters = $this->parsePreparedParameters($parameters); $parsedParameters = $this->parsePreparedParameters($parameters);
@ -137,7 +147,8 @@ class SQLite3Connector extends DBConnector {
return null; return null;
} }
public function query($sql, $errorLevel = E_USER_ERROR) { public function query($sql, $errorLevel = E_USER_ERROR)
{
// Return successful result // Return successful result
$handle = @$this->dbConn->query($sql); $handle = @$this->dbConn->query($sql);
if ($handle) { if ($handle) {
@ -149,22 +160,26 @@ class SQLite3Connector extends DBConnector {
return null; return null;
} }
public function quoteString($value) { public function quoteString($value)
{
return "'".$this->escapeString($value)."'"; return "'".$this->escapeString($value)."'";
} }
public function escapeString($value) { public function escapeString($value)
{
return $this->dbConn->escapeString($value); return $this->dbConn->escapeString($value);
} }
public function selectDatabase($name) { public function selectDatabase($name)
{
if ($name !== $this->databaseName) { if ($name !== $this->databaseName) {
user_error("SQLite3Connector can't change databases. Please create a new database connection", E_USER_ERROR); user_error("SQLite3Connector can't change databases. Please create a new database connection", E_USER_ERROR);
} }
return true; return true;
} }
public function unloadDatabase() { public function unloadDatabase()
{
$this->dbConn->close(); $this->dbConn->close();
$this->databaseName = null; $this->databaseName = null;
} }

132
code/SQLite3Database.php
View File

@ -5,7 +5,8 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3Database extends SS_Database { class SQLite3Database extends SS_Database
{
/** /**
* Database schema manager object * Database schema manager object
@ -48,7 +49,8 @@ class SQLite3Database extends SS_Database {
* *
* @return string * @return string
*/ */
public static function database_extension() { public static function database_extension()
{
return Config::inst()->get('SQLite3Database', 'database_extension'); return Config::inst()->get('SQLite3Database', 'database_extension');
} }
@ -58,9 +60,12 @@ class SQLite3Database extends SS_Database {
* @param string $name * @param string $name
* @return boolean * @return boolean
*/ */
public static function is_valid_database_name($name) { public static function is_valid_database_name($name)
{
$extension = self::database_extension(); $extension = self::database_extension();
if(empty($extension)) return true; if (empty($extension)) {
return true;
}
return substr_compare($name, $extension, -strlen($extension), strlen($extension)) === 0; return substr_compare($name, $extension, -strlen($extension), strlen($extension)) === 0;
} }
@ -73,8 +78,8 @@ class SQLite3Database extends SS_Database {
* - key: the encryption key (needs testing) * - key: the encryption key (needs testing)
* - memory: use the faster In-Memory database for unit tests * - memory: use the faster In-Memory database for unit tests
*/ */
public function connect($parameters) { public function connect($parameters)
{
if (!empty($parameters['memory'])) { if (!empty($parameters['memory'])) {
Deprecation::notice( Deprecation::notice(
'1.4.0', '1.4.0',
@ -143,19 +148,23 @@ class SQLite3Database extends SS_Database {
* *
* @return array * @return array
*/ */
public function getParameters() { public function getParameters()
{
return $this->parameters; return $this->parameters;
} }
public function getLivesInMemory() { public function getLivesInMemory()
{
return isset($this->parameters['path']) && $this->parameters['path'] === ':memory:'; return isset($this->parameters['path']) && $this->parameters['path'] === ':memory:';
} }
public function supportsCollations() { public function supportsCollations()
{
return true; return true;
} }
public function supportsTimezoneOverride() { public function supportsTimezoneOverride()
{
return false; return false;
} }
@ -165,7 +174,8 @@ class SQLite3Database extends SS_Database {
* @param string pragma name * @param string pragma name
* @param string value to set * @param string value to set
*/ */
public function setPragma($pragma, $value) { public function setPragma($pragma, $value)
{
$this->query("PRAGMA $pragma = $value"); $this->query("PRAGMA $pragma = $value");
} }
@ -175,15 +185,18 @@ class SQLite3Database extends SS_Database {
* @param string pragma name * @param string pragma name
* @return string the pragma value * @return string the pragma value
*/ */
public function getPragma($pragma) { public function getPragma($pragma)
{
return $this->query("PRAGMA $pragma")->value(); return $this->query("PRAGMA $pragma")->value();
} }
public function getDatabaseServer() { public function getDatabaseServer()
{
return "sqlite"; return "sqlite";
} }
public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) { public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR)
{
if (!$this->schemaManager->databaseExists($name)) { if (!$this->schemaManager->databaseExists($name)) {
// Check DB creation permisson // Check DB creation permisson
if (!$create) { if (!$create) {
@ -204,11 +217,13 @@ class SQLite3Database extends SS_Database {
return true; return true;
} }
function now(){ public function now()
{
return "datetime('now', 'localtime')"; return "datetime('now', 'localtime')";
} }
function random(){ public function random()
{
return 'random()'; return 'random()';
} }
@ -236,8 +251,11 @@ class SQLite3Database extends SS_Database {
if ($extraFilter) { if ($extraFilter) {
$extraFilters['SiteTree'] = " AND $extraFilter"; $extraFilters['SiteTree'] = " AND $extraFilter";
if($alternativeFileFilter) $extraFilters['File'] = " AND $alternativeFileFilter"; if ($alternativeFileFilter) {
else $extraFilters['File'] = $extraFilters['SiteTree']; $extraFilters['File'] = " AND $alternativeFileFilter";
} else {
$extraFilters['File'] = $extraFilters['SiteTree'];
}
} }
// Always ensure that only pages with ShowInSearch = 1 can be searched // Always ensure that only pages with ShowInSearch = 1 can be searched
@ -343,8 +361,11 @@ class SQLite3Database extends SS_Database {
$objects[] = new $record['ClassName']($record); $objects[] = new $record['ClassName']($record);
} }
if(isset($objects)) $doSet = new ArrayList($objects); if (isset($objects)) {
else $doSet = new ArrayList(); $doSet = new ArrayList($objects);
} else {
$doSet = new ArrayList();
}
$list = new PaginatedList($doSet); $list = new PaginatedList($doSet);
$list->setPageStart($start); $list->setPageStart($start);
$list->setPageLEngth($pageLength); $list->setPageLEngth($pageLength);
@ -355,32 +376,36 @@ class SQLite3Database extends SS_Database {
/* /*
* Does this database support transactions? * Does this database support transactions?
*/ */
public function supportsTransactions(){ public function supportsTransactions()
{
return version_compare($this->getVersion(), '3.6', '>='); return version_compare($this->getVersion(), '3.6', '>=');
} }
public function supportsExtensions($extensions = array('partitions', 'tablespaces', 'clustering')){ public function supportsExtensions($extensions = array('partitions', 'tablespaces', 'clustering'))
{
if(isset($extensions['partitions'])) if (isset($extensions['partitions'])) {
return true; return true;
elseif(isset($extensions['tablespaces'])) } elseif (isset($extensions['tablespaces'])) {
return true; return true;
elseif(isset($extensions['clustering'])) } elseif (isset($extensions['clustering'])) {
return true; return true;
else } else {
return false; return false;
} }
}
public function transactionStart($transaction_mode = false, $session_characteristics = false) { public function transactionStart($transaction_mode = false, $session_characteristics = false)
{
$this->query('BEGIN'); $this->query('BEGIN');
} }
public function transactionSavepoint($savepoint) { public function transactionSavepoint($savepoint)
{
$this->query("SAVEPOINT \"$savepoint\""); $this->query("SAVEPOINT \"$savepoint\"");
} }
public function transactionRollback($savepoint = false){ public function transactionRollback($savepoint = false)
{
if ($savepoint) { if ($savepoint) {
$this->query("ROLLBACK TO $savepoint;"); $this->query("ROLLBACK TO $savepoint;");
} else { } else {
@ -388,11 +413,13 @@ class SQLite3Database extends SS_Database {
} }
} }
public function transactionEnd($chain = false){ public function transactionEnd($chain = false)
{
$this->query('COMMIT;'); $this->query('COMMIT;');
} }
public function clearTable($table) { public function clearTable($table)
{
$this->query("DELETE FROM \"$table\""); $this->query("DELETE FROM \"$table\"");
} }
@ -412,7 +439,9 @@ class SQLite3Database extends SS_Database {
} else { } else {
$comp = 'LIKE'; $comp = 'LIKE';
} }
if($negate) $comp = 'NOT ' . $comp; if ($negate) {
$comp = 'NOT ' . $comp;
}
} }
if ($parameterised) { if ($parameterised) {
@ -422,9 +451,14 @@ class SQLite3Database extends SS_Database {
} }
} }
function formattedDatetimeClause($date, $format) { public function formattedDatetimeClause($date, $format)
{
preg_match_all('/%(.)/', $format, $matches); preg_match_all('/%(.)/', $format, $matches);
foreach($matches[1] as $match) if(array_search($match, array('Y','m','d','H','i','s','U')) === false) user_error('formattedDatetimeClause(): unsupported format character %' . $match, E_USER_WARNING); foreach ($matches[1] as $match) {
if (array_search($match, array('Y', 'm', 'd', 'H', 'i', 's', 'U')) === false) {
user_error('formattedDatetimeClause(): unsupported format character %' . $match, E_USER_WARNING);
}
}
$translate = array( $translate = array(
'/%i/' => '%M', '/%i/' => '%M',
@ -434,8 +468,12 @@ class SQLite3Database extends SS_Database {
$format = preg_replace(array_keys($translate), array_values($translate), $format); $format = preg_replace(array_keys($translate), array_values($translate), $format);
$modifiers = array(); $modifiers = array();
if($format == '%s' && $date != 'now') $modifiers[] = 'utc'; if ($format == '%s' && $date != 'now') {
if($format != '%s' && $date == 'now') $modifiers[] = 'localtime'; $modifiers[] = 'utc';
}
if ($format != '%s' && $date == 'now') {
$modifiers[] = 'localtime';
}
if (preg_match('/^now$/i', $date)) { if (preg_match('/^now$/i', $date)) {
$date = "'now'"; $date = "'now'";
@ -447,9 +485,12 @@ class SQLite3Database extends SS_Database {
return "strftime('$format', $date$modifier)"; return "strftime('$format', $date$modifier)";
} }
function datetimeIntervalClause($date, $interval) { public function datetimeIntervalClause($date, $interval)
{
$modifiers = array(); $modifiers = array();
if($date == 'now') $modifiers[] = 'localtime'; if ($date == 'now') {
$modifiers[] = 'localtime';
}
if (preg_match('/^now$/i', $date)) { if (preg_match('/^now$/i', $date)) {
$date = "'now'"; $date = "'now'";
@ -461,12 +502,17 @@ class SQLite3Database extends SS_Database {
return "datetime($date$modifier, '$interval')"; return "datetime($date$modifier, '$interval')";
} }
function datetimeDifferenceClause($date1, $date2) { public function datetimeDifferenceClause($date1, $date2)
{
$modifiers1 = array(); $modifiers1 = array();
$modifiers2 = array(); $modifiers2 = array();
if($date1 == 'now') $modifiers1[] = 'localtime'; if ($date1 == 'now') {
if($date2 == 'now') $modifiers2[] = 'localtime'; $modifiers1[] = 'localtime';
}
if ($date2 == 'now') {
$modifiers2[] = 'localtime';
}
if (preg_match('/^now$/i', $date1)) { if (preg_match('/^now$/i', $date1)) {
$date1 = "'now'"; $date1 = "'now'";

30
code/SQLite3Query.php
View File

@ -5,7 +5,8 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3Query extends SS_Query { class SQLite3Query extends SS_Query
{
/** /**
* The SQLite3Connector object that created this result set. * The SQLite3Connector object that created this result set.
@ -26,33 +27,44 @@ class SQLite3Query extends SS_Query {
* @param SQLite3Connector $database The database object that created this query. * @param SQLite3Connector $database The database object that created this query.
* @param SQLite3Result $handle the internal sqlite3 handle that is points to the resultset. * @param SQLite3Result $handle the internal sqlite3 handle that is points to the resultset.
*/ */
public function __construct(SQLite3Connector $database, SQLite3Result $handle) { public function __construct(SQLite3Connector $database, SQLite3Result $handle)
{
$this->database = $database; $this->database = $database;
$this->handle = $handle; $this->handle = $handle;
} }
public function __destruct() { public function __destruct()
if($this->handle) $this->handle->finalize(); {
if ($this->handle) {
$this->handle->finalize();
}
} }
public function seek($row) { public function seek($row)
{
$this->handle->reset(); $this->handle->reset();
$i=0; $i=0;
while($i < $row && $row = @$this->handle->fetchArray()) $i++; while ($i < $row && $row = @$this->handle->fetchArray()) {
$i++;
}
return true; return true;
} }
/** /**
* @todo This looks terrible but there is no SQLite3::get_num_rows() implementation * @todo This looks terrible but there is no SQLite3::get_num_rows() implementation
*/ */
public function numRecords() { public function numRecords()
{
$c=0; $c=0;
while($this->handle->fetchArray()) $c++; while ($this->handle->fetchArray()) {
$c++;
}
$this->handle->reset(); $this->handle->reset();
return $c; return $c;
} }
public function nextRecord() { public function nextRecord()
{
if ($data = $this->handle->fetchArray(SQLITE3_ASSOC)) { if ($data = $this->handle->fetchArray(SQLITE3_ASSOC)) {
return $data; return $data;
} else { } else {

14
code/SQLite3QueryBuilder.php
View File

@ -5,14 +5,16 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3QueryBuilder extends DBQueryBuilder { class SQLite3QueryBuilder extends DBQueryBuilder
{
/** /**
* @param SQLInsert $query * @param SQLInsert $query
* @param array $parameters * @param array $parameters
* @return string * @return string
*/ */
protected function buildInsertQuery(SQLInsert $query, array &$parameters) { protected function buildInsertQuery(SQLInsert $query, array &$parameters)
{
// Multi-row insert requires SQLite specific syntax prior to 3.7.11 // Multi-row insert requires SQLite specific syntax prior to 3.7.11
// For backwards compatibility reasons include the "union all select" syntax // For backwards compatibility reasons include the "union all select" syntax
@ -59,12 +61,15 @@ class SQLite3QueryBuilder extends DBQueryBuilder {
* @param array $parameters Out parameter for the resulting query parameters * @param array $parameters Out parameter for the resulting query parameters
* @return string The finalised limit SQL fragment * @return string The finalised limit SQL fragment
*/ */
public function buildLimitFragment(SQLSelect $query, array &$parameters) { public function buildLimitFragment(SQLSelect $query, array &$parameters)
{
$nl = $this->getSeparator(); $nl = $this->getSeparator();
// Ensure limit is given // Ensure limit is given
$limit = $query->getLimit(); $limit = $query->getLimit();
if(empty($limit)) return ''; if (empty($limit)) {
return '';
}
// For literal values return this as the limit SQL // For literal values return this as the limit SQL
if (! is_array($limit)) { if (! is_array($limit)) {
@ -90,5 +95,4 @@ class SQLite3QueryBuilder extends DBQueryBuilder {
} }
return $clause; return $clause;
} }
} }

203
code/SQLite3SchemaManager.php
View File

@ -5,7 +5,8 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3SchemaManager extends DBSchemaManager { class SQLite3SchemaManager extends DBSchemaManager
{
/** /**
* Instance of the database controller this schema belongs to * Instance of the database controller this schema belongs to
@ -28,22 +29,29 @@ class SQLite3SchemaManager extends DBSchemaManager {
*/ */
public static $vacuum = true; public static $vacuum = true;
public function createDatabase($name) { public function createDatabase($name)
{
// Ensure that any existing database is cleared before connection // Ensure that any existing database is cleared before connection
$this->dropDatabase($name); $this->dropDatabase($name);
} }
public function dropDatabase($name) { public function dropDatabase($name)
{
// No need to delete database files if operating purely within memory // No need to delete database files if operating purely within memory
if($this->database->getLivesInMemory()) return; if ($this->database->getLivesInMemory()) {
return;
}
// If using file based database ensure any existing file is removed // If using file based database ensure any existing file is removed
$parameters = $this->database->getParameters(); $parameters = $this->database->getParameters();
$fullpath = $parameters['path'] . '/' . $name; $fullpath = $parameters['path'] . '/' . $name;
if(is_writable($fullpath)) unlink($fullpath); if (is_writable($fullpath)) {
unlink($fullpath);
}
} }
function databaseList() { public function databaseList()
{
$parameters = $this->database->getParameters(); $parameters = $this->database->getParameters();
// If in-memory use the current database name only // If in-memory use the current database name only
@ -57,20 +65,27 @@ class SQLite3SchemaManager extends DBSchemaManager {
// Filter each file in this directory // Filter each file in this directory
$databases = array(); $databases = array();
if($files !== false) foreach($files as $file) { if ($files !== false) {
foreach ($files as $file) {
// Filter non-files // Filter non-files
if(!is_file("$directory/$file")) continue; if (!is_file("$directory/$file")) {
continue;
}
// Filter those with correct extension // Filter those with correct extension
if(!SQLite3Database::is_valid_database_name($file)) continue; if (!SQLite3Database::is_valid_database_name($file)) {
continue;
}
$databases[] = $file; $databases[] = $file;
} }
}
return $databases; return $databases;
} }
public function databaseExists($name) { public function databaseExists($name)
{
$databases = $this->databaseList(); $databases = $this->databaseList();
return in_array($name, $databases); return in_array($name, $databases);
} }
@ -78,11 +93,13 @@ class SQLite3SchemaManager extends DBSchemaManager {
/** /**
* Empties any cached enum values * Empties any cached enum values
*/ */
public function flushCache() { public function flushCache()
{
$this->enum_map = array(); $this->enum_map = array();
} }
function schemaUpdate($callback) { public function schemaUpdate($callback)
{
// Set locking mode // Set locking mode
$this->database->setPragma('locking_mode', 'EXCLUSIVE'); $this->database->setPragma('locking_mode', 'EXCLUSIVE');
$this->checkAndRepairTable(); $this->checkAndRepairTable();
@ -99,7 +116,9 @@ class SQLite3SchemaManager extends DBSchemaManager {
// Revert locking mode // Revert locking mode
$this->database->setPragma('locking_mode', SQLite3Database::$default_pragma['locking_mode']); $this->database->setPragma('locking_mode', SQLite3Database::$default_pragma['locking_mode']);
if($error) throw $error; if ($error) {
throw $error;
}
} }
/** /**
@ -107,17 +126,25 @@ class SQLite3SchemaManager extends DBSchemaManager {
* *
* @param string $table * @param string $table
*/ */
public function clearTable($table) { public function clearTable($table)
if($table != 'SQLiteEnums') $this->dbConn->query("DELETE FROM \"$table\""); {
if ($table != 'SQLiteEnums') {
$this->dbConn->query("DELETE FROM \"$table\"");
}
} }
public function createTable($table, $fields = null, $indexes = null, $options = null, $advancedOptions = null) { public function createTable($table, $fields = null, $indexes = null, $options = null, $advancedOptions = null)
if(!isset($fields['ID'])) $fields['ID'] = $this->IdColumn(); {
if (!isset($fields['ID'])) {
$fields['ID'] = $this->IdColumn();
}
$fieldSchemata = array(); $fieldSchemata = array();
if($fields) foreach($fields as $k => $v) { if ($fields) {
foreach ($fields as $k => $v) {
$fieldSchemata[] = "\"$k\" $v"; $fieldSchemata[] = "\"$k\" $v";
} }
}
$fieldSchemas = implode(",\n", $fieldSchemata); $fieldSchemas = implode(",\n", $fieldSchemata);
// Switch to "CREATE TEMPORARY TABLE" for temporary tables // Switch to "CREATE TEMPORARY TABLE" for temporary tables
@ -138,28 +165,38 @@ class SQLite3SchemaManager extends DBSchemaManager {
public function alterTable($tableName, $newFields = null, $newIndexes = null, $alteredFields = null, public function alterTable($tableName, $newFields = null, $newIndexes = null, $alteredFields = null,
$alteredIndexes = null, $alteredOptions = null, $advancedOptions = null $alteredIndexes = null, $alteredOptions = null, $advancedOptions = null
) { ) {
if($newFields) foreach($newFields as $fieldName => $fieldSpec) { if ($newFields) {
foreach ($newFields as $fieldName => $fieldSpec) {
$this->createField($tableName, $fieldName, $fieldSpec); $this->createField($tableName, $fieldName, $fieldSpec);
} }
}
if($alteredFields) foreach($alteredFields as $fieldName => $fieldSpec) { if ($alteredFields) {
foreach ($alteredFields as $fieldName => $fieldSpec) {
$this->alterField($tableName, $fieldName, $fieldSpec); $this->alterField($tableName, $fieldName, $fieldSpec);
} }
if($newIndexes) foreach($newIndexes as $indexName => $indexSpec) {
$this->createIndex($tableName, $indexName, $indexSpec);
} }
if($alteredIndexes) foreach($alteredIndexes as $indexName => $indexSpec) { if ($newIndexes) {
foreach ($newIndexes as $indexName => $indexSpec) {
$this->createIndex($tableName, $indexName, $indexSpec);
}
}
if ($alteredIndexes) {
foreach ($alteredIndexes as $indexName => $indexSpec) {
$this->alterIndex($tableName, $indexName, $indexSpec); $this->alterIndex($tableName, $indexName, $indexSpec);
} }
} }
}
public function renameTable($oldTableName, $newTableName) { public function renameTable($oldTableName, $newTableName)
{
$this->query("ALTER TABLE \"$oldTableName\" RENAME TO \"$newTableName\""); $this->query("ALTER TABLE \"$oldTableName\" RENAME TO \"$newTableName\"");
} }
public function checkAndRepairTable($tableName = null) { public function checkAndRepairTable($tableName = null)
{
$ok = true; $ok = true;
if (!SapphireTest::using_temp_db() && !self::$checked_and_repaired) { if (!SapphireTest::using_temp_db() && !self::$checked_and_repaired) {
@ -167,11 +204,13 @@ class SQLite3SchemaManager extends DBSchemaManager {
// Check for any tables with failed integrity // Check for any tables with failed integrity
if ($messages = $this->query('PRAGMA integrity_check')) { if ($messages = $this->query('PRAGMA integrity_check')) {
foreach($messages as $message) if($message['integrity_check'] != 'ok') { foreach ($messages as $message) {
if ($message['integrity_check'] != 'ok') {
Debug::show($message['integrity_check']); Debug::show($message['integrity_check']);
$ok = false; $ok = false;
} }
} }
}
// If enabled vacuum (clean and rebuild) the database // If enabled vacuum (clean and rebuild) the database
if (self::$vacuum) { if (self::$vacuum) {
@ -189,7 +228,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
return $ok; return $ok;
} }
public function createField($table, $field, $spec) { public function createField($table, $field, $spec)
{
$this->query("ALTER TABLE \"$table\" ADD \"$field\" $spec"); $this->query("ALTER TABLE \"$table\" ADD \"$field\" $spec");
} }
@ -199,7 +239,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @param string $fieldName The name of the field to change. * @param string $fieldName The name of the field to change.
* @param string $fieldSpec The new field specification * @param string $fieldSpec The new field specification
*/ */
public function alterField($tableName, $fieldName, $fieldSpec) { public function alterField($tableName, $fieldName, $fieldSpec)
{
$oldFieldList = $this->fieldList($tableName); $oldFieldList = $this->fieldList($tableName);
$fieldNameList = '"' . implode('","', array_keys($oldFieldList)) . '"'; $fieldNameList = '"' . implode('","', array_keys($oldFieldList)) . '"';
@ -208,7 +249,9 @@ class SQLite3SchemaManager extends DBSchemaManager {
} }
// Skip non-existing columns // Skip non-existing columns
if(!array_key_exists($fieldName, $oldFieldList)) return; if (!array_key_exists($fieldName, $oldFieldList)) {
return;
}
// Update field spec // Update field spec
$newColsSpec = array(); $newColsSpec = array();
@ -229,7 +272,9 @@ class SQLite3SchemaManager extends DBSchemaManager {
$indexList = $this->indexList($tableName); $indexList = $this->indexList($tableName);
// Then alter the table column // Then alter the table column
foreach($queries as $query) $this->query($query.';'); foreach ($queries as $query) {
$this->query($query.';');
}
// Recreate the indexes // Recreate the indexes
foreach ($indexList as $indexName => $indexSpec) { foreach ($indexList as $indexName => $indexSpec) {
@ -237,11 +282,14 @@ class SQLite3SchemaManager extends DBSchemaManager {
} }
} }
public function renameField($tableName, $oldName, $newName) { public function renameField($tableName, $oldName, $newName)
{
$oldFieldList = $this->fieldList($tableName); $oldFieldList = $this->fieldList($tableName);
// Skip non-existing columns // Skip non-existing columns
if(!array_key_exists($oldName, $oldFieldList)) return; if (!array_key_exists($oldName, $oldFieldList)) {
return;
}
// Determine column mappings // Determine column mappings
$oldCols = array(); $oldCols = array();
@ -265,7 +313,9 @@ class SQLite3SchemaManager extends DBSchemaManager {
$oldIndexList = $this->indexList($tableName); $oldIndexList = $this->indexList($tableName);
// Then alter the table column // Then alter the table column
foreach($queries as $query) $this->query($query.';'); foreach ($queries as $query) {
$this->query($query.';');
}
// Recreate the indexes // Recreate the indexes
foreach ($oldIndexList as $indexName => $indexSpec) { foreach ($oldIndexList as $indexName => $indexSpec) {
@ -275,7 +325,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
} }
} }
public function fieldList($table) { public function fieldList($table)
{
$sqlCreate = $this->preparedQuery( $sqlCreate = $this->preparedQuery(
'SELECT sql FROM sqlite_master WHERE type = ? AND name = ?', 'SELECT sql FROM sqlite_master WHERE type = ? AND name = ?',
array('table', $table) array('table', $table)
@ -306,7 +357,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @param string $indexName The name of the index. * @param string $indexName The name of the index.
* @param array $indexSpec The specification of the index, see Database::requireIndex() for more details. * @param array $indexSpec The specification of the index, see Database::requireIndex() for more details.
*/ */
public function createIndex($tableName, $indexName, $indexSpec) { public function createIndex($tableName, $indexName, $indexSpec)
{
$parsedSpec = $this->parseIndexSpec($indexName, $indexSpec); $parsedSpec = $this->parseIndexSpec($indexName, $indexSpec);
$sqliteName = $this->buildSQLiteIndexName($tableName, $indexName); $sqliteName = $this->buildSQLiteIndexName($tableName, $indexName);
$columns = $parsedSpec['value']; $columns = $parsedSpec['value'];
@ -314,7 +366,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
$this->query("CREATE $unique INDEX IF NOT EXISTS \"$sqliteName\" ON \"$tableName\" ($columns)"); $this->query("CREATE $unique INDEX IF NOT EXISTS \"$sqliteName\" ON \"$tableName\" ($columns)");
} }
public function alterIndex($tableName, $indexName, $indexSpec) { public function alterIndex($tableName, $indexName, $indexSpec)
{
// Drop existing index // Drop existing index
$sqliteName = $this->buildSQLiteIndexName($tableName, $indexName); $sqliteName = $this->buildSQLiteIndexName($tableName, $indexName);
$this->query("DROP INDEX IF EXISTS \"$sqliteName\""); $this->query("DROP INDEX IF EXISTS \"$sqliteName\"");
@ -333,11 +386,13 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @param string $indexName * @param string $indexName
* @return string The SQLite3 name of the index * @return string The SQLite3 name of the index
*/ */
protected function buildSQLiteIndexName($tableName, $indexName) { protected function buildSQLiteIndexName($tableName, $indexName)
{
return "{$tableName}_{$indexName}"; return "{$tableName}_{$indexName}";
} }
protected function parseIndexSpec($name, $spec) { protected function parseIndexSpec($name, $spec)
{
$spec = parent::parseIndexSpec($name, $spec); $spec = parent::parseIndexSpec($name, $spec);
// Only allow index / unique index types // Only allow index / unique index types
@ -348,11 +403,13 @@ class SQLite3SchemaManager extends DBSchemaManager {
return $spec; return $spec;
} }
public function indexKey($table, $index, $spec) { public function indexKey($table, $index, $spec)
{
return $this->buildSQLiteIndexName($table, $index); return $this->buildSQLiteIndexName($table, $index);
} }
public function indexList($table) { public function indexList($table)
{
$indexList = array(); $indexList = array();
// Enumerate each index and related fields // Enumerate each index and related fields
@ -379,7 +436,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
return $indexList; return $indexList;
} }
public function tableList() { public function tableList()
{
$tables = array(); $tables = array();
$result = $this->preparedQuery('SELECT name FROM sqlite_master WHERE type = ?', array('table')); $result = $this->preparedQuery('SELECT name FROM sqlite_master WHERE type = ?', array('table'));
foreach ($result as $record) { foreach ($result as $record) {
@ -395,7 +453,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function boolean($values) { public function boolean($values)
{
$default = empty($values['default']) ? 0 : (int)$values['default']; $default = empty($values['default']) ? 0 : (int)$values['default'];
return "BOOL NOT NULL DEFAULT $default"; return "BOOL NOT NULL DEFAULT $default";
} }
@ -406,7 +465,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function date($values){ public function date($values)
{
return "TEXT"; return "TEXT";
} }
@ -416,7 +476,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function decimal($values, $asDbValue = false) { public function decimal($values, $asDbValue = false)
{
$default = isset($values['default']) && is_numeric($values['default']) ? $values['default'] : 0; $default = isset($values['default']) && is_numeric($values['default']) ? $values['default'] : 0;
return "NUMERIC NOT NULL DEFAULT $default"; return "NUMERIC NOT NULL DEFAULT $default";
} }
@ -436,7 +497,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function enum($values){ public function enum($values)
{
$tablefield = $values['table'] . '.' . $values['name']; $tablefield = $values['table'] . '.' . $values['name'];
$enumValues = implode(',', $values['enums']); $enumValues = implode(',', $values['enums']);
@ -472,7 +534,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function set($values) { public function set($values)
{
return $this->enum($values); return $this->enum($values);
} }
@ -482,7 +545,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function float($values, $asDbValue = false){ public function float($values, $asDbValue = false)
{
return "REAL"; return "REAL";
} }
@ -492,7 +556,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function double($values, $asDbValue = false){ public function double($values, $asDbValue = false)
{
return "REAL"; return "REAL";
} }
@ -502,7 +567,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function int($values, $asDbValue = false){ public function int($values, $asDbValue = false)
{
return "INTEGER({$values['precision']}) " . strtoupper($values['null']) . " DEFAULT " . (int)$values['default']; return "INTEGER({$values['precision']}) " . strtoupper($values['null']) . " DEFAULT " . (int)$values['default'];
} }
@ -512,7 +578,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function bigint($values, $asDbValue = false){ public function bigint($values, $asDbValue = false)
{
return $this->int($values, $asDbValue); return $this->int($values, $asDbValue);
} }
@ -523,7 +590,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function ss_datetime($values, $asDbValue = false) { public function ss_datetime($values, $asDbValue = false)
{
return "DATETIME"; return "DATETIME";
} }
@ -533,7 +601,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function text($values, $asDbValue = false) { public function text($values, $asDbValue = false)
{
return 'TEXT'; return 'TEXT';
} }
@ -543,7 +612,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function time($values) { public function time($values)
{
return "TEXT"; return "TEXT";
} }
@ -553,7 +623,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* @params array $values Contains a tokenised list of info about this data type * @params array $values Contains a tokenised list of info about this data type
* @return string * @return string
*/ */
public function varchar($values, $asDbValue = false) { public function varchar($values, $asDbValue = false)
{
return "VARCHAR({$values['precision']}) COLLATE NOCASE"; return "VARCHAR({$values['precision']}) COLLATE NOCASE";
} }
@ -561,15 +632,18 @@ class SQLite3SchemaManager extends DBSchemaManager {
* Return a 4 digit numeric type. MySQL has a proprietary 'Year' type. * Return a 4 digit numeric type. MySQL has a proprietary 'Year' type.
* For SQLite3 we use TEXT * For SQLite3 we use TEXT
*/ */
public function year($values, $asDbValue = false){ public function year($values, $asDbValue = false)
{
return "TEXT"; return "TEXT";
} }
public function IdColumn($asDbValue = false, $hasAutoIncPK = true){ public function IdColumn($asDbValue = false, $hasAutoIncPK = true)
{
return 'INTEGER PRIMARY KEY AUTOINCREMENT'; return 'INTEGER PRIMARY KEY AUTOINCREMENT';
} }
function hasTable($tableName) { public function hasTable($tableName)
{
return (bool)$this->preparedQuery( return (bool)$this->preparedQuery(
'SELECT name FROM sqlite_master WHERE type = ? AND name = ?', 'SELECT name FROM sqlite_master WHERE type = ? AND name = ?',
array('table', $tableName) array('table', $tableName)
@ -581,7 +655,8 @@ class SQLite3SchemaManager extends DBSchemaManager {
* *
* @return array * @return array
*/ */
public function enumValuesForField($tableName, $fieldName) { public function enumValuesForField($tableName, $fieldName)
{
$tablefield = "$tableName.$fieldName"; $tablefield = "$tableName.$fieldName";
// Check already cached values for this field // Check already cached values for this field
@ -604,12 +679,16 @@ class SQLite3SchemaManager extends DBSchemaManager {
return array(); return array();
} }
function dbDataType($type){ public function dbDataType($type)
{
$values = array( $values = array(
'unsigned integer' => 'INT' 'unsigned integer' => 'INT'
); );
if(isset($values[$type])) return $values[$type]; if (isset($values[$type])) {
else return ''; return $values[$type];
} else {
return '';
}
} }
} }

49
code/SQLiteDatabaseConfigurationHelper.php
View File

@ -8,7 +8,8 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper { class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
{
/** /**
* Create a connection of the appropriate type * Create a connection of the appropriate type
@ -17,7 +18,8 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
* @param string $error Error message passed by value * @param string $error Error message passed by value
* @return mixed|null Either the connection object, or null if error * @return mixed|null Either the connection object, or null if error
*/ */
protected function createConnection($databaseConfig, &$error) { protected function createConnection($databaseConfig, &$error)
{
$error = null; $error = null;
try { try {
if (!file_exists($databaseConfig['path'])) { if (!file_exists($databaseConfig['path'])) {
@ -56,12 +58,14 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
} }
} }
public function requireDatabaseFunctions($databaseConfig) { public function requireDatabaseFunctions($databaseConfig)
{
$data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']); $data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']);
return !empty($data['supported']); return !empty($data['supported']);
} }
public function requireDatabaseServer($databaseConfig) { public function requireDatabaseServer($databaseConfig)
{
$path = $databaseConfig['path']; $path = $databaseConfig['path'];
$error = ''; $error = '';
$success = false; $success = false;
@ -90,29 +94,38 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
* @param array $databaseConfig Associative array of db configuration, e.g. "type", "path" etc * @param array $databaseConfig Associative array of db configuration, e.g. "type", "path" etc
* @return array Result - e.g. array('success' => true, 'error' => 'details of error') * @return array Result - e.g. array('success' => true, 'error' => 'details of error')
*/ */
public function requireDatabaseConnection($databaseConfig) { public function requireDatabaseConnection($databaseConfig)
{
// Do additional validation around file paths // Do additional validation around file paths
if(empty($databaseConfig['path'])) return array( if (empty($databaseConfig['path'])) {
return array(
'success' => false, 'success' => false,
'error' => "Missing directory path" 'error' => "Missing directory path"
); );
if(empty($databaseConfig['database'])) return array( }
if (empty($databaseConfig['database'])) {
return array(
'success' => false, 'success' => false,
'error' => "Missing database filename" 'error' => "Missing database filename"
); );
}
// Create and secure db directory // Create and secure db directory
$path = $databaseConfig['path']; $path = $databaseConfig['path'];
$dirCreated = self::create_db_dir($path); $dirCreated = self::create_db_dir($path);
if(!$dirCreated) return array( if (!$dirCreated) {
return array(
'success' => false, 'success' => false,
'error' => sprintf('Cannot create path: "%s"', $path) 'error' => sprintf('Cannot create path: "%s"', $path)
); );
}
$dirSecured = self::secure_db_dir($path); $dirSecured = self::secure_db_dir($path);
if(!$dirSecured) return array( if (!$dirSecured) {
return array(
'success' => false, 'success' => false,
'error' => sprintf('Cannot secure path through .htaccess: "%s"', $path) 'error' => sprintf('Cannot secure path through .htaccess: "%s"', $path)
); );
}
$conn = $this->createConnection($databaseConfig, $error); $conn = $this->createConnection($databaseConfig, $error);
$success = !empty($conn); $success = !empty($conn);
@ -124,7 +137,8 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
); );
} }
public function getDatabaseVersion($databaseConfig) { public function getDatabaseVersion($databaseConfig)
{
$version = 0; $version = 0;
switch ($databaseConfig['type']) { switch ($databaseConfig['type']) {
@ -144,7 +158,8 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
return $version; return $version;
} }
public function requireDatabaseVersion($databaseConfig) { public function requireDatabaseVersion($databaseConfig)
{
$success = false; $success = false;
$error = ''; $error = '';
$version = $this->getDatabaseVersion($databaseConfig); $version = $this->getDatabaseVersion($databaseConfig);
@ -162,7 +177,8 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
); );
} }
public function requireDatabaseOrCreatePermissions($databaseConfig) { public function requireDatabaseOrCreatePermissions($databaseConfig)
{
$conn = $this->createConnection($databaseConfig, $error); $conn = $this->createConnection($databaseConfig, $error);
$success = $alreadyExists = !empty($conn); $success = $alreadyExists = !empty($conn);
return array( return array(
@ -179,7 +195,8 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
* @param String $path Absolute path, usually with a hidden folder. * @param String $path Absolute path, usually with a hidden folder.
* @return boolean * @return boolean
*/ */
public static function create_db_dir($path) { public static function create_db_dir($path)
{
return file_exists($path) || mkdir($path); return file_exists($path) || mkdir($path);
} }
@ -193,11 +210,13 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper {
* @param String $path Absolute path, containing a SQLite datatbase * @param String $path Absolute path, containing a SQLite datatbase
* @return boolean * @return boolean
*/ */
public static function secure_db_dir($path) { public static function secure_db_dir($path)
{
return (is_writeable($path)) ? file_put_contents($path . '/.htaccess', 'deny from all') : false; return (is_writeable($path)) ? file_put_contents($path . '/.htaccess', 'deny from all') : false;
} }
public function requireDatabaseAlterPermissions($databaseConfig) { public function requireDatabaseAlterPermissions($databaseConfig)
{
// no concept of table-specific permissions; If you can connect you can alter schema // no concept of table-specific permissions; If you can connect you can alter schema
return array( return array(
'success' => true, 'success' => true,