StorePathInfoValidator.php

<?php
/**
 * Copyright 2011 Adobe
 * All Rights Reserved.
 */

declare(strict_types=1);

namespace Magento\Store\App\Request;

use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\Request\Http;
use Magento\Framework\App\Request\PathInfo;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
use Magento\Framework\App\Area;
use Magento\Store\Api\StoreRepositoryInterface;
use Magento\Store\Model\Store;
use Magento\Store\Model\StoreIsInactiveException;
use Magento\Store\Model\Validation\StoreCodeValidator;

/**
 * Gets the store from the path if valid
 */
class StorePathInfoValidator implements ResetAfterRequestInterface
{
    /**
     * Store Config
     *
     * @var ScopeConfigInterface
     */
    private $config;

    /**
     * @var StoreRepositoryInterface
     */
    private $storeRepository;

    /**
     * @var PathInfo
     */
    private $pathInfo;

    /**
     * @var StoreCodeValidator
     */
    private $storeCodeValidator;

    /**
     * @var array
     */
    private array $validatedStoreCodes = [];

    /**
     * @param ScopeConfigInterface $config
     * @param StoreRepositoryInterface $storeRepository
     * @param PathInfo $pathInfo
     * @param StoreCodeValidator $storeCodeValidator
     */
    public function __construct(
        ScopeConfigInterface $config,
        StoreRepositoryInterface $storeRepository,
        PathInfo $pathInfo,
        StoreCodeValidator $storeCodeValidator
    ) {
        $this->config = $config;
        $this->storeRepository = $storeRepository;
        $this->pathInfo = $pathInfo;
        $this->storeCodeValidator = $storeCodeValidator;
    }

    /**
     * Get store code from path info validate if config value. If path info is empty the try to calculate from request.
     *
     * @param Http $request
     * @param string $pathInfo
     * @return string|null
     */
    public function getValidStoreCode(Http $request, string $pathInfo = '') : ?string
    {
        $useStoreCodeInUrl = (bool) $this->config->getValue(Store::XML_PATH_STORE_IN_URL);
        if (!$useStoreCodeInUrl) {
            return null;
        }

        if (empty($pathInfo)) {
            $pathInfo = $this->pathInfo->getPathInfo($request->getRequestUri(), $request->getBaseUrl());
        }
        $storeCode = $this->getStoreCode($pathInfo);

        if (
            empty($storeCode)
            || $storeCode === Area::AREA_GRAPHQL
            || $storeCode === Store::ADMIN_CODE
            || !$this->storeCodeValidator->isValid($storeCode)
        ) {
            return null;
        }

        if (array_key_exists($storeCode, $this->validatedStoreCodes)) {
            return $this->validatedStoreCodes[$storeCode];
        }

        try {
            $this->storeRepository->getActiveStoreByCode($storeCode);

            $this->validatedStoreCodes[$storeCode] = $storeCode;
            return $storeCode;
        } catch (NoSuchEntityException $e) {
            $this->validatedStoreCodes[$storeCode] = null;
            return null;
        } catch (StoreIsInactiveException $e) {
            $this->validatedStoreCodes[$storeCode] = null;
            return null;
        }
    }

    /**
     * Get store code from path info string
     *
     * @param string $pathInfo
     * @return string
     */
    private function getStoreCode(string $pathInfo) : string
    {
        $pathParts = explode('/', ltrim($pathInfo, '/'), 2);
        return current($pathParts);
    }

    /**
     * @inheritDoc
     */
    public function _resetState(): void
    {
        $this->validatedStoreCodes = [];
    }
}