Your IP : 216.73.216.86
<?php
namespace Bitrix\Main\Data;
use Bitrix\Main;
use Bitrix\Main\Config;
class CacheEngineFiles implements CacheEngineInterface, CacheEngineStatInterface
{
protected int $written = 0;
protected int $read = 0;
protected string $path = '';
protected bool $useLock = false;
protected string $rootDirectory;
protected static array $lockHandles = [];
/**
* Engine constructor.
* @param array $options Cache options.
*/
public function __construct($options = [])
{
$config = Config\Configuration::getValue('cache');
if (isset($config['use_lock']))
{
$this->useLock = (bool)$config['use_lock'];
}
if (isset($options['actual_data']) && !$this->useLock)
{
$this->useLock = !$options['actual_data'];
}
$this->rootDirectory = $config['root_directory'] ?? Main\Loader::getDocumentRoot();
}
/**
* Returns number of bytes read from disk or false if there was no read operation.
* @return integer
*/
public function getReadBytes(): int
{
return $this->read;
}
/**
* Returns number of bytes written to disk or false if there was no write operation.
* @return integer
*/
public function getWrittenBytes(): int
{
return $this->written;
}
/**
* Returns physical file path after read or write operation.
* @return string
*/
public function getCachePath(): string
{
return $this->path;
}
/**
* Returns true if cache can be read or written.
* @return bool
*/
public function isAvailable(): bool
{
return true;
}
/**
* Deletes physical file. Returns true on success.
* @param string $fileName Absolute physical path.
* @return void
*/
private static function unlink(string $fileName): void
{
if (isset(self::$lockHandles[$fileName]) && self::$lockHandles[$fileName])
{
fclose(self::$lockHandles[$fileName]);
unset(self::$lockHandles[$fileName]);
}
if (file_exists($fileName))
{
@chmod($fileName, BX_FILE_PERMISSIONS);
@unlink($fileName);
}
}
/**
* Adds delayed delete worker agent.
* @return void
*/
private static function addAgent(): void
{
global $APPLICATION;
static $agentAdded = false;
if (!$agentAdded)
{
$agentAdded = true;
$agents = \CAgent::GetList(
['ID' => 'DESC'],
['NAME' => '\\Bitrix\\Main\\Data\\CacheEngineFiles::delayedDelete(%']
);
if (!$agents->Fetch())
{
$res = \CAgent::AddAgent(
'\\Bitrix\\Main\\Data\\CacheEngineFiles::delayedDelete();',
'main', // module
'Y', // period
1 // interval
);
if (!$res)
{
$APPLICATION->ResetException();
}
}
}
}
/**
* Generates very temporary file name by adding some random suffix to the file path.
* Returns empty string on failure.
* @param string $fileName File path within document root.
* @return string
*/
private function randomizeFile(string $fileName): string
{
for ($i = 0; $i < 99; $i++)
{
$suffix = rand(0, 999999);
if (!file_exists($this->rootDirectory . $fileName . $suffix))
{
return $fileName . $suffix;
}
}
return '';
}
/**
* Cleans (removes) cache directory or file.
* @param string $baseDir Base cache directory (usually /bitrix/cache).
* @param string $initDir Directory within base.
* @param string $filename File name.
* @return void
*/
public function clean($baseDir, $initDir = '', $filename = ''): void
{
if (($filename !== false) && ($filename !== ''))
{
static::unlink($this->rootDirectory . $baseDir . $initDir . $filename);
}
else
{
$initDir = trim($initDir, '/');
if ($initDir == '')
{
$sourceDir = $this->rootDirectory . '/' . trim($baseDir, '/');
if (file_exists($sourceDir) && is_dir($sourceDir))
{
$dh = opendir($sourceDir);
if (is_resource($dh))
{
while ($entry = readdir($dh))
{
if (preg_match("/^(\\.|\\.\\.|.*\\.~\\d+)\$/", $entry))
{
continue;
}
if (is_dir($sourceDir . '/' . $entry))
{
$this->clean($baseDir, $entry);
}
elseif (is_file($sourceDir . '/' . $entry))
{
static::unlink($sourceDir . '/' . $entry);
}
}
}
}
}
else
{
$source = '/' . trim($baseDir, '/') . '/' . $initDir;
$source = rtrim($source, '/');
$delayedDelete = false;
if (!preg_match("/^(\\.|\\.\\.|.*\\.~\\d+)\$/", $source) && file_exists($this->rootDirectory . $source))
{
if (is_file($this->rootDirectory . $source))
{
static::unlink($this->rootDirectory . $source);
}
else
{
$target = $this->randomizeFile($source . '.~');
if ($target != '')
{
Main\Data\Internal\CacheTagTable::add([
'SITE_ID' => '*',
'CACHE_SALT' => '*',
'RELATIVE_PATH' => $target,
'TAG' => '*',
]);
if (@rename($this->rootDirectory . $source, $this->rootDirectory . $target))
{
$delayedDelete = true;
}
}
}
}
if ($delayedDelete)
{
static::addAgent();
}
else
{
DeleteDirFilesEx($baseDir . $initDir, $this->rootDirectory);
}
}
}
}
/**
* Tries to put non-blocking exclusive lock on the file.
* Returns true if file not exists, or lock was successfully got.
* @param string $fileName Absolute cache file path.
* @return boolean
*/
protected function lock(string $fileName): bool
{
$wouldBlock = 0;
self::$lockHandles[$fileName] = @fopen($fileName, "r+");
if (self::$lockHandles[$fileName])
{
flock(self::$lockHandles[$fileName], LOCK_EX | LOCK_NB, $wouldBlock);
}
return $wouldBlock !== 1;
}
/**
* Releases the lock obtained by lock method.
* @param string $fileName Absolute cache file path.
* @return void
*/
protected function unlock(string $fileName): void
{
if (!empty(self::$lockHandles[$fileName]))
{
fclose(self::$lockHandles[$fileName]);
unset(self::$lockHandles[$fileName]);
}
}
/**
* Reads cache from the file. Returns true if file exists, not expired, and successfully read.
* @param mixed &$vars Cached result.
* @param string $baseDir Base cache directory (usually /bitrix/cache).
* @param string $initDir Directory within base.
* @param string $filename File name.
* @param integer $ttl Expiration period in seconds.
* @return boolean
*/
public function read(&$vars, $baseDir, $initDir, $filename, $ttl): bool
{
$fn = $this->rootDirectory . '/' . ltrim($baseDir . $initDir, '/') . $filename;
if (!file_exists($fn))
{
return false;
}
$ser_content = '';
$dateexpire = 0;
$datecreate = 0;
$zeroDanger = false;
$handle = null;
if (is_array($vars))
{
$INCLUDE_FROM_CACHE = 'Y';
if (!@include($fn))
{
return false;
}
}
else
{
$handle = fopen($fn, 'rb');
if (!$handle)
{
return false;
}
$datecreate = fread($handle, 2);
if ($datecreate == 'BX')
{
$datecreate = fread($handle, 12);
$dateexpire = fread($handle, 12);
}
else
{
$datecreate .= fread($handle, 10);
}
}
$this->read = @filesize($fn);
$this->path = $fn;
$res = true;
if (intval($datecreate) < (time() - $ttl))
{
if ($this->useLock)
{
if ($this->lock($fn))
{
$res = false;
}
}
else
{
$res = false;
}
}
if ($res)
{
if (is_array($vars))
{
$vars = unserialize($ser_content);
}
else
{
$vars = fread($handle, $this->read);
}
}
if ($handle)
{
fclose($handle);
}
return $res;
}
/**
* Writes cache into the file.
* @param mixed $vars Cached result.
* @param string $baseDir Base cache directory (usually /bitrix/cache).
* @param string $initDir Directory within base.
* @param string $filename File name.
* @param integer $ttl Expiration period in seconds.
* @return void
*/
public function write($vars, $baseDir, $initDir, $filename, $ttl): void
{
static $search = ["\\", "'", "\0"];
static $replace = ["\\\\", "\\'", "'.chr(0).'"];
$ttl = (int) $ttl;
$folder = $this->rootDirectory . '/' . ltrim($baseDir . $initDir, '/');
$fn = $folder . $filename;
$fnTmp = $folder . md5(mt_rand()) . '.tmp';
if (!CheckDirPath($fn))
{
return;
}
if ($handle = fopen($fnTmp, "wb+"))
{
if (is_array($vars))
{
$contents = "<?";
$contents .= "\nif(\$INCLUDE_FROM_CACHE!='Y')return false;";
$contents .= "\n\$datecreate = '" . str_pad(time(), 12, "0", STR_PAD_LEFT) . "';";
$contents .= "\n\$dateexpire = '" . str_pad(time() + intval($ttl), 12, "0", STR_PAD_LEFT) . "';";
$contents .= "\n\$ser_content = '" . str_replace($search, $replace, serialize($vars)) . "';";
$contents .= "\nreturn true;";
$contents .= "\n?>";
}
else
{
$contents = "BX" . str_pad(time(), 12, "0", STR_PAD_LEFT) . str_pad(time() + $ttl, 12, "0", STR_PAD_LEFT);
$contents .= $vars;
}
$this->written = fwrite($handle, $contents);
$this->path = $fn;
$len = strlen($contents);
fclose($handle);
static::unlink($fn);
if ($this->written === $len)
{
rename($fnTmp, $fn);
}
static::unlink($fnTmp);
if ($this->useLock)
{
$this->unlock($fn);
}
}
}
/**
* Returns true if cache file has expired.
* @param string $path Absolute physical path.
* @return boolean
*/
public function isCacheExpired($path): bool
{
if (!file_exists($path))
{
return true;
}
$fileHandler = fopen($path, 'rb');
if ($fileHandler)
{
$header = fread($fileHandler, 150);
fclose($fileHandler);
}
else
{
return true;
}
if (
preg_match("/dateexpire\\s*=\\s*'(\\d+)'/im", $header, $match)
|| preg_match("/^BX\\d{12}(\\d{12})/", $header, $match)
|| preg_match("/^(\\d{12})/", $header, $match)
)
{
if ($match[1] == '' || doubleval($match[1]) < time())
{
return true;
}
}
return false;
}
/**
* Deletes one cache directory. Works no longer than etime.
* @param integer $etime Timestamp when to stop working.
* @param array $ar Record from b_cache_tag.
* @return void
*/
protected static function deleteOneDir(int $etime = 0, array $ar = []): void
{
if (empty($ar))
{
return;
}
$deleteFromQueue = false;
$root = (new static())->rootDirectory;
$dirName = $root . $ar['RELATIVE_PATH'];
if ($ar['RELATIVE_PATH'] != '' && file_exists($dirName))
{
if (is_file($dirName))
{
DeleteDirFilesEx($ar['RELATIVE_PATH'], $root);
$deleteFromQueue = true;
}
else
{
$dir = scandir($dirName);
$counter = count($dir);
foreach ($dir as $file)
{
$counter--;
if ($file != '.' && $file != '..')
{
DeleteDirFilesEx($ar['RELATIVE_PATH'] . '/' . $file, $root);
}
if (time() > $etime)
{
break;
}
}
if ($counter == 0)
{
rmdir($dirName);
$deleteFromQueue = true;
}
}
}
else
{
$deleteFromQueue = true;
}
if ($deleteFromQueue)
{
Main\Data\Internal\CacheTagTable::delete($ar['ID']);
}
}
/**
* Agent function which deletes marked cache directories.
* @param integer $count Desired delete count.
* @return string
*/
public static function delayedDelete($count = 1): string
{
$delta = 10;
$deleted = 0;
$etime = time() + 2;
$count = (int) $count;
if ($count < 1)
{
$count = 1;
}
$tags = Main\Data\Internal\CacheTagTable::query()
->setSelect(['ID', 'RELATIVE_PATH'])
->where('TAG', '*')
->setLimit($count + $delta)
->fetchAll();
foreach ($tags as $item)
{
static::deleteOneDir($etime, $item);
$deleted++;
if (time() > $etime)
{
break;
}
}
if ($deleted > $count)
{
$count = $deleted;
}
elseif ($deleted < $count && $count > 1)
{
$count--;
}
if ($deleted > 0)
{
return "\\Bitrix\\Main\\Data\\CacheEngineFiles::delayedDelete({$count});";
}
else
{
return '';
}
}
}