_FileCache::__construct() - Code Metrics - Inspection of "update php 7" - mikelynn2/blacklistmonitor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc4b44...8707d7 )

by mike

created 2017-05-19 19:34 UTC

_FileCache::__construct() B

↳ Parent: _FileCache

Complexity

Conditions	5
Paths	12

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	12
nc	12
nop	4
dl	0
loc	17
rs	8.8571
c	0
b	0
f	0

<?php

class _FileCache {
	// Create a new FileCache instance.
	// Parameters:
	// $path: The path to the base directory which will be used for the cache.
	// $expirationTimeInSeconds: The expiration time, in seconds, for items added to the
	//     cache.  Any value less than 1 is automatically clamped to 1.
	//     Optional.  Defaults to 30.
	// $cleanInterval: How often to clean expired entries.  On average, expired entries will
	//     be cleaned every $cleanInterval get or set requests.  Any value < 1 will be clamped
	//     to 1.
	//     Optional.  Defaults to 1000.
	// $directoryDepth: The number of directories deep to make the cache.  The directory names
	//     are derived from segments of the sha1 hash of the cache key, working from left to right.
	//     Each segment consists of the next two hexadecimal characters of the sha1 hash of the
	//     cache key.  This must be between 1 and 10, inclusive.
	//     Optional.  Defaults to 2.
	public function __construct(
		$path = '',
		$expirationTimeInSeconds = 30,
		$cleanInterval = 2000,
		$directoryDepth = 2) {

		$this->path = '/tmp/_FileCache_/'.(string)$path;
class MyClass { }

$x = new MyClass();
$x->foo = true;

		if ($expirationTimeInSeconds < 1) $expirationTimeInSeconds = 1;
		$this->expirationTimeInSeconds = (int)$expirationTimeInSeconds;
class MyClass { }

$x = new MyClass();
$x->foo = true;

		if ($cleanInterval < 1) $cleanInterval = 1;
		$this->cleanInterval = (int)$cleanInterval;
class MyClass { }

$x = new MyClass();
$x->foo = true;

		if ($directoryDepth<1) $directoryDepth=1; else if ($directoryDepth>10) $directoryDepth=10;
		$this->directoryDepth = (int)$directoryDepth;
class MyClass { }

$x = new MyClass();
$x->foo = true;
	}

	// Get an object from the cache.
	// Parameters:
	//     $key: The cache key.
	// Returns:
	//     The object which was previously stored, or false if a cache miss occurred.
	public function get($key) {
//return false;
		if (($this->cleanInterval == 1) ||
			(rand(1, $this->cleanInterval) == $this->cleanInterval)) {
			$this->clean();
		}
		$val = false;
		$fn = $this->getCacheFilename($key);
		$exptime = time()-$this->expirationTimeInSeconds;
		$fileData = @file_get_contents($fn);
		if ($fileData!==false && @file_exists($fn) && (@filemtime($fn) > $exptime)) {
			$val = unserialize($fileData);
		}
		return $val;
	}

	// Store an object into the cache.
	// Parameters:
	//     $key: The cache key.
	//     $value: The object to store.
	public function set($key, $value) {
		if (($this->cleanInterval == 1) ||
			(rand(1, $this->cleanInterval) == $this->cleanInterval)) {
			$this->clean();
		}
		$fn = $this->getCacheFilename($key, true);
		$fileData = file_put_contents($fn,serialize($value));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
	}

	// Delete an object from the cache.
	// Parameters:
	//     $key: The cache key.
	public function delete($key) {
		$fn = $this->getCacheFilename($key);

		// Delete the cache file.
		if (@unlink($fn)) {
			// Delete empty subdirectories, all the way up to but excluding the top-level cache dir.
			$refPath = rtrim($this->path, "/\\");
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$dir = rtrim(dirname($fn), "/\\");
			for ($i = 0; $i < $this->directoryDepth; $i++) {
				if (!@rmdir($dir)) break;
				$dir = rtrim(dirname($dir), "/\\");
			}
		}
	}

	// Clean expired entries.
	public function clean() {
		$this->cleanPath($this->path);
	}

	// Clean expired entries from a directory.
	public function cleanPath($path) {
		$exptime = time()-$this->expirationTimeInSeconds;
		foreach (@glob($path.'/*', GLOB_NOSORT) as $fn) {
			if (@is_dir($fn)) {
				$this->cleanPath($fn);
			} else if (@filemtime($fn) <= $exptime) {
				@unlink($fn);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
			}
		}
		if ($path != $this->path) {
			@rmdir($path);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		}
	}

	private function getCacheFilename($key, $autoCreateDirectory = false) {
		$hash = sha1($key);
		$path = $this->path;
		for ($i = 0, $idx = 0; $i < $this->directoryDepth; $i++, $idx += 2) {
			$path .= '/'.substr($hash, $idx, 2);
		}
		if ($autoCreateDirectory) @mkdir($path, 0777, true);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		$path .= '/'.$hash;
		return $path;
	}

	public function fixPermissions($user) {
		$cmd = escapeshellcmd('chown -R '.$user.':'.$user. ' ' . $this->path);
		exec($cmd);
	}


}


1		<?php
2
3		class _FileCache {
4		// Create a new FileCache instance.
5		// Parameters:
6		// $path: The path to the base directory which will be used for the cache.
7		// $expirationTimeInSeconds: The expiration time, in seconds, for items added to the
8		// cache. Any value less than 1 is automatically clamped to 1.
9		// Optional. Defaults to 30.
10		// $cleanInterval: How often to clean expired entries. On average, expired entries will
11		// be cleaned every $cleanInterval get or set requests. Any value < 1 will be clamped
12		// to 1.
13		// Optional. Defaults to 1000.
14		// $directoryDepth: The number of directories deep to make the cache. The directory names
15		// are derived from segments of the sha1 hash of the cache key, working from left to right.
16		// Each segment consists of the next two hexadecimal characters of the sha1 hash of the
17		// cache key. This must be between 1 and 10, inclusive.
18		// Optional. Defaults to 2.
19		public function __construct(
20		$path = '',
21		$expirationTimeInSeconds = 30,
22		$cleanInterval = 2000,
23		$directoryDepth = 2) {
24
25		$this->path = '/tmp/_FileCache_/'.(string)$path;
		0 ignored issues – show Bug introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report The property `path` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26
27		if ($expirationTimeInSeconds < 1) $expirationTimeInSeconds = 1;
28		$this->expirationTimeInSeconds = (int)$expirationTimeInSeconds;
		0 ignored issues – show Bug introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report The property `expirationTimeInSeconds` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
29
30		if ($cleanInterval < 1) $cleanInterval = 1;
31		$this->cleanInterval = (int)$cleanInterval;
		0 ignored issues – show Bug introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report The property `cleanInterval` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
32
33		if ($directoryDepth<1) $directoryDepth=1; else if ($directoryDepth>10) $directoryDepth=10;
34		$this->directoryDepth = (int)$directoryDepth;
		0 ignored issues – show Bug introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report The property `directoryDepth` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
35		}
36
37		// Get an object from the cache.
38		// Parameters:
39		// $key: The cache key.
40		// Returns:
41		// The object which was previously stored, or false if a cache miss occurred.
42		public function get($key) {
43		//return false;
44	View Code Duplication	if (($this->cleanInterval == 1) \|\|
45		(rand(1, $this->cleanInterval) == $this->cleanInterval)) {
46		$this->clean();
47		}
48		$val = false;
49		$fn = $this->getCacheFilename($key);
50		$exptime = time()-$this->expirationTimeInSeconds;
51		$fileData = @file_get_contents($fn);
52		if ($fileData!==false && @file_exists($fn) && (@filemtime($fn) > $exptime)) {
53		$val = unserialize($fileData);
54		}
55		return $val;
56		}
57
58		// Store an object into the cache.
59		// Parameters:
60		// $key: The cache key.
61		// $value: The object to store.
62		public function set($key, $value) {
63	View Code Duplication	if (($this->cleanInterval == 1) \|\|
64		(rand(1, $this->cleanInterval) == $this->cleanInterval)) {
65		$this->clean();
66		}
67		$fn = $this->getCacheFilename($key, true);
68		$fileData = file_put_contents($fn,serialize($value));
		0 ignored issues – show Unused Code introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report `$fileData` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
69		}
70
71		// Delete an object from the cache.
72		// Parameters:
73		// $key: The cache key.
74		public function delete($key) {
75		$fn = $this->getCacheFilename($key);
76
77		// Delete the cache file.
78		if (@unlink($fn)) {
79		// Delete empty subdirectories, all the way up to but excluding the top-level cache dir.
80		$refPath = rtrim($this->path, "/\\");
		0 ignored issues – show Unused Code introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report `$refPath` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
81		$dir = rtrim(dirname($fn), "/\\");
82		for ($i = 0; $i < $this->directoryDepth; $i++) {
83		if (!@rmdir($dir)) break;
84		$dir = rtrim(dirname($dir), "/\\");
85		}
86		}
87		}
88
89		// Clean expired entries.
90		public function clean() {
91		$this->cleanPath($this->path);
92		}
93
94		// Clean expired entries from a directory.
95		public function cleanPath($path) {
96		$exptime = time()-$this->expirationTimeInSeconds;
97		foreach (@glob($path.'/*', GLOB_NOSORT) as $fn) {
98		if (@is_dir($fn)) {
99		$this->cleanPath($fn);
100		} else if (@filemtime($fn) <= $exptime) {
101		@unlink($fn);
		0 ignored issues – show Security Best Practice introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
102		}
103		}
104		if ($path != $this->path) {
105		@rmdir($path);
		0 ignored issues – show Security Best Practice introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
106		}
107		}
108
109		private function getCacheFilename($key, $autoCreateDirectory = false) {
110		$hash = sha1($key);
111		$path = $this->path;
112		for ($i = 0, $idx = 0; $i < $this->directoryDepth; $i++, $idx += 2) {
113		$path .= '/'.substr($hash, $idx, 2);
114		}
115		if ($autoCreateDirectory) @mkdir($path, 0777, true);
		0 ignored issues – show Security Best Practice introduced 2015-11-21 21:56 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
116		$path .= '/'.$hash;
117		return $path;
118		}
119
120		public function fixPermissions($user) {
121		$cmd = escapeshellcmd('chown -R '.$user.':'.$user. ' ' . $this->path);
122		exec($cmd);
123		}
124
125
126		}
127

mikelynn2 / blacklistmonitor

GitHub Access Token became invalid

Push — master ( bc4b44...8707d7 )

_FileCache::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like