vendor/pimcore/pimcore/lib/Cache/FullPage/SessionStatus.php line 49

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Cache\FullPage;
  20. use Pimcore\Event\Cache\FullPage\IgnoredSessionKeysEvent;
  21. use Pimcore\Event\FullPageCacheEvents;
  22. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  23. use Symfony\Component\HttpFoundation\Request;
  25. /**
  26.  * Determines if the full page cache should be disabled due to
  27.  * session (started session containing data).
  28.  */
  29. class SessionStatus
  30. {
  31.     /**
  32.      * @var string
  33.      */
  34.     private $symfonyMetadataStorageKey;
  36.     /**
  37.      * @var EventDispatcherInterface
  38.      */
  39.     private $eventDispatcher;
  41.     public function __construct(
  42.         string $symfonyMetadataStorageKey,
  43.         EventDispatcherInterface $eventDispatcher
  44.     ) {
  45.         $this->symfonyMetadataStorageKey = $symfonyMetadataStorageKey;
  46.         $this->eventDispatcher = $eventDispatcher;
  47.     }
  49.     public function isDisabledBySession(Request $request): bool
  50.     {
  51.         if (!$request->hasSession() || empty($request->getSession()->getId())) {
  52.             return false;
  53.         }
  55.         // we fall back to $_SESSION from here on as the session API does not expose a list of namespaces
  56.         $sessionData = $_SESSION ?? null;
  57.         if (empty($sessionData)) {
  58.             return false;
  59.         }
  61.         if (!is_array($sessionData)) {
  62.             return false;
  63.         }
  65.         // disable full page cache if any session key besides the ignored
  66.         // ones (e.g. symfony metadata, targeting) have data
  67.         $ignoredSessionKeys = $this->getIgnoredSessionKeys();
  69.         foreach ($sessionData as $key => $value) {
  70.             if (!in_array($key, $ignoredSessionKeys) && !empty($value)) {
  71.                 return true;
  72.             }
  73.         }
  75.         return false;
  76.     }
  78.     private function getIgnoredSessionKeys(): array
  79.     {
  80.         $event = new IgnoredSessionKeysEvent([$this->symfonyMetadataStorageKey]);
  82.         $this->eventDispatcher->dispatch(FullPageCacheEvents::IGNORED_SESSION_KEYS, $event);
  84.         return $event->getKeys();
  85.     }
  86. }