FileCache::getIterator() - Code Metrics - Inspection of "Require PHP 7.1" - doctrine/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#220)

by Luís

created 2017-05-20 18:36 UTC

FileCache::getIterator() A

↳ Parent: FileCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0
crap	1

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\Common\Cache;

/**
 * Base file cache driver.
 *
 * @since  2.3
 * @author Fabio B. Silva <[email protected]>
 * @author Tobias Schultze <http://tobion.de>
 */
abstract class FileCache extends CacheProvider
{
    /**
     * The cache directory.
     *
     * @var string
     */
    protected $directory;

    /**
     * The cache file extension.
     *
     * @var string
     */
    private $extension;

    /**
     * @var int
     */
    private $umask;

    /**
     * @var int
     */
    private $directoryStringLength;

    /**
     * @var int
     */
    private $extensionStringLength;

    /**
     * @var bool
     */
    private $isRunningOnWindows;

    /**
     * Constructor.
     *
     * @param string $directory The cache directory.
     * @param string $extension The cache file extension.
     *
     * @throws \InvalidArgumentException
     */
    public function __construct($directory, $extension = '', $umask = 0002)
    {
        // YES, this needs to be *before* createPathIfNeeded()
        if ( ! is_int($umask)) {
            throw new \InvalidArgumentException(sprintf(
                'The umask parameter is required to be integer, was: %s',
                gettype($umask)
            ));
        }
        $this->umask = $umask;

        if ( ! $this->createPathIfNeeded($directory)) {
            throw new \InvalidArgumentException(sprintf(
                'The directory "%s" does not exist and could not be created.',
                $directory
            ));
        }

        if ( ! is_writable($directory)) {
            throw new \InvalidArgumentException(sprintf(
                'The directory "%s" is not writable.',
                $directory
            ));
        }

        // YES, this needs to be *after* createPathIfNeeded()
        $this->directory = realpath($directory);
        $this->extension = (string) $extension;

        $this->directoryStringLength = strlen($this->directory);
        $this->extensionStringLength = strlen($this->extension);
        $this->isRunningOnWindows    = defined('PHP_WINDOWS_VERSION_BUILD');
    }

    /**
     * Gets the cache directory.
     *
     * @return string
     */
    public function getDirectory()
    {
        return $this->directory;
    }

    /**
     * Gets the cache file extension.
     *
     * @return string
     */
    public function getExtension()
    {
        return $this->extension;
    }

    /**
     * @param string $id
     *
     * @return string
     */
    protected function getFilename($id)
    {
        $hash = hash('sha256', $id);

        // This ensures that the filename is unique and that there are no invalid chars in it.
        if (
            '' === $id
            || ((strlen($id) * 2 + $this->extensionStringLength) > 255)
            || ($this->isRunningOnWindows && ($this->directoryStringLength + 4 + strlen($id) * 2 + $this->extensionStringLength) > 258)
        ) {
            // Most filesystems have a limit of 255 chars for each path component. On Windows the the whole path is limited
            // to 260 chars (including terminating null char). Using long UNC ("\\?\" prefix) does not work with the PHP API.
            // And there is a bug in PHP (https://bugs.php.net/bug.php?id=70943) with path lengths of 259.
            // So if the id in hex representation would surpass the limit, we use the hash instead. The prefix prevents
            // collisions between the hash and bin2hex.
            $filename = '_' . $hash;
        } else {
            $filename = bin2hex($id);
        }

        return $this->directory
            . DIRECTORY_SEPARATOR
            . substr($hash, 0, 2)
            . DIRECTORY_SEPARATOR
            . $filename
            . $this->extension;
    }

    /**
     * {@inheritdoc}
     */
    protected function doDelete($id)
    {
        $filename = $this->getFilename($id);

        return @unlink($filename) || ! file_exists($filename);
    }

    /**
     * {@inheritdoc}
     */
    protected function doFlush()
    {
        foreach ($this->getIterator() as $name => $file) {
            if ($file->isDir()) {
                // Remove the intermediate directories which have been created to balance the tree. It only takes effect
                // if the directory is empty. If several caches share the same directory but with different file extensions,
                // the other ones are not removed.
                @rmdir($name);
            } elseif ($this->isFilenameEndingWithExtension($name)) {
                // If an extension is set, only remove files which end with the given extension.
                // If no extension is set, we have no other choice than removing everything.
                @unlink($name);
            }
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    protected function doGetStats()
    {
        $usage = 0;
        foreach ($this->getIterator() as $name => $file) {
            if (! $file->isDir() && $this->isFilenameEndingWithExtension($name)) {
                $usage += $file->getSize();
            }
        }

        $free = disk_free_space($this->directory);

        return [
            Cache::STATS_HITS               => null,
            Cache::STATS_MISSES             => null,
            Cache::STATS_UPTIME             => null,
            Cache::STATS_MEMORY_USAGE       => $usage,
            Cache::STATS_MEMORY_AVAILABLE   => $free,
        ];
    }

    /**
     * Create path if needed.
     *
     * @param string $path
     * @return bool TRUE on success or if path already exists, FALSE if path cannot be created.
     */
    private function createPathIfNeeded(string $path) : bool
    {
        if ( ! is_dir($path)) {
            if (false === @mkdir($path, 0777 & (~$this->umask), true) && !is_dir($path)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Writes a string content to file in an atomic way.
     *
     * @param string $filename Path to the file where to write the data.
     * @param string $content  The content to write
     *
     * @return bool TRUE on success, FALSE if path cannot be created, if path is not writable or an any other error.
     */
    protected function writeFile(string $filename, string $content) : bool
    {
        $filepath = pathinfo($filename, PATHINFO_DIRNAME);

        if ( ! $this->createPathIfNeeded($filepath)) {
            return false;
        }

        if ( ! is_writable($filepath)) {
            return false;
        }

        $tmpFile = tempnam($filepath, 'swap');
        @chmod($tmpFile, 0666 & (~$this->umask));

        if (file_put_contents($tmpFile, $content) !== false) {
            if (@rename($tmpFile, $filename)) {
                return true;
            }

            @unlink($tmpFile);
        }

        return false;
    }

    /**
     * @return \Iterator
     */
    private function getIterator() : \Iterator
    {
        return new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($this->directory, \FilesystemIterator::SKIP_DOTS),
            \RecursiveIteratorIterator::CHILD_FIRST
        );
    }

    /**
     * @param string $name The filename
     *
     * @return bool
     */
    private function isFilenameEndingWithExtension(string $name) : bool
    {
        return '' === $this->extension
            || strrpos($name, $this->extension) === (strlen($name) - $this->extensionStringLength);
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace Doctrine\Common\Cache;
21
22		/**
23		* Base file cache driver.
24		*
25		* @since 2.3
26		* @author Fabio B. Silva <[email protected]>
27		* @author Tobias Schultze <http://tobion.de>
28		*/
29		abstract class FileCache extends CacheProvider
30		{
31		/**
32		* The cache directory.
33		*
34		* @var string
35		*/
36		protected $directory;
37
38		/**
39		* The cache file extension.
40		*
41		* @var string
42		*/
43		private $extension;
44
45		/**
46		* @var int
47		*/
48		private $umask;
49
50		/**
51		* @var int
52		*/
53		private $directoryStringLength;
54
55		/**
56		* @var int
57		*/
58		private $extensionStringLength;
59
60		/**
61		* @var bool
62		*/
63		private $isRunningOnWindows;
64
65		/**
66		* Constructor.
67		*
68		* @param string $directory The cache directory.
69		* @param string $extension The cache file extension.
70		*
71		* @throws \InvalidArgumentException
72		*/
73	166	public function __construct($directory, $extension = '', $umask = 0002)
74		{
75		// YES, this needs to be before createPathIfNeeded()
76	166	if ( ! is_int($umask)) {
77	1	throw new \InvalidArgumentException(sprintf(
78	1	'The umask parameter is required to be integer, was: %s',
79	1	gettype($umask)
80		));
81		}
82	165	$this->umask = $umask;
83
84	165	if ( ! $this->createPathIfNeeded($directory)) {
85		throw new \InvalidArgumentException(sprintf(
86		'The directory "%s" does not exist and could not be created.',
87		$directory
88		));
89		}
90
91	165	if ( ! is_writable($directory)) {
92		throw new \InvalidArgumentException(sprintf(
93		'The directory "%s" is not writable.',
94		$directory
95		));
96		}
97
98		// YES, this needs to be after createPathIfNeeded()
99	165	$this->directory = realpath($directory);
100	165	$this->extension = (string) $extension;
101
102	165	$this->directoryStringLength = strlen($this->directory);
103	165	$this->extensionStringLength = strlen($this->extension);
104	165	$this->isRunningOnWindows = defined('PHP_WINDOWS_VERSION_BUILD');
105	165	}
106
107		/**
108		* Gets the cache directory.
109		*
110		* @return string
111		*/
112	1	public function getDirectory()
113		{
114	1	return $this->directory;
115		}
116
117		/**
118		* Gets the cache file extension.
119		*
120		* @return string
121		*/
122	1	public function getExtension()
123		{
124	1	return $this->extension;
125		}
126
127		/**
128		* @param string $id
129		*
130		* @return string
131		*/
132	162	protected function getFilename($id)
133		{
134	162	$hash = hash('sha256', $id);
135
136		// This ensures that the filename is unique and that there are no invalid chars in it.
137		if (
138	162	'' === $id
139	162	\|\| ((strlen($id) * 2 + $this->extensionStringLength) > 255)
140	162	\|\| ($this->isRunningOnWindows && ($this->directoryStringLength + 4 + strlen($id) * 2 + $this->extensionStringLength) > 258)
141		) {
142		// Most filesystems have a limit of 255 chars for each path component. On Windows the the whole path is limited
143		// to 260 chars (including terminating null char). Using long UNC ("\\?\" prefix) does not work with the PHP API.
144		// And there is a bug in PHP (https://bugs.php.net/bug.php?id=70943) with path lengths of 259.
145		// So if the id in hex representation would surpass the limit, we use the hash instead. The prefix prevents
146		// collisions between the hash and bin2hex.
147	12	$filename = '_' . $hash;
148		} else {
149	160	$filename = bin2hex($id);
150		}
151
152	162	return $this->directory
153	162	. DIRECTORY_SEPARATOR
154	162	. substr($hash, 0, 2)
155	162	. DIRECTORY_SEPARATOR
156	162	. $filename
157	162	. $this->extension;
158		}
159
160		/**
161		* {@inheritdoc}
162		*/
163	88	protected function doDelete($id)
164		{
165	88	$filename = $this->getFilename($id);
166
167	88	return @unlink($filename) \|\| ! file_exists($filename);
168		}
169
170		/**
171		* {@inheritdoc}
172		*/
173	6	protected function doFlush()
174		{
175	6	foreach ($this->getIterator() as $name => $file) {
176	6	if ($file->isDir()) {
177		// Remove the intermediate directories which have been created to balance the tree. It only takes effect
178		// if the directory is empty. If several caches share the same directory but with different file extensions,
179		// the other ones are not removed.
180	6	@rmdir($name);
181	6	} elseif ($this->isFilenameEndingWithExtension($name)) {
182		// If an extension is set, only remove files which end with the given extension.
183		// If no extension is set, we have no other choice than removing everything.
184	6	@unlink($name);
185		}
186		}
187
188	6	return true;
189		}
190
191		/**
192		* {@inheritdoc}
193		*/
194	4	protected function doGetStats()
195		{
196	4	$usage = 0;
197	4	foreach ($this->getIterator() as $name => $file) {
198	2	if (! $file->isDir() && $this->isFilenameEndingWithExtension($name)) {
199	2	$usage += $file->getSize();
200		}
201		}
202
203	4	$free = disk_free_space($this->directory);
204
205		return [
206	4	Cache::STATS_HITS => null,
207	4	Cache::STATS_MISSES => null,
208	4	Cache::STATS_UPTIME => null,
209	4	Cache::STATS_MEMORY_USAGE => $usage,
210	4	Cache::STATS_MEMORY_AVAILABLE => $free,
211		];
212		}
213
214		/**
215		* Create path if needed.
216		*
217		* @param string $path
218		* @return bool TRUE on success or if path already exists, FALSE if path cannot be created.
219		*/
220	165	private function createPathIfNeeded(string $path) : bool
221		{
222	165	if ( ! is_dir($path)) {
223	161	if (false === @mkdir($path, 0777 & (~$this->umask), true) && !is_dir($path)) {
224		return false;
225		}
226		}
227
228	165	return true;
229		}
230
231		/**
232		* Writes a string content to file in an atomic way.
233		*
234		* @param string $filename Path to the file where to write the data.
235		* @param string $content The content to write
236		*
237		* @return bool TRUE on success, FALSE if path cannot be created, if path is not writable or an any other error.
238		*/
239	153	protected function writeFile(string $filename, string $content) : bool
240		{
241	153	$filepath = pathinfo($filename, PATHINFO_DIRNAME);
242
243	153	if ( ! $this->createPathIfNeeded($filepath)) {
244		return false;
245		}
246
247	153	if ( ! is_writable($filepath)) {
248		return false;
249		}
250
251	153	$tmpFile = tempnam($filepath, 'swap');
252	153	@chmod($tmpFile, 0666 & (~$this->umask));
253
254	153	if (file_put_contents($tmpFile, $content) !== false) {
255	153	if (@rename($tmpFile, $filename)) {
256	153	return true;
257		}
258
259		@unlink($tmpFile);
260		}
261
262		return false;
263		}
264
265		/**
266		* @return \Iterator
267		*/
268	10	private function getIterator() : \Iterator
269		{
270	10	return new \RecursiveIteratorIterator(
271	10	new \RecursiveDirectoryIterator($this->directory, \FilesystemIterator::SKIP_DOTS),
272	10	\RecursiveIteratorIterator::CHILD_FIRST
273		);
274		}
275
276		/**
277		* @param string $name The filename
278		*
279		* @return bool
280		*/
281	8	private function isFilenameEndingWithExtension(string $name) : bool
282		{
283	8	return '' === $this->extension
284	8	\|\| strrpos($name, $this->extension) === (strlen($name) - $this->extensionStringLength);
285		}
286		}
287

doctrine / cache

Pull Request — master (#220)

FileCache::getIterator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like