/usr/share/php/PHP/Depend/Util/Cache/Driver/File/Directory.php is in pdepend 1.1.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | <?php
/**
* This file is part of PHP_Depend.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 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.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Util_Cache_Driver_File
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://pdepend.org/
* @since 0.10.0
*/
/**
* Directory helper for the file system based cache implementation.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Util_Cache_Driver_File
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.1.4
* @link http://pdepend.org/
* @since 0.10.0
*/
class PHP_Depend_Util_Cache_Driver_File_Directory
{
/**
* The current cache version/hash number.
*/
const VERSION = PHP_Depend_Util_Cache_Driver::VERSION;
/**
* The cache root directory.
*
* @var string
*/
protected $cacheDir = null;
/**
* Constructs a new cache directory helper instance.
*
* @param string $cacheDir The cache root directory.
*/
public function __construct($cacheDir)
{
$this->cacheDir = $this->ensureExists($cacheDir);
if (false === $this->isValidVersion()) {
$this->flush();
}
}
/**
* Creates a cache directory for the given cache entry key and returns the
* full qualified path for that cache directory.
*
* @param string $key The cache for an entry.
*
* @return string
*/
public function createCacheDirectory($key)
{
return $this->createOrReturnCacheDirectory($key);
}
/**
* Returns the full qualified path for an existing cache directory or
* creates a new cache directory for the given cache entry key and returns
* the full qualified path for that cache directory.
*
* @param string $key The cache for an entry.
*
* @return string
*/
protected function createOrReturnCacheDirectory($key)
{
$path = $this->getCacheDir() . '/' . substr($key, 0, 2);
if (false === file_exists($path)) {
mkdir($path, 0775, true);
}
return $path;
}
/**
* Ensures that the given <b>$cacheDir</b> really exists.
*
* @param string $cacheDir The cache root directory.
*
* @return string
*/
protected function ensureExists($cacheDir)
{
if (false === file_exists($cacheDir)) {
mkdir($cacheDir, 0775, true);
}
return $cacheDir;
}
/**
* Tests if the current software cache version is similar to the stored
* file system cache version.
*
* @return boolean
*/
protected function isValidVersion()
{
return (self::VERSION === $this->readVersion());
}
/**
* Reads the stored cache version number from the cache root directory.
*
* @return string
*/
protected function readVersion()
{
if (file_exists($this->getVersionFile())) {
return trim(file_get_contents($this->getVersionFile()));
}
return null;
}
/**
* Writes the current software cache version into a file in the cache root
* directory.
*
* @return void
*/
protected function writeVersion()
{
file_put_contents($this->getVersionFile(), self::VERSION);
}
/**
* Returns the file name for the used version file.
*
* @return string
*/
protected function getVersionFile()
{
return $this->getCacheDir() . '/_version';
}
/**
* Returns the cache root directory.
*
* @return string
*/
protected function getCacheDir()
{
return $this->cacheDir;
}
/**
* Flushes all contents below the configured cache root directory and writes
* a version file with the current software version.
*
* @return void
*/
protected function flush()
{
$this->flushDirectory($this->getCacheDir());
$this->writeVersion();
}
/**
* Deletes all files and directories below the given <b>$cacheDir</b>.
*
* @param string $cacheDir A cache directory.
*
* @return void
*/
protected function flushDirectory($cacheDir)
{
foreach (new DirectoryIterator($cacheDir) as $child) {
$this->flushEntry($child);
}
}
/**
* Flushes the cache record for the given file info instance, independent if
* it is a file, directory or symlink.
*
* @param SplFileInfo $file File info object that represents an entity
* within the cache's file system.
*
* @return void
*/
protected function flushEntry(SplFileInfo $file)
{
$path = $file->getRealPath();
if ($file->isDot()) {
return;
} else if ($file->isFile()) {
unlink($path);
} else {
$this->flushDirectory($path);
rmdir($path);
}
}
}
|