Init custom store path url module

Author: thomas-kl1

Block/Adminhtml/Config/Form/Field/Select/Store.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Block\Adminhtml\Config\Form\Field\Select;
+
+use Magento\Framework\View\Element\Context;
+use Magento\Framework\View\Element\Html\Select;
+use Magento\Store\Model\System\Store as StoreSource;
+
+class Store extends Select
+{
+    private StoreSource $storeSource;
+
+    public function __construct(
+        Context $context,
+        StoreSource $storeSource,
+        array $data = []
+    ) {
+        $this->storeSource = $storeSource;
+        parent::__construct($context, $data);
+    }
+
+    public function setInputName(string $inputName): self
+    {
+        return $this->setData('name', $inputName);
+    }
+
+    protected function _toHtml(): string
+    {
+        if ($this->getData('multiple')) {
+            $this->setData('extra_params', 'multiple="multiple"');
+            $this->setInputName($this->getData('name') . '[]');
+        }
+        if (!$this->getOptions()) {
+            $this->setOptions($this->storeSource->toOptionArray());
+        }
+
+        return parent::_toHtml();
+    }
+}

Block/Adminhtml/Config/Form/Field/StorePath.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Block\Adminhtml\Config\Form\Field;
+
+use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
+use Magento\Framework\DataObject;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Phrase;
+use Magento\Framework\View\Element\Html\Select;
+use Opengento\StorePathUrl\Block\Adminhtml\Config\Form\Field\Select\Store;
+
+class StorePath extends AbstractFieldArray
+{
+    /**
+     * @throws LocalizedException
+     */
+    public function getStoreSelectRenderer(): Select
+    {
+        if (!$this->hasData('store_select_renderer')) {
+            $this->setData(
+                'store_select_renderer',
+                $this->getLayout()->createBlock(
+                    Store::class,
+                    '',
+                    ['data' => ['is_render_to_js_template' => true]]
+                )
+            );
+        }
+
+        return $this->getData('store_select_renderer');
+    }
+
+    /**
+     * @throws LocalizedException
+     */
+    protected function _prepareToRender(): void
+    {
+        $this->addColumn(
+            'store',
+            [
+                'label' => new Phrase('Store'),
+                'class' => 'required-entry',
+                'renderer' => $this->getStoreSelectRenderer(),
+            ]
+        );
+        $this->addColumn('path', ['label' => new Phrase('Path'), 'class' => 'required-entry']);
+        $this->_addAfter = false;
+        $this->_addButtonLabel = (new Phrase('Add Store Path'))->render();
+    }
+
+    /**
+     * @inheritdoc
+     * @throws LocalizedException
+     */
+    protected function _prepareArrayRow(DataObject $row): void
+    {
+        $row->setData(
+            'option_extra_attrs',
+            [
+                'option_' . $this->getStoreSelectRenderer()->calcOptionHash($row->getData('store')) => 'selected="selected"',
+            ]
+        );
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) OpenGento
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Model/Config.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Model;
+
+use Magento\Directory\Helper\Data;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Serialize\SerializerInterface;
+use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\Store;
+use Opengento\StorePathUrl\Model\Config\PathType;
+
+class Config
+{
+    private const CONFIG_PATH_USE_STORE_PATH = 'web/url/use_store_path';
+    private const CONFIG_PATH_CUSTOM_PATH_MAPPER = 'web/url/custom_path_mapper';
+
+    private ?array $customPathMapper = null;
+
+    public function __construct(
+        private ScopeConfigInterface $scopeConfig,
+        private SerializerInterface $serializer
+    ) {}
+
+    public function isEnabled(): bool
+    {
+        return $this->scopeConfig->isSetFlag(Store::XML_PATH_STORE_IN_URL)
+            && $this->getStorePathType() !== PathType::StoreCode;
+    }
+
+    public function getStorePathType(): PathType
+    {
+        return PathType::from($this->scopeConfig->getValue(self::CONFIG_PATH_USE_STORE_PATH));
+    }
+
+    public function getCountry(StoreInterface $store): string
+    {
+        return (string)$this->scopeConfig->getValue(
+            Data::XML_PATH_DEFAULT_COUNTRY,
+            ScopeInterface::SCOPE_STORE,
+            $store->getId()
+        );
+    }
+
+    public function getLocale(StoreInterface $store): string
+    {
+        return (string)$this->scopeConfig->getValue(
+            Data::XML_PATH_DEFAULT_LOCALE,
+            ScopeInterface::SCOPE_STORE,
+            $store->getId()
+        );
+    }
+
+    public function getCustomPathMapper(): array
+    {
+        return $this->customPathMapper ??= $this->resolveCustomPathMapper();
+    }
+
+    private function resolveCustomPathMapper(): array
+    {
+        $customPaths = $this->serializer->unserialize(
+            $this->scopeConfig->getValue(self::CONFIG_PATH_CUSTOM_PATH_MAPPER) ?? '{}'
+        );
+
+        $mapper = [];
+        foreach ($customPaths as $customPath) {
+            if (isset($customPath['store'], $customPath['path'])) {
+                $mapper[(int)$customPath['store']] = (string)$customPath['path'];
+            }
+        }
+
+        return $mapper;
+    }
+}

Model/Config/PathType.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Model\Config;
+
+use Magento\Framework\Phrase;
+
+enum PathType: string
+{
+    private const PHRASES = [
+        self::StoreCode->value => 'Store Code',
+        self::CountryCode->value => 'Country Code',
+        self::LocaleUnderscore->value => 'Locale Code (_)',
+        self::LocaleHyphen->value => 'Locale Code (-)',
+        self::Custom->value => 'Custom',
+    ];
+
+    case StoreCode = 'store_code';
+    case CountryCode = 'country_code';
+    case LocaleUnderscore = 'locale_underscore';
+    case LocaleHyphen = 'locale_hyphen';
+    case Custom = 'custom';
+
+    public function getLabel(): Phrase
+    {
+        return new Phrase(self::PHRASES[$this->value]);
+    }
+}

Model/Config/Source/PathTypes.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Model\Config\Source;
+
+use Magento\Framework\Data\OptionSourceInterface;
+use Opengento\StorePathUrl\Model\Config\PathType;
+
+use function array_map;
+
+class PathTypes implements OptionSourceInterface
+{
+    private ?array $options = null;
+
+    public function toOptionArray(): array
+    {
+        return $this->options ??= array_map(
+            static fn(PathType $pathType): array => ['label' => $pathType->getLabel(), 'value' => $pathType->value],
+            PathType::cases()
+        );
+    }
+}

Model/StoreSwitcher/ApplyStorePath.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Model\StoreSwitcher;
+
+use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Model\StoreSwitcherInterface;
+use Opengento\StorePathUrl\Model\Config;
+use Opengento\StorePathUrl\Service\UriUtils;
+
+class ApplyStorePath implements StoreSwitcherInterface
+{
+    public function __construct(
+        private Config $config,
+        private UriUtils $uriUtils
+    ) {}
+
+    public function switch(StoreInterface $fromStore, StoreInterface $targetStore, string $redirectUrl): string
+    {
+        return $this->config->isEnabled() ? $this->uriUtils->replaceStoreCode($redirectUrl, $targetStore) : $redirectUrl;
+    }
+}

Model/StoreSwitcher/RevertStorePath.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Model\StoreSwitcher;
+
+use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Model\StoreSwitcherInterface;
+use Opengento\StorePathUrl\Model\Config;
+use Opengento\StorePathUrl\Service\UriUtils;
+
+class RevertStorePath implements StoreSwitcherInterface
+{
+    public function __construct(
+        private Config $config,
+        private UriUtils $uriUtils
+    ) {}
+
+    public function switch(StoreInterface $fromStore, StoreInterface $targetStore, string $redirectUrl): string
+    {
+        return $this->config->isEnabled() ? $this->uriUtils->replacePathCode($redirectUrl, $targetStore) : $redirectUrl;
+    }
+}

Plugin/App/Request/PathInfo.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace Opengento\StorePathUrl\Plugin\App\Request;
+
+use Magento\Framework\App\Request\PathInfo as PathInfoSubject;
+use Opengento\StorePathUrl\Service\StorePathFixer;
+use Opengento\StorePathUrl\Model\Config;
+
+class PathInfo
+{
+    public function __construct(
+        private Config $config,
+        private StorePathFixer $storePathFixer
+    ) {}
+
+    public function beforeGetPathInfo(PathInfoSubject $subject, string $requestUri, string $baseUrl): array
+    {
+        if ($this->config->isEnabled()) {
+            $requestUri = $this->storePathFixer->fix($baseUrl, $requestUri);
+        }
+
+        return [$requestUri, $baseUrl];
+    }
+}

Plugin/App/Request/StorePathInfoValidator.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright © OpenGento, All rights reserved.
+ */
+
+namespace Opengento\StorePathUrl\Plugin\App\Request;
+
+use Magento\Framework\App\Request\Http;
+use Magento\Store\App\Request\StorePathInfoValidator as StorePathInfoValidatorSubject;
+use Opengento\StorePathUrl\Model\Config;
+use Opengento\StorePathUrl\Service\StorePathFixer;
+
+class StorePathInfoValidator
+{
+    public function __construct(
+        private Config $config,
+        private StorePathFixer $storePathFixer
+    ) {}
+
+    public function beforeGetValidStoreCode(
+        StorePathInfoValidatorSubject $subject,
+        Http $request,
+        string $pathInfo = ''
+    ): array {
+        if ($pathInfo !== '' && $this->config->isEnabled()) {
+            $pathInfo = $this->storePathFixer->fix($request->getBaseUrl(), $pathInfo);
+        }
+
+        return [$request, $pathInfo];
+    }
+}