Skip to content
Snippets Groups Projects
Commit 0bb100a0 authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update ahcache class

parent c7e7cf8d
No related branches found
No related tags found
1 merge request!62V2.0
This commit is part of merge request !62. Comments created here will be created in the context of that merge request.
Show whitespace changes
Inline Side-by-side
public_html/deployment/classes/cache.class.php
+ 806
− 412
View file @ 0bb100a0
<?php <?php
/** /**
* --------------------------------------------------------------------------------<br>
* __ ______ __
* ____ _/ /_ / ____/___ ______/ /_ ___
* / __ `/ __ \/ / / __ `/ ___/ __ \/ _ \
* / /_/ / / / / /___/ /_/ / /__/ / / / __/
* \__,_/_/ /_/\____/\__,_/\___/_/ /_/\___/
*
* --------------------------------------------------------------------------------<br>
* AXELS CACHE CLASS<br> * AXELS CACHE CLASS<br>
* --------------------------------------------------------------------------------<br>
* <br> * <br>
* THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE <br> * THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE <br>
* LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR <br> * LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR <br>
...@@ -25,15 +35,43 @@ ...@@ -25,15 +35,43 @@
* - _cleanup checks with file_exists<br> * - _cleanup checks with file_exists<br>
* 2014-03-31 2.3 - added _setup() that to includes custom settings<br> * 2014-03-31 2.3 - added _setup() that to includes custom settings<br>
* - limit number of files in cache directory<br> * - limit number of files in cache directory<br>
* 2019-11-24 2.4 - added getCachedItems() to get a filtered list of cache files<br>
* - added remove file to make complete cache of a module invalid<br>
* - rename var in cache.class_config.php to "$this->_sCacheDirDivider"<br>
* 2019-11-26 2.5 - added getModules() to get a list of existing modules that stored<br>
* a cached item<br>
* 2021-09-28 2.6 added a simple admin UI; the cache class got a few new methods
* - update: cleanup() now always deletes expired items
* - update: dump() styles output as table
* - added: getCurrentModule
* - added: deleteModule
* - added: loadCachefile
* - added: removefileDelete
* - added: setCacheId
* - added: setModule
* 2021-09-30 2.7 FIX: remove chdir() in _readCacheItem()
* 2021-10-07 2.8 FIX: remove chdir() in _readCacheItem()
* ADD reference file to expire a cache item
* - added: getRefFile
* - added: setRefFile
* - update: dump, isExpired, isNewerThanFile, write
* - update cache admin
* 2023-03-17 2.9 FIX: harden _getAllCacheData to prevent PHP warnings
* 2023-06-02 2.10 shorten code: defaults using ??; short array syntax
* 2023-11-20 2.11 check data subkey before writing
* --------------------------------------------------------------------------------<br>
* compatible to PHP 7 ... 8.2<br>
* --------------------------------------------------------------------------------<br> * --------------------------------------------------------------------------------<br>
* @version 2.3 * @version 2.11
* @author Axel Hahn * @author Axel Hahn
* @link http://www.axel-hahn.de/php_contentcache * @link https://www.axel-hahn.de/docs/ahcache/index.htm
* @license GPL * @license GPL
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL 3.0 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL 3.0
* @package Axels Cache * @package Axels Cache
*/ */
class AhCache { if (!class_exists("AhCache")) {
class AhCache
{
/** /**
* a module name string is used as relative cache path * a module name string is used as relative cache path
...@@ -55,7 +93,6 @@ class AhCache { ...@@ -55,7 +93,6 @@ class AhCache {
* @var string * @var string
*/ */
private $_sCacheDir = ''; private $_sCacheDir = '';
// private $_sCacheDir='/tmp/';
/** /**
* absolute filename of cache file * absolute filename of cache file
...@@ -67,7 +104,7 @@ class AhCache { ...@@ -67,7 +104,7 @@ class AhCache {
* divider to limit count of cachefiles * divider to limit count of cachefiles
* @var type * @var type
*/ */
private $_sCacheDirDevider = false; private $_sCacheDirDivider = false;
/** /**
* fileextension for storing cachefiles (without ".") * fileextension for storing cachefiles (without ".")
...@@ -95,7 +132,22 @@ class AhCache { ...@@ -95,7 +132,22 @@ class AhCache {
* cachedata and file infos of cachefile (returned array of php function stat) * cachedata and file infos of cachefile (returned array of php function stat)
* @var array * @var array
*/ */
private $_aCacheInfos = array(); private $_aCacheInfos = [];
/**
* Full path to a cache remove file for the current module
* @var string
*/
private $_sCacheRemovefile = false;
/**
* Reference file: a cache is outdated if the reference file is newer than
* the cache item.
* TTL can be set in methods setRefFile($sFile) or write($data, $iTtl, $sFile)
* TTL can be read with getRefFile()
* @var string
*/
private $_sRefFile = false;
/* ---------------------------------------------------------------------- /* ----------------------------------------------------------------------
constructor constructor
...@@ -104,22 +156,12 @@ class AhCache { ...@@ -104,22 +156,12 @@ class AhCache {
/** /**
* constructor * constructor
* @param string $sModule name of module or app that uses the cache * @param string $sModule name of module or app that uses the cache
* @param string $sCacheID cache-id (must be uniq for a module; used to generate filename of cachefile) * @param string $sCacheID cache-id (must be uniq within a module; used to generate filename of cachefile)
* @return boolean * @return boolean
*/ */
public function __construct($sModule = ".", $sCacheID = '.') { public function __construct($sModule = ".", $sCacheID = '.')
$this->_setup(); {
if (!$sModule) $this->setModule($sModule, $sCacheID);
die("ERROR: no module was given.<br>");
if (!$sCacheID)
die("ERROR: no id was given.<br>");
$this->sModule = $sModule;
$this->sCacheID = $sCacheID;
$this->_getCacheFilename();
$this->read();
return true; return true;
} }
...@@ -129,13 +171,23 @@ class AhCache { ...@@ -129,13 +171,23 @@ class AhCache {
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* load custom config from cache.class_config.php and set a cache * init
* - load custom config from cache.class_config.php
* - set a cache
* - set remove file (if does not exist)
* directory * directory
*/ */
private function _setup() { private function _setup()
{
if (!$this->sModule) {
die("ERROR: no module was given.<br>");
}
if (!$this->sCacheID) {
die("ERROR: no id was given.<br>");
}
$sCfgfile = "cache.class_config.php"; $sCfgfile = "cache.class_config.php";
if (file_exists(__DIR__ . "/" . $sCfgfile)) { if (file_exists(__DIR__ . "/" . $sCfgfile)) {
include($sCfgfile); include(__DIR__ . "/" . $sCfgfile);
} }
if (!$this->_sCacheDir) { if (!$this->_sCacheDir) {
if (getenv("TEMP")) if (getenv("TEMP"))
...@@ -146,58 +198,15 @@ class AhCache { ...@@ -146,58 +198,15 @@ class AhCache {
$this->_sCacheDir = "."; $this->_sCacheDir = ".";
$this->_sCacheDir .= "/~cache"; $this->_sCacheDir .= "/~cache";
} }
} $this->_sCacheRemovefile = $this->_sCacheDir . '/' . $this->sModule . '/__remove_me_to_make_caches_invalid__';
if (!file_exists($this->_sCacheRemovefile)) {
// ---------------------------------------------------------------------- if (!is_dir($this->_sCacheDir . '/' . $this->sModule)) {
/** if (!mkdir($this->_sCacheDir . '/' . $this->sModule, 0750, true)) {
* recursive cleanup of a given directory; this function is used by die("ERROR: unable to create directory " . $this->_sCacheDir . '/' . $this->sModule);
* public function cleanup()
* @since 2.0
* @param string $sDir full path of a local directory
* @param string $iTS timestamp
* @return true
*/
private function _cleanupDir($sDir, $iTS) {
echo "<ul><li class=\"dir\">DIR: <strong>$sDir</strong><ul>";
if (!file_exists($sDir)) {
echo "\t Directory does not exist - [$sDir]</ul></li></ul>";
return;
}
if (!($d = dir($sDir))) {
echo "\t Cannot open directory - [$sDir]</ul></li></ul>";
return;
}
while ($entry = $d->read()) {
$sEntry = $sDir . "/" . $entry;
if (is_dir($sEntry) && $entry != '.' && $entry != '..') {
$this->_cleanupDir($sEntry, $iTS);
}
if (file_exists($sEntry)) {
$ext = pathinfo($sEntry, PATHINFO_EXTENSION);
$ext = substr($sEntry, strrpos($sEntry, '.') + 1);
$exts = explode(".", $sEntry);
$n = count($exts) - 1;
$ext = $exts[$n];
if ($ext == $this->_sCacheExt) {
$aTmp = stat($sEntry);
$iAge = date("U") - $aTmp['mtime'];
if ($aTmp['mtime'] <= $iTS) {
echo "<li class=\"delfile\">delete cachefile: $sEntry ($iAge s)<br>";
unlink($sEntry);
} else {
echo "<li class=\"keepfile\">keep cachefile: $sEntry ($iAge s; " . ($aTmp['mtime'] - $iTS) . " s left)</li>";
}
} }
} }
touch($this->_sCacheRemovefile);
} }
echo "</ul></li></ul>";
// try to delete if it should be empty
@rmdir($sDir);
return true; return true;
} }
...@@ -207,29 +216,53 @@ class AhCache { ...@@ -207,29 +216,53 @@ class AhCache {
* @since 2.0 * @since 2.0
* @return array array with data, file stat * @return array array with data, file stat
*/ */
private function _getAllCacheData() { private function _getAllCacheData()
if (!$this->_sCacheFile) {
if (!$this->_sCacheFile) {
return false; return false;
$this->_aCacheInfos = array(); }
if (file_exists($this->_sCacheFile)) { $this->_aCacheInfos = [];
$aTmp = unserialize(file_get_contents($this->_sCacheFile)); $aTmp = $this->_readCacheItem($this->_sCacheFile);
$this->_aCacheInfos['data'] = $aTmp['data']; if (is_array($aTmp) && count($aTmp)) {
$this->_iTtl = $aTmp['iTtl']; $this->_aCacheInfos['data'] = $aTmp['data'] ?? false;
$this->_tsExpire = $aTmp['tsExpire']; $this->_iTtl = $aTmp['iTtl'] ? $aTmp['iTtl'] : -1;
$this->_tsExpire = $aTmp['tsExpire'] ? $aTmp['tsExpire'] : -1;
$this->_sRefFile = $aTmp['sRefFile'] ?? false;
$this->_aCacheInfos['stat'] = stat($this->_sCacheFile); $this->_aCacheInfos['stat'] = stat($this->_sCacheFile);
// @see loadCachefile: it sets module + id to false
$this->sModule = $this->sModule ? $this->sModule : $aTmp['module'];
$this->sCacheID = $this->sCacheID ? $this->sCacheID : $aTmp['cacheid'];
} }
return $this->_aCacheInfos; return $this->_aCacheInfos;
} }
/**
* read a raw cache item and return it as hash
*
* @param string $sFile filename with full path or relative to cache base path
* @return array|boolean
*/
private function _readCacheItem($sFile)
{
$sFull = file_exists($sFile) ? $sFile : $this->_sCacheDir . '/' . $sFile;
if (file_exists($sFull)) {
return unserialize(file_get_contents($sFull));
}
return false;
}
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* private function _getCacheFilename() - get full filename of cachefile * private function _getCacheFilename() - get full filename of cachefile
* @return string full filename of cachefile * @return string full filename of cachefile
*/ */
private function _getCacheFilename() { private function _getCacheFilename()
{
$sMyFile = md5($this->sCacheID); $sMyFile = md5($this->sCacheID);
if($this->_sCacheDirDevider && $this->_sCacheDirDevider>0){ if ($this->_sCacheDirDivider && $this->_sCacheDirDivider > 0) {
$sMyFile=preg_replace('/([0-9a-f]{'.$this->_sCacheDirDevider.'})/', "$1/", $sMyFile); $sMyFile = preg_replace('/([0-9a-f]{' . $this->_sCacheDirDivider . '})/', "$1/", $sMyFile);
} }
$sMyFile .= "." . $this->_sCacheExt; $sMyFile .= "." . $this->_sCacheExt;
$sMyFile = str_replace("/.", ".", $sMyFile); $sMyFile = str_replace("/.", ".", $sMyFile);
...@@ -240,12 +273,48 @@ class AhCache { ...@@ -240,12 +273,48 @@ class AhCache {
/* ---------------------------------------------------------------------- /* ----------------------------------------------------------------------
public funtions public funtions
---------------------------------------------------------------------- */
/**
* helper function - remove empty cache directories up to module cache dir
*
* @param string $sDir
* @param boolean $bShowOutput flag: show output? default: false (=no output)
* @return void
*/
private function _removeEmptyCacheDir($sDir, $bShowOutput = false)
{
// echo $bShowOutput ? __METHOD__."($sDir)<br>\n" : '';
if ($sDir > $this->_sCacheDir . "/" . $this->sModule) {
echo $bShowOutput ? "REMOVE DIR [$sDir] ... " : '';
if (is_dir($sDir)) {
if (rmdir($sDir)) {
chdir($this->_sCacheDir);
echo $bShowOutput ? "OK<br>\n" : '';
usleep(20000); // 0.02 sec
$this->_removeEmptyCacheDir(dirname($sDir), $bShowOutput);
} else {
echo $bShowOutput ? "failed.<br>\n" : '';
return false;
}
} else {
echo $bShowOutput ? "skip: not a directory.<br>\n" : '';
}
return true;
}
return false;
}
/* ----------------------------------------------------------------------
public funtions
---------------------------------------------------------------------- */ ---------------------------------------------------------------------- */
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* Cleanup cache directory; delete all cachefiles older than n seconds * Cleanup cache directory; It deletes all outdated cache items of current module.
* Other filetypes in the directory won't be touched. * Additionally you can delete all cachefiles older than n seconds (because
* there are cache items that are not based on a TTL).
* Other filetypes in the cache directory won't be touched.
* Empty directories will be deleted. * Empty directories will be deleted.
* *
* Only the directory of the initialized module/ app will be deleted. * Only the directory of the initialized module/ app will be deleted.
...@@ -256,28 +325,163 @@ class AhCache { ...@@ -256,28 +325,163 @@ class AhCache {
* *
* @since 2.0 * @since 2.0
* @param int $iSec max age of cachefile; older cachefiles will be deleted * @param int $iSec max age of cachefile; older cachefiles will be deleted
* @param boolean $bShowOutput flag: show output? default: false (=no output)
* @return true * @return true
*/ */
public function cleanup($iSec = false) { public function cleanup($iSec = false, $bShowOutput = false)
echo date("d.m.y - H:i:s") . " START CLEANUP $this->_sCacheDir/" . $this->sModule . ", $iSec s<br> {
<style> // quick and dirty
.dir{color:#888;} $aFilter = ['lifetimeBelow' => 0];
.delfile{color:#900;} if (!$iSec === false) {
.keepfile{color:#ccc;} $aFilter['ageOlder'] = $iSec;
</style>"; }
$this->_cleanupDir($this->_sCacheDir . "/" . $this->sModule, date("U") - $iSec); $aData = $this->getCachedItems(false, $aFilter);
echo date("d.m.y - H:i:s") . " END CLEANUP <br>"; echo $bShowOutput ? 'CLEANUP ' . count($aData) . " files\n" : '';
if ($aData) {
$aFiles = array_keys($aData);
rsort($aFiles);
foreach (array_keys($aData) as $sFile) {
echo $bShowOutput ? 'DELETE ' . $sFile . "<br>\n" : '';
unlink($sFile);
$this->_removeEmptyCacheDir(dirname($sFile), $bShowOutput);
}
}
return true; return true;
} }
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function delete - delete a single cachefile if it exist * get an array with cached data elements
* @since 2.4
*
* @param string $sDir full path of cache dir; default: false (auto detect cache dir)
* @param array $aFilter filter; valid keys are
* - ageOlder integer return items that are older [n] sec
* - lifetimeBelow integer return items that expire in less [n] sec (or outdated)
* - lifetimeGreater integer return items that expire in more than [n] sec
* - ttlBelow integer return items with ttl less than [n] sec
* - ttlGreater integer return items with ttl more than [n] sec
* no filter returns all cached entries
* @return array
*/
public function getCachedItems($sDir = false, $aFilter = [])
{
$aReturn = [];
$sDir = $sDir ? $sDir : $this->_sCacheDir . "/" . $this->sModule;
if (!file_exists($sDir)) {
// echo "\t Directory does not exist - [$sDir]";
return false;
}
if (!($d = dir($sDir))) {
// echo "\t Cannot open directory - [$sDir]</ul></li></ul>";
return;
}
while ($entry = $d->read()) {
$sEntry = $sDir . "/" . $entry;
if (is_dir($sEntry) && $entry != '.' && $entry != '..') {
$aReturn = array_merge($aReturn, $this->getCachedItems($sEntry, $aFilter));
}
if (file_exists($sEntry)) {
$ext = pathinfo($sEntry, PATHINFO_EXTENSION);
$ext = substr($sEntry, strrpos($sEntry, '.') + 1);
$exts = explode(".", $sEntry);
$n = count($exts) - 1;
$ext = $exts[$n];
if ($ext == $this->_sCacheExt) {
$aData = $this->_readCacheItem($sEntry);
unset($aData['data']);
$aData['_lifetime'] = $aData['tsExpire'] - date('U');
$aData['_age'] = date('U') - filemtime($sEntry);
$aData['_lifetime'] = filemtime($sEntry) > filemtime($this->_sCacheRemovefile) ? $aData['tsExpire'] - date('U') : -1;
$bAdd = false;
if (isset($aFilter['ageOlder']) && ($aData['_age'] > $aFilter['ageOlder'])) {
$bAdd = true;
}
if (isset($aFilter['lifetimeBelow']) && ($aData['_lifetime'] < $aFilter['lifetimeBelow'])) {
$bAdd = true;
}
if (isset($aFilter['lifetimeGreater']) && ($aData['_lifetime'] > $aFilter['lifetimeGreater'])) {
$bAdd = true;
}
if (isset($aFilter['ttlBelow']) && ($aData['iTtl'] < $aFilter['ttlBelow'])) {
$bAdd = true;
}
if (isset($aFilter['ttlGreater']) && ($aData['iTtl'] > $aFilter['ttlGreater'])) {
$bAdd = true;
}
if (!is_array($aFilter) || !count($aFilter)) {
$bAdd = true;
}
if ($bAdd) {
$aReturn[$sEntry] = $aData;
}
}
}
}
return $aReturn;
}
// ----------------------------------------------------------------------
/**
* get currently activated module
* @since 2.6
* @return string
*/
public function getCurrentModule()
{
return $this->sModule;
}
// ----------------------------------------------------------------------
/**
* get current cache id
* @since 2.6
* @return string
*/
public function getCurrentId()
{
return $this->sCacheID;
}
// ----------------------------------------------------------------------
/**
* get a flat array of module names that saved a cache item already
* @since 2.5
*
* @return array
*/
public function getModules()
{
$aReturn = [];
foreach (glob($this->_sCacheDir . '/*') as $sEntry) {
if (is_dir($sEntry)) {
$aReturn[] = basename($sEntry);
}
}
return $aReturn;
}
// ----------------------------------------------------------------------
/**
* delete a single cache item if it exist.
* It returns true if a cache item was deleted. It returns false if it
* does not exist (yet) or the deletion failed.
* @return boolean * @return boolean
*/ */
public function delete() { public function delete()
if (!file_exists($this->_sCacheFile)) {
if (!file_exists($this->_sCacheFile)) {
return false; return false;
}
if (unlink($this->_sCacheFile)) { if (unlink($this->_sCacheFile)) {
$this->_aCacheInfos['data'] = false; $this->_aCacheInfos['data'] = false;
$this->_aCacheInfos['stat'] = false; $this->_aCacheInfos['stat'] = false;
...@@ -285,28 +489,64 @@ class AhCache { ...@@ -285,28 +489,64 @@ class AhCache {
} }
return false; return false;
} }
// ----------------------------------------------------------------------
/**
* delete all existing cached items of the set module
* Remark: this method should be used in an admin interface or cronjob only.
* It makes a recursive filesystem scan and is quite slow.
*
* @since 2.6
* @param boolean $bShowOutput flag: show output? default: false (=no output)
* @return boolean
*/
public function deleteModule($bShowOutput = false)
{
if (!$this->sModule) {
return false;
}
$this->cleanup(0, $bShowOutput);
$this->removefileDelete();
return rmdir($this->_sCacheDir . "/" . $this->sModule);
}
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function dump() - dump variables of cache class * public function dump() - dump variables of cache class
* @return true * @return true
*/ */
public function dump() { public function dump()
echo " {
<hr> $sReturn = '';
<strong>cache->dump()<br></strong> $sReturn .= "<table>
<strong>module: </strong>" . $this->sModule . "<br> <!--<strong>" . __METHOD__ . "()<br></strong>-->
<strong>ID: </strong>" . $this->sCacheID . "<br> <tr><td><strong>module: </strong></td><td>" . $this->sModule . "</td></tr>
<strong>filename: </strong>" . $this->_sCacheFile; <tr><td><strong>ID: </strong></td><td>" . $this->sCacheID . "</td></tr>
if (!file_exists($this->_sCacheFile)) <tr><td><strong>filename: </strong></td><td>" . $this->_sCacheFile . "</td></tr>
echo " (does not exist yet)"; ";
echo "<br> if (file_exists($this->_sCacheFile)) {
<strong>age: </strong>" . $this->getAge() . " s<br> $sReturn .= "
<strong>ttl: </strong>" . $this->getTtl() . " s<br> <tr><td><strong>size: </strong></td><td>" . filesize($this->_sCacheFile) . " byte</td></tr>
<strong>expires: </strong>" . $this->getExpire() . " (" . date("d.m.y - H:i:s", $this->getExpire()) . ")<br> <tr><td><strong>created: </strong></td><td>" . filemtime($this->_sCacheFile) . " (" . date("d.m.y - H:i:s", filemtime($this->_sCacheFile)) . ")</td></tr>
<tr><td><strong>ttl: </strong></td><td>" . $this->getTtl() . " s</td></tr>
" . ($this->getTtl() < 0
? ''
: "<tr><td><strong>expires: </strong></td><td>" . $this->getExpire() . " (" . date("d.m.y - H:i:s", $this->getExpire()) . ") "
. ($this->iExpired() > 0 ? '<span class="outdated">' . $this->iExpired() . ' s EXPIRED</span>' : ' ... <span class="ok">' . -$this->iExpired() . " s left") . "</td></tr>"
)
. "<tr><td><strong>age: </strong></td><td>" . $this->getAge() . " s</td></tr>"
. "<tr><td><strong>reference file: </strong></td><td>" . ($this->getRefFile() ? $this->getRefFile() : 'NONE') . " </td></tr>"
. "<br>
</table>
<strong>data in the cache:</strong>
<pre>"; <pre>";
print_r($this->_aCacheInfos); $sReturn .= htmlentities(print_r($this->_aCacheInfos, 1));
echo "</pre><hr>"; $sReturn .= "</pre><hr>";
} else {
$sReturn .= "</table>Cache file does not exist (yet).<br>
Maybe the _sDivider was changed in another cache instance.<br>
";
}
echo $sReturn;
return true; return true;
} }
...@@ -315,11 +555,14 @@ class AhCache { ...@@ -315,11 +555,14 @@ class AhCache {
* public function getCacheAge() - get age in seconds of exisiting cachefile * public function getCacheAge() - get age in seconds of exisiting cachefile
* @return int age in seconds; -1 if cachefiles does not exist * @return int age in seconds; -1 if cachefiles does not exist
*/ */
public function getAge() { public function getAge()
if (!isset($this->_aCacheInfos['stat'])) {
if (!isset($this->_aCacheInfos['stat'])) {
$this->_getAllCacheData(); $this->_getAllCacheData();
if (!isset($this->_aCacheInfos['stat'])) }
if (!isset($this->_aCacheInfos['stat'])) {
return -1; return -1;
}
return date("U") - $this->_aCacheInfos['stat']['mtime']; return date("U") - $this->_aCacheInfos['stat']['mtime'];
} }
...@@ -329,32 +572,64 @@ class AhCache { ...@@ -329,32 +572,64 @@ class AhCache {
* @since 2.0 * @since 2.0
* @return int unix ts of cache expiration * @return int unix ts of cache expiration
*/ */
public function getExpire() { public function getExpire()
{
return $this->_tsExpire; return $this->_tsExpire;
} }
// ----------------------------------------------------------------------
/**
* public function getRefFile() - get reference file that invalidates the
* cache item
* @since 2.8
* @return int get ttl of cache
*/
public function getRefFile()
{
return $this->_sRefFile;
}
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function getTtl() - get TTL of cache in seconds * public function getTtl() - get TTL of cache in seconds
* @since 2.0 * @since 2.0
* @return int get ttl of cache * @return int get ttl of cache
*/ */
public function getTtl() { public function getTtl()
{
return $this->_iTtl; return $this->_iTtl;
} }
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function isExpired() - cache expired? To check it * public function isExpired() - cache expired? To check it
* you must use ttl while writing data, i.e. * you must use ttl while writing data, i.e.
* $oCache->write($sData, $iTtl); * $oCache->write($sData, [$iTtl, [RefFile]]);
* A cache item is expired if
* - the module remove file is newer
* - if a ttl was set: the min. ttl
* @since 2.0 * @since 2.0
* @return bool cache is expired? * @return bool cache is expired?
*/ */
public function isExpired() { public function isExpired()
if (!$this->_tsExpire) {
// cache data already exist? $this->_aCacheInfos is set by constructor
// in the read method
if (!isset($this->_aCacheInfos['data'])) {
return true;
}
// check if remove file was touched
$iAgeOfCache = $this->getAge();
if ($iAgeOfCache > (date("U") - filemtime($this->_sCacheRemovefile))) {
return true;
}
// check if cahe item is expired
if ($this->_tsExpire && (date("U") > $this->_tsExpire)) {
return true; return true;
return ((date("U") - $this->_tsExpire)>0); }
// check timestamp of reference file (if one was set)
return !$this->isNewerThanFile();
} }
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
...@@ -364,9 +639,11 @@ class AhCache { ...@@ -364,9 +639,11 @@ class AhCache {
* @since 2.1 * @since 2.1
* @return int expired time in seconds; negative if cache is not expired * @return int expired time in seconds; negative if cache is not expired
*/ */
public function iExpired() { public function iExpired()
if (!$this->_tsExpire) {
if (!$this->_tsExpire) {
return true; return true;
}
return date("U") - $this->_tsExpire; return date("U") - $this->_tsExpire;
} }
...@@ -379,11 +656,17 @@ class AhCache { ...@@ -379,11 +656,17 @@ class AhCache {
* @param string $sRefFile local filename * @param string $sRefFile local filename
* @return integer time in sec how much the cache file is newer; negative if reference file is newer * @return integer time in sec how much the cache file is newer; negative if reference file is newer
*/ */
public function isNewerThanFile($sRefFile) { public function isNewerThanFile($sRefFile = null)
if (!file_exists($sRefFile)) {
return false; if (is_null($sRefFile)) {
if (!isset($this->_aCacheInfos['stat'])) $sRefFile = $this->_sRefFile;
}
if (!$sRefFile || !file_exists($sRefFile)) {
return true;
}
if (!isset($this->_aCacheInfos['stat'])) {
return false; return false;
}
$aTmp = stat($sRefFile); $aTmp = stat($sRefFile);
$iTimeRef = $aTmp['mtime']; $iTimeRef = $aTmp['mtime'];
...@@ -392,19 +675,73 @@ class AhCache { ...@@ -392,19 +675,73 @@ class AhCache {
return $this->_aCacheInfos['stat']['mtime'] - $iTimeRef; return $this->_aCacheInfos['stat']['mtime'] - $iTimeRef;
} }
// ----------------------------------------------------------------------
/**
* load cache item from a given file - this is like reverse engineering
* by reading data file; needed for a admin interface only
*
* @since 2.6
* @param string $sFile filename with full path
* @return boolean
*/
public function loadCachefile($sFile)
{
$this->_sCacheFile = false;
$this->sModule = false;
$this->sCacheID = false;
if (file_exists($sFile)) {
$this->_sCacheFile = $sFile;
$this->_getAllCacheData();
// reverse engineered _sCacheDirDivider
$sRelfile = str_replace($this->_sCacheDir . "/" . $this->sModule, '', $this->_sCacheFile);
$sTmp = preg_replace('#^\/([0-9a-f]*)([/\.].*)#', '$1', $sRelfile);
$this->_sCacheDirDivider = strlen($sTmp);
return true;
}
return false;
}
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function getCacheData() - read cachedata if it exist * public function getCacheData() - read cachedata if it exist
* @return various cachedata or false if cache does not exist * @return various cachedata or false if cache does not exist
*/ */
public function read() { public function read()
if (!isset($this->_aCacheInfos['data'])) {
if (!isset($this->_aCacheInfos['data'])) {
$this->_getAllCacheData(); $this->_getAllCacheData();
if (!isset($this->_aCacheInfos['data'])) }
if (!isset($this->_aCacheInfos['data'])) {
return false; return false;
}
return $this->_aCacheInfos['data']; return $this->_aCacheInfos['data'];
} }
// ----------------------------------------------------------------------
/**
* delete module based remove file
*
* @since 2.6
* @return boolean
*/
public function removefileDelete()
{
if (file_exists($this->_sCacheRemovefile)) {
return unlink($this->_sCacheRemovefile);
}
return false;
}
// ----------------------------------------------------------------------
/**
* make all cache items invalid by touching the remove file
*
* @since 2.6
* @return boolean
*/
public function removefileTouch()
{
return touch($this->_sCacheRemovefile);
}
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function setData($data) - set cachedata into cache object * public function setData($data) - set cachedata into cache object
...@@ -414,10 +751,54 @@ class AhCache { ...@@ -414,10 +751,54 @@ class AhCache {
* @param various $data data to store in cache * @param various $data data to store in cache
* @return boolean * @return boolean
*/ */
public function setData($data) { public function setData($data)
{
return $this->_aCacheInfos['data'] = $data; return $this->_aCacheInfos['data'] = $data;
} }
/**
* set new cache id; it keeps current module
* @param string $sCacheID cache-id (must be uniq within a module; used to generate filename of cachefile)
* adding the cache id is recommendet, otherwise
* you addiionally need to call setCacheId()
* @return boolean
*/
public function setCacheId($sCacheID)
{
$this->sCacheID = $sCacheID;
$this->_setup();
$this->_getCacheFilename();
$this->read();
return true;
}
/**
* set module
* @param string $sModule name of module or app that uses the cache
* @param string $sCacheID optional: cache-id (must be uniq within a module; used to generate filename of cachefile)
* adding the cache id is recommendet, otherwise
* you addiionally need to call setCacheId()
* @return boolean
*/
public function setModule($sModule, $sCacheID = false)
{
$this->sModule = $sModule;
return $this->setCacheId($sCacheID);
}
// ----------------------------------------------------------------------
/**
* public function setRefFile() - set a reference file that invalidates the
* cache if the file is newer than the stored item
* @since 2.8
* @param int $iTtl ttl value in seconds
* @return int get ttl of cache
*/
public function setRefFile($sFile)
{
return $this->_sRefFile = $sFile;
}
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function setTtl() - set TTL of cache in seconds * public function setTtl() - set TTL of cache in seconds
...@@ -425,28 +806,32 @@ class AhCache { ...@@ -425,28 +806,32 @@ class AhCache {
* Remark: You additionally need to call the write() method to store a new ttl value with * Remark: You additionally need to call the write() method to store a new ttl value with
* data in the filesystem * data in the filesystem
* @since 2.0 * @since 2.0
* @param type $iTtl ttl value in seconds * @param int $iTtl ttl value in seconds
* @return int get ttl of cache * @return int get ttl of cache
*/ */
public function setTtl($iTtl) { public function setTtl($iTtl)
{
return $this->_iTtl = $iTtl; return $this->_iTtl = $iTtl;
} }
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
/** /**
* public function touch() - touch cachefile if it exist * public function touch() - touch cachefile if it exist
* For cachedata with a ttl a new expiration will be set * For cached data a new expiration based on existing ttl will be set
* @return boolean * @return boolean
*/ */
public function touch() { public function touch()
if (!file_exists($this->_sCacheFile)) {
if (!file_exists($this->_sCacheFile)) {
return false; return false;
}
// touch der Datei reicht nicht mehr, weil tsExpire verloren ginge // touch der Datei reicht nicht mehr, weil tsExpire verloren ginge
if (!$this->_iTtl) if (!$this->_iTtl) {
$bReturn = touch($this->_sCacheFile); $bReturn = touch($this->_sCacheFile);
else } else {
$bReturn = $this->write(); $bReturn = $this->write();
}
$this->_getAllCacheData(); $this->_getAllCacheData();
...@@ -459,35 +844,44 @@ class AhCache { ...@@ -459,35 +844,44 @@ class AhCache {
* - data can be any serializable type, like string, array or object * - data can be any serializable type, like string, array or object
* - set ttl in s (from now); optional parameter * - set ttl in s (from now); optional parameter
* @param various $data data to store in cache * @param various $data data to store in cache
* @param int $iTtl time in s if content cache expires (min. 0) * @param int $iTtl optional: time in s if content cache expires (min. 0)
* @param string $sRefFile optional: set a reference file that invalidates the cache if it is newer
* @return bool success of write action * @return bool success of write action
*/ */
public function write($data = false, $iTtl = -1) { public function write($data = false, $iTtl = null, $sRefFile = null)
if (!$this->_sCacheFile) {
if (!$this->_sCacheFile) {
return false; return false;
}
$sDir = dirname($this->_sCacheFile); $sDir = dirname($this->_sCacheFile);
if (!is_dir($sDir)) if (!is_dir($sDir)) {
if (!mkdir($sDir, 0750, true)) if (!mkdir($sDir, 0750, true)) {
die("ERROR: unable to create directory " . $sDir); die("ERROR: unable to create directory " . $sDir);
}
}
if (!$data === false) if (!$data === false) {
$this->setData($data); $this->setData($data);
}
if (!$iTtl >= 0) { if (!is_null($iTtl)) {
$this->setTtl($iTtl); $this->setTtl($iTtl);
} }
if (!is_null($sRefFile)) {
$this->setRefFile($sRefFile);
}
$aTmp = array( $aTmp = [
'iTtl' => $this->_iTtl, 'iTtl' => $this->_iTtl,
'sRefFile' => $this->_sRefFile,
'tsExpire' => date("U") + $this->_iTtl, 'tsExpire' => date("U") + $this->_iTtl,
'module' => $this->sModule, 'module' => $this->sModule,
'cacheid' => $this->sCacheID, 'cacheid' => $this->sCacheID,
'data' => $this->_aCacheInfos['data'], 'data' => isset($this->_aCacheInfos['data']) ? $this->_aCacheInfos['data'] : '',
); ];
return file_put_contents($this->_sCacheFile, serialize($aTmp)); return file_put_contents($this->_sCacheFile, serialize($aTmp));
} }
}
} }
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment