Symfony Profiler

<?php
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Cache\Core;
use DeepCopy\TypeMatcher\TypeMatcher;
use Pimcore\Event\CoreCacheEvents;
use Pimcore\Model\Document\Hardlink\Wrapper\WrapperInterface;
use Pimcore\Model\Element\ElementDumpStateInterface;
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Model\Element\Service;
use Pimcore\Model\Version\SetDumpStateFilter;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerInterface;
use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
use Symfony\Component\Cache\CacheItem;
use Symfony\Contracts\EventDispatcher\Event;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* Core pimcore cache handler with logic handling deferred save on shutdown (specialized for internal pimcore use). This
* explicitely does not expose a PSR-6 API but is intended for internal use from Pimcore\Cache or directly. Actual
* cache calls are forwarded to a PSR-6 cache implementation though.
*
* Use Pimcore\Cache static interface, do not use this handler directly
*
* @internal
*/
class CoreCacheHandler implements LoggerAwareInterface
{
use LoggerAwareTrait;
/**
* @var EventDispatcherInterface
*/
protected $dispatcher;
/**
* @var TagAwareAdapterInterface
*/
protected $pool;
/**
* @var WriteLock
*/
protected $writeLock;
/**
* Actually write/load to/from cache?
*
* @var bool
*/
protected $enabled = true;
/**
* Is the cache handled in CLI mode?
*
* @var bool
*/
protected $handleCli = false;
/**
* Contains the items which should be written to the cache on shutdown
*
* @var CacheQueueItem[]
*/
protected $saveQueue = [];
/**
* Tags which were already cleared
*
* @var array
*/
protected $clearedTags = [];
/**
* Items having one of the tags in this list are not saved
*
* @var array
*/
protected $tagsIgnoredOnSave = [];
/**
* Items having one of the tags in this list are not cleared when calling clearTags
*
* @var array
*/
protected $tagsIgnoredOnClear = [];
/**
* Items having tags which are in this array are cleared on shutdown. This is especially for the output-cache.
*
* @var array
*/
protected $tagsClearedOnShutdown = [];
/**
* State variable which is set to true after the cache was cleared - prevent new items being
* written to cache after a clear.
*
* @var bool
*/
protected $cacheCleared = false;
/**
* Tags in this list are shifted to the clearTagsOnShutdown list when scheduled via clearTags. See comment on normalizeClearTags
* method why this exists.
*
* @var array
*/
protected $shutdownTags = ['output'];
/**
* If set to true items are directly written into the cache, and do not get into the queue
*
* @var bool
*/
protected $forceImmediateWrite = false;
/**
* How many items should stored to the cache within one process
*
* @var int
*/
protected $maxWriteToCacheItems = 50;
/**
* @var bool
*/
protected $writeInProgress = false;
/**
* @var \Closure
*/
protected $emptyCacheItemClosure;
/**
* @param TagAwareAdapterInterface $adapter
* @param WriteLock $writeLock
* @param EventDispatcherInterface $dispatcher
*/
public function __construct(TagAwareAdapterInterface $adapter, WriteLock $writeLock, EventDispatcherInterface $dispatcher)
{
$this->pool = $adapter;
$this->dispatcher = $dispatcher;
$this->writeLock = $writeLock;
}
/**
* @internal
*
* @param TagAwareAdapterInterface $pool
*/
public function setPool(TagAwareAdapterInterface $pool): void
{
$this->pool = $pool;
}
/**
* @return WriteLock
*/
public function getWriteLock()
{
return $this->writeLock;
}
/**
* @codeCoverageIgnore
*
* @return LoggerInterface
*/
public function getLogger()
{
return $this->logger;
}
/**
* {@inheritdoc}
*/
public function enable()
{
$this->enabled = true;
$this->dispatchStatusEvent();
return $this;
}
/**
* {@inheritdoc}
*/
public function disable()
{
$this->enabled = false;
$this->dispatchStatusEvent();
return $this;
}
/**
* @return bool
*/
public function isEnabled()
{
return $this->enabled;
}
protected function dispatchStatusEvent()
{
$this->dispatcher->dispatch(new Event(),
$this->isEnabled()
? CoreCacheEvents::ENABLE
: CoreCacheEvents::DISABLE
);
}
/**
* @codeCoverageIgnore
*
* @return bool
*/
public function getHandleCli()
{
return $this->handleCli;
}
/**
* @codeCoverageIgnore
*
* @param bool $handleCli
*
* @return $this
*/
public function setHandleCli($handleCli)
{
$this->handleCli = (bool)$handleCli;
return $this;
}
/**
* @codeCoverageIgnore
*
* @return bool
*/
public function getForceImmediateWrite()
{
return $this->forceImmediateWrite;
}
/**
* @codeCoverageIgnore
*
* @param bool $forceImmediateWrite
*
* @return $this
*/
public function setForceImmediateWrite($forceImmediateWrite)
{
$this->forceImmediateWrite = (bool)$forceImmediateWrite;
return $this;
}
/**
* @param int $maxWriteToCacheItems
*
* @return $this
*/
public function setMaxWriteToCacheItems($maxWriteToCacheItems)
{
$this->maxWriteToCacheItems = (int)$maxWriteToCacheItems;
return $this;
}
/**
* Load data from cache (retrieves data from cache item)
*
* @param string $key
*
* @return mixed
*/
public function load($key)
{
if (!$this->enabled) {
$this->logger->debug('Not loading object {key} from cache (deactivated)', ['key' => $key]);
return false;
}
$item = $this->getItem($key);
if ($item->isHit()) {
$data = $item->get();
if (is_object($data)) {
$data->____pimcore_cache_item__ = $key; // TODO where is this used?
}
return $data;
}
return false;
}
/**
* Get PSR-6 cache item
*
* @param string $key
*
* @return CacheItem
*/
public function getItem($key)
{
$item = $this->pool->getItem($key);
if ($item->isHit()) {
$this->logger->debug('Successfully got data for key {key} from cache', ['key' => $key]);
} else {
$this->logger->debug('Key {key} doesn\'t exist in cache', ['key' => $key]);
}
return $item;
}
/**
* Save data to cache
*
* @param string $key
* @param mixed $data
* @param array $tags
* @param int|\DateInterval|null $lifetime
* @param int|null $priority
* @param bool $force
*
* @return bool
*/
public function save($key, $data, array $tags = [], $lifetime = null, $priority = 0, $force = false)
{
if ($this->writeInProgress) {
return false;
}
CacheItem::validateKey($key);
if (!$this->enabled) {
$this->logger->debug('Not saving object {key} to cache (deactivated)', ['key' => $key]);
return false;
}
if ($this->isCli()) {
if (!$this->handleCli && !$force) {
$this->logger->debug(
'Not saving {key} to cache as process is running in CLI mode (pass force to override or set handleCli to true)',
['key' => $key]
);
return false;
}
}
if ($force || $this->forceImmediateWrite) {
$data = $this->prepareCacheData($data);
if (null === $data) {
// logging is done in prepare method if item could not be created
return false;
}
// add cache tags to item
$tags = $this->prepareCacheTags($key, $data, $tags);
if (null === $tags) {
return false;
}
return $this->storeCacheData($key, $data, $tags, $lifetime, $force);
} else {
$cacheQueueItem = new CacheQueueItem($key, $data, $tags, $lifetime, $priority, $force);
return $this->addToSaveQueue($cacheQueueItem);
}
}
/**
* Add item to save queue, respecting maxWriteToCacheItems setting
*
* @param CacheQueueItem $item
*
* @return bool
*/
protected function addToSaveQueue(CacheQueueItem $item)
{
$data = $this->prepareCacheData($item->getData());
if ($data) {
$this->saveQueue[$item->getKey()] = $item;
if (count($this->saveQueue) > ($this->maxWriteToCacheItems*3)) {
$this->cleanupQueue();
}
return true;
}
return false;
}
/**
* @internal
*/
public function cleanupQueue(): void
{
// order by priority
uasort($this->saveQueue, function (CacheQueueItem $a, CacheQueueItem $b) {
return $b->getPriority() <=> $a->getPriority();
});
// remove overrun
array_splice($this->saveQueue, $this->maxWriteToCacheItems);
}
/**
* Prepare data for cache item and handle items we don't want to save (e.g. hardlinks)
*
* @param mixed $data
*
* @return mixed
*/
protected function prepareCacheData($data)
{
// do not cache hardlink-wrappers
if ($data instanceof WrapperInterface) {
return null;
}
// clean up and prepare models
if ($data instanceof ElementInterface) {
// check for corrupt data
if (!$data->getId()) {
return null;
}
}
return $data;
}
/**
* Create tags for cache item - do this as late as possible as this is potentially expensive (nested items, dependencies)
*
* @param string $key
* @param mixed $data
* @param array $tags
*
* @return null|string[]
*/
protected function prepareCacheTags(string $key, $data, array $tags = [])
{
// clean up and prepare models
if ($data instanceof ElementInterface) {
// get tags for this element
$tags = $data->getCacheTags($tags);
$this->logger->debug(
'Prepared {class} {id} for data cache',
[
'class' => get_class($data),
'id' => $data->getId(),
'tags' => $tags,
]
);
}
// array_values() because the tags from \Element_Interface and some others are associative eg. array("object_123" => "object_123")
$tags = array_values($tags);
$tags = array_unique($tags);
// check if any of our tags is in cleared tags or tags ignored on save lists
foreach ($tags as $tag) {
if (isset($this->clearedTags[$tag])) {
$this->logger->debug('Aborted caching for key {key} because tag {tag} is in the cleared tags list', [
'key' => $key,
'tag' => $tag,
]);
return null;
}
if (in_array($tag, $this->tagsIgnoredOnSave)) {
$this->logger->debug('Aborted caching for key {key} because tag {tag} is in the ignored tags on save list', [
'key' => $key,
'tag' => $tag,
'tags' => $tags,
'tagsIgnoredOnSave' => $this->tagsIgnoredOnSave,
]);
return null;
}
}
return $tags;
}
/**
* @param string $key
* @param mixed $data
* @param array $tags
* @param int|\DateInterval|null $lifetime
* @param bool $force
*
* @return bool
*/
protected function storeCacheData(string $key, $data, array $tags = [], $lifetime = null, $force = false)
{
if ($this->writeInProgress) {
return false;
}
if (!$this->enabled) {
// TODO return true here as the noop (not storing anything) is basically successful?
return false;
}
// don't put anything into the cache, when cache is cleared
if ($this->cacheCleared && !$force) {
return false;
}
$this->writeInProgress = true;
if ($data instanceof ElementInterface) {
// fetch a fresh copy
$type = Service::getElementType($data);
$data = Service::getElementById($type, $data->getId(), ['force' => true]);
if (!$data->__isBasedOnLatestData()) {
$this->logger->warning('Not saving {key} to cache as element is not based on latest data', [
'key' => $key,
]);
$this->writeInProgress = false;
return false;
}
// dump state is used to trigger a full serialized dump in __sleep eg. in Document, AbstractObject
$data->setInDumpState(false);
$context = [
'source' => __METHOD__,
'conversion' => false,
];
$copier = Service::getDeepCopyInstance($data, $context);
$copier->addFilter(new SetDumpStateFilter(false), new \DeepCopy\Matcher\PropertyMatcher(ElementDumpStateInterface::class, ElementDumpStateInterface::DUMP_STATE_PROPERTY_NAME));
$copier->addTypeFilter(
new \DeepCopy\TypeFilter\ReplaceFilter(
function ($currentValue) {
if ($currentValue instanceof CacheMarshallerInterface) {
$marshalledValue = $currentValue->marshalForCache();
return $marshalledValue;
}
return $currentValue;
}
),
new TypeMatcher(CacheMarshallerInterface::class)
);
$data = $copier->copy($data);
}
$item = $this->pool->getItem($key);
$item->set($data);
$item->expiresAfter($lifetime);
$item->tag($tags);
$item->tag($key);
$result = $this->pool->save($item);
if ($result) {
$this->logger->debug('Added entry {key} to cache', ['key' => $item->getKey()]);
} else {
try {
$itemData = $item->get();
if (!is_scalar($itemData)) {
$itemData = serialize($itemData);
}
$itemSizeText = formatBytes(mb_strlen((string) $itemData));
} catch (\Throwable $e) {
$itemSizeText = 'unknown';
}
$this->logger->error(
'Failed to add entry {key} to cache. Item size was {itemSize}',
[
'key' => $item->getKey(),
'itemSize' => $itemSizeText,
]
);
}
$this->writeInProgress = false;
return $result;
}
/**
* Remove a cache item
*
* @param string $key
*
* @return bool
*/
public function remove($key)
{
CacheItem::validateKey($key);
$this->writeLock->lock();
return $this->pool->deleteItem($key);
}
/**
* Empty the cache
*
* @return bool
*/
public function clearAll()
{
$this->writeLock->lock();
$this->logger->info('Clearing the whole cache');
$result = $this->pool->clear();
// immediately acquire the write lock again (force), because the lock is in the cache too
$this->writeLock->lock(true);
// set state to cache cleared - prevents new items being written to cache
$this->cacheCleared = true;
return $result;
}
/**
* @param string $tag
*
* @return bool
*/
public function clearTag($tag)
{
return $this->clearTags([$tag]);
}
/**
* @param string[] $tags
*
* @return bool
*/
public function clearTags(array $tags): bool
{
$this->writeLock->lock();
$originalTags = $tags;
$this->logger->debug(
'Clearing cache tags',
['tags' => $tags]
);
$tags = $this->normalizeClearTags($tags);
if (count($tags) > 0) {
$result = $this->pool->invalidateTags($tags);
$this->addClearedTags($tags);
return $result;
}
$this->logger->warning(
'Could not clear tags as tag list is empty after normalization',
[
'tags' => $tags,
'originalTags' => $originalTags,
]
);
return false;
}
/**
* Clears all tags stored in tagsClearedOnShutdown, this function is executed during Pimcore shutdown
*
* @return bool
*/
public function clearTagsOnShutdown()
{
if (empty($this->tagsClearedOnShutdown)) {
return true;
}
$this->logger->debug('Clearing shutdown cache tags', ['tags' => $this->tagsClearedOnShutdown]);
$result = $this->pool->invalidateTags($this->tagsClearedOnShutdown);
$this->addClearedTags($this->tagsClearedOnShutdown);
$this->tagsClearedOnShutdown = [];
return $result;
}
/**
* Normalize (unique) clear tags and shift special tags to shutdown (e.g. output)
*
* @param array $tags
*
* @return array
*/
protected function normalizeClearTags(array $tags)
{
$blacklist = $this->tagsIgnoredOnClear;
// Shutdown tags are special tags being shifted to shutdown when scheduled to clear via clearTags. Explanation for
// the "output" tag:
// check for the tag output, because items with this tags are only cleared after the process is finished
// the reason is that eg. long running importers will clean the output-cache on every save/update, that's not necessary,
// only cleaning the output-cache on shutdown should be enough
foreach ($this->shutdownTags as $shutdownTag) {
if (in_array($shutdownTag, $tags)) {
$this->addTagClearedOnShutdown($shutdownTag);
$blacklist[] = $shutdownTag;
}
}
// ensure that every tag is unique
$tags = array_unique($tags);
// don't clear tags in ignore array
$tags = array_filter($tags, function ($tag) use ($blacklist) {
return !in_array($tag, $blacklist);
});
return $tags;
}
/**
* Add tag to list of cleared tags (internal use only)
*
* @param string|array $tags
*
* @return $this
*/
protected function addClearedTags($tags)
{
if (!is_array($tags)) {
$tags = [$tags];
}
foreach ($tags as $tag) {
$this->clearedTags[$tag] = true;
}
return $this;
}
/**
* Adds a tag to the shutdown queue, see clearTagsOnShutdown
*
* @internal
*
* @param string $tag
*
* @return $this
*/
public function addTagClearedOnShutdown($tag)
{
$this->writeLock->lock();
$this->tagsClearedOnShutdown[] = $tag;
$this->tagsClearedOnShutdown = array_unique($this->tagsClearedOnShutdown);
return $this;
}
/**
* @internal
*
* @param string $tag
*
* @return $this
*/
public function addTagIgnoredOnSave($tag)
{
$this->tagsIgnoredOnSave[] = $tag;
$this->tagsIgnoredOnSave = array_unique($this->tagsIgnoredOnSave);
return $this;
}
/**
* @internal
*
* @param string $tag
*
* @return $this
*/
public function removeTagIgnoredOnSave($tag)
{
$this->tagsIgnoredOnSave = array_filter($this->tagsIgnoredOnSave, function ($t) use ($tag) {
return $t !== $tag;
});
return $this;
}
/**
* @internal
*
* @param string $tag
*
* @return $this
*/
public function addTagIgnoredOnClear($tag)
{
$this->tagsIgnoredOnClear[] = $tag;
$this->tagsIgnoredOnClear = array_unique($this->tagsIgnoredOnClear);
return $this;
}
/**
* @internal
*
* @param string $tag
*
* @return $this
*/
public function removeTagIgnoredOnClear($tag)
{
$this->tagsIgnoredOnClear = array_filter($this->tagsIgnoredOnClear, function ($t) use ($tag) {
return $t !== $tag;
});
return $this;
}
/**
* @internal
*
* @param array $tags
*
* @return $this
*/
public function removeClearedTags(array $tags)
{
foreach ($tags as $tag) {
unset($this->clearedTags[$tag]);
}
return $this;
}
/**
* Writes save queue to the cache
*
* @internal
*
* @return bool
*/
public function writeSaveQueue()
{
$totalResult = true;
if ($this->writeLock->hasLock()) {
if (count($this->saveQueue) > 0) {
$this->logger->debug(
'Not writing save queue as there\'s an active write lock. Save queue contains {saveQueueCount} items.',
['saveQueueCount' => count($this->saveQueue)]
);
}
return false;
}
$this->cleanupQueue();
$processedKeys = [];
foreach ($this->saveQueue as $queueItem) {
$key = $queueItem->getKey();
// check if key was already processed and don't save it again
if (in_array($key, $processedKeys)) {
$this->logger->warning('Not writing item as key {key} was already processed', ['key' => $key]);
continue;
}
$tags = $this->prepareCacheTags($queueItem->getKey(), $queueItem->getData(), $queueItem->getTags());
if (null === $tags) {
$result = false;
// item shouldn't go to the cache (either because it's tags are ignored or were cleared within this process) -> see $this->prepareCacheTags();
} else {
$result = $this->storeCacheData($queueItem->getKey(), $queueItem->getData(), $tags, $queueItem->getLifetime(), $queueItem->isForce());
}
$processedKeys[] = $key;
$totalResult = $totalResult && $result;
}
// reset
$this->saveQueue = [];
return $totalResult;
}
/**
* Shut down pimcore - write cache entries and clean up
*
* @internal
*
* @param bool $forceWrite
*
* @return $this
*/
public function shutdown($forceWrite = false)
{
// clear tags scheduled for the shutdown
$this->clearTagsOnShutdown();
$doWrite = true;
// writes make only sense for HTTP(S)
// CLI are normally longer running scripts that tend to produce race conditions
// so CLI scripts are not writing to the cache at all
if ($this->isCli()) {
if (!($this->handleCli || $forceWrite)) {
$doWrite = false;
$queueCount = count($this->saveQueue);
if ($queueCount > 0) {
$this->logger->debug(
'Not writing save queue to cache as process is running in CLI mode. Save queue contains {saveQueueCount} items.',
['saveQueueCount' => count($this->saveQueue)]
);
}
}
}
// write collected items to cache backend
if ($doWrite) {
$this->writeSaveQueue();
}
// remove the write lock
$this->writeLock->removeLock();
return $this;
}
/**
* @codeCoverageIgnore
*
* @return bool
*/
protected function isCli()
{
return php_sapi_name() === 'cli';
}
}

vendor/pimcore/pimcore/lib/Cache/Core/CoreCacheHandler.php line 310