ACPT-493: Upload csv with request parameter

aa-kashk · aa-kashk · commit 601ccea4b55c · 2022-07-19T14:10:28.000-05:00
diff --git a/app/code/Magento/ImportCsv/Model/StartImport.php b/app/code/Magento/ImportCsv/Model/StartImport.php
@@ -10,6 +10,7 @@
 use Magento\ImportCsvApi\Api\Data\SourceDataInterface;
 use Magento\ImportCsvApi\Api\StartImportInterface;
 use Magento\ImportExport\Model\Import;
+use Magento\ImportExport\Model\Import\Source\Factory as SourceFactory;
 
 /**
  * @inheritdoc
@@ -22,13 +23,21 @@ class StartImport implements StartImportInterface
      */
     private $import;
 
+    /**
+     * @var SourceFactory
+     */
+    private $sourceFactory;
+
     /**
      * @param Import $import
+     * @param SourceFactory $sourceFactory
      */
     public function __construct(
-        Import $import
+        Import $import,
+        SourceFactory $sourceFactory
     ) {
         $this->import = $import;
+        $this->sourceFactory = $sourceFactory;
     }
 
     /**
@@ -41,7 +50,7 @@ public function execute(
         $import = $this->import->setData($source);
         $errors = [];
         try {
-            $source = $import->getSourceForApiData();
+            $source = $this->sourceFactory->create($import->getData('csvData'));
             $this->processValidationResult($import->validateSource($source), $errors);
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             $errors[] = $e->getMessage();
diff --git a/app/code/Magento/ImportExport/Model/Import.php b/app/code/Magento/ImportExport/Model/Import.php
@@ -17,7 +17,6 @@
 use Magento\Framework\Filesystem;
 use Magento\Framework\HTTP\Adapter\FileTransferFactory;
 use Magento\Framework\Indexer\IndexerRegistry;
-use Magento\Framework\Math\Random;
 use Magento\Framework\Message\ManagerInterface;
 use Magento\Framework\Stdlib\DateTime\DateTime;
 use Magento\ImportExport\Helper\Data as DataHelper;
@@ -30,6 +29,7 @@
 use Magento\ImportExport\Model\Import\Entity\Factory;
 use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingError;
 use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface;
+use Magento\ImportExport\Model\Import\Source\Factory as SourceFactory;
 use Magento\ImportExport\Model\ResourceModel\Import\Data;
 use Magento\ImportExport\Model\Source\Import\AbstractBehavior;
 use Magento\ImportExport\Model\Source\Import\Behavior\Factory as BehaviorFactory;
@@ -193,6 +193,11 @@ class Import extends AbstractModel
      */
     private $messageManager;
 
+    /**
+     * @var SourceFactory
+     */
+    private $sourceFactory;
+
     /**
      * @var Upload
      */
@@ -215,6 +220,7 @@ class Import extends AbstractModel
      * @param DateTime $localeDate
      * @param array $data
      * @param ManagerInterface|null $messageManager
+     * @param SourceFactory $sourceFactory
      * @param Upload|null $upload
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -235,6 +241,7 @@ public function __construct(
         DateTime $localeDate,
         array $data = [],
         ManagerInterface $messageManager = null,
+        SourceFactory $sourceFactory = null,
         Upload $upload = null
     ) {
         $this->_importExportData = $importExportData;
@@ -252,6 +259,8 @@ public function __construct(
         $this->localeDate = $localeDate;
         $this->messageManager = $messageManager ?: ObjectManager::getInstance()
             ->get(ManagerInterface::class);
+        $this->sourceFactory = $sourceFactory?? ObjectManager::getInstance()
+            ->get(SourceFactory::class);
         $this->upload = $upload ?: ObjectManager::getInstance()
             ->get(Upload::class);
         parent::__construct($logger, $filesystem, $data);
@@ -304,7 +313,8 @@ protected function _getEntityAdapter()
 
     /**
      * Returns source adapter object.
-     *
+     * @Deprecated
+     * @see \Magento\ImportExport\Model\Import\Source\Factory::create()
      * @param string $sourceFile Full path to source file
      * @return AbstractSource
      * @throws FileSystemException
@@ -318,20 +328,6 @@ protected function _getSourceAdapter($sourceFile)
         );
     }
 
-    /**
-     * Returns source adapter object for Api Data.
-     *
-     * @return AbstractSource
-     */
-    protected function _getSourceAdapterForApi()
-    {
-        return Adapter::findAdapterForData(
-            // phpcs:ignore Magento2.Functions.DiscouragedFunction
-            trim(base64_decode($this->getData('csvData'))),
-            $this->getData(self::FIELD_FIELD_SEPARATOR)
-        );
-    }
-
     /**
      * Return operation result messages
      *
@@ -588,7 +584,11 @@ public function uploadFileAndGetSource()
     {
         $sourceFile = $this->uploadSource();
         try {
-            $source = $this->_getSourceAdapter($sourceFile);
+            $source = $this->sourceFactory->create(
+                $sourceFile,
+                $this->_filesystem->getDirectoryWrite(DirectoryList::ROOT),
+                $this->getData(self::FIELD_FIELD_SEPARATOR)
+            );
         } catch (\Exception $e) {
             $this->_varDirectory->delete($this->_varDirectory->getRelativePath($sourceFile));
             throw new LocalizedException(__($e->getMessage()));
@@ -597,16 +597,6 @@ public function uploadFileAndGetSource()
         return $source;
     }
 
-    /**
-     * Get Source adapter object
-     *
-     * @return AbstractSource
-     */
-    public function getSourceForApiData()
-    {
-        return $this->_getSourceAdapterForApi();
-    }
-
     /**
      * Get Var Directory instance
      *
diff --git a/app/code/Magento/ImportExport/Model/Import/Adapter.php b/app/code/Magento/ImportExport/Model/Import/Adapter.php
@@ -6,10 +6,12 @@
 namespace Magento\ImportExport\Model\Import;
 
 use Magento\Framework\Filesystem\Directory\Write;
+use Magento\ImportExport\Model\Import\Source\Factory;
 
 /**
  * Import adapter model
- *
+ * @Deprecated
+ * @see \Magento\ImportExport\Model\Import\Source\Factory
  * @author      Magento Core Team <core@magentocommerce.com>
  */
 class Adapter
@@ -63,17 +65,4 @@ public static function findAdapterFor($source, $directory, $options = null)
     {
         return self::factory(pathinfo($source, PATHINFO_EXTENSION), $directory, $source, $options); // phpcs:ignore
     }
-
-    /**
-     * Create adapter instance for specified source.
-     *
-     * @param string $source Source
-     * @param mixed $options OPTIONAL Adapter constructor options
-     * phpcs:disable Magento2.Functions.StaticFunction
-     * @return AbstractSource
-     */
-    public static function findAdapterForData($source, $options = null)
-    {
-        return self::factory('Base64EncodedCsvData', null, $source, $options);
-    }
 }
diff --git a/app/code/Magento/ImportExport/Model/Import/Source/Base64EncodedCsvData.php b/app/code/Magento/ImportExport/Model/Import/Source/Base64EncodedCsvData.php
@@ -31,11 +31,12 @@ class Base64EncodedCsvData extends AbstractSource
     /**
      * Read Data and detect column names
      *
-     * @param string $data
+     * @param string $source
      */
-    public function __construct(string $data)
+    public function __construct(string $source)
     {
-        $rowsData = preg_split("/\r\n|\n|\r/", $data);
+        $source = trim(base64_decode($source));
+        $rowsData = preg_split("/\r\n|\n|\r/", $source);
         $colNames = explode(',', $rowsData[0]);
         $this->rows = array_splice($rowsData, 1);
         parent::__construct($colNames);
diff --git a/app/code/Magento/ImportExport/Model/Import/Source/Csv.php b/app/code/Magento/ImportExport/Model/Import/Source/Csv.php
@@ -42,27 +42,27 @@ class Csv extends \Magento\ImportExport\Model\Import\AbstractSource
      *
      * There must be column names in the first line
      *
-     * @param string $file
+     * @param string $source
      * @param Read $directory
      * @param string $delimiter
      * @param string $enclosure
      * @throws \LogicException
      */
     public function __construct(
-        $file,
+        $source,
         Read $directory,
         $delimiter = ',',
         $enclosure = '"'
     ) {
         // phpcs:ignore Magento2.Functions.DiscouragedFunction
         register_shutdown_function([$this, 'destruct']);
         try {
-            $this->filePath = $directory->getRelativePath($file);
+            $this->filePath = $directory->getRelativePath($source);
             $this->_file = $directory->openFile($this->filePath, 'r');
             $this->_file->seek(0);
             self::$openFiles[$this->filePath] = true;
         } catch (\Magento\Framework\Exception\FileSystemException $e) {
-            throw new \LogicException("Unable to open file: '{$file}'");
+            throw new \LogicException("Unable to open file: '{$source}'");
         }
         if ($delimiter) {
             $this->_delimiter = $delimiter;
diff --git a/app/code/Magento/ImportExport/Model/Import/Source/Factory.php b/app/code/Magento/ImportExport/Model/Import/Source/Factory.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\ImportExport\Model\Import\Source;
+
+use Magento\Framework\ObjectManagerInterface;
+use Magento\ImportExport\Model\Import\AbstractSource;
+
+class Factory
+{
+    /**
+     * Object Manager
+     *
+     * @var \Magento\Framework\ObjectManagerInterface
+     */
+    private $objectManager;
+
+    public function __construct(
+        ObjectManagerInterface $objectManager
+    ) {
+        $this->objectManager = $objectManager;
+    }
+
+    /**
+     * @param $source
+     * @param $directory
+     * @param $options
+     * @return AbstractSource
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function create($source, $directory = null, $options = null): AbstractSource
+    {
+        $adapterClass = 'Magento\ImportExport\Model\Import\Source\\';
+        if (file_exists($source)) {
+            $type = ucfirst(strtolower(pathinfo($source, PATHINFO_EXTENSION)));
+        } else {
+            $type = 'Base64EncodedCsvData';
+        }
+        if (!is_string($source) || !$source) {
+            throw new \Magento\Framework\Exception\LocalizedException(
+                __('The source type must be a non-empty string.')
+            );
+        }
+        $adapterClass.= $type;
+        if (!class_exists($adapterClass)) {
+            throw new \Magento\Framework\Exception\LocalizedException(
+                __('\'%1\' file extension is not supported', $type)
+            );
+        }
+        return $this->objectManager->create(
+            $adapterClass,
+            [
+                'source' => $source,
+                'directory' => $directory,
+                'options' => $options
+            ]
+        );
+    }
+}
diff --git a/app/code/Magento/ImportExport/Model/Import/Source/Zip.php b/app/code/Magento/ImportExport/Model/Import/Source/Zip.php
@@ -14,28 +14,28 @@
 class Zip extends Csv
 {
     /**
-     * @param string $file
+     * @param string $source
      * @param \Magento\Framework\Filesystem\Directory\Write $directory
      * @param string $options
      * @param \Magento\Framework\Archive\Zip|null $zipArchive
      * @throws \Magento\Framework\Exception\LocalizedException
      * @throws \Magento\Framework\Exception\ValidatorException
      */
     public function __construct(
-        $file,
+        $source,
         \Magento\Framework\Filesystem\Directory\Write $directory,
         $options,
         \Magento\Framework\Archive\Zip $zipArchive = null
     ) {
         $zip = $zipArchive ?? ObjectManager::getInstance()->get(\Magento\Framework\Archive\Zip::class);
         $csvFile = $zip->unpack(
-            $file,
-            preg_replace('/\.zip$/i', '.csv', $file)
+            $source,
+            preg_replace('/\.zip$/i', '.csv', $source)
         );
         if (!$csvFile) {
             throw new ValidatorException(__('Sorry, but the data is invalid or the file is not uploaded.'));
         }
-        $directory->delete($directory->getRelativePath($file));
+        $directory->delete($directory->getRelativePath($source));
 
         try {
             parent::__construct($csvFile, $directory, $options);
diff --git a/app/code/Magento/ImportExport/Test/Unit/Helper/ReportTest.php b/app/code/Magento/ImportExport/Test/Unit/Helper/ReportTest.php
@@ -204,6 +204,7 @@ public function testGetSummaryStats()
         $importHistoryModel = $this->createMock(History::class);
         $localeDate = $this->createMock(\Magento\Framework\Stdlib\DateTime\DateTime::class);
         $upload = $this->createMock(Upload::class);
+        $sourceFactoryMock = $this->createMock(\Magento\ImportExport\Model\Import\Source\Factory::class);
         $import = new Import(
             $logger,
             $filesystem,
@@ -221,7 +222,7 @@ public function testGetSummaryStats()
             $localeDate,
             [],
             null,
-            null,
+            $sourceFactoryMock,
             $upload
         );
         $import->setData('entity', 'catalog_product');
diff --git a/app/code/Magento/ImportExport/Test/Unit/Model/ImportTest.php b/app/code/Magento/ImportExport/Test/Unit/Model/ImportTest.php
@@ -231,6 +231,7 @@ protected function setUp(): void
             ->expects($this->any())
             ->method('getDriver')
             ->willReturn($this->_driver);
+        $sourceFactoryMock = $this->createMock(\Magento\ImportExport\Model\Import\Source\Factory::class);
         $this->upload = $this->createMock(Upload::class);
         $this->import = $this->getMockBuilder(Import::class)
             ->setConstructorArgs(
@@ -251,7 +252,7 @@ protected function setUp(): void
                     $this->dateTime,
                     [],
                     null,
-                    null,
+                    $sourceFactoryMock,
                     $this->upload
                 ]
             )
