vendor/shopware/core/Framework/Api/Controller/CacheController.php line 55

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Api\Controller;
  5. use Shopware\Core\Framework\Adapter\Cache\CacheClearer;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexerRegistry;
  7. use Shopware\Core\Framework\Log\Package;
  8. use Shopware\Core\Framework\Routing\Annotation\Acl;
  9. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  10. use Shopware\Core\Framework\Routing\Annotation\Since;
  11. use Shopware\Core\Framework\Util\Random;
  12. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  13. use Shopware\Storefront\Framework\Cache\CacheWarmer\CacheWarmer;
  14. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  15. use Symfony\Component\Cache\Adapter\AdapterInterface;
  16. use Symfony\Component\Cache\Adapter\TagAwareAdapter;
  17. use Symfony\Component\Cache\Adapter\TraceableAdapter;
  18. use Symfony\Component\HttpFoundation\JsonResponse;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\Routing\Annotation\Route;
  22. /**
  23.  * @Route(defaults={"_routeScope"={"api"}})
  24.  */
  25. #[Package('system-settings')]
  26. class CacheController extends AbstractController
  27. {
  28.     private CacheClearer $cacheClearer;
  30.     private AdapterInterface $adapter;
  32.     private ?CacheWarmer $cacheWarmer;
  34.     private EntityIndexerRegistry $indexerRegistry;
  36.     /**
  37.      * @internal
  38.      */
  39.     public function __construct(
  40.         CacheClearer $cacheClearer,
  41.         AdapterInterface $adapter,
  42.         ?CacheWarmer $cacheWarmer,
  43.         EntityIndexerRegistry $indexerRegistry
  44.     ) {
  45.         $this->cacheClearer = $cacheClearer;
  46.         $this->adapter = $adapter;
  47.         $this->cacheWarmer = $cacheWarmer;
  48.         $this->indexerRegistry = $indexerRegistry;
  49.     }
  51.     /**
  52.      * @Since("6.2.0.0")
  53.      * @Route("/api/_action/cache_info", name="api.action.cache.info", methods={"GET"}, defaults={"_acl"={"system:cache:info"}})
  54.      */
  55.     public function info(): JsonResponse
  56.     {
  57.         return new JsonResponse([
  58.             'environment' => $this->getParameter('kernel.environment'),
  59.             'httpCache' => $this->container->get('parameter_bag')->has('shopware.http.cache.enabled') && $this->getParameter('shopware.http.cache.enabled'),
  60.             'cacheAdapter' => $this->getUsedCache($this->adapter),
  61.         ]);
  62.     }
  64.     /**
  65.      * @Since("6.2.0.0")
  66.      * @Route("/api/_action/index", name="api.action.cache.index", methods={"POST"}, defaults={"_acl"={"api_action_cache_index"}})
  67.      */
  68.     public function index(RequestDataBag $dataBag): Response
  69.     {
  70.         $data = $dataBag->all();
  71.         $skip = !empty($data['skip']) && \is_array($data['skip']) ? $data['skip'] : [];
  73.         $this->indexerRegistry->sendIndexingMessage([], $skip);
  75.         return new Response('', Response::HTTP_NO_CONTENT);
  76.     }
  78.     /**
  79.      * @Since("6.2.0.0")
  80.      * @Route("/api/_action/cache_warmup", name="api.action.cache.delete_and_warmup", methods={"DELETE"}, defaults={"_acl"={"system:clear:cache"}})
  81.      */
  82.     public function clearCacheAndScheduleWarmUp(): Response
  83.     {
  84.         if ($this->cacheWarmer === null) {
  85.             throw new \RuntimeException('Storefront is not installed');
  86.         }
  88.         $this->cacheWarmer->warmUp(Random::getAlphanumericString(32));
  90.         return new Response('', Response::HTTP_NO_CONTENT);
  91.     }
  93.     /**
  94.      * @Since("6.0.0.0")
  95.      * @Route("/api/_action/cache", name="api.action.cache.delete", methods={"DELETE"}, defaults={"_acl"={"system:clear:cache"}})
  96.      */
  97.     public function clearCache(): Response
  98.     {
  99.         $this->cacheClearer->clear();
  101.         return new Response('', Response::HTTP_NO_CONTENT);
  102.     }
  104.     /**
  105.      * @Since("6.2.0.0")
  106.      * @Route("/api/_action/cleanup", name="api.action.cache.cleanup", methods={"DELETE"}, defaults={"_acl"={"system:clear:cache"}})
  107.      */
  108.     public function clearOldCacheFolders(): Response
  109.     {
  110.         $this->cacheClearer->scheduleCacheFolderCleanup();
  112.         return new Response('', Response::HTTP_NO_CONTENT);
  113.     }
  115.     /**
  116.      * @Since("6.2.0.0")
  117.      * @Route("/api/_action/container_cache", name="api.action.container-cache.delete", methods={"DELETE"}, defaults={"_acl"={"system:clear:cache"}})
  118.      */
  119.     public function clearContainerCache(): Response
  120.     {
  121.         $this->cacheClearer->clearContainerCache();
  123.         return new Response('', Response::HTTP_NO_CONTENT);
  124.     }
  126.     private function getUsedCache(AdapterInterface $adapter): string
  127.     {
  128.         if ($adapter instanceof TagAwareAdapter || $adapter instanceof TraceableAdapter) {
  129.             // Do not declare function as static
  130.             $func = \Closure::bind(function () use ($adapter) {
  131.                 return $adapter->pool;
  132.             }, $adapter, \get_class($adapter));
  134.             $adapter = $func();
  135.         }
  137.         if ($adapter instanceof TraceableAdapter) {
  138.             return $this->getUsedCache($adapter);
  139.         }
  141.         $name = \get_class($adapter);
  142.         \assert(\is_string($name));
  143.         $parts = explode('\\', $name);
  144.         $name = str_replace('Adapter', '', end($parts));
  146.         return $name;
  147.     }
  148. }