6486: magento#6486: Unable to save certain product properties via Rest API. Decrease Product Repository overall complexity.

Author: nmalevanec

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

@@ -6,10 +6,8 @@
  */
 namespace Magento\Catalog\Model;
 
-use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Model\Product\Gallery\MimeTypeExtensionMap;
 use Magento\Catalog\Model\ResourceModel\Product\Collection;
-use Magento\Framework\Api\Data\ImageContentInterface;
 use Magento\Framework\Api\Data\ImageContentInterfaceFactory;
 use Magento\Framework\Api\ImageContentValidatorInterface;
 use Magento\Framework\Api\ImageProcessorInterface;
@@ -18,10 +16,8 @@
 use Magento\Framework\DB\Adapter\DeadlockException;
 use Magento\Framework\DB\Adapter\LockWaitException;
 use Magento\Framework\Exception\CouldNotSaveException;
-use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
-use Magento\Framework\Exception\StateException;
 use Magento\Framework\Exception\ValidatorException;
 
 /**
@@ -116,11 +112,15 @@ class ProductRepository implements \Magento\Catalog\Api\ProductRepositoryInterfa
     protected $fileSystem;
 
     /**
+     * @deprecated
+     * @see \Magento\Catalog\Model\MediaGalleryProcessor
      * @var ImageContentInterfaceFactory
      */
     protected $contentFactory;
 
     /**
+     * @deprecated
+     * @see \Magento\Catalog\Model\MediaGalleryProcessor
      * @var ImageProcessorInterface
      */
     protected $imageProcessor;
@@ -131,7 +131,7 @@ class ProductRepository implements \Magento\Catalog\Api\ProductRepositoryInterfa
     protected $extensionAttributesJoinProcessor;
 
     /**
-     * @var \Magento\Catalog\Model\Product\Gallery\Processor
+     * @var ProductRepository\MediaGalleryProcessor
      */
     protected $mediaGalleryProcessor;
 
@@ -378,53 +378,6 @@ private function assignProductToWebsites(\Magento\Catalog\Model\Product $product
         $product->setWebsiteIds($websiteIds);
     }
 
-    /**
-     * @param ProductInterface $product
-     * @param array $newEntry
-     * @return $this
-     * @throws InputException
-     * @throws StateException
-     * @throws \Magento\Framework\Exception\LocalizedException
-     */
-    protected function processNewMediaGalleryEntry(
-        ProductInterface $product,
-        array  $newEntry
-    ) {
-        /** @var ImageContentInterface $contentDataObject */
-        $contentDataObject = $newEntry['content'];
-
-        /** @var \Magento\Catalog\Model\Product\Media\Config $mediaConfig */
-        $mediaConfig = $product->getMediaConfig();
-        $mediaTmpPath = $mediaConfig->getBaseTmpMediaPath();
-
-        $relativeFilePath = $this->imageProcessor->processImageContent($mediaTmpPath, $contentDataObject);
-        $tmpFilePath = $mediaConfig->getTmpMediaShortUrl($relativeFilePath);
-
-        if (!$product->hasGalleryAttribute()) {
-            throw new StateException(__('Requested product does not support images.'));
-        }
-
-        $imageFileUri = $this->getMediaGalleryProcessor()->addImage(
-            $product,
-            $tmpFilePath,
-            isset($newEntry['types']) ? $newEntry['types'] : [],
-            true,
-            isset($newEntry['disabled']) ? $newEntry['disabled'] : true
-        );
-        // Update additional fields that are still empty after addImage call
-        $this->getMediaGalleryProcessor()->updateImage(
-            $product,
-            $imageFileUri,
-            [
-                'label' => $newEntry['label'],
-                'position' => $newEntry['position'],
-                'disabled' => $newEntry['disabled'],
-                'media_type' => $newEntry['media_type'],
-            ]
-        );
-        return $this;
-    }
-
     /**
      * Process product links, creating new links, updating and deleting existing links
      *
@@ -483,67 +436,6 @@ private function processLinks(\Magento\Catalog\Api\Data\ProductInterface $produc
         return $this;
     }
 
-    /**
-     * Process Media gallery data before save product.
-     *
-     * Compare Media Gallery Entries Data with existing Media Gallery
-     * * If Media entry has not value_id set it as new
-     * * If Existing entry 'value_id' absent in Media Gallery set 'removed' flag
-     * * Merge Existing and new media gallery
-     *
-     * @param ProductInterface $product contains only existing media gallery items
-     * @param array $mediaGalleryEntries array which contains all media gallery items
-     * @return $this
-     * @throws InputException
-     * @throws StateException
-     * @throws LocalizedException
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     */
-    protected function processMediaGallery(ProductInterface $product, $mediaGalleryEntries)
-    {
-        $existingMediaGallery = $product->getMediaGallery('images');
-        $newEntries = [];
-        $entriesById = [];
-        if (!empty($existingMediaGallery)) {
-            foreach ($mediaGalleryEntries as $entry) {
-                if (isset($entry['id'])) {
-                    $entriesById[$entry['id']] = $entry;
-                } else {
-                    $newEntries[] = $entry;
-                }
-            }
-            foreach ($existingMediaGallery as $key => &$existingEntry) {
-                if (isset($entriesById[$existingEntry['value_id']])) {
-                    $updatedEntry = $entriesById[$existingEntry['value_id']];
-                    if (array_key_exists('file', $updatedEntry) && $updatedEntry['file'] === null) {
-                        unset($updatedEntry['file']);
-                    }
-                    $existingMediaGallery[$key] = array_merge($existingEntry, $updatedEntry);
-                } else {
-                    //set the removed flag
-                    $existingEntry['removed'] = true;
-                }
-            }
-            unset($existingEntry);
-            $product->setData('media_gallery', ["images" => $existingMediaGallery]);
-        } else {
-            $newEntries = $mediaGalleryEntries;
-        }
-
-        $this->getMediaGalleryProcessor()->clearMediaAttribute($product, array_keys($product->getMediaAttributes()));
-        $images = $product->getMediaGallery('images');
-        if ($images) {
-            foreach ($images as $image) {
-                if (!isset($image['removed']) && !empty($image['types'])) {
-                    $this->getMediaGalleryProcessor()->setMediaAttribute($product, $image['types'], $image['file']);
-                }
-            }
-        }
-        $this->processEntries($product, $newEntries, $entriesById);
-
-        return $this;
-    }
-
     /**
      * {@inheritdoc}
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -580,7 +472,10 @@ public function save(\Magento\Catalog\Api\Data\ProductInterface $product, $saveO
 
         $this->processLinks($product, $productLinks);
         if (isset($productDataArray['media_gallery_entries'])) {
-            $this->processMediaGallery($product, $productDataArray['media_gallery_entries']);
+            $this->getMediaGalleryProcessor()->processMediaGallery(
+                $product,
+                $productDataArray['media_gallery_entries']
+            );
         }
 
         if (!$product->getOptionsReadonly()) {
@@ -752,13 +647,13 @@ public function cleanCache()
     }
 
     /**
-     * @return Product\Gallery\Processor
+     * @return ProductRepository\MediaGalleryProcessor
      */
     private function getMediaGalleryProcessor()
     {
         if (null === $this->mediaGalleryProcessor) {
             $this->mediaGalleryProcessor = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Magento\Catalog\Model\Product\Gallery\Processor::class);
+                ->get(ProductRepository\MediaGalleryProcessor::class);
         }
         return $this->mediaGalleryProcessor;
     }
@@ -778,60 +673,4 @@ private function getCollectionProcessor()
         }
         return $this->collectionProcessor;
     }
-
-    /**
-     * Convert extension attribute for product media gallery.
-     *
-     * @param array $newEntry
-     * @param array $extensionAttributes
-     * @return void
-     */
-    private function processExtensionAttributes(array &$newEntry, array $extensionAttributes)
-    {
-        foreach ($extensionAttributes as $code => $value) {
-            if (is_array($value)) {
-                $this->processExtensionAttributes($newEntry, $value);
-            } else {
-                $newEntry[$code] = $value;
-            }
-        }
-        unset($newEntry['extension_attributes']);
-    }
-
-    /**
-     * Convert entries into product media gallery data and set to product.
-     *
-     * @param ProductInterface $product
-     * @param array $newEntries
-     * @param array $entriesById
-     * @throws InputException
-     * @throws LocalizedException
-     * @throws StateException
-     * @return void
-     */
-    private function processEntries(ProductInterface $product, array $newEntries, array $entriesById)
-    {
-        foreach ($newEntries as $newEntry) {
-            if (!isset($newEntry['content'])) {
-                throw new InputException(__('The image content is not valid.'));
-            }
-            /** @var ImageContentInterface $contentDataObject */
-            $contentDataObject = $this->contentFactory->create()
-                ->setName($newEntry['content'][ImageContentInterface::NAME])
-                ->setBase64EncodedData($newEntry['content'][ImageContentInterface::BASE64_ENCODED_DATA])
-                ->setType($newEntry['content'][ImageContentInterface::TYPE]);
-            $newEntry['content'] = $contentDataObject;
-            $this->processNewMediaGalleryEntry($product, $newEntry);
-
-            $finalGallery = $product->getData('media_gallery');
-            $newEntryId = key(array_diff_key($product->getData('media_gallery')['images'], $entriesById));
-            if (isset($newEntry['extension_attributes'])) {
-                $this->processExtensionAttributes($newEntry, $newEntry['extension_attributes']);
-            }
-            $newEntry = array_replace_recursive($newEntry, $finalGallery['images'][$newEntryId]);
-            $entriesById[$newEntryId] = $newEntry;
-            $finalGallery['images'][$newEntryId] = $newEntry;
-            $product->setData('media_gallery', $finalGallery);
-        }
-    }
 }