[feature/sqlite3] Add support for SQLite 3

Minimum version requirement is 3.6.15 as that's what ships with PHP 5.3.0
when support for SQLite 3 was added.

PHPBB3-9728

phpBB/phpbb/db/driver/sqlite3.php

@@ -0,0 +1,350 @@
+<?php
+/**
+*
+* @package dbal
+* @copyright (c) 2014 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+namespace phpbb\db\driver;
+
+/**
+* SQLite3 Database Abstraction Layer
+* Minimum Requirement: 3.6.15+
+* @package dbal
+*/
+class sqlite3 extends \phpbb\db\driver\driver
+{
+	var $connect_error = '';
+
+	/** @var \SQLite3 */
+	var $dbo = null;
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false, $new_link = false)
+	{
+		$this->persistency = false;
+		$this->user = $sqluser;
+		$this->server = $sqlserver . (($port) ? ':' . $port : '');
+		$this->dbname = $database;
+
+		if (!class_exists('SQLite3', false))
+		{
+			$this->connect_error = 'SQLite3 not found, is the extension installed?';
+			return $this->sql_error('');
+		}
+
+		try
+		{
+			$this->dbo = new \SQLite3($this->server, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE);
+			$this->db_connect_id = true;
+		}
+		catch (Exception $e)
+		{
+			return array('message' => $e->getMessage());
+		}
+
+		return true;
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_server_info($raw = false, $use_cache = true)
+	{
+		global $cache;
+
+		if (!$use_cache || empty($cache) || ($this->sql_server_version = $cache->get('sqlite_version')) === false)
+		{
+			$version = \SQLite3::version();
+
+			$this->sql_server_version = $version['versionString'];
+
+			if (!empty($cache) && $use_cache)
+			{
+				$cache->put('sqlite_version', $this->sql_server_version);
+			}
+		}
+
+		return ($raw) ? $this->sql_server_version : 'SQLite ' . $this->sql_server_version;
+	}
+
+	/**
+	* SQL Transaction
+	* @access private
+	*/
+	function _sql_transaction($status = 'begin')
+	{
+		switch ($status)
+		{
+			case 'begin':
+				return $this->dbo->exec('BEGIN IMMEDIATE');
+			break;
+
+			case 'commit':
+				return $this->dbo->exec('COMMIT');
+			break;
+
+			case 'rollback':
+				return $this->dbo->exec('ROLLBACK');
+			break;
+		}
+
+		return true;
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_query($query = '', $cache_ttl = 0)
+	{
+		if ($query != '')
+		{
+			global $cache;
+
+			// EXPLAIN only in extra debug mode
+			if (defined('DEBUG'))
+			{
+				$this->sql_report('start', $query);
+			}
+
+			$this->last_query_text = $query;
+			$this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;
+			$this->sql_add_num_queries($this->query_result);
+
+			if ($this->query_result === false)
+			{
+				if (($this->query_result = @$this->dbo->query($query)) === false)
+				{
+					$this->sql_error($query);
+				}
+
+				if (defined('DEBUG'))
+				{
+					$this->sql_report('stop', $query);
+				}
+
+				if ($cache && $cache_ttl)
+				{
+					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);
+				}
+			}
+			else if (defined('DEBUG'))
+			{
+				$this->sql_report('fromcache', $query);
+			}
+		}
+		else
+		{
+			return false;
+		}
+
+		return $this->query_result;
+	}
+
+	/**
+	* Build LIMIT query
+	*/
+	function _sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0)
+	{
+		$this->query_result = false;
+
+		// if $total is set to 0 we do not want to limit the number of rows
+		if ($total == 0)
+		{
+			$total = -1;
+		}
+
+		$query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
+
+		return $this->sql_query($query, $cache_ttl);
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_affectedrows()
+	{
+		return ($this->db_connect_id) ? $this->dbo->changes() : false;
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_fetchrow($query_id = false)
+	{
+		global $cache;
+
+		if ($query_id === false)
+		{
+			$query_id = $this->query_result;
+		}
+
+		if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))
+		{
+			return $cache->sql_fetchrow($query_id);
+		}
+
+		return is_object($query_id) ? $query_id->fetchArray(SQLITE3_ASSOC) : false;
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_nextid()
+	{
+		return ($this->db_connect_id) ? $this->dbo->lastInsertRowID() : false;
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_freeresult($query_id = false)
+	{
+		global $cache;
+
+		if ($query_id === false)
+		{
+			$query_id = $this->query_result;
+		}
+
+		if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))
+		{
+			return $cache->sql_freeresult($query_id);
+		}
+
+		if ($query_id)
+		{
+			return @$query_id->finalize();
+		}
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_escape($msg)
+	{
+		return \SQLite3::escapeString($msg);
+	}
+
+	/**
+	* {@inheritDoc}
+	*
+	* For SQLite an underscore is a not-known character...
+	*/
+	function sql_like_expression($expression)
+	{
+		// Unlike LIKE, GLOB is case sensitive (unfortunatly). SQLite users need to live with it!
+		// We only catch * and ? here, not the character map possible on file globbing.
+		$expression = str_replace(array(chr(0) . '_', chr(0) . '%'), array(chr(0) . '?', chr(0) . '*'), $expression);
+
+		$expression = str_replace(array('?', '*'), array("\?", "\*"), $expression);
+		$expression = str_replace(array(chr(0) . "\?", chr(0) . "\*"), array('?', '*'), $expression);
+
+		return 'GLOB \'' . $this->sql_escape($expression) . '\'';
+	}
+
+	/**
+	* return sql error array
+	* @access private
+	*/
+	function _sql_error()
+	{
+		if (class_exists('SQLite3', false))
+		{
+			$error = array(
+				'message'	=> $this->dbo->lastErrorMsg(),
+				'code'		=> $this->dbo->lastErrorCode(),
+			);
+		}
+		else
+		{
+			$error = array(
+				'message'	=> $this->connect_error,
+				'code'		=> '',
+			);
+		}
+
+		return $error;
+	}
+
+	/**
+	* Build db-specific query data
+	* @access private
+	*/
+	function _sql_custom_build($stage, $data)
+	{
+		return $data;
+	}
+
+	/**
+	* Close sql connection
+	* @access private
+	*/
+	function _sql_close()
+	{
+		return $this->dbo->close();
+	}
+
+	/**
+	* Build db-specific report
+	* @access private
+	*/
+	function _sql_report($mode, $query = '')
+	{
+		switch ($mode)
+		{
+			case 'start':
+
+				$explain_query = $query;
+				if (preg_match('/UPDATE ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
+				{
+					$explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
+				}
+				else if (preg_match('/DELETE FROM ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
+				{
+					$explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
+				}
+
+				if (preg_match('/^SELECT/', $explain_query))
+				{
+					$html_table = false;
+
+					if ($result = $this->dbo->query("EXPLAIN QUERY PLAN $explain_query"))
+					{
+						while ($row = $result->fetchArray(SQLITE3_ASSOC))
+						{
+							$html_table = $this->sql_report('add_select_row', $query, $html_table, $row);
+						}
+					}
+
+					if ($html_table)
+					{
+						$this->html_hold .= '</table>';
+					}
+				}
+
+			break;
+
+			case 'fromcache':
+				$endtime = explode(' ', microtime());
+				$endtime = $endtime[0] + $endtime[1];
+
+				$result = $this->dbo->query($query);
+				while ($void = $result->fetchArray(SQLITE3_ASSOC))
+				{
+					// Take the time spent on parsing rows into account
+				}
+
+				$splittime = explode(' ', microtime());
+				$splittime = $splittime[0] + $splittime[1];
+
+				$this->sql_report('record_fromcache', $query, $endtime, $splittime);
+
+			break;
+		}
+	}
+}

phpBB/phpbb/db/tools.php

@@ -257,6 +257,36 @@ class tools
 				'VARBINARY'	=> 'blob',
 			),
 
+			'sqlite3'	=> array(
+				'INT:'		=> 'INT(%d)',
+				'BINT'		=> 'BIGINT(20)',
+				'UINT'		=> 'INTEGER UNSIGNED',
+				'UINT:'		=> 'INTEGER UNSIGNED',
+				'TINT:'		=> 'TINYINT(%d)',
+				'USINT'		=> 'INTEGER UNSIGNED',
+				'BOOL'		=> 'INTEGER UNSIGNED',
+				'VCHAR'		=> 'VARCHAR(255)',
+				'VCHAR:'	=> 'VARCHAR(%d)',
+				'CHAR:'		=> 'CHAR(%d)',
+				'XSTEXT'	=> 'TEXT(65535)',
+				'STEXT'		=> 'TEXT(65535)',
+				'TEXT'		=> 'TEXT(65535)',
+				'MTEXT'		=> 'MEDIUMTEXT(16777215)',
+				'XSTEXT_UNI'=> 'TEXT(65535)',
+				'STEXT_UNI'	=> 'TEXT(65535)',
+				'TEXT_UNI'	=> 'TEXT(65535)',
+				'MTEXT_UNI'	=> 'MEDIUMTEXT(16777215)',
+				'TIMESTAMP'	=> 'INTEGER UNSIGNED', //'int(11) UNSIGNED',
+				'DECIMAL'	=> 'DECIMAL(5,2)',
+				'DECIMAL:'	=> 'DECIMAL(%d,2)',
+				'PDECIMAL'	=> 'DECIMAL(6,3)',
+				'PDECIMAL:'	=> 'DECIMAL(%d,3)',
+				'VCHAR_UNI'	=> 'VARCHAR(255)',
+				'VCHAR_UNI:'=> 'VARCHAR(%d)',
+				'VCHAR_CI'	=> 'VARCHAR(255)',
+				'VARBINARY'	=> 'BLOB',
+			),
+
 			'postgres'	=> array(
 				'INT:'		=> 'INT4',
 				'BINT'		=> 'INT8',
@@ -299,7 +329,7 @@ class tools
 	* A list of supported DBMS. We change this class to support more DBMS, the DBMS itself only need to follow some rules.
 	* @var array
 	*/
-	var $supported_dbms = array('firebird', 'mssql', 'mssqlnative', 'mysql_40', 'mysql_41', 'oracle', 'postgres', 'sqlite');
+	var $supported_dbms = array('firebird', 'mssql', 'mssqlnative', 'mysql_40', 'mysql_41', 'oracle', 'postgres', 'sqlite', 'sqlite3');
 
 	/**
 	* This is set to true if user only wants to return the 'to-be-executed' SQL statement(s) (as an array).
@@ -389,6 +419,13 @@ class tools
 					WHERE type = "table"';
 			break;
 
+			case 'sqlite3':
+				$sql = 'SELECT name
+					FROM sqlite_master
+					WHERE type = "table"
+						AND name <> "sqlite_sequence"';
+			break;
+
 			case 'mssql':
 			case 'mssql_odbc':
 			case 'mssqlnative':
@@ -567,6 +604,7 @@ class tools
 					case 'mysql_41':
 					case 'postgres':
 					case 'sqlite':
+					case 'sqlite3':
 						$table_sql .= ",\n\t PRIMARY KEY (" . implode(', ', $table_data['PRIMARY_KEY']) . ')';
 					break;
 
@@ -604,6 +642,7 @@ class tools
 
 			case 'mysql_40':
 			case 'sqlite':
+			case 'sqlite3':
 				$table_sql .= "\n);";
 				$statements[] = $table_sql;
 			break;
@@ -722,7 +761,7 @@ class tools
 		$sqlite = false;
 
 		// For SQLite we need to perform the schema changes in a much more different way
-		if ($this->db->sql_layer == 'sqlite' && $this->return_statements)
+		if (($this->db->sql_layer == 'sqlite' || $this->db->sql_layer == 'sqlite3') && $this->return_statements)
 		{
 			$sqlite_data = array();
 			$sqlite = true;
@@ -1140,6 +1179,7 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 				$sql = "SELECT sql
 					FROM sqlite_master
 					WHERE type = 'table'
@@ -1273,6 +1313,7 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 				$sql = "PRAGMA index_list('" . $table_name . "');";
 				$col = 'name';
 			break;
@@ -1293,6 +1334,7 @@ class tools
 				case 'oracle':
 				case 'postgres':
 				case 'sqlite':
+				case 'sqlite3':
 					$row[$col] = substr($row[$col], strlen($table_name) + 1);
 				break;
 			}
@@ -1377,6 +1419,7 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 				$sql = "PRAGMA index_list('" . $table_name . "');";
 				$col = 'name';
 			break;
@@ -1390,7 +1433,7 @@ class tools
 				continue;
 			}
 
-			if ($this->sql_layer == 'sqlite' && !$row['unique'])
+			if (($this->sql_layer == 'sqlite' || $this->sql_layer == 'sqlite3') && !$row['unique'])
 			{
 				continue;
 			}
@@ -1418,6 +1461,7 @@ class tools
 				case 'firebird':
 				case 'postgres':
 				case 'sqlite':
+				case 'sqlite3':
 					$row[$col] = substr($row[$col], strlen($table_name) + 1);
 				break;
 			}
@@ -1629,11 +1673,17 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 				$return_array['primary_key_set'] = false;
 				if (isset($column_data[2]) && $column_data[2] == 'auto_increment')
 				{
 					$sql .= ' INTEGER PRIMARY KEY';
 					$return_array['primary_key_set'] = true;
+
+					if ($this->sql_layer === 'sqlite3')
+					{
+						$sql .= ' AUTOINCREMENT';
+					}
 				}
 				else
 				{
@@ -1770,13 +1820,14 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 
 				if ($inline && $this->return_statements)
 				{
 					return $column_name . ' ' . $column_data['column_type_sql'];
 				}
 
-				if (version_compare(sqlite_libversion(), '3.0') == -1)
+				if (version_compare($this->db->sql_server_info(true), '3.0') == -1)
 				{
 					$sql = "SELECT sql
 						FROM sqlite_master
@@ -1829,7 +1880,7 @@ class tools
 				}
 				else
 				{
-					$statements[] = 'ALTER TABLE ' . $table_name . ' ADD ' . $column_name . ' [' . $column_data['column_type_sql'] . ']';
+					$statements[] = 'ALTER TABLE ' . $table_name . ' ADD ' . $column_name . ' ' . $column_data['column_type_sql'];
 				}
 			break;
 		}
@@ -1908,67 +1959,61 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 
 				if ($inline && $this->return_statements)
 				{
 					return $column_name;
 				}
 
-				if (version_compare(sqlite_libversion(), '3.0') == -1)
+				$sql = "SELECT sql
+					FROM sqlite_master
+					WHERE type = 'table'
+						AND name = '{$table_name}'
+					ORDER BY type DESC, name;";
+				$result = $this->db->sql_query($sql);
+
+				if (!$result)
 				{
-					$sql = "SELECT sql
-						FROM sqlite_master
-						WHERE type = 'table'
-							AND name = '{$table_name}'
-						ORDER BY type DESC, name;";
-					$result = $this->db->sql_query($sql);
-
-					if (!$result)
-					{
-						break;
-					}
-
-					$row = $this->db->sql_fetchrow($result);
-					$this->db->sql_freeresult($result);
-
-					$statements[] = 'begin';
-
-					// Create a backup table and populate it, destroy the existing one
-					$statements[] = preg_replace('#CREATE\s+TABLE\s+"?' . $table_name . '"?#i', 'CREATE TEMPORARY TABLE ' . $table_name . '_temp', $row['sql']);
-					$statements[] = 'INSERT INTO ' . $table_name . '_temp SELECT * FROM ' . $table_name;
-					$statements[] = 'DROP TABLE ' . $table_name;
-
-					preg_match('#\((.*)\)#s', $row['sql'], $matches);
-
-					$new_table_cols = trim($matches[1]);
-					$old_table_cols = preg_split('/,(?![\s\w]+\))/m', $new_table_cols);
-					$column_list = array();
-
-					foreach ($old_table_cols as $declaration)
-					{
-						$entities = preg_split('#\s+#', trim($declaration));
-						if ($entities[0] == 'PRIMARY' || $entities[0] === $column_name)
-						{
-							continue;
-						}
-						$column_list[] = $entities[0];
-					}
-
-					$columns = implode(',', $column_list);
-
-					$new_table_cols = preg_replace('/' . $column_name . '[^,]+(?:,|$)/m', '', $new_table_cols);
-
-					// create a new table and fill it up. destroy the temp one
-					$statements[] = 'CREATE TABLE ' . $table_name . ' (' . $new_table_cols . ');';
-					$statements[] = 'INSERT INTO ' . $table_name . ' (' . $columns . ') SELECT ' . $columns . ' FROM ' . $table_name . '_temp;';
-					$statements[] = 'DROP TABLE ' . $table_name . '_temp';
-
-					$statements[] = 'commit';
+					break;
 				}
-				else
+
+				$row = $this->db->sql_fetchrow($result);
+				$this->db->sql_freeresult($result);
+
+				$statements[] = 'begin';
+
+				// Create a backup table and populate it, destroy the existing one
+				$statements[] = preg_replace('#CREATE\s+TABLE\s+"?' . $table_name . '"?#i', 'CREATE TEMPORARY TABLE ' . $table_name . '_temp', $row['sql']);
+				$statements[] = 'INSERT INTO ' . $table_name . '_temp SELECT * FROM ' . $table_name;
+				$statements[] = 'DROP TABLE ' . $table_name;
+
+				preg_match('#\((.*)\)#s', $row['sql'], $matches);
+
+				$new_table_cols = trim($matches[1]);
+				$old_table_cols = preg_split('/,(?![\s\w]+\))/m', $new_table_cols);
+				$column_list = array();
+
+				foreach ($old_table_cols as $declaration)
 				{
-					$statements[] = 'ALTER TABLE ' . $table_name . ' DROP COLUMN ' . $column_name;
+					$entities = preg_split('#\s+#', trim($declaration));
+					if ($entities[0] == 'PRIMARY' || $entities[0] === $column_name)
+					{
+						continue;
+					}
+					$column_list[] = $entities[0];
 				}
+
+				$columns = implode(',', $column_list);
+
+				$new_table_cols = preg_replace('/' . $column_name . '[^,]+(?:,|$)/m', '', $new_table_cols);
+
+				// create a new table and fill it up. destroy the temp one
+				$statements[] = 'CREATE TABLE ' . $table_name . ' (' . $new_table_cols . ');';
+				$statements[] = 'INSERT INTO ' . $table_name . ' (' . $columns . ') SELECT ' . $columns . ' FROM ' . $table_name . '_temp;';
+				$statements[] = 'DROP TABLE ' . $table_name . '_temp';
+
+				$statements[] = 'commit';
 			break;
 		}
 
@@ -1998,6 +2043,7 @@ class tools
 			case 'oracle':
 			case 'postgres':
 			case 'sqlite':
+			case' sqlite3':
 				$statements[] = 'DROP INDEX ' . $table_name . '_' . $index_name;
 			break;
 		}
@@ -2104,6 +2150,7 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 
 				if ($inline && $this->return_statements)
 				{
@@ -2182,6 +2229,7 @@ class tools
 			case 'postgres':
 			case 'oracle':
 			case 'sqlite':
+			case 'sqlite3':
 				$statements[] = 'CREATE UNIQUE INDEX ' . $table_name . '_' . $index_name . ' ON ' . $table_name . '(' . implode(', ', $column) . ')';
 			break;
 
@@ -2225,6 +2273,7 @@ class tools
 			case 'postgres':
 			case 'oracle':
 			case 'sqlite':
+			case 'sqlite3':
 				$statements[] = 'CREATE INDEX ' . $table_name . '_' . $index_name . ' ON ' . $table_name . '(' . implode(', ', $column) . ')';
 			break;
 
@@ -2316,6 +2365,7 @@ class tools
 				break;
 
 				case 'sqlite':
+				case 'sqlite3':
 					$sql = "PRAGMA index_info('" . $table_name . "');";
 					$col = 'name';
 				break;
@@ -2335,6 +2385,7 @@ class tools
 					case 'oracle':
 					case 'postgres':
 					case 'sqlite':
+					case 'sqlite3':
 						$row[$col] = substr($row[$col], strlen($table_name) + 1);
 					break;
 				}
@@ -2488,6 +2539,7 @@ class tools
 			break;
 
 			case 'sqlite':
+			case 'sqlite3':
 
 				if ($inline && $this->return_statements)
 				{