Merge pull request #330 from Inchoo/bugfix/#261-IO-issue-with-renamed-images

Added fix for image placeholder when IO is enabled

Author: vvuksan

Diff for: Model/Config.php

@@ -327,6 +327,12 @@ class Config extends \Magento\PageCache\Model\Config
     const XML_FASTLY_IMAGE_OPTIMIZATIONS
         = 'system/full_page_cache/fastly/fastly_image_optimization_configuration/image_optimizations';
 
+    /**
+     * XML path to image verify flag
+     */
+    const XML_FASTLY_IMAGE_VERIFY
+        = 'system/full_page_cache/fastly/fastly_image_optimization_configuration/image_verify';
+
     /**
      * XML path to image optimization force lossy flag
      */

Diff for: Model/Product/Image.php

@@ -182,17 +182,6 @@ private function fastlyResize()
 
     private function adjustSize()
     {
-        $originalImage = $this->_mediaDirectory->getAbsolutePath($this->getBaseFile());
-        $originalSize = getimagesize($originalImage);
-
-        if ($this->getWidth() > $originalSize[0]) {
-            $this->setWidth($originalSize[0]);
-        }
-
-        if ($this->getHeight() > $originalSize[1]) {
-            $this->setHeight($originalSize[1]);
-        }
-
         $this->fastlyParameters['width'] = $this->_width;
         $this->fastlyParameters['height'] = $this->_height;
 
@@ -203,38 +192,6 @@ private function adjustSize()
         }
     }
 
-    /**
-     * Return resized product image information
-     *
-     * @return array
-     */
-    public function getResizedImageInfo()
-    {
-        if ($this->isFastlyImageOptimizationEnabled() == false) {
-            return parent::getResizedImageInfo();
-        }
-
-        // Return image data
-        if ($this->getBaseFile() !== null) {
-            return [
-                0 => $this->getWidth(),
-                1 => $this->getHeight()
-            ];
-        }
-
-        // No image, parse the placeholder
-        $asset = $this->_assetRepo->createAsset(
-            "Magento_Catalog::images/product/placeholder/{$this->getDestinationSubdir()}.jpg"
-        );
-        $img = $asset->getSourceFile();
-        $imageInfo = getimagesize($img);
-
-        $this->setWidth($imageInfo[0]);
-        $this->setHeight($imageInfo[1]);
-
-        return $imageInfo;
-    }
-
     /**
      * Wrapper for original saveFile()
      *

Diff for: Model/View/Asset/Image.php

@@ -24,13 +24,17 @@
 use Magento\Catalog\Helper\Image as ImageHelper;
 use Magento\Catalog\Model\Product\Media\ConfigInterface;
 use Magento\Catalog\Model\View\Asset\Image as ImageModel;
+use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Encryption\EncryptorInterface;
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\View\Asset\ContextInterface;
 use Magento\PageCache\Model\Config as PageCacheConfig;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\UrlInterface;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Filesystem\Io\File;
+use Magento\Framework\Filesystem;
 
 /**
  * Class Image
@@ -62,6 +66,10 @@ class Image extends ImageModel
      * @var null
      */
     private $fastlyUrl = null;
+    /**
+     * @var null
+     */
+    private $isImageVerifyEnabled = null;
     /**
      * @var ScopeConfigInterface
      */
@@ -81,6 +89,16 @@ class Image extends ImageModel
      */
     private $miscParams;
 
+    /**
+     * @var File
+     */
+    private $file;
+
+    /**
+     * @var Filesystem
+     */
+    private $filesystem;
+
     /**
      * Image constructor.
      * @param ConfigInterface $mediaConfig
@@ -89,7 +107,9 @@ class Image extends ImageModel
      * @param ScopeConfigInterface $scopeConfig
      * @param ImageHelper $imageHelper
      * @param StoreManagerInterface $storeManager
-     * @param string $filePath
+     * @param File $file
+     * @param Filesystem $filesystem
+     * @param $filePath
      * @param array $miscParams
      */
     public function __construct(
@@ -99,18 +119,23 @@ public function __construct(
         ScopeConfigInterface $scopeConfig,
         ImageHelper $imageHelper,
         StoreManagerInterface $storeManager,
+        File $file,
+        Filesystem $filesystem,
         $filePath,
         array $miscParams
     ) {
         $this->scopeConfig = $scopeConfig;
         $this->imageHelper = $imageHelper;
         $this->storeManager = $storeManager;
         $this->miscParams = $miscParams;
+        $this->file = $file;
+        $this->filesystem = $filesystem;
         parent::__construct($mediaConfig, $context, $encryptor, $filePath, $miscParams);
     }
 
     /**
      * @return string|null
+     * @throws FileSystemException
      * @throws NoSuchEntityException
      */
     public function getUrl()
@@ -218,12 +243,23 @@ public function getBaseFileUrl($baseFile)
 
     /**
      * @throws NoSuchEntityException
+     * @throws FileSystemException
      */
     public function getFastlyUrl()
     {
         $baseFile = $this->getSourceFile();
         $url = $this->getBaseFileUrl($baseFile);
 
+        if ($this->isImageVerifyEnabled()) {
+            $mediaDir = $this->filesystem->getDirectoryWrite(DirectoryList::MEDIA);
+            $imageAbsolutePath = $mediaDir->getAbsolutePath($baseFile);
+
+            if (!$this->file->fileExists($imageAbsolutePath)) {
+                $imageHelper = \Magento\Framework\App\ObjectManager::getInstance()->get(ImageHelper::class);
+                $url = $imageHelper->getDefaultPlaceholderUrl($this->miscParams['image_type']);
+            }
+        }
+
         $imageQuality = $this->scopeConfig->getValue(Config::XML_FASTLY_IMAGE_OPTIMIZATION_IMAGE_QUALITY);
 
         $this->fastlyParameters['quality'] = $imageQuality;
@@ -294,4 +330,22 @@ private function fastlyRotate($angle)
 
         return $this;
     }
+
+    /**
+     * @return bool|null
+     */
+    private function isImageVerifyEnabled()
+    {
+        if ($this->isImageVerifyEnabled !== null) {
+            return $this->isImageVerifyEnabled;
+        }
+
+        $this->isImageVerifyEnabled = true;
+
+        if ($this->scopeConfig->isSetFlag(Config::XML_FASTLY_IMAGE_VERIFY) == false) {
+            $this->isImageVerifyEnabled = false;
+        }
+
+        return $this->isImageVerifyEnabled;
+    }
 }

Diff for: etc/adminhtml/system.xml

@@ -573,6 +573,17 @@
                             <source_model>Fastly\Cdn\Model\Config\Backend\PixelRatios</source_model>
                             <validate>required_entry</validate>
                         </field>
+                        <!-- =========================================
+                             Image Verify select field
+                        ========================================== -->
+                        <field id="image_verify" translate="label comment" type="select" sortOrder="40" showInDefault="1" showInWebsite="0" showInStore="0">
+                            <label>Verify Image</label>
+                            <comment>Verify image actually exists on the disk. May cause performance issues especially on systems with shared filesystems.</comment>
+                            <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                            <depends>
+                                <field id="image_optimizations">1</field>
+                            </depends>
+                        </field>
                     </group>
                     <!-- ============================
                         Maintenance Support group

Diff for: etc/config.xml

@@ -50,6 +50,7 @@
                         <image_optimization_bg_color>1</image_optimization_bg_color>
                         <image_optimization_canvas>1</image_optimization_canvas>
                         <image_optimizations_ratios>2,3</image_optimizations_ratios>
+                        <image_verify>0</image_verify>
                     </fastly_image_optimization_configuration>
                     <fastly_web_hooks>
                         <enable_webhooks>0</enable_webhooks>