mirror of
https://github.com/silverstripe/silverstripe-sqlite3
synced 2024-10-22 17:05:37 +02:00
API Apply SilverStripe\SQLite namespace to module
This commit is contained in:
Damian Mooyman
parent
0bd28649f5
commit
e36e74ab2f
7
.upgrade.yml
Normal file
7
.upgrade.yml
Normal file
@ -0,0 +1,7 @@
|
||||
mappings:
|
||||
SQLite3Connector: SilverStripe\SQLite\SQLite3Connector
|
||||
SQLite3Database: SilverStripe\SQLite\SQLite3Database
|
||||
SQLite3Query: SilverStripe\SQLite\SQLite3Query
|
||||
SQLite3QueryBuilder: SilverStripe\SQLite\SQLite3QueryBuilder
|
||||
SQLite3SchemaManager: SilverStripe\SQLite\SQLite3SchemaManager
|
||||
SQLiteDatabaseConfigurationHelper: SilverStripe\SQLite\SQLiteDatabaseConfigurationHelper
|
||||
@ -3,27 +3,34 @@ name: sqlite3connectors
|
||||
---
|
||||
Injector:
|
||||
SQLite3PDODatabase:
|
||||
class: 'SQLite3Database'
|
||||
class: 'SilverStripe\SQLite\SQLite3Database'
|
||||
properties:
|
||||
connector: %$PDOConnector
|
||||
schemaManager: %$SQLite3SchemaManager
|
||||
queryBuilder: %$SQLite3QueryBuilder
|
||||
SQLite3Database:
|
||||
class: 'SQLite3Database'
|
||||
class: 'SilverStripe\SQLite\SQLite3Database'
|
||||
properties:
|
||||
connector: %$SQLite3Connector
|
||||
schemaManager: %$SQLite3SchemaManager
|
||||
queryBuilder: %$SQLite3QueryBuilder
|
||||
# Legacy connector names
|
||||
SQLiteDatabase:
|
||||
class: 'SQLite3Database'
|
||||
class: 'SilverStripe\SQLite\SQLite3Database'
|
||||
properties:
|
||||
connector: %$SQLite3Connector
|
||||
schemaManager: %$SQLite3SchemaManager
|
||||
queryBuilder: %$SQLite3QueryBuilder
|
||||
SQLitePDODatabase:
|
||||
class: 'SQLite3Database'
|
||||
class: 'SilverStripe\SQLite\SQLite3Database'
|
||||
properties:
|
||||
connector: %$SQLite3Connector
|
||||
schemaManager: %$SQLite3SchemaManager
|
||||
queryBuilder: %$SQLite3QueryBuilder
|
||||
SQLite3Connector:
|
||||
class: 'SilverStripe\SQLite\SQLite3Connector'
|
||||
type: prototype
|
||||
SQLite3SchemaManager:
|
||||
class: 'SilverStripe\SQLite\SQLite3SchemaManager'
|
||||
SQLite3QueryBuilder:
|
||||
class: 'SilverStripe\SQLite\SQLite3QueryBuilder'
|
||||
|
||||
@ -1,8 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace SilverStripe\SQLite;
|
||||
|
||||
use SilverStripe\ORM\Connect\DBConnector;
|
||||
use SQLite3;
|
||||
|
||||
/**
|
||||
* SQLite connector class
|
||||
*
|
||||
*
|
||||
* @package SQLite3
|
||||
*/
|
||||
class SQLite3Connector extends DBConnector
|
||||
@ -10,14 +15,14 @@ class SQLite3Connector extends DBConnector
|
||||
|
||||
/**
|
||||
* The name of the database.
|
||||
*
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $databaseName;
|
||||
|
||||
/**
|
||||
* Connection to the DBMS.
|
||||
*
|
||||
*
|
||||
* @var SQLite3
|
||||
*/
|
||||
protected $dbConn;
|
||||
@ -66,7 +71,7 @@ class SQLite3Connector extends DBConnector
|
||||
|
||||
/**
|
||||
* Prepares the list of parameters in preparation for passing to mysqli_stmt_bind_param
|
||||
*
|
||||
*
|
||||
* @param array $parameters List of parameters
|
||||
* @return array List of parameters types and values
|
||||
*/
|
||||
@ -133,14 +138,14 @@ class SQLite3Connector extends DBConnector
|
||||
$type = $parsedParameters[$i]['type'];
|
||||
$statement->bindValue($i+1, $value, $type);
|
||||
}
|
||||
|
||||
|
||||
// Return successful result
|
||||
$handle = $statement->execute();
|
||||
if ($handle) {
|
||||
return new SQLite3Query($this, $handle);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Handle error
|
||||
$values = $this->parameterValues($parameters);
|
||||
$this->databaseError($this->getLastError(), $errorLevel, $sql, $values);
|
||||
@ -154,7 +159,7 @@ class SQLite3Connector extends DBConnector
|
||||
if ($handle) {
|
||||
return new SQLite3Query($this, $handle);
|
||||
}
|
||||
|
||||
|
||||
// Handle error
|
||||
$this->databaseError($this->getLastError(), $errorLevel, $sql);
|
||||
return null;
|
||||
|
||||
@ -1,8 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace SilverStripe\SQLite;
|
||||
|
||||
use SilverStripe\ORM\DataList;
|
||||
use SilverStripe\ORM\ArrayList;
|
||||
use SilverStripe\ORM\Connect\SS_Database;
|
||||
use Config;
|
||||
use Deprecation;
|
||||
use PaginatedList;
|
||||
use SilverStripe\ORM\Queries\SQLSelect;
|
||||
|
||||
|
||||
/**
|
||||
* SQLite database controller class
|
||||
*
|
||||
*
|
||||
* @package SQLite3
|
||||
*/
|
||||
class SQLite3Database extends SS_Database
|
||||
@ -10,7 +21,7 @@ class SQLite3Database extends SS_Database
|
||||
|
||||
/**
|
||||
* Database schema manager object
|
||||
*
|
||||
*
|
||||
* @var SQLite3SchemaManager
|
||||
*/
|
||||
protected $schemaManager = null;
|
||||
@ -18,21 +29,21 @@ class SQLite3Database extends SS_Database
|
||||
/*
|
||||
* 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
|
||||
*/
|
||||
protected $parameters;
|
||||
|
||||
/*
|
||||
* if we're on a In-Memory db
|
||||
*
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
protected $livesInMemory = false;
|
||||
|
||||
/**
|
||||
* List of default pragma values
|
||||
*
|
||||
*
|
||||
* @todo Migrate to SS config
|
||||
*
|
||||
* @var array
|
||||
@ -46,7 +57,7 @@ class SQLite3Database extends SS_Database
|
||||
/**
|
||||
* Extension used to distinguish between sqllite database files and other files.
|
||||
* Required to handle multiple databases.
|
||||
*
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function database_extension()
|
||||
@ -56,7 +67,7 @@ class SQLite3Database extends SS_Database
|
||||
|
||||
/**
|
||||
* Check if a database name has a valid extension
|
||||
*
|
||||
*
|
||||
* @param string $name
|
||||
* @return boolean
|
||||
*/
|
||||
@ -89,7 +100,7 @@ class SQLite3Database extends SS_Database
|
||||
unset($parameters['memory']);
|
||||
$parameters['path'] = ':memory:';
|
||||
}
|
||||
|
||||
|
||||
//We will store these connection parameters for use elsewhere (ie, unit tests)
|
||||
$this->parameters = $parameters;
|
||||
$this->schemaManager->flushCache();
|
||||
@ -122,7 +133,7 @@ class SQLite3Database extends SS_Database
|
||||
SQLiteDatabaseConfigurationHelper::secure_db_dir($parameters['path']);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// 'path' and 'database' are merged into the full file path, which
|
||||
// is the format that connectors such as PDOConnector expect
|
||||
$parameters['filepath'] = $file;
|
||||
@ -145,7 +156,7 @@ class SQLite3Database extends SS_Database
|
||||
|
||||
/**
|
||||
* Retrieve parameters used to connect to this SQLLite database
|
||||
*
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getParameters()
|
||||
@ -170,9 +181,9 @@ class SQLite3Database extends SS_Database
|
||||
|
||||
/**
|
||||
* Execute PRAGMA commands.
|
||||
*
|
||||
* @param string pragma name
|
||||
* @param string value to set
|
||||
*
|
||||
* @param string $pragma name
|
||||
* @param string $value to set
|
||||
*/
|
||||
public function setPragma($pragma, $value)
|
||||
{
|
||||
@ -181,8 +192,8 @@ class SQLite3Database extends SS_Database
|
||||
|
||||
/**
|
||||
* Gets pragma value.
|
||||
*
|
||||
* @param string pragma name
|
||||
*
|
||||
* @param string $pragma name
|
||||
* @return string the pragma value
|
||||
*/
|
||||
public function getPragma($pragma)
|
||||
@ -236,9 +247,17 @@ class SQLite3Database extends SS_Database
|
||||
* - there must not be more than one MATCH operator per statement
|
||||
* - the fts3 extension needs to be available
|
||||
* for now we use the MySQL implementation with the MATCH()AGAINST() uglily replaced with LIKE
|
||||
*
|
||||
*
|
||||
* @param array $classesToSearch
|
||||
* @param string $keywords Keywords as a space separated string
|
||||
* @return object DataObjectSet of result pages
|
||||
* @param int $start
|
||||
* @param int $pageLength
|
||||
* @param string $sortBy
|
||||
* @param string $extraFilter
|
||||
* @param bool $booleanSearch
|
||||
* @param string $alternativeFileFilter
|
||||
* @param bool $invertedMatch
|
||||
* @return PaginatedList DataObjectSet of result pages
|
||||
*/
|
||||
public function searchEngine($classesToSearch, $keywords, $start, $pageLength, $sortBy = "Relevance DESC",
|
||||
$extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false
|
||||
@ -260,7 +279,7 @@ class SQLite3Database extends SS_Database
|
||||
|
||||
// Always ensure that only pages with ShowInSearch = 1 can be searched
|
||||
$extraFilters['SiteTree'] .= ' AND ShowInSearch <> 0';
|
||||
// File.ShowInSearch was added later, keep the database driver backwards compatible
|
||||
// File.ShowInSearch was added later, keep the database driver backwards compatible
|
||||
// by checking for its existence first
|
||||
$fields = $this->getSchemaManager()->fieldList('File');
|
||||
if (array_key_exists('ShowInSearch', $fields)) {
|
||||
@ -291,7 +310,10 @@ class SQLite3Database extends SS_Database
|
||||
$baseClasses = array('SiteTree' => '', 'File' => '');
|
||||
$queries = array();
|
||||
foreach ($classesToSearch as $class) {
|
||||
$queries[$class] = DataList::create($class)->where($notMatch . $match[$class] . $extraFilters[$class], "")->dataQuery()->query();
|
||||
$queries[$class] = DataList::create($class)
|
||||
->where($notMatch . $match[$class] . $extraFilters[$class])
|
||||
->dataQuery()
|
||||
->query();
|
||||
$fromArr = $queries[$class]->getFrom();
|
||||
$baseClasses[$class] = reset($fromArr);
|
||||
}
|
||||
@ -348,6 +370,7 @@ class SQLite3Database extends SS_Database
|
||||
$queryParameters = array();
|
||||
$totalCount = 0;
|
||||
foreach ($queries as $query) {
|
||||
/** @var SQLSelect $query */
|
||||
$querySQLs[] = $query->sql($parameters);
|
||||
$queryParameters = array_merge($queryParameters, $parameters);
|
||||
$totalCount += $query->unlimitedRowCount();
|
||||
@ -368,7 +391,7 @@ class SQLite3Database extends SS_Database
|
||||
}
|
||||
$list = new PaginatedList($doSet);
|
||||
$list->setPageStart($start);
|
||||
$list->setPageLEngth($pageLength);
|
||||
$list->setPageLength($pageLength);
|
||||
$list->setTotalItems($totalCount);
|
||||
return $list;
|
||||
}
|
||||
|
||||
@ -1,8 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace SilverStripe\SQLite;
|
||||
|
||||
use SilverStripe\ORM\Connect\SS_Query;
|
||||
use SQLite3Result;
|
||||
|
||||
/**
|
||||
* A result-set from a SQLite3 database.
|
||||
*
|
||||
*
|
||||
* @package SQLite3
|
||||
*/
|
||||
class SQLite3Query extends SS_Query
|
||||
@ -10,14 +15,14 @@ class SQLite3Query extends SS_Query
|
||||
|
||||
/**
|
||||
* The SQLite3Connector object that created this result set.
|
||||
*
|
||||
*
|
||||
* @var SQLite3Connector
|
||||
*/
|
||||
protected $database;
|
||||
|
||||
/**
|
||||
* The internal sqlite3 handle that points to the result set.
|
||||
*
|
||||
*
|
||||
* @var SQLite3Result
|
||||
*/
|
||||
protected $handle;
|
||||
|
||||
@ -1,13 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace SilverStripe\SQLite;
|
||||
|
||||
use SilverStripe\ORM\Queries\SQLAssignmentRow;
|
||||
use SilverStripe\ORM\Queries\SQLInsert;
|
||||
use SilverStripe\ORM\Queries\SQLSelect;
|
||||
use SilverStripe\ORM\Connect\DBQueryBuilder;
|
||||
use InvalidArgumentException;
|
||||
|
||||
/**
|
||||
* Builds a SQL query string from a SQLExpression object
|
||||
*
|
||||
*
|
||||
* @package SQLite3
|
||||
*/
|
||||
class SQLite3QueryBuilder extends DBQueryBuilder
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* @param SQLInsert $query
|
||||
* @param array $parameters
|
||||
@ -20,14 +28,15 @@ class SQLite3QueryBuilder extends DBQueryBuilder
|
||||
|
||||
$nl = $this->getSeparator();
|
||||
$into = $query->getInto();
|
||||
|
||||
|
||||
// Column identifiers
|
||||
$columns = $query->getColumns();
|
||||
|
||||
|
||||
// Build all rows
|
||||
$rowParts = array();
|
||||
foreach ($query->getRows() as $row) {
|
||||
// Build all columns in this row
|
||||
/** @var SQLAssignmentRow $row */
|
||||
$assignments = $row->getAssignments();
|
||||
// Join SET components together, considering parameters
|
||||
$parts = array();
|
||||
@ -50,7 +59,7 @@ class SQLite3QueryBuilder extends DBQueryBuilder
|
||||
}
|
||||
$columnSQL = implode(', ', $columns);
|
||||
$sql = "INSERT INTO {$into}{$nl}($columnSQL){$nl}SELECT " . implode("{$nl}UNION ALL SELECT ", $rowParts);
|
||||
|
||||
|
||||
return $sql;
|
||||
}
|
||||
|
||||
@ -89,7 +98,7 @@ class SQLite3QueryBuilder extends DBQueryBuilder
|
||||
} else {
|
||||
$clause .= "LIMIT -1 ";
|
||||
}
|
||||
|
||||
|
||||
if (isset($limit['start']) && is_numeric($limit['start']) && $limit['start'] !== 0) {
|
||||
$clause .= "OFFSET {$limit['start']}";
|
||||
}
|
||||
|
||||
@ -1,8 +1,16 @@
|
||||
<?php
|
||||
|
||||
namespace SilverStripe\SQLite;
|
||||
|
||||
use SilverStripe\ORM\Connect\DBSchemaManager;
|
||||
use Exception;
|
||||
use SapphireTest;
|
||||
use Debug;
|
||||
use Director;
|
||||
|
||||
/**
|
||||
* SQLite schema manager class
|
||||
*
|
||||
*
|
||||
* @package SQLite3
|
||||
*/
|
||||
class SQLite3SchemaManager extends DBSchemaManager
|
||||
@ -10,7 +18,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Instance of the database controller this schema belongs to
|
||||
*
|
||||
*
|
||||
* @var SQLite3Database
|
||||
*/
|
||||
protected $database = null;
|
||||
@ -28,7 +36,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
* @var boolean
|
||||
*/
|
||||
public static $vacuum = true;
|
||||
|
||||
|
||||
public function createDatabase($name)
|
||||
{
|
||||
// Ensure that any existing database is cleared before connection
|
||||
@ -41,7 +49,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
if ($this->database->getLivesInMemory()) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
// If using file based database ensure any existing file is removed
|
||||
$parameters = $this->database->getParameters();
|
||||
$fullpath = $parameters['path'] . '/' . $name;
|
||||
@ -49,35 +57,35 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
unlink($fullpath);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public function databaseList()
|
||||
{
|
||||
$parameters = $this->database->getParameters();
|
||||
|
||||
|
||||
// If in-memory use the current database name only
|
||||
if ($this->database->getLivesInMemory()) {
|
||||
return array($parameters['database']);
|
||||
}
|
||||
|
||||
|
||||
// If using file based database enumerate files in the database directory
|
||||
$directory = $parameters['path'];
|
||||
$files = scandir($directory);
|
||||
|
||||
|
||||
// Filter each file in this directory
|
||||
$databases = array();
|
||||
if ($files !== false) {
|
||||
foreach ($files as $file) {
|
||||
|
||||
|
||||
// Filter non-files
|
||||
if (!is_file("$directory/$file")) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
||||
// Filter those with correct extension
|
||||
if (!SQLite3Database::is_valid_database_name($file)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
||||
$databases[] = $file;
|
||||
}
|
||||
}
|
||||
@ -89,7 +97,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
$databases = $this->databaseList();
|
||||
return in_array($name, $databases);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Empties any cached enum values
|
||||
*/
|
||||
@ -97,14 +105,14 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
{
|
||||
$this->enum_map = array();
|
||||
}
|
||||
|
||||
|
||||
public function schemaUpdate($callback)
|
||||
{
|
||||
// Set locking mode
|
||||
$this->database->setPragma('locking_mode', 'EXCLUSIVE');
|
||||
$this->checkAndRepairTable();
|
||||
$this->flushCache();
|
||||
|
||||
|
||||
// Initiate schema update
|
||||
$error = null;
|
||||
try {
|
||||
@ -112,10 +120,10 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
} catch (Exception $ex) {
|
||||
$error = $ex;
|
||||
}
|
||||
|
||||
|
||||
// Revert locking mode
|
||||
$this->database->setPragma('locking_mode', SQLite3Database::$default_pragma['locking_mode']);
|
||||
|
||||
|
||||
if ($error) {
|
||||
throw $error;
|
||||
}
|
||||
@ -123,13 +131,13 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Empty a specific table
|
||||
*
|
||||
*
|
||||
* @param string $table
|
||||
*/
|
||||
public function clearTable($table)
|
||||
{
|
||||
if ($table != 'SQLiteEnums') {
|
||||
$this->dbConn->query("DELETE FROM \"$table\"");
|
||||
$this->query("DELETE FROM \"$table\"");
|
||||
}
|
||||
}
|
||||
|
||||
@ -189,7 +197,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public function renameTable($oldTableName, $newTableName)
|
||||
{
|
||||
$this->query("ALTER TABLE \"$oldTableName\" RENAME TO \"$newTableName\"");
|
||||
@ -201,7 +209,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
if (!SapphireTest::using_temp_db() && !self::$checked_and_repaired) {
|
||||
$this->alterationMessage("Checking database integrity", "repaired");
|
||||
|
||||
|
||||
// Check for any tables with failed integrity
|
||||
if ($messages = $this->query('PRAGMA integrity_check')) {
|
||||
foreach ($messages as $message) {
|
||||
@ -211,7 +219,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// If enabled vacuum (clean and rebuild) the database
|
||||
if (self::$vacuum) {
|
||||
$this->query('VACUUM', E_USER_NOTICE);
|
||||
@ -224,7 +232,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
}
|
||||
self::$checked_and_repaired = true;
|
||||
}
|
||||
|
||||
|
||||
return $ok;
|
||||
}
|
||||
|
||||
@ -270,7 +278,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
// Remember original indexes
|
||||
$indexList = $this->indexList($tableName);
|
||||
|
||||
|
||||
// Then alter the table column
|
||||
foreach ($queries as $query) {
|
||||
$this->query($query.';');
|
||||
@ -290,7 +298,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
if (!array_key_exists($oldName, $oldFieldList)) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
// Determine column mappings
|
||||
$oldCols = array();
|
||||
$newColsSpec = array();
|
||||
@ -328,10 +336,10 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
public function fieldList($table)
|
||||
{
|
||||
$sqlCreate = $this->preparedQuery(
|
||||
'SELECT sql FROM sqlite_master WHERE type = ? AND name = ?',
|
||||
'SELECT "sql" FROM "sqlite_master" WHERE "type" = ? AND "name" = ?',
|
||||
array('table', $table)
|
||||
)->record();
|
||||
|
||||
|
||||
$fieldList = array();
|
||||
if ($sqlCreate && $sqlCreate['sql']) {
|
||||
preg_match('/^[\s]*CREATE[\s]+TABLE[\s]+[\'"]?[a-zA-Z0-9_\\\]+[\'"]?[\s]*\((.+)\)[\s]*$/ims',
|
||||
@ -352,7 +360,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Create an index on a table.
|
||||
*
|
||||
*
|
||||
* @param string $tableName The name of the table.
|
||||
* @param string $indexName The name of the index.
|
||||
* @param array $indexSpec The specification of the index, see Database::requireIndex() for more details.
|
||||
@ -371,17 +379,17 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
// Drop existing index
|
||||
$sqliteName = $this->buildSQLiteIndexName($tableName, $indexName);
|
||||
$this->query("DROP INDEX IF EXISTS \"$sqliteName\"");
|
||||
|
||||
|
||||
// Create the index
|
||||
$this->createIndex($tableName, $indexName, $indexSpec);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
*
|
||||
* @param string $tableName
|
||||
* @param string $indexName
|
||||
* @return string The SQLite3 name of the index
|
||||
@ -390,19 +398,19 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
{
|
||||
return "{$tableName}_{$indexName}";
|
||||
}
|
||||
|
||||
|
||||
protected function parseIndexSpec($name, $spec)
|
||||
{
|
||||
$spec = parent::parseIndexSpec($name, $spec);
|
||||
|
||||
|
||||
// Only allow index / unique index types
|
||||
if (!in_array($spec['type'], array('index', 'unique'))) {
|
||||
$spec['type'] = 'index';
|
||||
}
|
||||
|
||||
|
||||
return $spec;
|
||||
}
|
||||
|
||||
|
||||
public function indexKey($table, $index, $spec)
|
||||
{
|
||||
return $this->buildSQLiteIndexName($table, $index);
|
||||
@ -411,20 +419,20 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
public function indexList($table)
|
||||
{
|
||||
$indexList = array();
|
||||
|
||||
|
||||
// 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"];
|
||||
$indexType = $index['unique'] ? 'unique' : 'index';
|
||||
|
||||
|
||||
// Determine a clean list of column names within this index
|
||||
$list = array();
|
||||
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(
|
||||
'name' => $indexName,
|
||||
@ -446,11 +454,11 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
}
|
||||
return $tables;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Return a boolean type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function boolean($values)
|
||||
@ -461,8 +469,8 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Return a date type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function date($values)
|
||||
@ -472,11 +480,11 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Return a decimal type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function decimal($values, $asDbValue = false)
|
||||
public function decimal($values)
|
||||
{
|
||||
$default = isset($values['default']) && is_numeric($values['default']) ? $values['default'] : 0;
|
||||
return "NUMERIC NOT NULL DEFAULT $default";
|
||||
@ -488,25 +496,25 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
* @var array
|
||||
*/
|
||||
protected $enum_map = array();
|
||||
|
||||
|
||||
/**
|
||||
* Return a enum type-formatted string
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function enum($values)
|
||||
{
|
||||
$tablefield = $values['table'] . '.' . $values['name'];
|
||||
$enumValues = implode(',', $values['enums']);
|
||||
|
||||
|
||||
// Ensure the cache table exists
|
||||
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) {
|
||||
$this->preparedQuery(
|
||||
@ -515,7 +523,7 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
);
|
||||
$this->enum_map[$tablefield] = $enumValues;
|
||||
}
|
||||
|
||||
|
||||
// Set default
|
||||
if (!empty($values['default'])) {
|
||||
$default = str_replace(array('"', "'", "\\", "\0"), "", $values['default']);
|
||||
@ -524,14 +532,14 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
return 'TEXT';
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Return a set type-formatted string
|
||||
* This type doesn't exist in SQLite either
|
||||
*
|
||||
*
|
||||
* @see SQLite3SchemaManager::enum()
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function set($values)
|
||||
@ -541,33 +549,33 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Return a float type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function float($values, $asDbValue = false)
|
||||
public function float($values)
|
||||
{
|
||||
return "REAL";
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a Double type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function double($values, $asDbValue = false)
|
||||
public function double($values)
|
||||
{
|
||||
return "REAL";
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a int type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function int($values, $asDbValue = false)
|
||||
public function int($values)
|
||||
{
|
||||
return "INTEGER({$values['precision']}) " . strtoupper($values['null']) . " DEFAULT " . (int)$values['default'];
|
||||
}
|
||||
@ -575,41 +583,41 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
/**
|
||||
* Return a bigint type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function bigint($values, $asDbValue = false)
|
||||
public function bigint($values)
|
||||
{
|
||||
return $this->int($values, $asDbValue);
|
||||
return $this->int($values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a datetime type-formatted string
|
||||
* 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
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function ss_datetime($values, $asDbValue = false)
|
||||
public function datetime($values)
|
||||
{
|
||||
return "DATETIME";
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a text type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function text($values, $asDbValue = false)
|
||||
public function text($values)
|
||||
{
|
||||
return 'TEXT';
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a time type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function time($values)
|
||||
@ -619,11 +627,11 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
|
||||
/**
|
||||
* Return a varchar type-formatted string
|
||||
*
|
||||
* @params array $values Contains a tokenised list of info about this data type
|
||||
*
|
||||
* @param array $values Contains a tokenised list of info about this data type
|
||||
* @return string
|
||||
*/
|
||||
public function varchar($values, $asDbValue = false)
|
||||
public function varchar($values)
|
||||
{
|
||||
return "VARCHAR({$values['precision']}) COLLATE NOCASE";
|
||||
}
|
||||
@ -645,25 +653,27 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
public function hasTable($tableName)
|
||||
{
|
||||
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)
|
||||
)->first();
|
||||
}
|
||||
|
||||
/**
|
||||
* Return enum values for the given field
|
||||
*
|
||||
*
|
||||
* @param string $tableName
|
||||
* @param string $fieldName
|
||||
* @return array
|
||||
*/
|
||||
public function enumValuesForField($tableName, $fieldName)
|
||||
{
|
||||
$tablefield = "$tableName.$fieldName";
|
||||
|
||||
|
||||
// Check already cached values for this field
|
||||
if (!empty($this->enum_map[$tablefield])) {
|
||||
return explode(',', $this->enum_map[$tablefield]);
|
||||
}
|
||||
|
||||
|
||||
// Retrieve and cache these details from the database
|
||||
$classnameinfo = $this->preparedQuery(
|
||||
"SELECT EnumList FROM SQLiteEnums WHERE TableColumn = ?",
|
||||
@ -674,17 +684,17 @@ class SQLite3SchemaManager extends DBSchemaManager
|
||||
$this->enum_map[$tablefield] = $valueList;
|
||||
return explode(',', $valueList);
|
||||
}
|
||||
|
||||
|
||||
// Fallback to empty list
|
||||
return array();
|
||||
}
|
||||
|
||||
|
||||
public function dbDataType($type)
|
||||
{
|
||||
$values = array(
|
||||
'unsigned integer' => 'INT'
|
||||
);
|
||||
|
||||
|
||||
if (isset($values[$type])) {
|
||||
return $values[$type];
|
||||
} else {
|
||||
|
||||
@ -1,19 +1,27 @@
|
||||
<?php
|
||||
|
||||
namespace SilverStripe\SQLite;
|
||||
|
||||
use DatabaseConfigurationHelper;
|
||||
use SQLite3;
|
||||
use PDO;
|
||||
use Exception;
|
||||
use DatabaseAdapterRegistry;
|
||||
|
||||
/**
|
||||
* This is a helper class for the SS installer.
|
||||
*
|
||||
*
|
||||
* It does all the specific checking for SQLiteDatabase
|
||||
* to ensure that the configuration is setup correctly.
|
||||
*
|
||||
*
|
||||
* @package SQLite3
|
||||
*/
|
||||
class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Create a connection of the appropriate type
|
||||
*
|
||||
*
|
||||
* @param array $databaseConfig
|
||||
* @param string $error Error message passed by value
|
||||
* @return mixed|null Either the connection object, or null if error
|
||||
@ -28,7 +36,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
}
|
||||
$file = $databaseConfig['path'] . '/' . $databaseConfig['database'];
|
||||
$conn = null;
|
||||
|
||||
|
||||
switch ($databaseConfig['type']) {
|
||||
case 'SQLite3Database':
|
||||
if (empty($databaseConfig['key'])) {
|
||||
@ -45,7 +53,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
$error = 'Invalid connection type';
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
if ($conn) {
|
||||
return $conn;
|
||||
} else {
|
||||
@ -57,7 +65,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public function requireDatabaseFunctions($databaseConfig)
|
||||
{
|
||||
$data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']);
|
||||
@ -88,9 +96,9 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
|
||||
/**
|
||||
* Ensure a database connection is possible using credentials provided.
|
||||
*
|
||||
*
|
||||
* @todo Validate path
|
||||
*
|
||||
*
|
||||
* @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')
|
||||
*/
|
||||
@ -109,7 +117,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
'error' => "Missing database filename"
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
// Create and secure db directory
|
||||
$path = $databaseConfig['path'];
|
||||
$dirCreated = self::create_db_dir($path);
|
||||
@ -129,7 +137,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
|
||||
$conn = $this->createConnection($databaseConfig, $error);
|
||||
$success = !empty($conn);
|
||||
|
||||
|
||||
return array(
|
||||
'success' => $success,
|
||||
'connection' => $conn,
|
||||
@ -140,7 +148,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
public function getDatabaseVersion($databaseConfig)
|
||||
{
|
||||
$version = 0;
|
||||
|
||||
|
||||
switch ($databaseConfig['type']) {
|
||||
case 'SQLite3Database':
|
||||
$info = SQLite3::version();
|
||||
@ -186,12 +194,12 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
'alreadyExists' => $alreadyExists,
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Creates the provided directory and prepares it for
|
||||
* 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
|
||||
*/
|
||||
@ -199,14 +207,14 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
{
|
||||
return file_exists($path) || mkdir($path);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Secure the provided directory via web-access
|
||||
* by placing a .htaccess file in it.
|
||||
* by placing a .htaccess file in it.
|
||||
* This is just required if the database directory
|
||||
* is placed within a publically accessible webroot (the
|
||||
* default path is in a hidden folder within assets/).
|
||||
*
|
||||
*
|
||||
* @param String $path Absolute path, containing a SQLite datatbase
|
||||
* @return boolean
|
||||
*/
|
||||
@ -214,7 +222,7 @@ class SQLiteDatabaseConfigurationHelper implements DatabaseConfigurationHelper
|
||||
{
|
||||
return (is_writeable($path)) ? file_put_contents($path . '/.htaccess', 'deny from all') : false;
|
||||
}
|
||||
|
||||
|
||||
public function requireDatabaseAlterPermissions($databaseConfig)
|
||||
{
|
||||
// no concept of table-specific permissions; If you can connect you can alter schema
|
||||
|
||||
@ -24,6 +24,11 @@
|
||||
"dev-master": "2.0.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"SilverStripe\\SQLite\\": "code/"
|
||||
}
|
||||
},
|
||||
"minimum-stability": "dev",
|
||||
"prefer-stable": true
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user