AC-12682 use DriverInterface to work with remote storage

Author: tranthienbinh1989

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

@@ -14,9 +14,11 @@
 use Magento\Framework\Config\ConfigOptionsListConstants;
 use Magento\Framework\Encryption\EncryptorInterface;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Filesystem;
 use Magento\Framework\View\Asset\ContextInterface;
 use Magento\Framework\View\Asset\LocalInterface;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Framework\App\Filesystem\DirectoryList;
 
 /**
  * A locally available image file asset that can be referred with a file path
@@ -25,6 +27,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)
      *
@@ -84,6 +91,11 @@ class Image implements LocalInterface
      */
     private $convertImageMiscParamsToReadableFormat;
 
+    /**
+     * @var Filesystem|null
+     */
+    private ?Filesystem $fileSystem;
+
     /**
      * Image constructor.
      *
@@ -96,6 +108,9 @@ class Image implements LocalInterface
      * @param CatalogMediaConfig $catalogMediaConfig
      * @param StoreManagerInterface $storeManager
      * @param ConvertImageMiscParamsToReadableFormat $convertImageMiscParamsToReadableFormat
+     * @param Filesystem|null $fileSystem
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         ConfigInterface $mediaConfig,
@@ -106,7 +121,8 @@ public function __construct(
         ImageHelper $imageHelper = null,
         CatalogMediaConfig $catalogMediaConfig = null,
         StoreManagerInterface $storeManager = null,
-        ?ConvertImageMiscParamsToReadableFormat $convertImageMiscParamsToReadableFormat = null
+        ?ConvertImageMiscParamsToReadableFormat $convertImageMiscParamsToReadableFormat = null,
+        ?Filesystem $fileSystem = null
     ) {
         if (isset($miscParams['image_type'])) {
             $this->sourceContentType = $miscParams['image_type'];
@@ -126,6 +142,7 @@ public function __construct(
         $this->mediaFormatUrl = $catalogMediaConfig->getMediaUrlFormat();
         $this->convertImageMiscParamsToReadableFormat = $convertImageMiscParamsToReadableFormat ?:
             ObjectManager::getInstance()->get(ConvertImageMiscParamsToReadableFormat::class);
+        $this->fileSystem = $fileSystem ?: ObjectManager::getInstance()->get(Filesystem::class);
     }
 
     /**
@@ -266,6 +283,7 @@ public function getModule()
      */
     private function getImageInfo()
     {
+        $mediaDirectory = $this->fileSystem->getDirectoryRead(DirectoryList::MEDIA);
         $data = implode('_', $this->convertToReadableFormat($this->miscParams));
 
         $pathTemplate = $this->getModule()
@@ -277,18 +295,20 @@ private function getImageInfo()
         $hashBasedPath = preg_replace(
             '|\Q' . DIRECTORY_SEPARATOR . '\E+|',
             DIRECTORY_SEPARATOR,
-            sprintf($pathTemplate, hash('md5', $data))
+            sprintf($pathTemplate, hash(self::HASH_ALGORITHM, $data))
         );
 
-        if (is_readable($this->context->getPath() . DIRECTORY_SEPARATOR . $hashBasedPath)) {
+        if ($mediaDirectory->isExist($this->context->getPath() . DIRECTORY_SEPARATOR . $hashBasedPath)) {
             return $hashBasedPath;
         }
 
         // This loop is intended to preserve backward compatibility and keep
         // existing encryption key based media gallery cache valid
         // even if an encryption key was changed.
-        foreach (preg_split('/\s+/s', $this->encryptor->exportKeys()) as $key) {
+        $keys = explode("\n", $this->encryptor->exportKeys());
+        foreach ($keys as $key) {
             if (str_starts_with($key, ConfigOptionsListConstants::STORE_KEY_ENCODED_RANDOM_STRING_PREFIX)) {
+                // phpcs:disable Magento2.Functions.DiscouragedFunction
                 $key = base64_decode(
                     substr($key, strlen(ConfigOptionsListConstants::STORE_KEY_ENCODED_RANDOM_STRING_PREFIX))
                 );
@@ -297,10 +317,10 @@ private function getImageInfo()
             $keyBasedPath = preg_replace(
                 '|\Q' . DIRECTORY_SEPARATOR . '\E+|',
                 DIRECTORY_SEPARATOR,
-                sprintf($pathTemplate, hash_hmac("md5", $data, $key))
+                sprintf($pathTemplate, hash_hmac(self::HASH_ALGORITHM, $data, $key))
             );
 
-            if (is_readable($this->context->getPath() . DIRECTORY_SEPARATOR . $keyBasedPath)) {
+            if ($mediaDirectory->isExist($this->context->getPath() . DIRECTORY_SEPARATOR . $keyBasedPath)) {
                 return $keyBasedPath;
             }
         }