paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
paulgoughbooks_old / trunk / system / Cache / Handlers / FileHandler.php
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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Cache\Handlers; use CodeIgniter\Cache\CacheInterface; use CodeIgniter\Cache\Exceptions\CacheException; /** * File system cache handler */ class FileHandler implements CacheInterface { /** * Prefixed to all cache names. * * @var string */ protected $prefix; /** * Where to store cached files on the disk. * * @var string */ protected $path; //-------------------------------------------------------------------- /** * Constructor. * * @param \Config\Cache $config * @throws CacheException */ public function __construct($config) { $path = ! empty($config->storePath) ? $config->storePath : WRITEPATH . 'cache'; if (! is_really_writable($path)) { throw CacheException::forUnableToWrite($path); } $this->prefix = $config->prefix ?: ''; $this->path = rtrim($path, '/') . '/'; } //-------------------------------------------------------------------- /** * Takes care of any handler-specific setup that must be done. */ public function initialize() { // Not to see here... } //-------------------------------------------------------------------- /** * Attempts to fetch an item from the cache store. * * @param string $key Cache item name * * @return mixed */ public function get(string $key) { $key = $this->prefix . $key; $data = $this->getItem($key); return is_array($data) ? $data['data'] : null; } //-------------------------------------------------------------------- /** * Saves an item to the cache store. * * @param string $key Cache item name * @param mixed $value The data to save * @param integer $ttl Time To Live, in seconds (default 60) * * @return mixed */ public function save(string $key, $value, int $ttl = 60) { $key = $this->prefix . $key; $contents = [ 'time' => time(), 'ttl' => $ttl, 'data' => $value, ]; if ($this->writeFile($this->path . $key, serialize($contents))) { chmod($this->path . $key, 0640); return true; } return false; } //-------------------------------------------------------------------- /** * Deletes a specific item from the cache store. * * @param string $key Cache item name * * @return boolean */ public function delete(string $key) { $key = $this->prefix . $key; return is_file($this->path . $key) && unlink($this->path . $key); } //-------------------------------------------------------------------- /** * Performs atomic incrementation of a raw stored value. * * @param string $key Cache ID * @param integer $offset Step/value to increase by * * @return mixed */ public function increment(string $key, int $offset = 1) { $key = $this->prefix . $key; $data = $this->getItem($key); if ($data === false) { $data = [ 'data' => 0, 'ttl' => 60, ]; } elseif (! is_int($data['data'])) { return false; } $new_value = $data['data'] + $offset; return $this->save($key, $new_value, $data['ttl']) ? $new_value : false; } //-------------------------------------------------------------------- /** * Performs atomic decrementation of a raw stored value. * * @param string $key Cache ID * @param integer $offset Step/value to increase by * * @return mixed */ public function decrement(string $key, int $offset = 1) { $key = $this->prefix . $key; $data = $this->getItem($key); if ($data === false) { $data = [ 'data' => 0, 'ttl' => 60, ]; } elseif (! is_int($data['data'])) { return false; } $new_value = $data['data'] - $offset; return $this->save($key, $new_value, $data['ttl']) ? $new_value : false; } //-------------------------------------------------------------------- /** * Will delete all items in the entire cache. * * @return boolean */ public function clean() { return $this->deleteFiles($this->path, false, true); } //-------------------------------------------------------------------- /** * Returns information on the entire cache. * * The information returned and the structure of the data * varies depending on the handler. * * @return mixed */ public function getCacheInfo() { return $this->getDirFileInfo($this->path); } //-------------------------------------------------------------------- /** * Returns detailed information about the specific item in the cache. * * @param string $key Cache item name. * * @return mixed */ public function getMetaData(string $key) { $key = $this->prefix . $key; if (! is_file($this->path . $key)) { return false; } $data = @unserialize(file_get_contents($this->path . $key)); if (is_array($data)) { $mtime = filemtime($this->path . $key); if (! isset($data['ttl'])) { return false; } return [ 'expire' => $mtime + $data['ttl'], 'mtime' => $mtime, 'data' => $data['data'], ]; } return false; } //-------------------------------------------------------------------- /** * Determines if the driver is supported on this system. * * @return boolean */ public function isSupported(): bool { return is_writable($this->path); } //-------------------------------------------------------------------- /** * Does the heavy lifting of actually retrieving the file and * verifying it's age. * * @param string $key * * @return boolean|mixed */ protected function getItem(string $key) { if (! is_file($this->path . $key)) { return false; } $data = unserialize(file_get_contents($this->path . $key)); if ($data['ttl'] > 0 && time() > $data['time'] + $data['ttl']) { // If the file is still there then remove it if (is_file($this->path . $key)) { unlink($this->path . $key); } return false; } return $data; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // SUPPORT METHODS FOR FILES //-------------------------------------------------------------------- /** * Writes a file to disk, or returns false if not successful. * * @param string $path * @param string $data * @param string $mode * * @return boolean */ protected function writeFile($path, $data, $mode = 'wb') { if (($fp = @fopen($path, $mode)) === false) { return false; } flock($fp, LOCK_EX); for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) { if (($result = fwrite($fp, substr($data, $written))) === false) { break; } } flock($fp, LOCK_UN); fclose($fp); return is_int($result); } //-------------------------------------------------------------------- /** * Delete Files * * Deletes all files contained in the supplied directory path. * Files must be writable or owned by the system in order to be deleted. * If the second parameter is set to TRUE, any directories contained * within the supplied base directory will be nuked as well. * * @param string $path File path * @param boolean $del_dir Whether to delete any directories found in the path * @param boolean $htdocs Whether to skip deleting .htaccess and index page files * @param integer $_level Current directory depth level (default: 0; internal use only) * * @return boolean */ protected function deleteFiles(string $path, bool $del_dir = false, bool $htdocs = false, int $_level = 0): bool { // Trim the trailing slash $path = rtrim($path, '/\\'); if (! $current_dir = @opendir($path)) { return false; } while (false !== ($filename = @readdir($current_dir))) { if ($filename !== '.' && $filename !== '..') { if (is_dir($path . DIRECTORY_SEPARATOR . $filename) && $filename[0] !== '.') { $this->deleteFiles($path . DIRECTORY_SEPARATOR . $filename, $del_dir, $htdocs, $_level + 1); } elseif ($htdocs !== true || ! preg_match('/^(\.htaccess|index\.(html|htm|php)|web\.config)$/i', $filename)) { @unlink($path . DIRECTORY_SEPARATOR . $filename); } } } closedir($current_dir); return ($del_dir === true && $_level > 0) ? @rmdir($path) : true; } //-------------------------------------------------------------------- /** * Get Directory File Information * * Reads the specified directory and builds an array containing the filenames, * filesize, dates, and permissions * * Any sub-folders contained within the specified path are read as well. * * @param string $source_dir Path to source * @param boolean $top_level_only Look only at the top level directory specified? * @param boolean $_recursion Internal variable to determine recursion status - do not use in calls * * @return array|false */ protected function getDirFileInfo(string $source_dir, bool $top_level_only = true, bool $_recursion = false) { static $_filedata = []; $relative_path = $source_dir; if ($fp = @opendir($source_dir)) { // reset the array and make sure $source_dir has a trailing slash on the initial call if ($_recursion === false) { $_filedata = []; $source_dir = rtrim(realpath($source_dir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR; } // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast while (false !== ($file = readdir($fp))) { if (is_dir($source_dir . $file) && $file[0] !== '.' && $top_level_only === false) { $this->getDirFileInfo($source_dir . $file . DIRECTORY_SEPARATOR, $top_level_only, true); } elseif ($file[0] !== '.') { $_filedata[$file] = $this->getFileInfo($source_dir . $file); $_filedata[$file]['relative_path'] = $relative_path; } } closedir($fp); return $_filedata; } return false; } //-------------------------------------------------------------------- /** * Get File Info * * Given a file and path, returns the name, path, size, date modified * Second parameter allows you to explicitly declare what information you want returned * Options are: name, server_path, size, date, readable, writable, executable, fileperms * Returns FALSE if the file cannot be found. * * @param string $file Path to file * @param mixed $returned_values Array or comma separated string of information returned * * @return array|false */ protected function getFileInfo(string $file, $returned_values = ['name', 'server_path', 'size', 'date']) { if (! is_file($file)) { return false; } if (is_string($returned_values)) { $returned_values = explode(',', $returned_values); } foreach ($returned_values as $key) { switch ($key) { case 'name': $fileInfo['name'] = basename($file); break; case 'server_path': $fileInfo['server_path'] = $file; break; case 'size': $fileInfo['size'] = filesize($file); break; case 'date': $fileInfo['date'] = filemtime($file); break; case 'readable': $fileInfo['readable'] = is_readable($file); break; case 'writable': $fileInfo['writable'] = is_writable($file); break; case 'executable': $fileInfo['executable'] = is_executable($file); break; case 'fileperms': $fileInfo['fileperms'] = fileperms($file); break; } } return $fileInfo; } //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/Cache/Handlers/FileHandler.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |