Merge pull request #9308 from magento-cia/AC-12682

AC-12682: Detach image cache generation from encryption key

Author: internal-magento-queue-manager[bot]

app/code/Magento/Catalog/Model/Product/Image/RemoveDeletedImagesFromCache.php

@@ -1,16 +1,26 @@
 <?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+/************************************************************************
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ***********************************************************************
  */
+
 declare(strict_types=1);
 
 namespace Magento\Catalog\Model\Product\Image;
 
 use Magento\Catalog\Helper\Image;
 use Magento\Catalog\Model\Product\Media\Config;
 use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\Encryption\Encryptor;
 use Magento\Framework\Encryption\EncryptorInterface;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
@@ -21,6 +31,11 @@
  */
 class RemoveDeletedImagesFromCache
 {
+    /**
+     * Current hashing algorithm
+     */
+    private const HASH_ALGORITHM = 'md5';
+
     /**
      * @var ConfigInterface
      */
@@ -103,10 +118,10 @@ public function removeDeletedImagesFromCache(array $files): void
                 unset($imageMiscParams['image_type']);
             }
 
-            $cacheId = $this->encryptor->hash(
+            $cacheId = hash(
+                self::HASH_ALGORITHM,
                 implode('_', $this->convertImageMiscParamsToReadableFormat
-                    ->convertImageMiscParamsToReadableFormat($imageMiscParams)),
-                Encryptor::HASH_VERSION_MD5
+                ->convertImageMiscParamsToReadableFormat($imageMiscParams))
             );
 
             foreach ($files as $filePath) {

app/code/Magento/Catalog/Model/View/Asset/Image.php

@@ -1,7 +1,17 @@
 <?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+/************************************************************************
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ***********************************************************************
  */
 
 namespace Magento\Catalog\Model\View\Asset;
@@ -11,7 +21,6 @@
 use Magento\Catalog\Model\Product\Image\ConvertImageMiscParamsToReadableFormat;
 use Magento\Catalog\Model\Product\Media\ConfigInterface;
 use Magento\Framework\App\ObjectManager;
-use Magento\Framework\Encryption\Encryptor;
 use Magento\Framework\Encryption\EncryptorInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\View\Asset\ContextInterface;
@@ -25,6 +34,11 @@
  */
 class Image implements LocalInterface
 {
+    /**
+     * Current hashing algorithm
+     */
+    private const HASH_ALGORITHM = 'md5';
+
     /**
      * Image type of image (thumbnail,small_image,image,swatch_image,swatch_thumb)
      *
@@ -96,6 +110,8 @@ class Image implements LocalInterface
      * @param CatalogMediaConfig $catalogMediaConfig
      * @param StoreManagerInterface $storeManager
      * @param ConvertImageMiscParamsToReadableFormat $convertImageMiscParamsToReadableFormat
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         ConfigInterface $mediaConfig,
@@ -260,29 +276,27 @@ public function getModule()
     }
 
     /**
-     * Retrieve part of path based on misc params
-     *
-     * @return string
-     */
-    private function getMiscPath()
-    {
-        return $this->encryptor->hash(
-            implode('_', $this->convertToReadableFormat($this->miscParams)),
-            Encryptor::HASH_VERSION_MD5
-        );
-    }
-
-    /**
-     * Generate path from image info
+     * Generate path from image info.
      *
      * @return string
      */
     private function getImageInfo()
     {
-        $path = $this->getModule()
-            . DIRECTORY_SEPARATOR . $this->getMiscPath()
-            . DIRECTORY_SEPARATOR . $this->getFilePath();
-        return preg_replace('|\Q'. DIRECTORY_SEPARATOR . '\E+|', DIRECTORY_SEPARATOR, $path);
+        $data = implode('_', $this->convertToReadableFormat($this->miscParams));
+
+        $pathTemplate = $this->getModule()
+            . DIRECTORY_SEPARATOR . "%s" . DIRECTORY_SEPARATOR
+            . $this->getFilePath();
+
+        /**
+         * New paths are generated without dependency on
+         * an encryption key.
+         */
+        return preg_replace(
+            '|\Q' . DIRECTORY_SEPARATOR . '\E+|',
+            DIRECTORY_SEPARATOR,
+            sprintf($pathTemplate, hash(self::HASH_ALGORITHM, $data))
+        );
     }
 
     /**

app/code/Magento/Catalog/Test/Unit/Model/Product/Image/RemoveDeletedImagesFromCacheTest.php

@@ -1,8 +1,19 @@
 <?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+/************************************************************************
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ***********************************************************************
  */
+
 declare(strict_types=1);
 
 namespace Magento\Catalog\Test\Unit\Model\Product\Image;
@@ -171,10 +182,6 @@ public function getRespectiveMethodMockObjForRemoveDeletedImagesFromCache(array
             ->method('convertImageMiscParamsToReadableFormat')
             ->willReturn($data['convertImageParamsToReadableFormat']);
 
-        $this->encryptor->expects($this->once())
-            ->method('hash')
-            ->willReturn('85b0304775df23c13f08dd2c1f9c4c28');
-
         $this->mediaConfig->expects($this->once())
             ->method('getBaseMediaPath')
             ->willReturn('catalog/product');