Merge remote-tracking branch 'mainline/2.4-develop' into honey-pr-bundle

Author: Prabhu Ram

app/code/Magento/Catalog/Model/ImageUploader.php

@@ -5,114 +5,116 @@
  */
 namespace Magento\Catalog\Model;
 
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\File\Uploader;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\File\Name;
+use Magento\Framework\Filesystem;
+use Magento\Framework\Filesystem\Directory\WriteInterface;
+use Magento\MediaStorage\Helper\File\Storage\Database;
+use Magento\MediaStorage\Model\File\UploaderFactory;
+use Magento\Store\Model\StoreManagerInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Catalog image uploader
  */
 class ImageUploader
 {
     /**
-     * Core file storage database
-     *
-     * @var \Magento\MediaStorage\Helper\File\Storage\Database
+     * @var Database
      */
     protected $coreFileStorageDatabase;
 
     /**
-     * Media directory object (writable).
-     *
-     * @var \Magento\Framework\Filesystem\Directory\WriteInterface
+     * @var WriteInterface
      */
     protected $mediaDirectory;
 
     /**
-     * Uploader factory
-     *
-     * @var \Magento\MediaStorage\Model\File\UploaderFactory
+     * @var UploaderFactory
      */
     private $uploaderFactory;
 
     /**
-     * Store manager
-     *
-     * @var \Magento\Store\Model\StoreManagerInterface
+     * @var StoreManagerInterface
      */
     protected $storeManager;
 
     /**
-     * @var \Psr\Log\LoggerInterface
+     * @var LoggerInterface
      */
     protected $logger;
 
     /**
-     * Base tmp path
-     *
      * @var string
      */
     protected $baseTmpPath;
 
     /**
-     * Base path
-     *
      * @var string
      */
     protected $basePath;
 
     /**
-     * Allowed extensions
-     *
      * @var string
      */
     protected $allowedExtensions;
 
     /**
-     * List of allowed image mime types
-     *
      * @var string[]
      */
     private $allowedMimeTypes;
 
     /**
-     * ImageUploader constructor
+     * @var Name
+     */
+    private $fileNameLookup;
+
+    /**
+     * ImageUploader constructor.
      *
-     * @param \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDatabase
-     * @param \Magento\Framework\Filesystem $filesystem
-     * @param \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory
-     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
-     * @param \Psr\Log\LoggerInterface $logger
+     * @param Database $coreFileStorageDatabase
+     * @param Filesystem $filesystem
+     * @param UploaderFactory $uploaderFactory
+     * @param StoreManagerInterface $storeManager
+     * @param LoggerInterface $logger
      * @param string $baseTmpPath
      * @param string $basePath
      * @param string[] $allowedExtensions
      * @param string[] $allowedMimeTypes
+     * @param Name|null $fileNameLookup
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
-        \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDatabase,
-        \Magento\Framework\Filesystem $filesystem,
-        \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory,
-        \Magento\Store\Model\StoreManagerInterface $storeManager,
-        \Psr\Log\LoggerInterface $logger,
+        Database $coreFileStorageDatabase,
+        Filesystem $filesystem,
+        UploaderFactory $uploaderFactory,
+        StoreManagerInterface $storeManager,
+        LoggerInterface $logger,
         $baseTmpPath,
         $basePath,
         $allowedExtensions,
-        $allowedMimeTypes = []
+        $allowedMimeTypes = [],
+        Name $fileNameLookup = null
     ) {
         $this->coreFileStorageDatabase = $coreFileStorageDatabase;
-        $this->mediaDirectory = $filesystem->getDirectoryWrite(\Magento\Framework\App\Filesystem\DirectoryList::MEDIA);
+        $this->mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
         $this->uploaderFactory = $uploaderFactory;
         $this->storeManager = $storeManager;
         $this->logger = $logger;
         $this->baseTmpPath = $baseTmpPath;
         $this->basePath = $basePath;
         $this->allowedExtensions = $allowedExtensions;
         $this->allowedMimeTypes = $allowedMimeTypes;
+        $this->fileNameLookup = $fileNameLookup ?? ObjectManager::getInstance()->get(Name::class);
     }
 
     /**
      * Set base tmp path
      *
      * @param string $baseTmpPath
-     *
      * @return void
      */
     public function setBaseTmpPath($baseTmpPath)
@@ -124,7 +126,6 @@ public function setBaseTmpPath($baseTmpPath)
      * Set base path
      *
      * @param string $basePath
-     *
      * @return void
      */
     public function setBasePath($basePath)
@@ -136,7 +137,6 @@ public function setBasePath($basePath)
      * Set allowed extensions
      *
      * @param string[] $allowedExtensions
-     *
      * @return void
      */
     public function setAllowedExtensions($allowedExtensions)
@@ -179,7 +179,6 @@ public function getAllowedExtensions()
      *
      * @param string $path
      * @param string $imageName
-     *
      * @return string
      */
     public function getFilePath($path, $imageName)
@@ -194,7 +193,7 @@ public function getFilePath($path, $imageName)
      * @param bool $returnRelativePath
      * @return string
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function moveFileFromTmp($imageName, $returnRelativePath = false)
     {
@@ -203,7 +202,7 @@ public function moveFileFromTmp($imageName, $returnRelativePath = false)
 
         $baseImagePath = $this->getFilePath(
             $basePath,
-            Uploader::getNewFileName(
+            $this->fileNameLookup->getNewFileName(
                 $this->mediaDirectory->getAbsolutePath(
                     $this->getFilePath($basePath, $imageName)
                 )
@@ -222,10 +221,7 @@ public function moveFileFromTmp($imageName, $returnRelativePath = false)
             );
         } catch (\Exception $e) {
             $this->logger->critical($e);
-            throw new \Magento\Framework\Exception\LocalizedException(
-                __('Something went wrong while saving the file(s).'),
-                $e
-            );
+            throw new LocalizedException(__('Something went wrong while saving the file(s).'), $e);
         }
 
         return $returnRelativePath ? $baseImagePath : $imageName;
@@ -235,10 +231,9 @@ public function moveFileFromTmp($imageName, $returnRelativePath = false)
      * Checking file for save and save it to tmp dir
      *
      * @param string $fileId
-     *
      * @return string[]
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function saveFileToTmpDir($fileId)
     {
@@ -249,15 +244,13 @@ public function saveFileToTmpDir($fileId)
         $uploader->setAllowedExtensions($this->getAllowedExtensions());
         $uploader->setAllowRenameFiles(true);
         if (!$uploader->checkMimeType($this->allowedMimeTypes)) {
-            throw new \Magento\Framework\Exception\LocalizedException(__('File validation failed.'));
+            throw new LocalizedException(__('File validation failed.'));
         }
         $result = $uploader->save($this->mediaDirectory->getAbsolutePath($baseTmpPath));
         unset($result['path']);
 
         if (!$result) {
-            throw new \Magento\Framework\Exception\LocalizedException(
-                __('File can not be saved to the destination folder.')
-            );
+            throw new LocalizedException(__('File can not be saved to the destination folder.'));
         }
 
         /**
@@ -277,7 +270,7 @@ public function saveFileToTmpDir($fileId)
                 $this->coreFileStorageDatabase->saveFile($relativePath);
             } catch (\Exception $e) {
                 $this->logger->critical($e);
-                throw new \Magento\Framework\Exception\LocalizedException(
+                throw new LocalizedException(
                     __('Something went wrong while saving the file(s).'),
                     $e
                 );

app/code/Magento/CatalogUrlRewrite/Model/ProductScopeRewriteGenerator.php

@@ -6,6 +6,7 @@
 namespace Magento\CatalogUrlRewrite\Model;
 
 use Magento\Catalog\Api\CategoryRepositoryInterface;
+use Magento\Catalog\Api\Data\CategoryInterface;
 use Magento\Catalog\Model\Category;
 use Magento\Catalog\Model\Product;
 use Magento\CatalogUrlRewrite\Model\Product\AnchorUrlRewriteGenerator;
@@ -15,12 +16,14 @@
 use Magento\CatalogUrlRewrite\Service\V1\StoreViewService;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\UrlRewrite\Model\MergeDataProviderFactory;
 
 /**
- * Class ProductScopeRewriteGenerator
+ * Generates Product/Category URLs for different scopes
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ProductScopeRewriteGenerator
@@ -174,7 +177,6 @@ public function generateForSpecificStoreView($storeId, $productCategories, Produ
                 continue;
             }
 
-            // category should be loaded per appropriate store if category's URL key has been changed
             $categories[] = $this->getCategoryWithOverriddenUrlKey($storeId, $category);
         }
 
@@ -240,9 +242,15 @@ public function isCategoryProperForGenerating(Category $category, $storeId)
      * Checks if URL key has been changed for provided category and returns reloaded category,
      * in other case - returns provided category.
      *
+     * Category should be loaded per appropriate store at all times. This is because whilst the URL key on the
+     * category in focus might be unchanged, parent category URL keys might be. If the category store ID
+     * and passed store ID are the same then return current category as it is correct but may have changed in memory
+     *
      * @param int $storeId
      * @param Category $category
-     * @return Category
+     *
+     * @return CategoryInterface
+     * @throws NoSuchEntityException
      */
     private function getCategoryWithOverriddenUrlKey($storeId, Category $category)
     {
@@ -252,9 +260,10 @@ private function getCategoryWithOverriddenUrlKey($storeId, Category $category)
             Category::ENTITY
         );
 
-        if (!$isUrlKeyOverridden) {
+        if (!$isUrlKeyOverridden && $storeId === $category->getStoreId()) {
             return $category;
         }
+
         return $this->categoryRepository->get($category->getEntityId(), $storeId);
     }
 

app/code/Magento/CatalogUrlRewrite/Plugin/Model/CategorySetSaveRewriteHistory.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogUrlRewrite\Plugin\Model;
+
+use Magento\Catalog\Model\Category;
+use Magento\Framework\Webapi\Rest\Request as RestRequest;
+use Magento\CatalogUrlRewrite\Model\CategoryUrlRewriteGenerator;
+
+class CategorySetSaveRewriteHistory
+{
+    private const SAVE_REWRITES_HISTORY = 'save_rewrites_history';
+
+    /**
+     * @var RestRequest
+     */
+    private $request;
+
+    /**
+     * @param RestRequest $request
+     */
+    public function __construct(RestRequest $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Add 'save_rewrites_history' param to the category for list
+     *
+     * @param CategoryUrlRewriteGenerator $subject
+     * @param Category $category
+     * @param bool $overrideStoreUrls
+     * @param int|null $rootCategoryId
+     * @return array
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeGenerate(
+        CategoryUrlRewriteGenerator $subject,
+        Category $category,
+        bool $overrideStoreUrls = false,
+        ?int $rootCategoryId = null
+    ) {
+        $requestBodyParams = $this->request->getBodyParams();
+
+        if ($this->isCustomAttributesExists($requestBodyParams, CategoryUrlRewriteGenerator::ENTITY_TYPE)) {
+            foreach ($requestBodyParams[CategoryUrlRewriteGenerator::ENTITY_TYPE]['custom_attributes'] as $attribute) {
+                if ($attribute['attribute_code'] === self::SAVE_REWRITES_HISTORY) {
+                    $category->setData(self::SAVE_REWRITES_HISTORY, (bool)$attribute['value']);
+                }
+            }
+        }
+
+        return [$category, $overrideStoreUrls, $rootCategoryId];
+    }
+
+    /**
+     * Check is any custom options exists in data
+     *
+     * @param array $requestBodyParams
+     * @param string $entityCode
+     * @return bool
+     */
+    private function isCustomAttributesExists(array $requestBodyParams, string $entityCode): bool
+    {
+        return !empty($requestBodyParams[$entityCode]['custom_attributes']);
+    }
+}