Converted to PSR-2

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

View File

@ -5,167 +5,182 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3Connector extends DBConnector { class SQLite3Connector extends DBConnector
{
/** /**
* The name of the database. * The name of the database.
* *
* @var string * @var string
*/ */
protected $databaseName; protected $databaseName;
/** /**
* Connection to the DBMS. * Connection to the DBMS.
* *
* @var SQLite3 * @var SQLite3
*/ */
protected $dbConn; protected $dbConn;
public function connect($parameters, $selectDB = false) { public function connect($parameters, $selectDB = false)
$file = $parameters['filepath']; {
$this->dbConn = empty($parameters['key']) $file = $parameters['filepath'];
? new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE) $this->dbConn = empty($parameters['key'])
: new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $parameters['key']); ? new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE)
$this->dbConn->busyTimeout(60000); : new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $parameters['key']);
$this->databaseName = $parameters['database']; $this->dbConn->busyTimeout(60000);
} $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(); {
return $message === 'not an error' ? null : $message; $message = $this->dbConn->lastErrorMsg();
} 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(); {
return trim($version['versionString']); $version = SQLite3::version();
} return trim($version['versionString']);
}
public function isActive() { public function isActive()
return $this->databaseName && $this->dbConn; {
} return $this->databaseName && $this->dbConn;
}
/** /**
* Prepares the list of parameters in preparation for passing to mysqli_stmt_bind_param * Prepares the list of parameters in preparation for passing to mysqli_stmt_bind_param
* *
* @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(); {
foreach($parameters as $value) { $values = array();
$phpType = gettype($value); foreach ($parameters as $value) {
$sqlType = null; $phpType = gettype($value);
$sqlType = null;
// Allow overriding of parameter type using an associative array // Allow overriding of parameter type using an associative array
if($phpType === 'array') { if ($phpType === 'array') {
$phpType = $value['type']; $phpType = $value['type'];
$value = $value['value']; $value = $value['value'];
} }
// Convert php variable type to one that makes mysqli_stmt_bind_param happy // Convert php variable type to one that makes mysqli_stmt_bind_param happy
// @see http://www.php.net/manual/en/mysqli-stmt.bind-param.php // @see http://www.php.net/manual/en/mysqli-stmt.bind-param.php
switch($phpType) { switch ($phpType) {
case 'boolean': case 'boolean':
case 'integer': case 'integer':
$sqlType = SQLITE3_INTEGER; $sqlType = SQLITE3_INTEGER;
break; break;
case 'float': // Not actually returnable from gettype case 'float': // Not actually returnable from gettype
case 'double': case 'double':
$sqlType = SQLITE3_FLOAT; $sqlType = SQLITE3_FLOAT;
break; break;
case 'object': // Allowed if the object or resource has a __toString method case 'object': // Allowed if the object or resource has a __toString method
case 'resource': case 'resource':
case 'string': case 'string':
$sqlType = SQLITE3_TEXT; $sqlType = SQLITE3_TEXT;
break; break;
case 'NULL': case 'NULL':
$sqlType = SQLITE3_NULL; $sqlType = SQLITE3_NULL;
break; break;
case 'blob': case 'blob':
$sqlType = SQLITE3_BLOB; $sqlType = SQLITE3_BLOB;
break; break;
case 'array': case 'array':
case 'unknown type': case 'unknown type':
default: default:
user_error("Cannot bind parameter \"$value\" as it is an unsupported type ($phpType)", E_USER_ERROR); user_error("Cannot bind parameter \"$value\" as it is an unsupported type ($phpType)", E_USER_ERROR);
break; break;
} }
$values[] = array( $values[] = array(
'type' => $sqlType, 'type' => $sqlType,
'value' => $value 'value' => $value
); );
} }
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 {
$parsedParameters = $this->parsePreparedParameters($parameters); // Type check, identify, and prepare parameters for passing to the statement bind function
$parsedParameters = $this->parsePreparedParameters($parameters);
// Prepare statement // Prepare statement
$statement = @$this->dbConn->prepare($sql); $statement = @$this->dbConn->prepare($sql);
if($statement) { if ($statement) {
// Bind and run to statement // Bind and run to statement
for($i = 0; $i < count($parsedParameters); $i++) { for ($i = 0; $i < count($parsedParameters); $i++) {
$value = $parsedParameters[$i]['value']; $value = $parsedParameters[$i]['value'];
$type = $parsedParameters[$i]['type']; $type = $parsedParameters[$i]['type'];
$statement->bindValue($i+1, $value, $type); $statement->bindValue($i+1, $value, $type);
} }
// Return successful result // Return successful result
$handle = $statement->execute(); $handle = $statement->execute();
if ($handle) { if ($handle) {
return new SQLite3Query($this, $handle); return new SQLite3Query($this, $handle);
} }
} }
// Handle error // Handle error
$values = $this->parameterValues($parameters); $values = $this->parameterValues($parameters);
$this->databaseError($this->getLastError(), $errorLevel, $sql, $values); $this->databaseError($this->getLastError(), $errorLevel, $sql, $values);
return null; return null;
} }
public function query($sql, $errorLevel = E_USER_ERROR) { public function query($sql, $errorLevel = E_USER_ERROR)
// Return successful result {
$handle = @$this->dbConn->query($sql); // Return successful result
if ($handle) { $handle = @$this->dbConn->query($sql);
return new SQLite3Query($this, $handle); if ($handle) {
} return new SQLite3Query($this, $handle);
}
// Handle error
$this->databaseError($this->getLastError(), $errorLevel, $sql); // Handle error
return null; $this->databaseError($this->getLastError(), $errorLevel, $sql);
} 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) { {
user_error("SQLite3Connector can't change databases. Please create a new database connection", E_USER_ERROR); if ($name !== $this->databaseName) {
} 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->databaseName = null; $this->dbConn->close();
} $this->databaseName = null;
}
} }

View File

@ -1,488 +1,534 @@
<?php <?php
/** /**
* SQLite database controller class * SQLite database controller class
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3Database extends SS_Database { class SQLite3Database extends SS_Database
{
/**
* Database schema manager object /**
* * Database schema manager object
* @var SQLite3SchemaManager *
*/ * @var SQLite3SchemaManager
protected $schemaManager = null; */
protected $schemaManager = null;
/*
* This holds the parameters that the original connection was created with, /*
* so we can switch back to it if necessary (used for unit tests) * This holds the parameters that the original connection was created with,
* * so we can switch back to it if necessary (used for unit tests)
* @var array *
*/ * @var array
protected $parameters; */
protected $parameters;
/*
* if we're on a In-Memory db /*
* * if we're on a In-Memory db
* @var boolean *
*/ * @var boolean
protected $livesInMemory = false; */
protected $livesInMemory = false;
/**
* List of default pragma values /**
* * List of default pragma values
* @todo Migrate to SS config *
* * @todo Migrate to SS config
* @var array *
*/ * @var array
public static $default_pragma = array( */
'encoding' => '"UTF-8"', public static $default_pragma = array(
'locking_mode' => 'NORMAL' 'encoding' => '"UTF-8"',
); 'locking_mode' => 'NORMAL'
);
/**
* Extension used to distinguish between sqllite database files and other files. /**
* Required to handle multiple databases. * Extension used to distinguish between sqllite database files and other files.
* * Required to handle multiple databases.
* @return string *
*/ * @return string
public static function database_extension() { */
return Config::inst()->get('SQLite3Database', 'database_extension'); public static function database_extension()
} {
return Config::inst()->get('SQLite3Database', 'database_extension');
/** }
* Check if a database name has a valid extension
* /**
* @param string $name * Check if a database name has a valid extension
* @return boolean *
*/ * @param string $name
public static function is_valid_database_name($name) { * @return boolean
$extension = self::database_extension(); */
if(empty($extension)) return true; public static function is_valid_database_name($name)
{
return substr_compare($name, $extension, -strlen($extension), strlen($extension)) === 0; $extension = self::database_extension();
} if (empty($extension)) {
return true;
/** }
* Connect to a SQLite3 database.
* @param array $parameters An map of parameters, which should include: return substr_compare($name, $extension, -strlen($extension), strlen($extension)) === 0;
* - database: The database to connect to, with the correct file extension (.sqlite) }
* - path: the path to the SQLite3 database file
* - key: the encryption key (needs testing) /**
* - memory: use the faster In-Memory database for unit tests * Connect to a SQLite3 database.
*/ * @param array $parameters An map of parameters, which should include:
public function connect($parameters) { * - database: The database to connect to, with the correct file extension (.sqlite)
* - path: the path to the SQLite3 database file
if(!empty($parameters['memory'])) { * - key: the encryption key (needs testing)
Deprecation::notice( * - memory: use the faster In-Memory database for unit tests
'1.4.0', */
"\$databaseConfig['memory'] is deprecated. Use \$databaseConfig['path'] = ':memory:' instead.", public function connect($parameters)
Deprecation::SCOPE_GLOBAL {
); if (!empty($parameters['memory'])) {
unset($parameters['memory']); Deprecation::notice(
$parameters['path'] = ':memory:'; '1.4.0',
} "\$databaseConfig['memory'] is deprecated. Use \$databaseConfig['path'] = ':memory:' instead.",
Deprecation::SCOPE_GLOBAL
//We will store these connection parameters for use elsewhere (ie, unit tests) );
$this->parameters = $parameters; unset($parameters['memory']);
$this->schemaManager->flushCache(); $parameters['path'] = ':memory:';
}
// Ensure database name is set
if(empty($parameters['database'])) { //We will store these connection parameters for use elsewhere (ie, unit tests)
$parameters['database'] = 'database' . self::database_extension(); $this->parameters = $parameters;
} $this->schemaManager->flushCache();
$dbName = $parameters['database'];
if(!self::is_valid_database_name($dbName)) { // Ensure database name is set
// If not using the correct file extension for database files then the if (empty($parameters['database'])) {
// results of SQLite3SchemaManager::databaseList will be unpredictable $parameters['database'] = 'database' . self::database_extension();
$extension = self::database_extension(); }
Deprecation::notice('3.2', "SQLite3Database now expects a database file with extension \"$extension\". Behaviour may be unpredictable otherwise."); $dbName = $parameters['database'];
} if (!self::is_valid_database_name($dbName)) {
// If not using the correct file extension for database files then the
// use the very lightspeed SQLite In-Memory feature for testing // results of SQLite3SchemaManager::databaseList will be unpredictable
if($this->getLivesInMemory()) { $extension = self::database_extension();
$file = ':memory:'; Deprecation::notice('3.2', "SQLite3Database now expects a database file with extension \"$extension\". Behaviour may be unpredictable otherwise.");
} else { }
// Ensure path is given
if(empty($parameters['path'])) { // use the very lightspeed SQLite In-Memory feature for testing
$parameters['path'] = ASSETS_PATH . '/.sqlitedb'; if ($this->getLivesInMemory()) {
} $file = ':memory:';
} else {
//assumes that the path to dbname will always be provided: // Ensure path is given
$file = $parameters['path'] . '/' . $dbName; if (empty($parameters['path'])) {
if(!file_exists($parameters['path'])) { $parameters['path'] = ASSETS_PATH . '/.sqlitedb';
SQLiteDatabaseConfigurationHelper::create_db_dir($parameters['path']); }
SQLiteDatabaseConfigurationHelper::secure_db_dir($parameters['path']);
} //assumes that the path to dbname will always be provided:
} $file = $parameters['path'] . '/' . $dbName;
if (!file_exists($parameters['path'])) {
// 'path' and 'database' are merged into the full file path, which SQLiteDatabaseConfigurationHelper::create_db_dir($parameters['path']);
// is the format that connectors such as PDOConnector expect SQLiteDatabaseConfigurationHelper::secure_db_dir($parameters['path']);
$parameters['filepath'] = $file; }
}
// Ensure that driver is available (required by PDO)
if(empty($parameters['driver'])) { // 'path' and 'database' are merged into the full file path, which
$parameters['driver'] = $this->getDatabaseServer(); // is the format that connectors such as PDOConnector expect
} $parameters['filepath'] = $file;
$this->connector->connect($parameters, true); // Ensure that driver is available (required by PDO)
if (empty($parameters['driver'])) {
foreach(self::$default_pragma as $pragma => $value) { $parameters['driver'] = $this->getDatabaseServer();
$this->setPragma($pragma, $value); }
}
$this->connector->connect($parameters, true);
if(empty(self::$default_pragma['locking_mode'])) {
self::$default_pragma['locking_mode'] = $this->getPragma('locking_mode'); foreach (self::$default_pragma as $pragma => $value) {
} $this->setPragma($pragma, $value);
} }
/** if (empty(self::$default_pragma['locking_mode'])) {
* Retrieve parameters used to connect to this SQLLite database self::$default_pragma['locking_mode'] = $this->getPragma('locking_mode');
* }
* @return array }
*/
public function getParameters() { /**
return $this->parameters; * Retrieve parameters used to connect to this SQLLite database
} *
* @return array
public function getLivesInMemory() { */
return isset($this->parameters['path']) && $this->parameters['path'] === ':memory:'; public function getParameters()
} {
return $this->parameters;
public function supportsCollations() { }
return true;
} public function getLivesInMemory()
{
public function supportsTimezoneOverride() { return isset($this->parameters['path']) && $this->parameters['path'] === ':memory:';
return false; }
}
public function supportsCollations()
/** {
* Execute PRAGMA commands. return true;
* }
* @param string pragma name
* @param string value to set public function supportsTimezoneOverride()
*/ {
public function setPragma($pragma, $value) { return false;
$this->query("PRAGMA $pragma = $value"); }
}
/**
/** * Execute PRAGMA commands.
* Gets pragma value. *
* * @param string pragma name
* @param string pragma name * @param string value to set
* @return string the pragma value */
*/ public function setPragma($pragma, $value)
public function getPragma($pragma) { {
return $this->query("PRAGMA $pragma")->value(); $this->query("PRAGMA $pragma = $value");
} }
public function getDatabaseServer() { /**
return "sqlite"; * Gets pragma value.
} *
* @param string pragma name
public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) { * @return string the pragma value
if (!$this->schemaManager->databaseExists($name)) { */
// Check DB creation permisson public function getPragma($pragma)
if (!$create) { {
if ($errorLevel !== false) { return $this->query("PRAGMA $pragma")->value();
user_error("Attempted to connect to non-existing database \"$name\"", $errorLevel); }
}
// Unselect database public function getDatabaseServer()
$this->connector->unloadDatabase(); {
return false; return "sqlite";
} }
$this->schemaManager->createDatabase($name);
} public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR)
{
// Reconnect using the existing parameters if (!$this->schemaManager->databaseExists($name)) {
$parameters = $this->parameters; // Check DB creation permisson
$parameters['database'] = $name; if (!$create) {
$this->connect($parameters); if ($errorLevel !== false) {
return true; user_error("Attempted to connect to non-existing database \"$name\"", $errorLevel);
} }
// Unselect database
function now(){ $this->connector->unloadDatabase();
return "datetime('now', 'localtime')"; return false;
} }
$this->schemaManager->createDatabase($name);
function random(){ }
return 'random()';
} // Reconnect using the existing parameters
$parameters = $this->parameters;
/** $parameters['database'] = $name;
* The core search engine configuration. $this->connect($parameters);
* @todo There is a fulltext search for SQLite making use of virtual tables, the fts3 extension and the return true;
* MATCH operator }
* there are a few issues with fts:
* - shared cached lock doesn't allow to create virtual tables on versions prior to 3.6.17 public function now()
* - there must not be more than one MATCH operator per statement {
* - the fts3 extension needs to be available return "datetime('now', 'localtime')";
* for now we use the MySQL implementation with the MATCH()AGAINST() uglily replaced with LIKE }
*
* @param string $keywords Keywords as a space separated string public function random()
* @return object DataObjectSet of result pages {
*/ return 'random()';
public function searchEngine($classesToSearch, $keywords, $start, $pageLength, $sortBy = "Relevance DESC", }
$extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false
) { /**
$keywords = $this->escapeString(str_replace(array('*','+','-','"','\''), '', $keywords)); * The core search engine configuration.
$htmlEntityKeywords = htmlentities(utf8_decode($keywords)); * @todo There is a fulltext search for SQLite making use of virtual tables, the fts3 extension and the
* MATCH operator
$extraFilters = array('SiteTree' => '', 'File' => ''); * there are a few issues with fts:
* - shared cached lock doesn't allow to create virtual tables on versions prior to 3.6.17
if($extraFilter) { * - there must not be more than one MATCH operator per statement
$extraFilters['SiteTree'] = " AND $extraFilter"; * - the fts3 extension needs to be available
* for now we use the MySQL implementation with the MATCH()AGAINST() uglily replaced with LIKE
if($alternativeFileFilter) $extraFilters['File'] = " AND $alternativeFileFilter"; *
else $extraFilters['File'] = $extraFilters['SiteTree']; * @param string $keywords Keywords as a space separated string
} * @return object DataObjectSet of result pages
*/
// Always ensure that only pages with ShowInSearch = 1 can be searched public function searchEngine($classesToSearch, $keywords, $start, $pageLength, $sortBy = "Relevance DESC",
$extraFilters['SiteTree'] .= ' AND ShowInSearch <> 0'; $extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false
// File.ShowInSearch was added later, keep the database driver backwards compatible ) {
// by checking for its existence first $keywords = $this->escapeString(str_replace(array('*', '+', '-', '"', '\''), '', $keywords));
$fields = $this->getSchemaManager()->fieldList('File'); $htmlEntityKeywords = htmlentities(utf8_decode($keywords));
if(array_key_exists('ShowInSearch', $fields)) {
$extraFilters['File'] .= " AND ShowInSearch <> 0"; $extraFilters = array('SiteTree' => '', 'File' => '');
}
if ($extraFilter) {
$limit = $start . ", " . (int) $pageLength; $extraFilters['SiteTree'] = " AND $extraFilter";
$notMatch = $invertedMatch ? "NOT " : ""; if ($alternativeFileFilter) {
if($keywords) { $extraFilters['File'] = " AND $alternativeFileFilter";
$match['SiteTree'] = " } else {
(Title LIKE '%$keywords%' OR MenuTitle LIKE '%$keywords%' OR Content LIKE '%$keywords%' OR MetaDescription LIKE '%$keywords%' OR $extraFilters['File'] = $extraFilters['SiteTree'];
Title LIKE '%$htmlEntityKeywords%' OR MenuTitle LIKE '%$htmlEntityKeywords%' OR Content LIKE '%$htmlEntityKeywords%' OR MetaDescription LIKE '%$htmlEntityKeywords%') }
"; }
$match['File'] = "(Name LIKE '%$keywords%' OR Title LIKE '%$keywords%') AND ClassName = 'File'";
// Always ensure that only pages with ShowInSearch = 1 can be searched
// We make the relevance search by converting a boolean mode search into a normal one $extraFilters['SiteTree'] .= ' AND ShowInSearch <> 0';
$relevanceKeywords = $keywords; // File.ShowInSearch was added later, keep the database driver backwards compatible
$htmlEntityRelevanceKeywords = $htmlEntityKeywords; // by checking for its existence first
$relevance['SiteTree'] = "(Title LIKE '%$relevanceKeywords%' OR MenuTitle LIKE '%$relevanceKeywords%' OR Content LIKE '%$relevanceKeywords%' OR MetaDescription LIKE '%$relevanceKeywords%') + (Title LIKE '%$htmlEntityRelevanceKeywords%' OR MenuTitle LIKE '%$htmlEntityRelevanceKeywords%' OR Content LIKE '%$htmlEntityRelevanceKeywords%' OR MetaDescription LIKE '%$htmlEntityRelevanceKeywords%')"; $fields = $this->getSchemaManager()->fieldList('File');
$relevance['File'] = "(Name LIKE '%$relevanceKeywords%' OR Title LIKE '%$relevanceKeywords%')"; if (array_key_exists('ShowInSearch', $fields)) {
} else { $extraFilters['File'] .= " AND ShowInSearch <> 0";
$relevance['SiteTree'] = $relevance['File'] = 1; }
$match['SiteTree'] = $match['File'] = "1 = 1";
} $limit = $start . ", " . (int) $pageLength;
// Generate initial queries and base table names $notMatch = $invertedMatch ? "NOT " : "";
$baseClasses = array('SiteTree' => '', 'File' => ''); if ($keywords) {
$queries = array(); $match['SiteTree'] = "
foreach($classesToSearch as $class) { (Title LIKE '%$keywords%' OR MenuTitle LIKE '%$keywords%' OR Content LIKE '%$keywords%' OR MetaDescription LIKE '%$keywords%' OR
$queries[$class] = DataList::create($class)->where($notMatch . $match[$class] . $extraFilters[$class], "")->dataQuery()->query(); Title LIKE '%$htmlEntityKeywords%' OR MenuTitle LIKE '%$htmlEntityKeywords%' OR Content LIKE '%$htmlEntityKeywords%' OR MetaDescription LIKE '%$htmlEntityKeywords%')
$fromArr = $queries[$class]->getFrom(); ";
$baseClasses[$class] = reset($fromArr); $match['File'] = "(Name LIKE '%$keywords%' OR Title LIKE '%$keywords%') AND ClassName = 'File'";
}
// We make the relevance search by converting a boolean mode search into a normal one
// Make column selection lists $relevanceKeywords = $keywords;
$select = array( $htmlEntityRelevanceKeywords = $htmlEntityKeywords;
'SiteTree' => array( $relevance['SiteTree'] = "(Title LIKE '%$relevanceKeywords%' OR MenuTitle LIKE '%$relevanceKeywords%' OR Content LIKE '%$relevanceKeywords%' OR MetaDescription LIKE '%$relevanceKeywords%') + (Title LIKE '%$htmlEntityRelevanceKeywords%' OR MenuTitle LIKE '%$htmlEntityRelevanceKeywords%' OR Content LIKE '%$htmlEntityRelevanceKeywords%' OR MetaDescription LIKE '%$htmlEntityRelevanceKeywords%')";
"\"ClassName\"", $relevance['File'] = "(Name LIKE '%$relevanceKeywords%' OR Title LIKE '%$relevanceKeywords%')";
"\"ID\"", } else {
"\"ParentID\"", $relevance['SiteTree'] = $relevance['File'] = 1;
"\"Title\"", $match['SiteTree'] = $match['File'] = "1 = 1";
"\"URLSegment\"", }
"\"Content\"",
"\"LastEdited\"", // Generate initial queries and base table names
"\"Created\"", $baseClasses = array('SiteTree' => '', 'File' => '');
"NULL AS \"Name\"", $queries = array();
"\"CanViewType\"", foreach ($classesToSearch as $class) {
"$relevance[SiteTree] AS Relevance" $queries[$class] = DataList::create($class)->where($notMatch . $match[$class] . $extraFilters[$class], "")->dataQuery()->query();
), $fromArr = $queries[$class]->getFrom();
'File' => array( $baseClasses[$class] = reset($fromArr);
"\"ClassName\"", }
"\"ID\"",
"NULL AS \"ParentID\"", // Make column selection lists
"\"Title\"", $select = array(
"NULL AS \"URLSegment\"", 'SiteTree' => array(
"NULL AS \"Content\"", "\"ClassName\"",
"\"LastEdited\"", "\"ID\"",
"\"Created\"", "\"ParentID\"",
"\"Name\"", "\"Title\"",
"NULL AS \"CanViewType\"", "\"URLSegment\"",
"$relevance[File] AS Relevance" "\"Content\"",
) "\"LastEdited\"",
); "\"Created\"",
"NULL AS \"Name\"",
// Process queries "\"CanViewType\"",
foreach($classesToSearch as $class) { "$relevance[SiteTree] AS Relevance"
// There's no need to do all that joining ),
$queries[$class]->setFrom($baseClasses[$class]); 'File' => array(
"\"ClassName\"",
$queries[$class]->setSelect(array()); "\"ID\"",
foreach($select[$class] as $clause) { "NULL AS \"ParentID\"",
if(preg_match('/^(.*) +AS +"?([^"]*)"?/i', $clause, $matches)) { "\"Title\"",
$queries[$class]->selectField($matches[1], $matches[2]); "NULL AS \"URLSegment\"",
} else { "NULL AS \"Content\"",
$queries[$class]->selectField(str_replace('"', '', $clause)); "\"LastEdited\"",
} "\"Created\"",
} "\"Name\"",
"NULL AS \"CanViewType\"",
$queries[$class]->setOrderBy(array()); "$relevance[File] AS Relevance"
} )
);
// Combine queries
$querySQLs = array(); // Process queries
$queryParameters = array(); foreach ($classesToSearch as $class) {
$totalCount = 0; // There's no need to do all that joining
foreach($queries as $query) { $queries[$class]->setFrom($baseClasses[$class]);
$querySQLs[] = $query->sql($parameters);
$queryParameters = array_merge($queryParameters, $parameters); $queries[$class]->setSelect(array());
$totalCount += $query->unlimitedRowCount(); foreach ($select[$class] as $clause) {
} if (preg_match('/^(.*) +AS +"?([^"]*)"?/i', $clause, $matches)) {
$queries[$class]->selectField($matches[1], $matches[2]);
$fullQuery = implode(" UNION ", $querySQLs) . " ORDER BY $sortBy LIMIT $limit"; } else {
// Get records $queries[$class]->selectField(str_replace('"', '', $clause));
$records = $this->preparedQuery($fullQuery, $queryParameters); }
}
foreach($records as $record) {
$objects[] = new $record['ClassName']($record); $queries[$class]->setOrderBy(array());
} }
if(isset($objects)) $doSet = new ArrayList($objects); // Combine queries
else $doSet = new ArrayList(); $querySQLs = array();
$list = new PaginatedList($doSet); $queryParameters = array();
$list->setPageStart($start); $totalCount = 0;
$list->setPageLEngth($pageLength); foreach ($queries as $query) {
$list->setTotalItems($totalCount); $querySQLs[] = $query->sql($parameters);
return $list; $queryParameters = array_merge($queryParameters, $parameters);
} $totalCount += $query->unlimitedRowCount();
}
/*
* Does this database support transactions? $fullQuery = implode(" UNION ", $querySQLs) . " ORDER BY $sortBy LIMIT $limit";
*/ // Get records
public function supportsTransactions(){ $records = $this->preparedQuery($fullQuery, $queryParameters);
return version_compare($this->getVersion(), '3.6', '>=');
} foreach ($records as $record) {
$objects[] = new $record['ClassName']($record);
public function supportsExtensions($extensions = array('partitions', 'tablespaces', 'clustering')){ }
if(isset($extensions['partitions'])) if (isset($objects)) {
return true; $doSet = new ArrayList($objects);
elseif(isset($extensions['tablespaces'])) } else {
return true; $doSet = new ArrayList();
elseif(isset($extensions['clustering'])) }
return true; $list = new PaginatedList($doSet);
else $list->setPageStart($start);
return false; $list->setPageLEngth($pageLength);
} $list->setTotalItems($totalCount);
return $list;
public function transactionStart($transaction_mode = false, $session_characteristics = false) { }
$this->query('BEGIN');
} /*
* Does this database support transactions?
public function transactionSavepoint($savepoint) { */
$this->query("SAVEPOINT \"$savepoint\""); public function supportsTransactions()
} {
return version_compare($this->getVersion(), '3.6', '>=');
public function transactionRollback($savepoint = false){ }
if($savepoint) { public function supportsExtensions($extensions = array('partitions', 'tablespaces', 'clustering'))
$this->query("ROLLBACK TO $savepoint;"); {
} else { if (isset($extensions['partitions'])) {
$this->query('ROLLBACK;'); return true;
} } elseif (isset($extensions['tablespaces'])) {
} return true;
} elseif (isset($extensions['clustering'])) {
public function transactionEnd($chain = false){ return true;
$this->query('COMMIT;'); } else {
} return false;
}
public function clearTable($table) { }
$this->query("DELETE FROM \"$table\"");
} public function transactionStart($transaction_mode = false, $session_characteristics = false)
{
public function comparisonClause($field, $value, $exact = false, $negate = false, $caseSensitive = null, $this->query('BEGIN');
$parameterised = false }
) {
if($exact && !$caseSensitive) { public function transactionSavepoint($savepoint)
$comp = ($negate) ? '!=' : '='; {
} else { $this->query("SAVEPOINT \"$savepoint\"");
if($caseSensitive) { }
// GLOB uses asterisks as wildcards.
// Replace them in search string, without replacing escaped percetage signs. public function transactionRollback($savepoint = false)
$comp = 'GLOB'; {
$value = preg_replace('/^%([^\\\\])/', '*$1', $value); if ($savepoint) {
$value = preg_replace('/([^\\\\])%$/', '$1*', $value); $this->query("ROLLBACK TO $savepoint;");
$value = preg_replace('/([^\\\\])%/', '$1*', $value); } else {
} else { $this->query('ROLLBACK;');
$comp = 'LIKE'; }
} }
if($negate) $comp = 'NOT ' . $comp;
} public function transactionEnd($chain = false)
{
if($parameterised) { $this->query('COMMIT;');
return sprintf("%s %s ?", $field, $comp); }
} else {
return sprintf("%s %s '%s'", $field, $comp, $value); public function clearTable($table)
} {
} $this->query("DELETE FROM \"$table\"");
}
function formattedDatetimeClause($date, $format) {
preg_match_all('/%(.)/', $format, $matches); public function comparisonClause($field, $value, $exact = false, $negate = false, $caseSensitive = null,
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); $parameterised = false
) {
$translate = array( if ($exact && !$caseSensitive) {
'/%i/' => '%M', $comp = ($negate) ? '!=' : '=';
'/%s/' => '%S', } else {
'/%U/' => '%s', if ($caseSensitive) {
); // GLOB uses asterisks as wildcards.
$format = preg_replace(array_keys($translate), array_values($translate), $format); // Replace them in search string, without replacing escaped percetage signs.
$comp = 'GLOB';
$modifiers = array(); $value = preg_replace('/^%([^\\\\])/', '*$1', $value);
if($format == '%s' && $date != 'now') $modifiers[] = 'utc'; $value = preg_replace('/([^\\\\])%$/', '$1*', $value);
if($format != '%s' && $date == 'now') $modifiers[] = 'localtime'; $value = preg_replace('/([^\\\\])%/', '$1*', $value);
} else {
if(preg_match('/^now$/i', $date)) { $comp = 'LIKE';
$date = "'now'"; }
} else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) { if ($negate) {
$date = "'$date'"; $comp = 'NOT ' . $comp;
} }
}
$modifier = empty($modifiers) ? '' : ", '" . implode("', '", $modifiers) . "'";
return "strftime('$format', $date$modifier)"; if ($parameterised) {
} return sprintf("%s %s ?", $field, $comp);
} else {
function datetimeIntervalClause($date, $interval) { return sprintf("%s %s '%s'", $field, $comp, $value);
$modifiers = array(); }
if($date == 'now') $modifiers[] = 'localtime'; }
if(preg_match('/^now$/i', $date)) { public function formattedDatetimeClause($date, $format)
$date = "'now'"; {
} else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) { preg_match_all('/%(.)/', $format, $matches);
$date = "'$date'"; 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);
$modifier = empty($modifiers) ? '' : ", '" . implode("', '", $modifiers) . "'"; }
return "datetime($date$modifier, '$interval')"; }
}
$translate = array(
function datetimeDifferenceClause($date1, $date2) { '/%i/' => '%M',
$modifiers1 = array(); '/%s/' => '%S',
$modifiers2 = array(); '/%U/' => '%s',
);
if($date1 == 'now') $modifiers1[] = 'localtime'; $format = preg_replace(array_keys($translate), array_values($translate), $format);
if($date2 == 'now') $modifiers2[] = 'localtime';
$modifiers = array();
if(preg_match('/^now$/i', $date1)) { if ($format == '%s' && $date != 'now') {
$date1 = "'now'"; $modifiers[] = 'utc';
} else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date1)) { }
$date1 = "'$date1'"; if ($format != '%s' && $date == 'now') {
} $modifiers[] = 'localtime';
}
if(preg_match('/^now$/i', $date2)) {
$date2 = "'now'"; if (preg_match('/^now$/i', $date)) {
} else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date2)) { $date = "'now'";
$date2 = "'$date2'"; } elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) {
} $date = "'$date'";
}
$modifier1 = empty($modifiers1) ? '' : ", '" . implode("', '", $modifiers1) . "'";
$modifier2 = empty($modifiers2) ? '' : ", '" . implode("', '", $modifiers2) . "'"; $modifier = empty($modifiers) ? '' : ", '" . implode("', '", $modifiers) . "'";
return "strftime('$format', $date$modifier)";
return "strftime('%s', $date1$modifier1) - strftime('%s', $date2$modifier2)"; }
}
} public function datetimeIntervalClause($date, $interval)
{
$modifiers = array();
if ($date == 'now') {
$modifiers[] = 'localtime';
}
if (preg_match('/^now$/i', $date)) {
$date = "'now'";
} elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) {
$date = "'$date'";
}
$modifier = empty($modifiers) ? '' : ", '" . implode("', '", $modifiers) . "'";
return "datetime($date$modifier, '$interval')";
}
public function datetimeDifferenceClause($date1, $date2)
{
$modifiers1 = array();
$modifiers2 = array();
if ($date1 == 'now') {
$modifiers1[] = 'localtime';
}
if ($date2 == 'now') {
$modifiers2[] = 'localtime';
}
if (preg_match('/^now$/i', $date1)) {
$date1 = "'now'";
} elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date1)) {
$date1 = "'$date1'";
}
if (preg_match('/^now$/i', $date2)) {
$date2 = "'now'";
} elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date2)) {
$date2 = "'$date2'";
}
$modifier1 = empty($modifiers1) ? '' : ", '" . implode("', '", $modifiers1) . "'";
$modifier2 = empty($modifiers2) ? '' : ", '" . implode("', '", $modifiers2) . "'";
return "strftime('%s', $date1$modifier1) - strftime('%s', $date2$modifier2)";
}
}

View File

@ -5,58 +5,70 @@
* *
* @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.
* *
* @var SQLite3Connector * @var SQLite3Connector
*/ */
protected $database; protected $database;
/** /**
* The internal sqlite3 handle that points to the result set. * The internal sqlite3 handle that points to the result set.
* *
* @var SQLite3Result * @var SQLite3Result
*/ */
protected $handle; protected $handle;
/** /**
* Hook the result-set given into a Query class, suitable for use by framework. * Hook the result-set given into a Query class, suitable for use by framework.
* @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->handle = $handle; $this->database = $database;
} $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(); {
$i=0; $this->handle->reset();
while($i < $row && $row = @$this->handle->fetchArray()) $i++; $i=0;
return true; while ($i < $row && $row = @$this->handle->fetchArray()) {
} $i++;
}
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; {
while($this->handle->fetchArray()) $c++; $c=0;
$this->handle->reset(); while ($this->handle->fetchArray()) {
return $c; $c++;
} }
$this->handle->reset();
return $c;
}
public function nextRecord() { public function nextRecord()
if($data = $this->handle->fetchArray(SQLITE3_ASSOC)) { {
return $data; if ($data = $this->handle->fetchArray(SQLITE3_ASSOC)) {
} else { return $data;
return false; } else {
} return false;
} }
}
} }

View File

@ -5,90 +5,94 @@
* *
* @package SQLite3 * @package SQLite3
*/ */
class SQLite3QueryBuilder extends DBQueryBuilder { class SQLite3QueryBuilder extends DBQueryBuilder
{
/**
* @param SQLInsert $query /**
* @param array $parameters * @param SQLInsert $query
* @return string * @param array $parameters
*/ * @return string
protected function buildInsertQuery(SQLInsert $query, array &$parameters) { */
// Multi-row insert requires SQLite specific syntax prior to 3.7.11 protected function buildInsertQuery(SQLInsert $query, array &$parameters)
// For backwards compatibility reasons include the "union all select" syntax {
// Multi-row insert requires SQLite specific syntax prior to 3.7.11
$nl = $this->getSeparator(); // For backwards compatibility reasons include the "union all select" syntax
$into = $query->getInto();
// Column identifiers
$columns = $query->getColumns();
// Build all rows
$rowParts = array();
foreach($query->getRows() as $row) {
// Build all columns in this row
$assignments = $row->getAssignments();
// Join SET components together, considering parameters
$parts = array();
foreach($columns as $column) {
// Check if this column has a value for this row
if(isset($assignments[$column])) {
// Assigment is a single item array, expand with a loop here
foreach($assignments[$column] as $assignmentSQL => $assignmentParameters) {
$parts[] = $assignmentSQL;
$parameters = array_merge($parameters, $assignmentParameters);
break;
}
} else {
// This row is missing a value for a column used by another row
$parts[] = '?';
$parameters[] = null;
}
}
$rowParts[] = implode(', ', $parts);
}
$columnSQL = implode(', ', $columns);
$sql = "INSERT INTO {$into}{$nl}($columnSQL){$nl}SELECT " . implode("{$nl}UNION ALL SELECT ", $rowParts);
return $sql;
}
/** $nl = $this->getSeparator();
* Return the LIMIT clause ready for inserting into a query. $into = $query->getInto();
*
* @param SQLSelect $query The expression object to build from // Column identifiers
* @param array $parameters Out parameter for the resulting query parameters $columns = $query->getColumns();
* @return string The finalised limit SQL fragment
*/ // Build all rows
public function buildLimitFragment(SQLSelect $query, array &$parameters) { $rowParts = array();
$nl = $this->getSeparator(); foreach ($query->getRows() as $row) {
// Build all columns in this row
$assignments = $row->getAssignments();
// Join SET components together, considering parameters
$parts = array();
foreach ($columns as $column) {
// Check if this column has a value for this row
if (isset($assignments[$column])) {
// Assigment is a single item array, expand with a loop here
foreach ($assignments[$column] as $assignmentSQL => $assignmentParameters) {
$parts[] = $assignmentSQL;
$parameters = array_merge($parameters, $assignmentParameters);
break;
}
} else {
// This row is missing a value for a column used by another row
$parts[] = '?';
$parameters[] = null;
}
}
$rowParts[] = implode(', ', $parts);
}
$columnSQL = implode(', ', $columns);
$sql = "INSERT INTO {$into}{$nl}($columnSQL){$nl}SELECT " . implode("{$nl}UNION ALL SELECT ", $rowParts);
return $sql;
}
// Ensure limit is given /**
$limit = $query->getLimit(); * Return the LIMIT clause ready for inserting into a query.
if(empty($limit)) return ''; *
* @param SQLSelect $query The expression object to build from
* @param array $parameters Out parameter for the resulting query parameters
* @return string The finalised limit SQL fragment
*/
public function buildLimitFragment(SQLSelect $query, array &$parameters)
{
$nl = $this->getSeparator();
// For literal values return this as the limit SQL // Ensure limit is given
if( ! is_array($limit)) { $limit = $query->getLimit();
return "{$nl}LIMIT $limit"; if (empty($limit)) {
} return '';
}
// Assert that the array version provides the 'limit' key // For literal values return this as the limit SQL
if( ! array_key_exists('limit', $limit) || ($limit['limit'] !== null && ! is_numeric($limit['limit']))) { if (! is_array($limit)) {
throw new InvalidArgumentException( return "{$nl}LIMIT $limit";
'SQLite3QueryBuilder::buildLimitSQL(): Wrong format for $limit: '. var_export($limit, true) }
);
}
$clause = "{$nl}"; // Assert that the array version provides the 'limit' key
if($limit['limit'] !== null) { if (! array_key_exists('limit', $limit) || ($limit['limit'] !== null && ! is_numeric($limit['limit']))) {
$clause .= "LIMIT {$limit['limit']} "; throw new InvalidArgumentException(
} else { 'SQLite3QueryBuilder::buildLimitSQL(): Wrong format for $limit: '. var_export($limit, true)
$clause .= "LIMIT -1 "; );
} }
if(isset($limit['start']) && is_numeric($limit['start']) && $limit['start'] !== 0) {
$clause .= "OFFSET {$limit['start']}";
}
return $clause;
}
$clause = "{$nl}";
if ($limit['limit'] !== null) {
$clause .= "LIMIT {$limit['limit']} ";
} else {
$clause .= "LIMIT -1 ";
}
if (isset($limit['start']) && is_numeric($limit['start']) && $limit['start'] !== 0) {
$clause .= "OFFSET {$limit['start']}";
}
return $clause;
}
} }

View File

@ -5,611 +5,690 @@
* *
* @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
* *
* @var SQLite3Database * @var SQLite3Database
*/ */
protected $database = null; protected $database = null;
/** /**
* Flag indicating whether or not the database has been checked and repaired * Flag indicating whether or not the database has been checked and repaired
* *
* @var boolean * @var boolean
*/ */
protected static $checked_and_repaired = false; protected static $checked_and_repaired = false;
/** /**
* Should schema be vacuumed during checkeAndRepairTable? * Should schema be vacuumed during checkeAndRepairTable?
* *
* @var boolean * @var boolean
*/ */
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 {
$this->dropDatabase($name); // Ensure that any existing database is cleared before connection
} $this->dropDatabase($name);
}
public function dropDatabase($name) { public function dropDatabase($name)
// No need to delete database files if operating purely within memory {
if($this->database->getLivesInMemory()) return; // No need to delete database files if operating purely within memory
if ($this->database->getLivesInMemory()) {
// If using file based database ensure any existing file is removed return;
$parameters = $this->database->getParameters(); }
$fullpath = $parameters['path'] . '/' . $name;
if(is_writable($fullpath)) unlink($fullpath); // If using file based database ensure any existing file is removed
} $parameters = $this->database->getParameters();
$fullpath = $parameters['path'] . '/' . $name;
function databaseList() { if (is_writable($fullpath)) {
$parameters = $this->database->getParameters(); unlink($fullpath);
}
// If in-memory use the current database name only }
if($this->database->getLivesInMemory()) {
return array($parameters['database']); public function databaseList()
} {
$parameters = $this->database->getParameters();
// If using file based database enumerate files in the database directory
$directory = $parameters['path']; // If in-memory use the current database name only
$files = scandir($directory); if ($this->database->getLivesInMemory()) {
return array($parameters['database']);
// Filter each file in this directory }
$databases = array();
if($files !== false) foreach($files as $file) { // If using file based database enumerate files in the database directory
$directory = $parameters['path'];
// Filter non-files $files = scandir($directory);
if(!is_file("$directory/$file")) continue;
// Filter each file in this directory
// Filter those with correct extension $databases = array();
if(!SQLite3Database::is_valid_database_name($file)) continue; if ($files !== false) {
foreach ($files as $file) {
$databases[] = $file;
} // Filter non-files
return $databases; if (!is_file("$directory/$file")) {
} continue;
}
// Filter those with correct extension
if (!SQLite3Database::is_valid_database_name($file)) {
continue;
}
$databases[] = $file;
}
}
return $databases;
}
public function databaseExists($name) { public function databaseExists($name)
$databases = $this->databaseList(); {
return in_array($name, $databases); $databases = $this->databaseList();
} return in_array($name, $databases);
}
/**
* Empties any cached enum values /**
*/ * Empties any cached enum values
public function flushCache() { */
$this->enum_map = array(); public function flushCache()
} {
$this->enum_map = array();
function schemaUpdate($callback) { }
// Set locking mode
$this->database->setPragma('locking_mode', 'EXCLUSIVE'); public function schemaUpdate($callback)
$this->checkAndRepairTable(); {
$this->flushCache(); // Set locking mode
$this->database->setPragma('locking_mode', 'EXCLUSIVE');
// Initiate schema update $this->checkAndRepairTable();
$error = null; $this->flushCache();
try {
parent::schemaUpdate($callback); // Initiate schema update
} catch(Exception $ex) { $error = null;
$error = $ex; try {
} parent::schemaUpdate($callback);
} catch (Exception $ex) {
// Revert locking mode $error = $ex;
$this->database->setPragma('locking_mode', SQLite3Database::$default_pragma['locking_mode']); }
if($error) throw $error; // Revert locking mode
} $this->database->setPragma('locking_mode', SQLite3Database::$default_pragma['locking_mode']);
if ($error) {
throw $error;
}
}
/** /**
* Empty a specific table * Empty a specific table
* *
* @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) {
$fieldSchemata[] = "\"$k\" $v"; foreach ($fields as $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
$temporary = empty($options['temporary']) ? "" : "TEMPORARY"; $temporary = empty($options['temporary']) ? "" : "TEMPORARY";
$this->query("CREATE $temporary TABLE \"$table\" ( $this->query("CREATE $temporary TABLE \"$table\" (
$fieldSchemas $fieldSchemas
)"); )");
if($indexes) { if ($indexes) {
foreach($indexes as $indexName => $indexDetails) { foreach ($indexes as $indexName => $indexDetails) {
$this->createIndex($table, $indexName, $indexDetails); $this->createIndex($table, $indexName, $indexDetails);
} }
} }
return $table; return $table;
} }
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) {
$this->createField($tableName, $fieldName, $fieldSpec); foreach ($newFields as $fieldName => $fieldSpec) {
} $this->createField($tableName, $fieldName, $fieldSpec);
}
}
if($alteredFields) foreach($alteredFields as $fieldName => $fieldSpec) { if ($alteredFields) {
$this->alterField($tableName, $fieldName, $fieldSpec); foreach ($alteredFields as $fieldName => $fieldSpec) {
} $this->alterField($tableName, $fieldName, $fieldSpec);
}
}
if($newIndexes) foreach($newIndexes as $indexName => $indexSpec) { if ($newIndexes) {
$this->createIndex($tableName, $indexName, $indexSpec); foreach ($newIndexes as $indexName => $indexSpec) {
} $this->createIndex($tableName, $indexName, $indexSpec);
}
}
if($alteredIndexes) foreach($alteredIndexes as $indexName => $indexSpec) { if ($alteredIndexes) {
$this->alterIndex($tableName, $indexName, $indexSpec); foreach ($alteredIndexes as $indexName => $indexSpec) {
} $this->alterIndex($tableName, $indexName, $indexSpec);
} }
}
public function renameTable($oldTableName, $newTableName) { }
$this->query("ALTER TABLE \"$oldTableName\" RENAME TO \"$newTableName\"");
} public function renameTable($oldTableName, $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) {
$this->alterationMessage("Checking database integrity", "repaired"); $this->alterationMessage("Checking database integrity", "repaired");
// 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) {
Debug::show($message['integrity_check']); if ($message['integrity_check'] != 'ok') {
$ok = false; Debug::show($message['integrity_check']);
} $ok = false;
} }
}
// If enabled vacuum (clean and rebuild) the database }
if(self::$vacuum) {
$this->query('VACUUM', E_USER_NOTICE); // If enabled vacuum (clean and rebuild) the database
$message = $this->database->getConnector()->getLastError(); if (self::$vacuum) {
if(preg_match('/authoriz/', $message)) { $this->query('VACUUM', E_USER_NOTICE);
$this->alterationMessage("VACUUM | $message", "error"); $message = $this->database->getConnector()->getLastError();
} else { if (preg_match('/authoriz/', $message)) {
$this->alterationMessage("VACUUMing", "repaired"); $this->alterationMessage("VACUUM | $message", "error");
} } else {
} $this->alterationMessage("VACUUMing", "repaired");
self::$checked_and_repaired = true; }
} }
self::$checked_and_repaired = true;
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");
}
/** /**
* Change the database type of the given field. * Change the database type of the given field.
* @param string $tableName The name of the tbale the field is in. * @param string $tableName The name of the tbale the field is in.
* @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); {
$fieldNameList = '"' . implode('","', array_keys($oldFieldList)) . '"'; $oldFieldList = $this->fieldList($tableName);
$fieldNameList = '"' . implode('","', array_keys($oldFieldList)) . '"';
if(!empty($_REQUEST['avoidConflict']) && Director::isDev()) { if (!empty($_REQUEST['avoidConflict']) && Director::isDev()) {
$fieldSpec = preg_replace('/\snot null\s/i', ' NOT NULL ON CONFLICT REPLACE ', $fieldSpec); $fieldSpec = preg_replace('/\snot null\s/i', ' NOT NULL ON CONFLICT REPLACE ', $fieldSpec);
} }
// 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();
foreach($oldFieldList as $name => $oldSpec) { foreach ($oldFieldList as $name => $oldSpec) {
$newColsSpec[] = "\"$name\" " . ($name == $fieldName ? $fieldSpec : $oldSpec); $newColsSpec[] = "\"$name\" " . ($name == $fieldName ? $fieldSpec : $oldSpec);
} }
$queries = array( $queries = array(
"BEGIN TRANSACTION", "BEGIN TRANSACTION",
"CREATE TABLE \"{$tableName}_alterfield_{$fieldName}\"(" . implode(',', $newColsSpec) . ")", "CREATE TABLE \"{$tableName}_alterfield_{$fieldName}\"(" . implode(',', $newColsSpec) . ")",
"INSERT INTO \"{$tableName}_alterfield_{$fieldName}\" SELECT {$fieldNameList} FROM \"$tableName\"", "INSERT INTO \"{$tableName}_alterfield_{$fieldName}\" SELECT {$fieldNameList} FROM \"$tableName\"",
"DROP TABLE \"$tableName\"", "DROP TABLE \"$tableName\"",
"ALTER TABLE \"{$tableName}_alterfield_{$fieldName}\" RENAME TO \"$tableName\"", "ALTER TABLE \"{$tableName}_alterfield_{$fieldName}\" RENAME TO \"$tableName\"",
"COMMIT" "COMMIT"
); );
// Remember original indexes // Remember original indexes
$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) {
$this->createIndex($tableName, $indexName, $indexSpec); $this->createIndex($tableName, $indexName, $indexSpec);
} }
} }
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 }
$oldCols = array();
$newColsSpec = array(); // Determine column mappings
foreach($oldFieldList as $name => $spec) { $oldCols = array();
$oldCols[] = "\"$name\"" . (($name == $oldName) ? " AS $newName" : ''); $newColsSpec = array();
$newColsSpec[] = "\"" . (($name == $oldName) ? $newName : $name) . "\" $spec"; foreach ($oldFieldList as $name => $spec) {
} $oldCols[] = "\"$name\"" . (($name == $oldName) ? " AS $newName" : '');
$newColsSpec[] = "\"" . (($name == $oldName) ? $newName : $name) . "\" $spec";
}
// SQLite doesn't support direct renames through ALTER TABLE // SQLite doesn't support direct renames through ALTER TABLE
$queries = array( $queries = array(
"BEGIN TRANSACTION", "BEGIN TRANSACTION",
"CREATE TABLE \"{$tableName}_renamefield_{$oldName}\" (" . implode(',', $newColsSpec) . ")", "CREATE TABLE \"{$tableName}_renamefield_{$oldName}\" (" . implode(',', $newColsSpec) . ")",
"INSERT INTO \"{$tableName}_renamefield_{$oldName}\" SELECT " . implode(',', $oldCols) . " FROM \"$tableName\"", "INSERT INTO \"{$tableName}_renamefield_{$oldName}\" SELECT " . implode(',', $oldCols) . " FROM \"$tableName\"",
"DROP TABLE \"$tableName\"", "DROP TABLE \"$tableName\"",
"ALTER TABLE \"{$tableName}_renamefield_{$oldName}\" RENAME TO \"$tableName\"", "ALTER TABLE \"{$tableName}_renamefield_{$oldName}\" RENAME TO \"$tableName\"",
"COMMIT" "COMMIT"
); );
// Remember original indexes // Remember original indexes
$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) {
// Rename columns to new columns // Rename columns to new columns
$indexSpec['value'] = preg_replace("/\"$oldName\"/i", "\"$newName\"", $indexSpec['value']); $indexSpec['value'] = preg_replace("/\"$oldName\"/i", "\"$newName\"", $indexSpec['value']);
$this->createIndex($tableName, $indexName, $indexSpec); $this->createIndex($tableName, $indexName, $indexSpec);
} }
} }
public function fieldList($table) { public function fieldList($table)
$sqlCreate = $this->preparedQuery( {
'SELECT sql FROM sqlite_master WHERE type = ? AND name = ?', $sqlCreate = $this->preparedQuery(
array('table', $table) 'SELECT sql FROM sqlite_master WHERE type = ? AND name = ?',
)->record(); array('table', $table)
)->record();
$fieldList = array();
if($sqlCreate && $sqlCreate['sql']) { $fieldList = array();
preg_match('/^[\s]*CREATE[\s]+TABLE[\s]+[\'"]?[a-zA-Z0-9_\\\]+[\'"]?[\s]*\((.+)\)[\s]*$/ims', if ($sqlCreate && $sqlCreate['sql']) {
$sqlCreate['sql'], $matches preg_match('/^[\s]*CREATE[\s]+TABLE[\s]+[\'"]?[a-zA-Z0-9_\\\]+[\'"]?[\s]*\((.+)\)[\s]*$/ims',
); $sqlCreate['sql'], $matches
$fields = isset($matches[1]) );
? preg_split('/,(?=(?:[^\'"]*$)|(?:[^\'"]*[\'"][^\'"]*[\'"][^\'"]*)*$)/x', $matches[1]) $fields = isset($matches[1])
: array(); ? preg_split('/,(?=(?:[^\'"]*$)|(?:[^\'"]*[\'"][^\'"]*[\'"][^\'"]*)*$)/x', $matches[1])
foreach($fields as $field) { : array();
$details = preg_split('/\s/', trim($field)); foreach ($fields as $field) {
$name = array_shift($details); $details = preg_split('/\s/', trim($field));
$name = str_replace('"', '', trim($name)); $name = array_shift($details);
$fieldList[$name] = implode(' ', $details); $name = str_replace('"', '', trim($name));
} $fieldList[$name] = implode(' ', $details);
} }
return $fieldList; }
} return $fieldList;
}
/** /**
* Create an index on a table. * Create an index on a table.
* *
* @param string $tableName The name of the table. * @param string $tableName The name of the table.
* @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); {
$sqliteName = $this->buildSQLiteIndexName($tableName, $indexName); $parsedSpec = $this->parseIndexSpec($indexName, $indexSpec);
$columns = $parsedSpec['value']; $sqliteName = $this->buildSQLiteIndexName($tableName, $indexName);
$unique = ($parsedSpec['type'] == 'unique') ? 'UNIQUE' : ''; $columns = $parsedSpec['value'];
$this->query("CREATE $unique INDEX IF NOT EXISTS \"$sqliteName\" ON \"$tableName\" ($columns)"); $unique = ($parsedSpec['type'] == 'unique') ? 'UNIQUE' : '';
} $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 {
$sqliteName = $this->buildSQLiteIndexName($tableName, $indexName); // Drop existing index
$this->query("DROP INDEX IF EXISTS \"$sqliteName\""); $sqliteName = $this->buildSQLiteIndexName($tableName, $indexName);
$this->query("DROP INDEX IF EXISTS \"$sqliteName\"");
// Create the index
$this->createIndex($tableName, $indexName, $indexSpec); // Create the index
} $this->createIndex($tableName, $indexName, $indexSpec);
}
/**
* Builds the internal SQLLite index name given the silverstripe table and index name. /**
* * Builds the internal SQLLite index name given the silverstripe table and index name.
* The name is built using the table and index name in order to prevent name collisions *
* between indexes of the same name across multiple tables * The name is built using the table and index name in order to prevent name collisions
* * between indexes of the same name across multiple tables
* @param string $tableName *
* @param string $indexName * @param string $tableName
* @return string The SQLite3 name of the index * @param string $indexName
*/ * @return string The SQLite3 name of the index
protected function buildSQLiteIndexName($tableName, $indexName) { */
return "{$tableName}_{$indexName}"; protected function buildSQLiteIndexName($tableName, $indexName)
} {
return "{$tableName}_{$indexName}";
protected function parseIndexSpec($name, $spec) { }
$spec = parent::parseIndexSpec($name, $spec);
protected function parseIndexSpec($name, $spec)
// Only allow index / unique index types {
if(!in_array($spec['type'], array('index', 'unique'))) { $spec = parent::parseIndexSpec($name, $spec);
$spec['type'] = 'index';
} // Only allow index / unique index types
if (!in_array($spec['type'], array('index', 'unique'))) {
return $spec; $spec['type'] = 'index';
} }
public function indexKey($table, $index, $spec) { return $spec;
return $this->buildSQLiteIndexName($table, $index); }
}
public function indexKey($table, $index, $spec)
{
return $this->buildSQLiteIndexName($table, $index);
}
public function indexList($table) { public function indexList($table)
$indexList = array(); {
$indexList = array();
// Enumerate each index and related fields
foreach($this->query("PRAGMA index_list(\"$table\")") as $index) { // Enumerate each index and related fields
foreach ($this->query("PRAGMA index_list(\"$table\")") as $index) {
// The SQLite internal index name, not the actual Silverstripe name
$indexName = $index["name"]; // The SQLite internal index name, not the actual Silverstripe name
$indexType = $index['unique'] ? 'unique' : 'index'; $indexName = $index["name"];
$indexType = $index['unique'] ? 'unique' : 'index';
// Determine a clean list of column names within this index
$list = array(); // Determine a clean list of column names within this index
foreach($this->query("PRAGMA index_info(\"$indexName\")") as $details) { $list = array();
$list[] = preg_replace('/^"?(.*)"?$/', '$1', $details['name']); foreach ($this->query("PRAGMA index_info(\"$indexName\")") as $details) {
} $list[] = preg_replace('/^"?(.*)"?$/', '$1', $details['name']);
}
// Safely encode this spec
$indexList[$indexName] = $this->parseIndexSpec($indexName, array( // Safely encode this spec
'name' => $indexName, $indexList[$indexName] = $this->parseIndexSpec($indexName, array(
'value' => $this->implodeColumnList($list), 'name' => $indexName,
'type' => $indexType 'value' => $this->implodeColumnList($list),
)); 'type' => $indexType
} ));
}
return $indexList; return $indexList;
} }
public function tableList() { public function tableList()
$tables = array(); {
$result = $this->preparedQuery('SELECT name FROM sqlite_master WHERE type = ?', array('table')); $tables = array();
foreach($result as $record) { $result = $this->preparedQuery('SELECT name FROM sqlite_master WHERE type = ?', array('table'));
$table = reset($record); foreach ($result as $record) {
$tables[strtolower($table)] = $table; $table = reset($record);
} $tables[strtolower($table)] = $table;
return $tables; }
} return $tables;
}
/**
* Return a boolean type-formatted string /**
* * Return a boolean type-formatted string
* @params array $values Contains a tokenised list of info about this data type *
* @return string * @params array $values Contains a tokenised list of info about this data type
*/ * @return string
public function boolean($values) { */
$default = empty($values['default']) ? 0 : (int)$values['default']; public function boolean($values)
return "BOOL NOT NULL DEFAULT $default"; {
} $default = empty($values['default']) ? 0 : (int)$values['default'];
return "BOOL NOT NULL DEFAULT $default";
}
/** /**
* Return a date type-formatted string * Return a date type-formatted string
* *
* @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";
}
/** /**
* Return a decimal type-formatted string * Return a decimal type-formatted string
* *
* @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; {
return "NUMERIC NOT NULL DEFAULT $default"; $default = isset($values['default']) && is_numeric($values['default']) ? $values['default'] : 0;
} return "NUMERIC NOT NULL DEFAULT $default";
}
/** /**
* Cached list of enum values indexed by table.column * Cached list of enum values indexed by table.column
* *
* @var array * @var array
*/ */
protected $enum_map = array(); protected $enum_map = array();
/** /**
* Return a enum type-formatted string * Return a enum type-formatted string
* *
* enums are not supported. as a workaround to store allowed values we creates an additional table * enums are not supported. as a workaround to store allowed values we creates an additional table
* *
* @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']; {
$enumValues = implode(',', $values['enums']); $tablefield = $values['table'] . '.' . $values['name'];
$enumValues = implode(',', $values['enums']);
// Ensure the cache table exists
if(empty($this->enum_map)) { // Ensure the cache table exists
$this->query("CREATE TABLE IF NOT EXISTS \"SQLiteEnums\" (\"TableColumn\" TEXT PRIMARY KEY, \"EnumList\" TEXT)"); if (empty($this->enum_map)) {
} $this->query("CREATE TABLE IF NOT EXISTS \"SQLiteEnums\" (\"TableColumn\" TEXT PRIMARY KEY, \"EnumList\" TEXT)");
}
// Ensure the table row exists
if(empty($this->enum_map[$tablefield]) || $this->enum_map[$tablefield] != $enumValues) { // Ensure the table row exists
$this->preparedQuery( if (empty($this->enum_map[$tablefield]) || $this->enum_map[$tablefield] != $enumValues) {
"REPLACE INTO SQLiteEnums (TableColumn, EnumList) VALUES (?, ?)", $this->preparedQuery(
array($tablefield, $enumValues) "REPLACE INTO SQLiteEnums (TableColumn, EnumList) VALUES (?, ?)",
); array($tablefield, $enumValues)
$this->enum_map[$tablefield] = $enumValues; );
} $this->enum_map[$tablefield] = $enumValues;
}
// Set default
if(!empty($values['default'])) { // Set default
$default = str_replace(array('"',"'","\\","\0"), "", $values['default']); if (!empty($values['default'])) {
return "TEXT DEFAULT '$default'"; $default = str_replace(array('"', "'", "\\", "\0"), "", $values['default']);
} else { return "TEXT DEFAULT '$default'";
return 'TEXT'; } else {
} return 'TEXT';
} }
}
/**
* Return a set type-formatted string /**
* This type doesn't exist in SQLite either * Return a set type-formatted string
* * This type doesn't exist in SQLite either
* @see SQLite3SchemaManager::enum() *
* * @see SQLite3SchemaManager::enum()
* @params array $values Contains a tokenised list of info about this data type *
* @return string * @params array $values Contains a tokenised list of info about this data type
*/ * @return string
public function set($values) { */
return $this->enum($values); public function set($values)
} {
return $this->enum($values);
}
/** /**
* Return a float type-formatted string * Return a float type-formatted string
* *
* @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";
}
/** /**
* Return a Double type-formatted string * Return a Double type-formatted string
* *
* @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";
}
/** /**
* Return a int type-formatted string * Return a int type-formatted string
* *
* @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'];
}
/** /**
* Return a bigint type-formatted string * Return a bigint type-formatted string
* *
* @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);
}
/** /**
* Return a datetime type-formatted string * Return a datetime type-formatted string
* For SQLite3, we simply return the word 'TEXT', no other parameters are necessary * For SQLite3, we simply return the word 'TEXT', no other parameters are necessary
* *
* @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";
}
/** /**
* Return a text type-formatted string * Return a text type-formatted string
* *
* @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';
}
/** /**
* Return a time type-formatted string * Return a time type-formatted string
* *
* @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";
}
/** /**
* Return a varchar type-formatted string * Return a varchar type-formatted string
* *
* @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";
}
/* /*
* 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( {
'SELECT name FROM sqlite_master WHERE type = ? AND name = ?', return (bool)$this->preparedQuery(
array('table', $tableName) 'SELECT name FROM sqlite_master WHERE type = ? AND name = ?',
)->first(); array('table', $tableName)
} )->first();
}
/** /**
* Return enum values for the given field * Return enum values for the given field
* *
* @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
if(!empty($this->enum_map[$tablefield])) { // Check already cached values for this field
return explode(',', $this->enum_map[$tablefield]); if (!empty($this->enum_map[$tablefield])) {
} return explode(',', $this->enum_map[$tablefield]);
}
// Retrieve and cache these details from the database
$classnameinfo = $this->preparedQuery( // Retrieve and cache these details from the database
"SELECT EnumList FROM SQLiteEnums WHERE TableColumn = ?", $classnameinfo = $this->preparedQuery(
array($tablefield) "SELECT EnumList FROM SQLiteEnums WHERE TableColumn = ?",
)->first(); array($tablefield)
if($classnameinfo) { )->first();
$valueList = $classnameinfo['EnumList']; if ($classnameinfo) {
$this->enum_map[$tablefield] = $valueList; $valueList = $classnameinfo['EnumList'];
return explode(',', $valueList); $this->enum_map[$tablefield] = $valueList;
} return explode(',', $valueList);
}
// Fallback to empty list
return array(); // Fallback to empty list
} return array();
}
function dbDataType($type){
$values = array( public function dbDataType($type)
'unsigned integer' => 'INT' {
); $values = array(
'unsigned integer' => 'INT'
if(isset($values[$type])) return $values[$type]; );
else return '';
} if (isset($values[$type])) {
return $values[$type];
} else {
return '';
}
}
} }

View File

@ -8,200 +8,219 @@
* *
* @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
* @param array $databaseConfig *
* @param string $error Error message passed by value * @param array $databaseConfig
* @return mixed|null Either the connection object, or null if error * @param string $error Error message passed by value
*/ * @return mixed|null Either the connection object, or null if error
protected function createConnection($databaseConfig, &$error) { */
$error = null; protected function createConnection($databaseConfig, &$error)
try { {
if(!file_exists($databaseConfig['path'])) { $error = null;
self::create_db_dir($databaseConfig['path']); try {
self::secure_db_dir($databaseConfig['path']); if (!file_exists($databaseConfig['path'])) {
} self::create_db_dir($databaseConfig['path']);
$file = $databaseConfig['path'] . '/' . $databaseConfig['database']; self::secure_db_dir($databaseConfig['path']);
$conn = null; }
$file = $databaseConfig['path'] . '/' . $databaseConfig['database'];
switch($databaseConfig['type']) { $conn = null;
case 'SQLite3Database':
if(empty($databaseConfig['key'])) { switch ($databaseConfig['type']) {
$conn = @new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE); case 'SQLite3Database':
} else { if (empty($databaseConfig['key'])) {
$conn = @new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $databaseConfig['key']); $conn = @new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE);
} } else {
break; $conn = @new SQLite3($file, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $databaseConfig['key']);
case 'SQLite3PDODatabase': }
// May throw a PDOException if fails break;
$conn = @new PDO("sqlite:$file"); case 'SQLite3PDODatabase':
break; // May throw a PDOException if fails
default: $conn = @new PDO("sqlite:$file");
$error = 'Invalid connection type'; break;
return null; default:
} $error = 'Invalid connection type';
return null;
if($conn) { }
return $conn;
} else { if ($conn) {
$error = 'Unknown connection error'; return $conn;
return null; } else {
} $error = 'Unknown connection error';
} catch(Exception $ex) { return null;
$error = $ex->getMessage(); }
return null; } catch (Exception $ex) {
} $error = $ex->getMessage();
} return null;
}
public function requireDatabaseFunctions($databaseConfig) { }
$data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']);
return !empty($data['supported']); public function requireDatabaseFunctions($databaseConfig)
} {
$data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']);
return !empty($data['supported']);
}
public function requireDatabaseServer($databaseConfig) { public function requireDatabaseServer($databaseConfig)
$path = $databaseConfig['path']; {
$error = ''; $path = $databaseConfig['path'];
$success = false; $error = '';
$success = false;
if(!$path) { if (!$path) {
$error = 'No database path provided'; $error = 'No database path provided';
} elseif(is_writable($path) || (!file_exists($path) && is_writable(dirname($path)))) { } elseif (is_writable($path) || (!file_exists($path) && is_writable(dirname($path)))) {
// check if folder is writeable // check if folder is writeable
$success = true; $success = true;
} else { } else {
$error = "Permission denied"; $error = "Permission denied";
} }
return array( return array(
'success' => $success, 'success' => $success,
'error' => $error, 'error' => $error,
'path' => $path 'path' => $path
); );
} }
/** /**
* Ensure a database connection is possible using credentials provided. * Ensure a database connection is possible using credentials provided.
* *
* @todo Validate path * @todo Validate path
* *
* @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 {
if(empty($databaseConfig['path'])) return array( // Do additional validation around file paths
'success' => false, if (empty($databaseConfig['path'])) {
'error' => "Missing directory path" return array(
); 'success' => false,
if(empty($databaseConfig['database'])) return array( 'error' => "Missing directory path"
'success' => false, );
'error' => "Missing database filename" }
); if (empty($databaseConfig['database'])) {
return array(
// Create and secure db directory 'success' => false,
$path = $databaseConfig['path']; 'error' => "Missing database filename"
$dirCreated = self::create_db_dir($path); );
if(!$dirCreated) return array( }
'success' => false,
'error' => sprintf('Cannot create path: "%s"', $path) // Create and secure db directory
); $path = $databaseConfig['path'];
$dirSecured = self::secure_db_dir($path); $dirCreated = self::create_db_dir($path);
if(!$dirSecured) return array( if (!$dirCreated) {
'success' => false, return array(
'error' => sprintf('Cannot secure path through .htaccess: "%s"', $path) 'success' => false,
); 'error' => sprintf('Cannot create path: "%s"', $path)
);
}
$dirSecured = self::secure_db_dir($path);
if (!$dirSecured) {
return array(
'success' => false,
'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);
return array( return array(
'success' => $success, 'success' => $success,
'connection' => $conn, 'connection' => $conn,
'error' => $error 'error' => $error
); );
} }
public function getDatabaseVersion($databaseConfig) { public function getDatabaseVersion($databaseConfig)
$version = 0; {
$version = 0;
switch($databaseConfig['type']) {
case 'SQLite3Database': switch ($databaseConfig['type']) {
$info = SQLite3::version(); case 'SQLite3Database':
$version = trim($info['versionString']); $info = SQLite3::version();
break; $version = trim($info['versionString']);
case 'SQLite3PDODatabase': break;
// Fallback to using sqlite_version() query case 'SQLite3PDODatabase':
$conn = $this->createConnection($databaseConfig, $error); // Fallback to using sqlite_version() query
if($conn) { $conn = $this->createConnection($databaseConfig, $error);
$version = $conn->getAttribute(PDO::ATTR_SERVER_VERSION); if ($conn) {
} $version = $conn->getAttribute(PDO::ATTR_SERVER_VERSION);
break; }
} break;
}
return $version; return $version;
} }
public function requireDatabaseVersion($databaseConfig) { public function requireDatabaseVersion($databaseConfig)
$success = false; {
$error = ''; $success = false;
$version = $this->getDatabaseVersion($databaseConfig); $error = '';
$version = $this->getDatabaseVersion($databaseConfig);
if($version) { if ($version) {
$success = version_compare($version, '3.3', '>='); $success = version_compare($version, '3.3', '>=');
if(!$success) { if (!$success) {
$error = "Your SQLite3 library version is $version. It's recommended you use at least 3.3."; $error = "Your SQLite3 library version is $version. It's recommended you use at least 3.3.";
} }
} }
return array( return array(
'success' => $success, 'success' => $success,
'error' => $error 'error' => $error
); );
} }
public function requireDatabaseOrCreatePermissions($databaseConfig) { public function requireDatabaseOrCreatePermissions($databaseConfig)
$conn = $this->createConnection($databaseConfig, $error); {
$success = $alreadyExists = !empty($conn); $conn = $this->createConnection($databaseConfig, $error);
return array( $success = $alreadyExists = !empty($conn);
'success' => $success, return array(
'alreadyExists' => $alreadyExists, 'success' => $success,
); 'alreadyExists' => $alreadyExists,
} );
}
/**
* Creates the provided directory and prepares it for /**
* storing SQLlite. Use {@link secure_db_dir()} to * Creates the provided directory and prepares it for
* secure it against unauthorized access. * storing SQLlite. Use {@link secure_db_dir()} to
* * secure it against unauthorized access.
* @param String $path Absolute path, usually with a hidden folder. *
* @return boolean * @param String $path Absolute path, usually with a hidden folder.
*/ * @return boolean
public static function create_db_dir($path) { */
return file_exists($path) || mkdir($path); public static function create_db_dir($path)
} {
return file_exists($path) || mkdir($path);
/** }
* Secure the provided directory via web-access
* by placing a .htaccess file in it. /**
* This is just required if the database directory * Secure the provided directory via web-access
* is placed within a publically accessible webroot (the * by placing a .htaccess file in it.
* default path is in a hidden folder within assets/). * This is just required if the database directory
* * is placed within a publically accessible webroot (the
* @param String $path Absolute path, containing a SQLite datatbase * default path is in a hidden folder within assets/).
* @return boolean *
*/ * @param String $path Absolute path, containing a SQLite datatbase
public static function secure_db_dir($path) { * @return boolean
return (is_writeable($path)) ? file_put_contents($path . '/.htaccess', 'deny from all') : false; */
} public static function secure_db_dir($path)
{
public function requireDatabaseAlterPermissions($databaseConfig) { return (is_writeable($path)) ? file_put_contents($path . '/.htaccess', 'deny from all') : false;
// no concept of table-specific permissions; If you can connect you can alter schema }
return array(
'success' => true, public function requireDatabaseAlterPermissions($databaseConfig)
'applies' => false {
); // no concept of table-specific permissions; If you can connect you can alter schema
} return array(
'success' => true,
'applies' => false
);
}
} }