FileCache::getDirectory() - Code Metrics - thecodingmachine/utils.cache.file-cache - Measure and Improve Code Quality continuously with Scrutinizer

FileCache::getDirectory() A
last analyzed 2016-09-22 08:16 UTC

↳ Parent: FileCache

Complexity

Conditions	3
Paths	4

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	4
nop	0

<?php
namespace Mouf\Utils\Cache;
use Mouf\Utils\Log\LogInterface;
use Psr\Log\LoggerInterface;

/**
 * This package contains a cache mechanism that relies on temporary files.
 *
 * IMPORTANT: unless you have a good reason to do otherwise, you should use the PhpFileCache instead of this class.
 *
 * TODO: make a global garbage collector that passes sometimes (like sessions in PHP)
 * 
 */
class FileCache implements CacheInterface {
	
	/**
	 * The default time to live of elements stored in the session (in seconds).
	 * Please note that if the session is flushed, all the elements of the cache will disapear anyway.
	 * If empty, the time to live will be the time of the session. 
	 *
	 * @Property
	 * @var int
	 */
	public $defaultTimeToLive;

	/**
	 * A prefix to be added to all the keys of the cache. Very useful to avoid conflicting name between different instances.
	 *
	 * @var string
	 */
	public $prefix = "";
	
	/**
	 * The logger used to trace the cache activity.
	 * Supports both PSR3 compatible logger and old Mouf logger for compatibility reasons.
	 *
	 * @var LoggerInterface|LogInterface
	 */
	public $log;

	/**
	 * The directory the files are stored in.
	 * If none is specified, they are stored in the "filecache" directory.
	 * The directory must end with a trailing "/".
	 *
	 * @Property
	 * @var string
	 */
	public $cacheDirectory;
		
	/**
	 * Whether the directory is relative to the system temp directory or not.
	 * 
	 * @Property
	 * @var boolean
	 */
	public $relativeToSystemTempDirectory = true;
	
	/**
	 * Returns the cached value for the key passed in parameter.
	 *
	 * @param string $key
	 * @return mixed
	 */
	public function get($key) {
		$filename = $this->getFileName($key);

		if (is_readable($filename)) {
            $fp = fopen($filename, "r");
            if ($fp === false) {//File may have been deleted between is_readable and fopen
                return null;
            }
			flock($fp, LOCK_SH);
            $timeout = fgets($fp);
			
			if ($timeout > time() || $timeout==0) {
				$contents = "";
				while (!feof($fp)) {
				  $contents .= fread($fp, 65536);
				}
				flock($fp, LOCK_UN);
				fclose($fp);
				$value = unserialize($contents);
				//$this->log->trace("Retrieving key '$key' from file cache: value returned:".var_export($value, true));

				if ($this->log) {
					if ($this->log instanceof LoggerInterface) {
						$this->log->info("Retrieving key '{key}' from file cache.", array('key'=>$key));
					} else {
						$this->log->trace("Retrieving key '$key' from file cache.");
					}						
				}
				return $value;
			} else {

				flock($fp, LOCK_UN);
				fclose($fp);
				unlink($filename);
				if ($this->log) {
					if ($this->log instanceof LoggerInterface) {
						$this->log->info("Retrieving key '{key}' from file cache: key outdated, cache miss.", array('key'=>$key));
					} else {
						$this->log->trace("Retrieving key '$key' from file cache: key outdated, cache miss.");
					}
				}
				return null;
			}
		} else {
			if ($this->log) {
				if ($this->log instanceof LoggerInterface) {
					$this->log->info("Retrieving key '{key}' from file cache: cache miss.", array('key'=>$key));
				} else {
					$this->log->trace("Retrieving key '$key' from file cache: cache miss.");
				}
			}
			return null;
		}
	}
	
	/**
	 * Sets the value in the cache.
	 *
	 * @param string $key The key of the value to store
	 * @param mixed $value The value to store
	 * @param float $timeToLive The time to live of the cache, in seconds.
	 */
	public function set($key, $value, $timeToLive = null) {
		$filename = $this->getFileName($key);
		//$this->log->trace("Storing value in cache: key '$key', value '".var_export($value, true)."'");

		if ($this->log) {
			if ($this->log instanceof LoggerInterface) {
				$this->log->info("Storing value in cache: key '{key}'", array('key'=>$key));
			} else {
				$this->log->trace("Storing value in cache: key '$key'");
			}
		}

        $oldUmask = umask(0);
		
		if (!is_writable($filename)) {

			if (!file_exists($this->getDirectory())) {
				mkdir($this->getDirectory(), 0777, true);
			}
		}
		
		if ($timeToLive == null) {

			if (empty($this->defaultTimeToLive)) {
				$timeOut = 0;
			} else {
				$timeOut = time() + $this->defaultTimeToLive;
			}
		} else {
			$timeOut = time() + $timeToLive;
		}
		
		$fp = fopen($filename, "w");
		flock($fp, LOCK_EX);
		fwrite($fp, $timeOut."\n");
		fwrite($fp, serialize($value));
		fflush($fp);
		flock($fp, LOCK_UN);
		fclose($fp);
        // Cache is shared with group, not with the rest of the world.
        chmod($filename, 0660);

        umask($oldUmask);
	}
	
	/**
	 * Removes the object whose key is $key from the cache.
	 *
	 * @param string $key The key of the object
	 */
	public function purge($key) {

		if ($this->log) {
			if ($this->log instanceof LoggerInterface) {
				$this->log->info("Purging key '{key}' from file cache.", array('key'=>$key));
			} else {
				$this->log->trace("Purging key '$key' from file cache.");
			}
		}
		$filename = $this->getFileName($key);
		if (file_exists($filename)) {
			unlink($filename);
		}
	}
	
	/**
	 * Removes all the objects from the cache.
	 *
	 */
	public function purgeAll() {
		if ($this->log) {
			if ($this->log instanceof LoggerInterface) {
				$this->log->info("Purging the whole file cache.");
			} else {
				$this->log->trace("Purging the whole file cache.");
			}
		}
		$files = glob($this->getDirectory()."*");
        if (false !== $files){// some file systems wont distinguish between empty match and an error
            $prefixFile = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix);
            foreach ($files as $filename) {
                if (empty($prefixFile) || strpos(basename($filename), $prefixFile) === 0) {
                    unlink($filename);
                }
            }
        }
	}
	
	protected function getDirectory() {

		$dir = "";
		if ($this->relativeToSystemTempDirectory) {
			$dir .= sys_get_temp_dir()."/";
		}
		if (!empty($this->cacheDirectory)) {
			$dir .= $this->cacheDirectory;
		} else {
			$dir .= "filecache/";
		}
		return $dir;
	}

	protected function getFileName($key) {
		// Remove any "/" and ":" from the name, and replace those with "_" ...
		$key = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix.$key);
		
		// Windows full path need to be less than 260 characters. We need to limit the size of the filename
		$fullPath = $this->getDirectory().$key.".cache";
		
		// Approximative value due to NTFS short file names (e.g. PROGRA~1) that get longer when evaluated by Windows
		if (strlen($fullPath)<160) {
			return $fullPath;
		}
		
		$prefix = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix);
		
		// If we go above 160 characters, let's transform the key into a md5
		
		return $this->getDirectory().$prefix.md5($key).'.cache';
	}
}


1		<?php
2		namespace Mouf\Utils\Cache;
3		use Mouf\Utils\Log\LogInterface;
4		use Psr\Log\LoggerInterface;
5
6		/**
7		* This package contains a cache mechanism that relies on temporary files.
8		*
9		* IMPORTANT: unless you have a good reason to do otherwise, you should use the PhpFileCache instead of this class.
10		*
11		* TODO: make a global garbage collector that passes sometimes (like sessions in PHP)
12		*
13		*/
14		class FileCache implements CacheInterface {
15
16		/**
17		* The default time to live of elements stored in the session (in seconds).
18		* Please note that if the session is flushed, all the elements of the cache will disapear anyway.
19		* If empty, the time to live will be the time of the session.
20		*
21		* @Property
22		* @var int
23		*/
24		public $defaultTimeToLive;
25
26		/**
27		* A prefix to be added to all the keys of the cache. Very useful to avoid conflicting name between different instances.
28		*
29		* @var string
30		*/
31		public $prefix = "";
32
33		/**
34		* The logger used to trace the cache activity.
35		* Supports both PSR3 compatible logger and old Mouf logger for compatibility reasons.
36		*
37		* @var LoggerInterface\|LogInterface
38		*/
39		public $log;
40
41		/**
42		* The directory the files are stored in.
43		* If none is specified, they are stored in the "filecache" directory.
44		* The directory must end with a trailing "/".
45		*
46		* @Property
47		* @var string
48		*/
49		public $cacheDirectory;
50
51		/**
52		* Whether the directory is relative to the system temp directory or not.
53		*
54		* @Property
55		* @var boolean
56		*/
57		public $relativeToSystemTempDirectory = true;
58
59		/**
60		* Returns the cached value for the key passed in parameter.
61		*
62		* @param string $key
63		* @return mixed
64		*/
65		public function get($key) {
66		$filename = $this->getFileName($key);
67
68		if (is_readable($filename)) {
69		$fp = fopen($filename, "r");
70		if ($fp === false) {//File may have been deleted between is_readable and fopen
71		return null;
72		}
73		flock($fp, LOCK_SH);
74		$timeout = fgets($fp);
75
76		if ($timeout > time() \|\| $timeout==0) {
77		$contents = "";
78		while (!feof($fp)) {
79		$contents .= fread($fp, 65536);
80		}
81		flock($fp, LOCK_UN);
82		fclose($fp);
83		$value = unserialize($contents);
84		//$this->log->trace("Retrieving key '$key' from file cache: value returned:".var_export($value, true));
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-22 08:16 UTC by Report Bug Copy Issue Report `71%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
85		if ($this->log) {
86		if ($this->log instanceof LoggerInterface) {
87		$this->log->info("Retrieving key '{key}' from file cache.", array('key'=>$key));
88		} else {
89		$this->log->trace("Retrieving key '$key' from file cache.");
90		}
91		}
92		return $value;
93	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2016-09-22 08:16 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...
94		flock($fp, LOCK_UN);
95		fclose($fp);
96		unlink($filename);
97		if ($this->log) {
98		if ($this->log instanceof LoggerInterface) {
99		$this->log->info("Retrieving key '{key}' from file cache: key outdated, cache miss.", array('key'=>$key));
100		} else {
101		$this->log->trace("Retrieving key '$key' from file cache: key outdated, cache miss.");
102		}
103		}
104		return null;
105		}
106		} else {
107		if ($this->log) {
108		if ($this->log instanceof LoggerInterface) {
109		$this->log->info("Retrieving key '{key}' from file cache: cache miss.", array('key'=>$key));
110		} else {
111		$this->log->trace("Retrieving key '$key' from file cache: cache miss.");
112		}
113		}
114		return null;
115		}
116		}
117
118		/**
119		* Sets the value in the cache.
120		*
121		* @param string $key The key of the value to store
122		* @param mixed $value The value to store
123		* @param float $timeToLive The time to live of the cache, in seconds.
124		*/
125		public function set($key, $value, $timeToLive = null) {
126		$filename = $this->getFileName($key);
127		//$this->log->trace("Storing value in cache: key '$key', value '".var_export($value, true)."'");
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-22 08:16 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128		if ($this->log) {
129		if ($this->log instanceof LoggerInterface) {
130		$this->log->info("Storing value in cache: key '{key}'", array('key'=>$key));
131		} else {
132		$this->log->trace("Storing value in cache: key '$key'");
133		}
134		}
135
136		$oldUmask = umask(0);
137
138	View Code Duplication	if (!is_writable($filename)) {
		0 ignored issues – show Duplication introduced 2015-12-31 08:24 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...
139		if (!file_exists($this->getDirectory())) {
140		mkdir($this->getDirectory(), 0777, true);
141		}
142		}
143
144	View Code Duplication	if ($timeToLive == null) {
		0 ignored issues – show Duplication introduced 2015-12-31 08:24 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...
145		if (empty($this->defaultTimeToLive)) {
146		$timeOut = 0;
147		} else {
148		$timeOut = time() + $this->defaultTimeToLive;
149		}
150		} else {
151		$timeOut = time() + $timeToLive;
152		}
153
154		$fp = fopen($filename, "w");
155		flock($fp, LOCK_EX);
156		fwrite($fp, $timeOut."\n");
157		fwrite($fp, serialize($value));
158		fflush($fp);
159		flock($fp, LOCK_UN);
160		fclose($fp);
161		// Cache is shared with group, not with the rest of the world.
162		chmod($filename, 0660);
163
164		umask($oldUmask);
165		}
166
167		/**
168		* Removes the object whose key is $key from the cache.
169		*
170		* @param string $key The key of the object
171		*/
172	View Code Duplication	public function purge($key) {
		0 ignored issues – show Duplication introduced 2015-12-31 08:24 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...
173		if ($this->log) {
174		if ($this->log instanceof LoggerInterface) {
175		$this->log->info("Purging key '{key}' from file cache.", array('key'=>$key));
176		} else {
177		$this->log->trace("Purging key '$key' from file cache.");
178		}
179		}
180		$filename = $this->getFileName($key);
181		if (file_exists($filename)) {
182		unlink($filename);
183		}
184		}
185
186		/**
187		* Removes all the objects from the cache.
188		*
189		*/
190		public function purgeAll() {
191		if ($this->log) {
192		if ($this->log instanceof LoggerInterface) {
193		$this->log->info("Purging the whole file cache.");
194		} else {
195		$this->log->trace("Purging the whole file cache.");
196		}
197		}
198		$files = glob($this->getDirectory()."*");
199		if (false !== $files){// some file systems wont distinguish between empty match and an error
200		$prefixFile = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix);
201		foreach ($files as $filename) {
202		if (empty($prefixFile) \|\| strpos(basename($filename), $prefixFile) === 0) {
203		unlink($filename);
204		}
205		}
206		}
207		}
208
209		protected function getDirectory() {
210
211		$dir = "";
212		if ($this->relativeToSystemTempDirectory) {
213		$dir .= sys_get_temp_dir()."/";
214		}
215		if (!empty($this->cacheDirectory)) {
216		$dir .= $this->cacheDirectory;
217		} else {
218		$dir .= "filecache/";
219		}
220		return $dir;
221		}
222
223		protected function getFileName($key) {
224		// Remove any "/" and ":" from the name, and replace those with "_" ...
225		$key = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix.$key);
226
227		// Windows full path need to be less than 260 characters. We need to limit the size of the filename
228		$fullPath = $this->getDirectory().$key.".cache";
229
230		// Approximative value due to NTFS short file names (e.g. PROGRA~1) that get longer when evaluated by Windows
231		if (strlen($fullPath)<160) {
232		return $fullPath;
233		}
234
235		$prefix = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix);
236
237		// If we go above 160 characters, let's transform the key into a md5
238
239		return $this->getDirectory().$prefix.md5($key).'.cache';
240		}
241		}
242

thecodingmachine / utils.cache.file-cache

FileCache::getDirectory() A last analyzed 2016-09-22 08:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FileCache::getDirectory() A
last analyzed 2016-09-22 08:16 UTC