Merge remote-tracking branch 'origin/MC-23740' into 2.4-develop-pr121

Author: OlgaVasyltsun

app/code/Magento/Backend/Model/Validator/UrlKey/CompositeUrlKey.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Backend\Model\Validator\UrlKey;
+
+/**
+ * Class Composite validates if urlKey doesn't matches frontName or restricted words(endpoint names)
+ */
+class CompositeUrlKey implements UrlKeyValidatorInterface
+{
+    /**
+     * @var UrlKeyValidatorInterface[]
+     */
+    private $validators;
+
+    /**
+     * @param array $validators
+     */
+    public function __construct(
+        array $validators = []
+    ) {
+        $this->validators = $validators;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function validate(string $urlKey): array
+    {
+        $errors = [];
+        foreach ($this->validators as $validator) {
+            $errors[] = $validator->validate($urlKey);
+        }
+
+        return array_merge([], ...$errors);
+    }
+}

app/code/Magento/Backend/Model/Validator/UrlKey/FrontName.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Backend\Model\Validator\UrlKey;
+
+use Magento\Backend\App\Area\FrontNameResolver;
+
+/**
+ * Class FrontName validates if urlKey doesn't matches frontName
+ */
+class FrontName implements UrlKeyValidatorInterface
+{
+    /**
+     * @var FrontNameResolver
+     */
+    private $frontNameResolver;
+
+    /**
+     * @param FrontNameResolver $frontNameResolver
+     */
+    public function __construct(
+        FrontNameResolver $frontNameResolver
+    ) {
+        $this->frontNameResolver = $frontNameResolver;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function validate(string $urlKey): array
+    {
+        $errors = [];
+        $frontName = $this->frontNameResolver->getFrontName();
+        if ($urlKey == $frontName) {
+            $errors[] = __(
+                'URL key "%1" matches a reserved endpoint name (%2). Use another URL key.',
+                $urlKey,
+                $frontName
+            );
+        }
+
+        return $errors;
+    }
+}

app/code/Magento/Backend/Model/Validator/UrlKey/RestrictedWords.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Backend\Model\Validator\UrlKey;
+
+use Magento\Framework\Validator\UrlKey;
+
+/**
+ * Class RestrictedWords validates if urlKey doesn't matches restricted words(endpoint names)
+ */
+class RestrictedWords implements UrlKeyValidatorInterface
+{
+    /**
+     * @var UrlKey
+     */
+    private $urlKey;
+
+    /**
+     * @param UrlKey $urlKey
+     */
+    public function __construct(
+        UrlKey $urlKey
+    ) {
+        $this->urlKey = $urlKey;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function validate(string $urlKey): array
+    {
+        $errors = [];
+        if (!$this->urlKey->isValid($urlKey)) {
+            $errors[] = __(
+                'URL key "%1" matches a reserved endpoint name (%2). Use another URL key.',
+                $urlKey,
+                implode(', ', $this->urlKey->getRestrictedValues())
+            );
+        }
+
+        return $errors;
+    }
+}

app/code/Magento/Backend/Model/Validator/UrlKey/UrlKeyValidatorInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Backend\Model\Validator\UrlKey;
+
+/**
+ * Interface UrlKeyValidatorInterface is responsive for validating urlKeys
+ */
+interface UrlKeyValidatorInterface
+{
+    /**
+     * Validates urlKey
+     *
+     * @param string $urlKey
+     * @return array
+     */
+    public function validate(string $urlKey): array;
+}

app/code/Magento/Backend/etc/di.xml

@@ -188,4 +188,12 @@
             <argument name="anchorRenderer" xsi:type="object">Magento\Backend\Block\AnchorRenderer</argument>
         </arguments>
     </type>
+    <type name="Magento\Backend\Model\Validator\UrlKey\CompositeUrlKey">
+        <arguments>
+            <argument name="validators" xsi:type="array">
+                <item name="frontNameValidator" xsi:type="object">Magento\Backend\Model\Validator\UrlKey\FrontName</item>
+                <item name="restrictedWordsValidator" xsi:type="object">Magento\Backend\Model\Validator\UrlKey\RestrictedWords</item>
+            </argument>
+        </arguments>
+    </type>
 </config>

app/code/Magento/Backend/i18n/en_US.csv

@@ -466,3 +466,4 @@ Pagination,Pagination
 "Theme Name","Theme Name"
 "Use URL parameter to enable template path hints for Storefront","Use URL parameter to enable template path hints for Storefront"
 "Add the following parameter to the URL to show template hints ?templatehints=[parameter_value]","Add the following parameter to the URL to show template hints ?templatehints=[parameter_value]"
+"URL key "%1" matches a reserved endpoint name (%2). Use another URL key.","URL key "%1" matches a reserved endpoint name (%2). Use another URL key."

app/code/Magento/CatalogUrlRewrite/Observer/CategoryUrlPathAutogeneratorObserver.php

@@ -16,6 +16,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\Store;
+use Magento\Backend\Model\Validator\UrlKey\CompositeUrlKey;
 
 /**
  * Class for set or update url path.
@@ -24,24 +25,17 @@ class CategoryUrlPathAutogeneratorObserver implements ObserverInterface
 {
 
     /**
-     * Reserved endpoint names.
-     *
-     * @var string[]
-     */
-    private $invalidValues = [];
-
-    /**
-     * @var \Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator
+     * @var CategoryUrlPathGenerator
      */
     protected $categoryUrlPathGenerator;
 
     /**
-     * @var \Magento\CatalogUrlRewrite\Model\Category\ChildrenCategoriesProvider
+     * @var ChildrenCategoriesProvider
      */
     protected $childrenCategoriesProvider;
 
     /**
-     * @var \Magento\CatalogUrlRewrite\Service\V1\StoreViewService
+     * @var StoreViewService
      */
     protected $storeViewService;
 
@@ -51,33 +45,29 @@ class CategoryUrlPathAutogeneratorObserver implements ObserverInterface
     private $categoryRepository;
 
     /**
-     * @var \Magento\Backend\App\Area\FrontNameResolver
+     * @var CompositeUrlKey
      */
-    private $frontNameResolver;
+    private $compositeUrlValidator;
 
     /**
      * @param CategoryUrlPathGenerator $categoryUrlPathGenerator
      * @param ChildrenCategoriesProvider $childrenCategoriesProvider
-     * @param \Magento\CatalogUrlRewrite\Service\V1\StoreViewService $storeViewService
+     * @param StoreViewService $storeViewService
      * @param CategoryRepositoryInterface $categoryRepository
-     * @param \Magento\Backend\App\Area\FrontNameResolver $frontNameResolver
-     * @param string[] $invalidValues
+     * @param CompositeUrlKey $compositeUrlValidator
      */
     public function __construct(
         CategoryUrlPathGenerator $categoryUrlPathGenerator,
         ChildrenCategoriesProvider $childrenCategoriesProvider,
         StoreViewService $storeViewService,
         CategoryRepositoryInterface $categoryRepository,
-        \Magento\Backend\App\Area\FrontNameResolver $frontNameResolver = null,
-        array $invalidValues = []
+        CompositeUrlKey $compositeUrlValidator
     ) {
         $this->categoryUrlPathGenerator = $categoryUrlPathGenerator;
         $this->childrenCategoriesProvider = $childrenCategoriesProvider;
         $this->storeViewService = $storeViewService;
         $this->categoryRepository = $categoryRepository;
-        $this->frontNameResolver = $frontNameResolver ?: \Magento\Framework\App\ObjectManager::getInstance()
-            ->get(\Magento\Backend\App\Area\FrontNameResolver::class);
-        $this->invalidValues = $invalidValues;
+        $this->compositeUrlValidator = $compositeUrlValidator;
     }
 
     /**
@@ -161,27 +151,12 @@ private function validateUrlKey(Category $category, ?string $urlKey): void
             throw new LocalizedException(__('Invalid URL key'));
         }
 
-        if (in_array($urlKey, $this->getInvalidValues())) {
-            throw new LocalizedException(
-                __(
-                    'URL key "%1" matches a reserved endpoint name (%2). Use another URL key.',
-                    $urlKey,
-                    implode(', ', $this->getInvalidValues())
-                )
-            );
+        $errors = $this->compositeUrlValidator->validate($urlKey);
+        if (!empty($errors)) {
+            throw new LocalizedException($errors[0]);
         }
     }
 
-    /**
-     * Get reserved endpoint names.
-     *
-     * @return array
-     */
-    private function getInvalidValues()
-    {
-        return array_unique(array_merge($this->invalidValues, [$this->frontNameResolver->getFrontName()]));
-    }
-
     /**
      * Update url path for children category.
      *

app/code/Magento/CatalogUrlRewrite/Observer/ProductUrlKeyAutogeneratorObserver.php

@@ -9,32 +9,49 @@
 use Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Backend\Model\Validator\UrlKey\CompositeUrlKey;
 
 class ProductUrlKeyAutogeneratorObserver implements ObserverInterface
 {
     /**
-     * @var \Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator
+     * @var ProductUrlPathGenerator
      */
     protected $productUrlPathGenerator;
 
+    /**
+     * @var CompositeUrlKey
+     */
+    private $compositeUrlValidator;
+
     /**
      * @param ProductUrlPathGenerator $productUrlPathGenerator
+     * @param CompositeUrlKey $compositeUrlValidator
      */
-    public function __construct(ProductUrlPathGenerator $productUrlPathGenerator)
-    {
+    public function __construct(
+        ProductUrlPathGenerator $productUrlPathGenerator,
+        CompositeUrlKey $compositeUrlValidator
+    ) {
         $this->productUrlPathGenerator = $productUrlPathGenerator;
+        $this->compositeUrlValidator = $compositeUrlValidator;
     }
 
     /**
-     * @param \Magento\Framework\Event\Observer $observer
-     * @return void
+     * Validates and sets url key for product
+     *
+     * @param Observer $observer
+     * @throws LocalizedException
      */
-    public function execute(\Magento\Framework\Event\Observer $observer)
+    public function execute(Observer $observer)
     {
         /** @var Product $product */
         $product = $observer->getEvent()->getProduct();
         $urlKey = $this->productUrlPathGenerator->getUrlKey($product);
         if (null !== $urlKey) {
+            $errors = $this->compositeUrlValidator->validate($urlKey);
+            if (!empty($errors)) {
+                throw new LocalizedException($errors[0]);
+            }
             $product->setUrlKey($urlKey);
         }
     }

app/code/Magento/CatalogUrlRewrite/Test/Mftf/Data/AdminCategoryRestrictedUrlMessageData.xml

@@ -13,5 +13,6 @@
         <data key="urlSoap">URL key "soap" matches a reserved endpoint name (admin, soap, rest, graphql, standard). Use another URL key.</data>
         <data key="urlRest">URL key "rest" matches a reserved endpoint name (admin, soap, rest, graphql, standard). Use another URL key.</data>
         <data key="urlGraphql">URL key "graphql" matches a reserved endpoint name (admin, soap, rest, graphql, standard). Use another URL key.</data>
+        <data key="urlAdminError">URL key "admin" matches a reserved endpoint name (admin). Use another URL key.</data>
     </entity>
 </entities>

app/code/Magento/CatalogUrlRewrite/Test/Mftf/Test/AdminCategoryWithRestrictedUrlKeyNotCreatedTest.xml

@@ -45,12 +45,12 @@
             <argument name="categoryName" value="admin"/>
             <argument name="categoryUrlKey" value=""/>
         </actionGroup>
-        <see selector="{{AdminMessagesSection.error}}" userInput='{{AdminCategoryRestrictedUrlErrorMessage.urlAdmin}}' stepKey="seeAdminFirstErrorMessage"/>
+        <see selector="{{AdminMessagesSection.error}}" userInput='{{AdminCategoryRestrictedUrlErrorMessage.urlAdminError}}' stepKey="seeAdminFirstErrorMessage"/>
         <actionGroup ref="FillCategoryNameAndUrlKeyAndSaveActionGroup" stepKey="fillAdminSecondCategoryForm">
             <argument name="categoryName" value="{{SimpleSubCategory.name}}"/>
             <argument name="categoryUrlKey" value="admin"/>
         </actionGroup>
-        <see selector="{{AdminMessagesSection.error}}" userInput='{{AdminCategoryRestrictedUrlErrorMessage.urlAdmin}}' stepKey="seeAdminSecondErrorMessage"/>
+        <see selector="{{AdminMessagesSection.error}}" userInput='{{AdminCategoryRestrictedUrlErrorMessage.urlAdminError}}' stepKey="seeAdminSecondErrorMessage"/>
         <!--Create category with 'admin' name-->
         <comment userInput="Create category with 'admin' name" stepKey="commentAdminCategoryCreation"/>
         <actionGroup ref="FillCategoryNameAndUrlKeyAndSaveActionGroup" stepKey="fillAdminThirdCategoryForm">