lib/internal/Magento/Framework/App/PageCache/Version.php - 2.4-develop - githubmirror/magento2

lib/internal/Magento/Framework/App/PageCache/Version.php
102 строки3 KB
Rafal Janicki
Delivery PR fix static tests
22 окт 2024, 14:48
22 окт 2024, 14:4863fdbf0
<?php
/**
 * Copyright 2024 Adobe
 * All Rights Reserved.
 */
declare(strict_types=1);

namespace Magento\Framework\App\PageCache;

use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\Stdlib\CookieManagerInterface;
use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
use Magento\Framework\App\Request\Http;

/**
 * PageCache Version
 *
 * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
 */
class Version
{
    /**
     * Name of cookie that holds private content version
     */
    public const COOKIE_NAME = 'private_content_version';

    /**
     * Ten years cookie period
     */
    public const COOKIE_PERIOD = 315360000;

    /**
     * Config setting for disabling session for GraphQl
     */
    private const XML_PATH_GRAPHQL_DISABLE_SESSION = 'graphql/session/disable';

    /**
     * @param CookieManagerInterface $cookieManager
     * @param CookieMetadataFactory $cookieMetadataFactory
     * @param Http $request
     * @param ScopeConfigInterface $scopeConfig
     */
    public function __construct(
        protected readonly CookieManagerInterface $cookieManager,
        protected readonly CookieMetadataFactory $cookieMetadataFactory,
        protected readonly Http $request,
        protected readonly ScopeConfigInterface $scopeConfig
    ) {
    }

    /**
     * Generate unique version identifier
     *
     * @return string
     */
    protected function generateValue(): string
    {
        //phpcs:ignore
        return md5(rand() . time());
    }

    /**
     * Handle private content version cookie
     * Set cookie if it is not set.
     * Increment version on post requests.
     * In all other cases do nothing.
     *
     * @return void
     */
    public function process(): void
    {
        if (!$this->request->isPost()) {
            return;
        }

        $originalPathInfo = $this->request->getOriginalPathInfo();
        if ($originalPathInfo && str_contains($originalPathInfo, '/graphql') && $this->isSessionDisabled() === true) {
            return;
        }

        $publicCookieMetadata = $this->cookieMetadataFactory->createPublicCookieMetadata()
            ->setDuration(self::COOKIE_PERIOD)
            ->setPath('/')
            ->setSecure($this->request->isSecure())
            ->setHttpOnly(false)
            ->setSameSite('Lax');
        $this->cookieManager->setPublicCookie(self::COOKIE_NAME, $this->generateValue(), $publicCookieMetadata);
    }

    /**
     * Returns configuration setting for disable session for GraphQl
     *
     * @return bool
     */
    private function isSessionDisabled(): bool
    {
        return (bool)$this->scopeConfig->getValue(
            self::XML_PATH_GRAPHQL_DISABLE_SESSION,
            ScopeConfigInterface::SCOPE_TYPE_DEFAULT
        );
    }
}