sqlite_cache - Code Metrics - Inspection of "SQLite update to go with #4446" - SimpleMachines/SMF2.1 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — release-2.1 (#4447)

by Martyn

created 2018-01-09 20:20 UTC

sqlite_cache A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	163
Duplicated Lines	15.34 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	25
loc	163
rs	10
c	0
b	0
f	0
wmc	22
lcom	1
cbo	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	connect()	0	14	2
A	isSupported()	9	9	4
A	getData()	0	12	3
A	putData()	0	9	1
A	cleanCache()	0	14	2
A	cacheSettings()	16	16	2
B	setCachedir()	0	13	5
A	getVersion()	0	5	1
A	housekeeping()	0	4	1

How to fix Duplicated Code

<?php

/**
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines http://www.simplemachines.org
 * @copyright 2017 Simple Machines and individual contributors
 * @license http://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1 Beta 4
 */

if (!defined('SMF'))
	die('Hacking attempt...');

/**
 * SQLite Cache API class
 * @package cacheAPI
 */
class sqlite_cache extends cache_api
{
	/**
	 * @var string The path to the current $cachedir directory.
	 */
	private $cachedir = null;

	/**
	 * @var SQLite3
	 */
	private $cacheDB = null;

	/**
	 * @var int
	 */
	private $cacheTime = 0;

	public function __construct()
	{
		parent::__construct();

		// Set our default cachedir.
		$this->setCachedir();
	}

	/**
	 * {@inheritDoc}
	 */
	public function connect()
	{

		$database = $this->cachedir . '/' . 'SQLite3Cache.db3';
		$this->cacheDB = new SQLite3($database);
		$this->cacheDB->busyTimeout(1000);
		if (filesize($database) == 0)
		{
			$this->cacheDB->exec('CREATE TABLE cache (key text unique, value blob, ttl int);');
			$this->cacheDB->exec('CREATE INDEX ttls ON cache(ttl);');
		}
		$this->cacheTime = time();

	}

	/**
	 * {@inheritDoc}
	 */
	public function isSupported($test = false)

	{
		$supported = class_exists("SQLite3") && is_writable($this->cachedir);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

		if ($test)
			return $supported;

		return parent::isSupported() && $supported;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getData($key, $ttl = null)
	{
		$ttl = time() - $ttl;
		$query = 'SELECT value FROM cache WHERE key = \'' . $this->cacheDB->escapeString($key) . '\' AND ttl >= ' . $ttl . ' LIMIT 1';
		$result = $this->cacheDB->query($query);

		$value = null;
		while ($res = $result->fetchArray(SQLITE3_ASSOC))
			$value = $res['value'];

		return !empty($value) ? $value : null;
	}

	/**
	 * {@inheritDoc}
	 */
	public function putData($key, $value, $ttl = null)
	{

		$ttl = $this->cacheTime + $ttl;
		$query = 'REPLACE INTO cache VALUES (\'' . $this->cacheDB->escapeString($key) . '\', \'' . $this->cacheDB->escapeString($value) . '\', ' . $this->cacheDB->escapeString($ttl) . ');';
		$result = $this->cacheDB->exec($query);

		return $result;
	}

	/**
	 * {@inheritDoc}
	 */
	public function cleanCache($type = '')
	{
		if($type == 'expired')
			$query = 'DELETE FROM cache WHERE ttl >= ' . time().';';
		else
			$query = 'DELETE FROM cache;';

		$result = $this->cacheDB->exec($query);
		
		$query	= 'VACUUM;';
		$this->cacheDB->exec($query);

		return $result;
	}

	/**
	 * {@inheritDoc}
	 */
	public function cacheSettings(array &$config_vars)

	{
		global $context, $txt;
function myFunction($a, $b) {
    // Do something
}

		$config_vars[] = $txt['cache_sqlite_settings'];
		$config_vars[] = array('cachedir_sqlite', $txt['cachedir_sqlite'], 'file', 'text', 36, 'cache_sqlite_cachedir');

		if (!isset($context['settings_post_javascript']))
			$context['settings_post_javascript'] = '';

		$context['settings_post_javascript'] .= '
			$("#cache_accelerator").change(function (e) {
				var cache_type = e.currentTarget.value;
				$("#cachedir_sqlite").prop("disabled", cache_type != "sqlite");
			});';
	}

	/**
	 * Sets the $cachedir or uses the SMF default $cachedir..
	 *
	 * @access public
	 *
	 * @param string $dir A valid path

	 *
	 * @return boolean If this was successful or not.

	 */
	public function setCachedir($dir = null)
	{
		global $cachedir, $cachedir_sqlite;
function myFunction($a, $b) {
    // Do something
}

		// If its invalid, use SMF's.
		if (is_null($dir) || !is_writable($dir))
			if(is_null($cachedir_sqlite) || !is_writable($cachedir_sqlite))
				$this->cachedir = $cachedir;
			else
				$this->cachedir = $cachedir_sqlite;
		else
			$this->cachedir = $dir;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getVersion()
	{
		$temp = $this->cacheDB->version();
		return $temp['versionString'];
	}

	/**
	 * {@inheritDoc}
	 */
	public function housekeeping()
	{
		$this->cleanCache('expired');
	}
}

?>


1		<?php
2
3		/**
4		* Simple Machines Forum (SMF)
5		*
6		* @package SMF
7		* @author Simple Machines http://www.simplemachines.org
8		* @copyright 2017 Simple Machines and individual contributors
9		* @license http://www.simplemachines.org/about/smf/license.php BSD
10		*
11		* @version 2.1 Beta 4
12		*/
13
14		if (!defined('SMF'))
15		die('Hacking attempt...');
16
17		/**
18		* SQLite Cache API class
19		* @package cacheAPI
20		*/
21		class sqlite_cache extends cache_api
22		{
23		/**
24		* @var string The path to the current $cachedir directory.
25		*/
26		private $cachedir = null;
27
28		/**
29		* @var SQLite3
30		*/
31		private $cacheDB = null;
32
33		/**
34		* @var int
35		*/
36		private $cacheTime = 0;
37
38		public function __construct()
39		{
40		parent::__construct();
41
42		// Set our default cachedir.
43		$this->setCachedir();
44		}
45
46		/**
47		* {@inheritDoc}
48		*/
49		public function connect()
50		{
51
52		$database = $this->cachedir . '/' . 'SQLite3Cache.db3';
53		$this->cacheDB = new SQLite3($database);
54		$this->cacheDB->busyTimeout(1000);
55		if (filesize($database) == 0)
56		{
57		$this->cacheDB->exec('CREATE TABLE cache (key text unique, value blob, ttl int);');
58		$this->cacheDB->exec('CREATE INDEX ttls ON cache(ttl);');
59		}
60		$this->cacheTime = time();
61
62		}
63
64		/**
65		* {@inheritDoc}
66		*/
67	View Code Duplication	public function isSupported($test = false)
		0 ignored issues – show Duplication introduced 2017-07-31 17:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
68		{
69		$supported = class_exists("SQLite3") && is_writable($this->cachedir);
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report The string literal `SQLite3` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
70
71		if ($test)
72		return $supported;
73
74		return parent::isSupported() && $supported;
75		}
76
77		/**
78		* {@inheritDoc}
79		*/
80		public function getData($key, $ttl = null)
81		{
82		$ttl = time() - $ttl;
83		$query = 'SELECT value FROM cache WHERE key = \'' . $this->cacheDB->escapeString($key) . '\' AND ttl >= ' . $ttl . ' LIMIT 1';
84		$result = $this->cacheDB->query($query);
85
86		$value = null;
87		while ($res = $result->fetchArray(SQLITE3_ASSOC))
88		$value = $res['value'];
89
90		return !empty($value) ? $value : null;
91		}
92
93		/**
94		* {@inheritDoc}
95		*/
96		public function putData($key, $value, $ttl = null)
97		{
98
99		$ttl = $this->cacheTime + $ttl;
100		$query = 'REPLACE INTO cache VALUES (\'' . $this->cacheDB->escapeString($key) . '\', \'' . $this->cacheDB->escapeString($value) . '\', ' . $this->cacheDB->escapeString($ttl) . ');';
101		$result = $this->cacheDB->exec($query);
102
103		return $result;
104		}
105
106		/**
107		* {@inheritDoc}
108		*/
109		public function cleanCache($type = '')
110		{
111		if($type == 'expired')
112		$query = 'DELETE FROM cache WHERE ttl >= ' . time().';';
113		else
114		$query = 'DELETE FROM cache;';
115
116		$result = $this->cacheDB->exec($query);
117
118		$query = 'VACUUM;';
119		$this->cacheDB->exec($query);
120
121		return $result;
122		}
123
124		/**
125		* {@inheritDoc}
126		*/
127	View Code Duplication	public function cacheSettings(array &$config_vars)
		0 ignored issues – show Duplication introduced 2017-07-31 17:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
128		{
129		global $context, $txt;
		0 ignored issues – show Compatibility Best Practice introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
130
131		$config_vars[] = $txt['cache_sqlite_settings'];
132		$config_vars[] = array('cachedir_sqlite', $txt['cachedir_sqlite'], 'file', 'text', 36, 'cache_sqlite_cachedir');
133
134		if (!isset($context['settings_post_javascript']))
135		$context['settings_post_javascript'] = '';
136
137		$context['settings_post_javascript'] .= '
138		$("#cache_accelerator").change(function (e) {
139		var cache_type = e.currentTarget.value;
140		$("#cachedir_sqlite").prop("disabled", cache_type != "sqlite");
141		});';
142		}
143
144		/**
145		* Sets the $cachedir or uses the SMF default $cachedir..
146		*
147		* @access public
148		*
149		* @param string $dir A valid path
		0 ignored issues – show Documentation introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$dir` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
150		*
151		* @return boolean If this was successful or not.
		0 ignored issues – show Documentation introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Should the return type not be `boolean\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
152		*/
153		public function setCachedir($dir = null)
154		{
155		global $cachedir, $cachedir_sqlite;
		0 ignored issues – show Compatibility Best Practice introduced 2017-12-30 17:35 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
156
157		// If its invalid, use SMF's.
158		if (is_null($dir) \|\| !is_writable($dir))
159		if(is_null($cachedir_sqlite) \|\| !is_writable($cachedir_sqlite))
160		$this->cachedir = $cachedir;
161		else
162		$this->cachedir = $cachedir_sqlite;
163		else
164		$this->cachedir = $dir;
165		}
166
167		/**
168		* {@inheritDoc}
169		*/
170		public function getVersion()
171		{
172		$temp = $this->cacheDB->version();
173		return $temp['versionString'];
174		}
175
176		/**
177		* {@inheritDoc}
178		*/
179		public function housekeeping()
180		{
181		$this->cleanCache('expired');
182		}
183		}
184
185		?>
186

SimpleMachines / SMF2.1

Pull Request — release-2.1 (#4447)

sqlite_cache A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like