File::delete() - Code Metrics - fwolf/fwlib - Measure and Improve Code Quality continuously with Scrutinizer

File::delete() A
last analyzed 2019-05-09 15:53 UTC

↳ Parent: File

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0

<?php
namespace Fwlib\Cache\Handler;

use Fwlib\Cache\AbstractHandler;
use Fwlib\Cache\OperateType;
use Fwlib\Util\UtilContainerAwareTrait;

/**
 * Key-value cache system, data store in file
 *
 * Notice: Expired cache file is not deleted automatic.
 *
 * @copyright   Copyright 2010-2015 Fwolf
 * @license     http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
 */
class File extends AbstractHandler
{
    use UtilContainerAwareTrait;


    /**
     * Error in config check
     *
     * @var string[]
     */
    protected $errorMessages = [];


    /**
     * Check if cache is ready for use
     *
     * @return  boolean
     */
    public function checkConfig()
    {
        $pass = true;
        $this->errorMessages = [];

        $dir = $this->getConfig('fileDir');
        if (empty($dir)) {

            $this->errorMessages[] = 'No cache file dir defined';
            $pass = false;

        } else {
            $message = $this->checkFileDirConfig($dir);
            if (!empty($message)) {
                $this->errorMessages[] =
                    'Cache file directory config error: ' . $message;
                $pass = false;
            }
        }

        $rule = $this->getConfig('fileRule');
        if (empty($rule)) {

            $this->errorMessages[] = 'No cache file rule defined';
            $pass = false;

        } else {
            $message = $this->checkFileRuleConfig($rule);
            if (!empty($message)) {
                $this->errorMessages[] =
                    'Cache file rule config error: ' . $message;
                $pass = false;
            }
        }

        return $pass;
    }


    /**
     * Check config/cache store dir valid and writable
     *
     * If error, return error msg, else return empty str.
     *
     * @param   string  $dir
     * @return  string
     */
    protected function checkFileDirConfig($dir)
    {
        $message = '';

        if (!file_exists($dir)) {

            if (false == mkdir($dir, 0755, true)) {

                $message = "Fail to create cache directory \"{$dir}\"";
            }

        } else {
            if (!is_writable($dir)) {
                $message = "Cache directory \"{$dir}\" is not writable.";
            }
        }

        return $message;
    }


    /**
     * Check cache rule exist and valid
     *
     * If error, return error msg, else return empty str.
     *
     * @param   string  $rule
     * @return  string
     */
    protected function checkFileRuleConfig($rule)

    {
        if (2 > strlen($rule)) {
            return('Cache rule is not defined or too short');
        }

        if (0 != (strlen($rule) % 2)) {
            return("Cache rule \"$rule\" may not right");
        }

        return '';
    }


    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        $file = $this->getFilePath($key);

        if (file_exists($file)) {
            $success = unlink($file);
            $this->log(OperateType::DELETE, $key, $success);
        }

        $this->log(OperateType::DELETE, $key, true);

        return $this;
    }


    /**
     * {@inheritdoc}
     *
     * File cache should check lifetime when get, return null when fail.
     */
    public function get($key, $lifetime = null)
    {
        if ($this->isExpired($key, $lifetime)) {
            $this->log(OperateType::GET, $key, false);
            return null;
        }

        // Read from file and parse it.
        $file = $this->getFilePath($key);
        $content = file_get_contents($file);
        $this->log(OperateType::GET, $key, !(false === $content));

        return $content;
    }


    /**
     * {@inheritdoc}
     */
    protected function getDefaultConfigs()
    {
        $configs = parent::getDefaultConfigs();


        // Dir where data file store
        $configs['fileDir'] = '/tmp/cache/';

        /**
         * Cache file store rule
         *
         * Group by every 2-chars, their means:
         * 10   first 2 char of md5 hash, 16 * 16 = 256
         * 11   3-4 char of md5 hash
         * 20   last 2 char of md5 hash
         * 30   first 2 char of key
         * 40   last 2 char of key
         * 5n   crc32, n=0..3, 16 * 16 = 256
         * Join these str with '/', got full path of cache file.
         */
        $configs['fileRule'] = '10';


        return $configs;
    }


    /**
     * @return  string[]
     */
    public function getErrorMessages()
    {
        return $this->errorMessages;
    }


    /**
     * Compute data file name of a key
     *
     * @param   string  $key
     * @return  string
     */
    protected function getFileName($key)
    {
        return substr(md5($key), 0, 8);
    }


    /**
     * Compute data file path of a key
     *
     * @param   string  $key
     * @return  string
     */
    protected function getFilePath($key)
    {
        $path = $this->getConfig('fileDir');

        $rules = str_split($this->getConfig('fileRule'), 2);

        foreach ($rules as $rule) {
            // Path section may be empty
            $pathSection = $this->getFilePathSection($rule, $key);
            if (!empty($pathSection)) {
                $pathSection .= '/';
            }

            $path .= $pathSection;
        }

        $path .= $this->getFileName($key);

        return $path;
    }


    /**
     * Compute path of a key by a single rule section
     *
     * @param   string  $rule
     * @param   string  $key
     * @return  string
     */
    protected function getFilePathSection($rule, $key)
    {
        $len = 2;

        if ($len > strlen($rule)) {
            return '';
        }

        $seed = $key;
        $start = 0;
        $seq = intval($rule{1});
        if (1 == $rule{0}) {
            // md5 from start
            $start = $len * $seq;
            $seed = md5($key);

        } elseif (2 == $rule{0}) {

            // md5 from end
            $start = -1 * $len * ($seq + 1);
            $seed = md5($key);

        } elseif (3 == $rule{0}) {
            // raw from start
            $start = $len * $seq;
            $seed = $key;

        } elseif (4 == $rule{0}) {

            // raw from end
            $start = -1 * $len * ($seq + 1);
            $seed = $key;

        } elseif (5 == $rule{0}) {
            // crc32
            if (3 < $seq) {
                $seq = $seq % 3;
            }
            $start = $len * $seq;
            $seed = hash('crc32', $key);
        }

        return substr($seed, $start, 2);
    }


    /**
     * {@inheritdoc}
     *
     * File cache does not keep lifetime in cache, so it need a lifetime from
     * outside, or use default lifetime config.
     */
    public function isExpired($key, $lifetime = null)
    {
        $file = $this->getFilePath($key);

        // File doesn't exist
        if (!file_exists($file)) {
            return true;
        }

        if (0 == $lifetime) {

            return false;
        }

        $expireTime = $this->computeExpireTime($lifetime, filemtime($file));

        return (time() > $expireTime);
    }


    /**
     * {@inheritdoc}
     */
    public function set($key, $val, $lifetime = null)
    {
        $file = $this->getFilePath($key);

        // Create each level dir if not exists
        $fileSystemUtil = $this->getUtilContainer()->getFileSystem();
        $dir = $fileSystemUtil->getDirName($file);
        if (!file_exists($dir)) {
            mkdir($dir, 0755, true);
        }

        // Finally write file
        $result = file_put_contents($file, $val, LOCK_EX);

        $this->log(OperateType::SET, $key, false !== $result);

        return $this;
    }
}


1		<?php
2		namespace Fwlib\Cache\Handler;
3
4		use Fwlib\Cache\AbstractHandler;
5		use Fwlib\Cache\OperateType;
6		use Fwlib\Util\UtilContainerAwareTrait;
7
8		/**
9		* Key-value cache system, data store in file
10		*
11		* Notice: Expired cache file is not deleted automatic.
12		*
13		* @copyright Copyright 2010-2015 Fwolf
14		* @license http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
15		*/
16		class File extends AbstractHandler
17		{
18		use UtilContainerAwareTrait;
19
20
21		/**
22		* Error in config check
23		*
24		* @var string[]
25		*/
26		protected $errorMessages = [];
27
28
29		/**
30		* Check if cache is ready for use
31		*
32		* @return boolean
33		*/
34		public function checkConfig()
35		{
36		$pass = true;
37		$this->errorMessages = [];
38
39		$dir = $this->getConfig('fileDir');
40	View Code Duplication	if (empty($dir)) {
		0 ignored issues – show Duplication introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
41		$this->errorMessages[] = 'No cache file dir defined';
42		$pass = false;
43
44		} else {
45		$message = $this->checkFileDirConfig($dir);
46		if (!empty($message)) {
47		$this->errorMessages[] =
48		'Cache file directory config error: ' . $message;
49		$pass = false;
50		}
51		}
52
53		$rule = $this->getConfig('fileRule');
54	View Code Duplication	if (empty($rule)) {
		0 ignored issues – show Duplication introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
55		$this->errorMessages[] = 'No cache file rule defined';
56		$pass = false;
57
58		} else {
59		$message = $this->checkFileRuleConfig($rule);
60		if (!empty($message)) {
61		$this->errorMessages[] =
62		'Cache file rule config error: ' . $message;
63		$pass = false;
64		}
65		}
66
67		return $pass;
68		}
69
70
71		/**
72		* Check config/cache store dir valid and writable
73		*
74		* If error, return error msg, else return empty str.
75		*
76		* @param string $dir
77		* @return string
78		*/
79		protected function checkFileDirConfig($dir)
80		{
81		$message = '';
82
83	View Code Duplication	if (!file_exists($dir)) {
		0 ignored issues – show Duplication introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
84		if (false == mkdir($dir, 0755, true)) {
		0 ignored issues – show Coding Style Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
85		$message = "Fail to create cache directory \"{$dir}\"";
86		}
87
88		} else {
89		if (!is_writable($dir)) {
90		$message = "Cache directory \"{$dir}\" is not writable.";
91		}
92		}
93
94		return $message;
95		}
96
97
98		/**
99		* Check cache rule exist and valid
100		*
101		* If error, return error msg, else return empty str.
102		*
103		* @param string $rule
104		* @return string
105		*/
106	View Code Duplication	protected function checkFileRuleConfig($rule)
		0 ignored issues – show Duplication introduced 2018-01-24 08:29 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...
107		{
108		if (2 > strlen($rule)) {
109		return('Cache rule is not defined or too short');
110		}
111
112		if (0 != (strlen($rule) % 2)) {
113		return("Cache rule \"$rule\" may not right");
114		}
115
116		return '';
117		}
118
119
120		/**
121		* {@inheritdoc}
122		*/
123		public function delete($key)
124		{
125		$file = $this->getFilePath($key);
126
127		if (file_exists($file)) {
128		$success = unlink($file);
129		$this->log(OperateType::DELETE, $key, $success);
130		}
131
132		$this->log(OperateType::DELETE, $key, true);
133
134		return $this;
135		}
136
137
138		/**
139		* {@inheritdoc}
140		*
141		* File cache should check lifetime when get, return null when fail.
142		*/
143		public function get($key, $lifetime = null)
144		{
145		if ($this->isExpired($key, $lifetime)) {
146		$this->log(OperateType::GET, $key, false);
147		return null;
148		}
149
150		// Read from file and parse it.
151		$file = $this->getFilePath($key);
152		$content = file_get_contents($file);
153		$this->log(OperateType::GET, $key, !(false === $content));
154
155		return $content;
156		}
157
158
159		/**
160		* {@inheritdoc}
161		*/
162		protected function getDefaultConfigs()
163		{
164		$configs = parent::getDefaultConfigs();
165
166
167		// Dir where data file store
168		$configs['fileDir'] = '/tmp/cache/';
169
170		/**
171		* Cache file store rule
172		*
173		* Group by every 2-chars, their means:
174		* 10 first 2 char of md5 hash, 16 * 16 = 256
175		* 11 3-4 char of md5 hash
176		* 20 last 2 char of md5 hash
177		* 30 first 2 char of key
178		* 40 last 2 char of key
179		* 5n crc32, n=0..3, 16 * 16 = 256
180		* Join these str with '/', got full path of cache file.
181		*/
182		$configs['fileRule'] = '10';
183
184
185		return $configs;
186		}
187
188
189		/**
190		* @return string[]
191		*/
192		public function getErrorMessages()
193		{
194		return $this->errorMessages;
195		}
196
197
198		/**
199		* Compute data file name of a key
200		*
201		* @param string $key
202		* @return string
203		*/
204		protected function getFileName($key)
205		{
206		return substr(md5($key), 0, 8);
207		}
208
209
210		/**
211		* Compute data file path of a key
212		*
213		* @param string $key
214		* @return string
215		*/
216		protected function getFilePath($key)
217		{
218		$path = $this->getConfig('fileDir');
219
220		$rules = str_split($this->getConfig('fileRule'), 2);
221
222		foreach ($rules as $rule) {
223		// Path section may be empty
224		$pathSection = $this->getFilePathSection($rule, $key);
225		if (!empty($pathSection)) {
226		$pathSection .= '/';
227		}
228
229		$path .= $pathSection;
230		}
231
232		$path .= $this->getFileName($key);
233
234		return $path;
235		}
236
237
238		/**
239		* Compute path of a key by a single rule section
240		*
241		* @param string $rule
242		* @param string $key
243		* @return string
244		*/
245		protected function getFilePathSection($rule, $key)
246		{
247		$len = 2;
248
249		if ($len > strlen($rule)) {
250		return '';
251		}
252
253		$seed = $key;
254		$start = 0;
255		$seq = intval($rule{1});
256		if (1 == $rule{0}) {
257		// md5 from start
258		$start = $len * $seq;
259		$seed = md5($key);
260
261	View Code Duplication	} elseif (2 == $rule{0}) {
		0 ignored issues – show Duplication introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
262		// md5 from end
263		$start = -1 * $len * ($seq + 1);
264		$seed = md5($key);
265
266		} elseif (3 == $rule{0}) {
267		// raw from start
268		$start = $len * $seq;
269		$seed = $key;
270
271	View Code Duplication	} elseif (4 == $rule{0}) {
		0 ignored issues – show Duplication introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
272		// raw from end
273		$start = -1 * $len * ($seq + 1);
274		$seed = $key;
275
276		} elseif (5 == $rule{0}) {
277		// crc32
278		if (3 < $seq) {
279		$seq = $seq % 3;
280		}
281		$start = $len * $seq;
282		$seed = hash('crc32', $key);
283		}
284
285		return substr($seed, $start, 2);
286		}
287
288
289		/**
290		* {@inheritdoc}
291		*
292		* File cache does not keep lifetime in cache, so it need a lifetime from
293		* outside, or use default lifetime config.
294		*/
295		public function isExpired($key, $lifetime = null)
296		{
297		$file = $this->getFilePath($key);
298
299		// File doesn't exist
300		if (!file_exists($file)) {
301		return true;
302		}
303
304		if (0 == $lifetime) {
		0 ignored issues – show Bug introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$lifetime` of type `integer\|null` to `0`; this is ambiguous as not only `0 == 0` is true, but `null == 0` is true, too. Consider using a strict comparison `===`. Loading history...
305		return false;
306		}
307
308		$expireTime = $this->computeExpireTime($lifetime, filemtime($file));
309
310		return (time() > $expireTime);
311		}
312
313
314		/**
315		* {@inheritdoc}
316		*/
317		public function set($key, $val, $lifetime = null)
318		{
319		$file = $this->getFilePath($key);
320
321		// Create each level dir if not exists
322		$fileSystemUtil = $this->getUtilContainer()->getFileSystem();
323		$dir = $fileSystemUtil->getDirName($file);
324		if (!file_exists($dir)) {
325		mkdir($dir, 0755, true);
326		}
327
328		// Finally write file
329		$result = file_put_contents($file, $val, LOCK_EX);
330
331		$this->log(OperateType::SET, $key, false !== $result);
332
333		return $this;
334		}
335		}
336

fwolf / fwlib

File::delete() A last analyzed 2019-05-09 15:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

File::delete() A
last analyzed 2019-05-09 15:53 UTC