Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
64.71% |
11 / 17 |
CRAP | |
66.41% |
85 / 128 |
| sqlite3 | |
0.00% |
0 / 1 |
|
64.71% |
11 / 17 |
275.03 | |
66.41% |
85 / 128 |
| sql_connect | |
0.00% |
0 / 1 |
4.73 | |
64.29% |
9 / 14 |
|||
| sql_server_info | |
100.00% |
1 / 1 |
7 | |
100.00% |
7 / 7 |
|||
| _sql_transaction | |
0.00% |
0 / 1 |
4.03 | |
87.50% |
7 / 8 |
|||
| sql_query | |
0.00% |
0 / 1 |
27.89 | |
75.00% |
24 / 32 |
|||
| _sql_query_limit | |
100.00% |
1 / 1 |
3 | |
100.00% |
5 / 5 |
|||
| sql_affectedrows | |
100.00% |
1 / 1 |
2 | |
100.00% |
1 / 1 |
|||
| sql_fetchrow | |
100.00% |
1 / 1 |
5 | |
100.00% |
7 / 7 |
|||
| sql_last_inserted_id | |
100.00% |
1 / 1 |
2 | |
100.00% |
1 / 1 |
|||
| sql_freeresult | |
100.00% |
1 / 1 |
5 | |
100.00% |
9 / 9 |
|||
| sql_escape | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| sql_like_expression | |
100.00% |
1 / 1 |
1 | |
100.00% |
4 / 4 |
|||
| sql_not_like_expression | |
100.00% |
1 / 1 |
1 | |
100.00% |
4 / 4 |
|||
| _sql_error | |
0.00% |
0 / 1 |
3.33 | |
66.67% |
4 / 6 |
|||
| _sql_custom_build | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| _sql_close | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| _sql_report | |
0.00% |
0 / 1 |
132.00 | |
0.00% |
0 / 26 |
|||
| sql_quote | |
0.00% |
0 / 1 |
2.00 | |
0.00% |
0 / 1 |
|||
| <?php | |
| /** | |
| * | |
| * This file is part of the phpBB Forum Software package. | |
| * | |
| * @copyright (c) phpBB Limited <https://www.phpbb.com> | |
| * @license GNU General Public License, version 2 (GPL-2.0) | |
| * | |
| * For full copyright and license information, please see | |
| * the docs/CREDITS.txt file. | |
| * | |
| */ | |
| namespace phpbb\db\driver; | |
| /** | |
| * SQLite3 Database Abstraction Layer | |
| * Minimum Requirement: 3.6.15+ | |
| */ | |
| class sqlite3 extends \phpbb\db\driver\driver | |
| { | |
| /** | |
| * @var string Stores errors during connection setup in case the driver is not available | |
| */ | |
| protected $connect_error = ''; | |
| /** | |
| * @var \SQLite3 The SQLite3 database object to operate against | |
| */ | |
| protected $dbo = null; | |
| /** | |
| * {@inheritDoc} | |
| */ | |
| public 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->dbo->busyTimeout(60000); | |
| $this->db_connect_id = true; | |
| } | |
| catch (\Exception $e) | |
| { | |
| $this->connect_error = $e->getMessage(); | |
| return array('message' => $this->connect_error); | |
| } | |
| return true; | |
| } | |
| /** | |
| * {@inheritDoc} | |
| */ | |
| public 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 | |
| * | |
| * @param string $status Should be one of the following strings: | |
| * begin, commit, rollback | |
| * @return bool Success/failure of the transaction query | |
| */ | |
| protected 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} | |
| */ | |
| public function sql_query($query = '', $cache_ttl = 0) | |
| { | |
| if ($query != '') | |
| { | |
| global $cache; | |
| if ($this->debug_sql_explain) | |
| { | |
| $this->sql_report('start', $query); | |
| } | |
| else if ($this->debug_load_time) | |
| { | |
| $this->curtime = microtime(true); | |
| } | |
| $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->transaction === true && strpos($query, 'INSERT') === 0) | |
| { | |
| $query = preg_replace('/^INSERT INTO/', 'INSERT OR ROLLBACK INTO', $query); | |
| } | |
| try | |
| { | |
| $this->query_result = @$this->dbo->query($query); | |
| } | |
| catch (\Error $e) | |
| { | |
| // Do nothing as SQL driver will report the error | |
| } | |
| if ($this->query_result === false) | |
| { | |
| // Try to recover a lost database connection | |
| if ($this->dbo && !@$this->dbo->lastErrorMsg()) | |
| { | |
| if ($this->sql_connect($this->server, $this->user, '', $this->dbname)) | |
| { | |
| $this->query_result = @$this->dbo->query($query); | |
| } | |
| } | |
| if ($this->query_result === false) | |
| { | |
| $this->sql_error($query); | |
| } | |
| } | |
| if ($this->debug_sql_explain) | |
| { | |
| $this->sql_report('stop', $query); | |
| } | |
| else if ($this->debug_load_time) | |
| { | |
| $this->sql_time += microtime(true) - $this->curtime; | |
| } | |
| if (!$this->query_result) | |
| { | |
| return false; | |
| } | |
| if ($cache && $cache_ttl) | |
| { | |
| $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl); | |
| } | |
| } | |
| else if ($this->debug_sql_explain) | |
| { | |
| $this->sql_report('fromcache', $query); | |
| } | |
| } | |
| else | |
| { | |
| return false; | |
| } | |
| return $this->query_result; | |
| } | |
| /** | |
| * Build LIMIT query | |
| * | |
| * @param string $query The SQL query to execute | |
| * @param int $total The number of rows to select | |
| * @param int $offset | |
| * @param int $cache_ttl Either 0 to avoid caching or | |
| * the time in seconds which the result shall be kept in cache | |
| * @return mixed Buffered, seekable result handle, false on error | |
| */ | |
| protected 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} | |
| */ | |
| public function sql_affectedrows() | |
| { | |
| return ($this->db_connect_id) ? $this->dbo->changes() : false; | |
| } | |
| /** | |
| * {@inheritDoc} | |
| */ | |
| public function sql_fetchrow($query_id = false) | |
| { | |
| global $cache; | |
| if ($query_id === false) | |
| { | |
| /** @var \SQLite3Result $query_id */ | |
| $query_id = $this->query_result; | |
| } | |
| $safe_query_id = $this->clean_query_id($query_id); | |
| if ($cache && $cache->sql_exists($safe_query_id)) | |
| { | |
| return $cache->sql_fetchrow($safe_query_id); | |
| } | |
| return is_object($query_id) ? @$query_id->fetchArray(SQLITE3_ASSOC) : false; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function sql_last_inserted_id() | |
| { | |
| return ($this->db_connect_id) ? $this->dbo->lastInsertRowID() : false; | |
| } | |
| /** | |
| * {@inheritDoc} | |
| */ | |
| public function sql_freeresult($query_id = false) | |
| { | |
| global $cache; | |
| if ($query_id === false) | |
| { | |
| $query_id = $this->query_result; | |
| } | |
| $safe_query_id = $this->clean_query_id($query_id); | |
| if ($cache && $cache->sql_exists($safe_query_id)) | |
| { | |
| return $cache->sql_freeresult($safe_query_id); | |
| } | |
| if ($query_id) | |
| { | |
| return @$query_id->finalize(); | |
| } | |
| } | |
| /** | |
| * {@inheritDoc} | |
| */ | |
| public function sql_escape($msg) | |
| { | |
| return \SQLite3::escapeString($msg); | |
| } | |
| /** | |
| * {@inheritDoc} | |
| * | |
| * For SQLite an underscore is an unknown character. | |
| */ | |
| public function sql_like_expression($expression) | |
| { | |
| // Unlike LIKE, GLOB is unfortunately case sensitive. | |
| // 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) . '\''; | |
| } | |
| /** | |
| * {@inheritDoc} | |
| * | |
| * For SQLite an underscore is an unknown character. | |
| */ | |
| public function sql_not_like_expression($expression) | |
| { | |
| // Unlike NOT LIKE, NOT GLOB is unfortunately case sensitive | |
| // 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 'NOT GLOB \'' . $this->sql_escape($expression) . '\''; | |
| } | |
| /** | |
| * return sql error array | |
| * | |
| * @return array | |
| */ | |
| protected function _sql_error() | |
| { | |
| if (class_exists('SQLite3', false) && isset($this->dbo)) | |
| { | |
| $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 | |
| * | |
| * @param string $stage Available stages: FROM, WHERE | |
| * @param mixed $data A string containing the CROSS JOIN query or an array of WHERE clauses | |
| * | |
| * @return string The db-specific query fragment | |
| */ | |
| protected function _sql_custom_build($stage, $data) | |
| { | |
| return $data; | |
| } | |
| /** | |
| * Close sql connection | |
| * | |
| * @return bool False if failure | |
| */ | |
| protected function _sql_close() | |
| { | |
| return $this->dbo->close(); | |
| } | |
| /** | |
| * Build db-specific report | |
| * | |
| * @param string $mode Available modes: display, start, stop, | |
| * add_select_row, fromcache, record_fromcache | |
| * @param string $query The Query that should be explained | |
| * @return mixed Either a full HTML page, boolean or null | |
| */ | |
| protected 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); | |
| if ($result) | |
| { | |
| 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; | |
| } | |
| } | |
| /** | |
| * {@inheritDoc} | |
| */ | |
| function sql_quote($msg) | |
| { | |
| return '\'' . $msg . '\''; | |
| } | |
| } |