Update SftpLoader.php

.github/ci/files/.env

@@ -0,0 +1 @@
+APP_ENV=test

.github/ci/scripts/setup-pimcore-environment.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -eu -o xtrace
+
+cp .github/ci/files/.env .

.github/workflows/static-analysis.yml

@@ -0,0 +1,42 @@
+name: "Static Analysis"
+
+on:
+    pull_request:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+    push:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+
+jobs:
+    static-analysis-phpstan:
+        name: "Static Analysis with PHPStan"
+        runs-on: "ubuntu-20.04"
+        strategy:
+            matrix:
+                include:
+                    - { php-version: "8.0", dependencies: "lowest" }
+                    - { php-version: "8.1", dependencies: "highest" }
+        steps:
+            - name: "Checkout code"
+              uses: "actions/checkout@v2"
+
+            - name: "Install PHP"
+              uses: "shivammathur/setup-php@v2"
+              with:
+                  coverage: "none"
+                  php-version: "${{ matrix.php-version }}"
+
+            - name: "Setup Pimcore environment"
+              run: |
+                  .github/ci/scripts/setup-pimcore-environment.sh
+
+            - name: "Install dependencies with Composer"
+              uses: "ramsey/composer-install@v1"
+              with:
+                  dependency-versions: "${{ matrix.dependencies }}"
+
+            - name: "Run a static analysis with phpstan/phpstan"
+              run: "vendor/bin/phpstan analyse --memory-limit=-1"

.gitignore

@@ -2,6 +2,7 @@
 Thumbs.db
 *.log
 
+/.env
 /phpunit.xml
 
 # PHP-CS-Fixer
@@ -15,4 +16,4 @@ Thumbs.db
 !/vendor/.gitkeep
 
 # PhpStorm / IDEA
-.idea
+.idea

composer.json

@@ -6,17 +6,21 @@
     "sort-packages": true
   },
   "require": {
-    "php": ">=7.4",
-    "pimcore/pimcore": "^6.9 || ^10.0",
-    "pimcore/data-hub": "^0.7 || ^1.0",
-    "phpoffice/phpspreadsheet": "^1.1",
+    "php": "^8.0",
+    "pimcore/pimcore": "^10.2",
+    "pimcore/data-hub": "^1.2@dev",
+    "phpoffice/phpspreadsheet": "^1.15",
     "dragonmantank/cron-expression": "^3.1",
+    "nesbot/carbon": "^2.27",
     "league/flysystem": "^2.0",
     "league/flysystem-sftp": "^2.0",
     "league/flysystem-bundle" : "^2.0",
     "ext-json": "*",
     "ext-fileinfo": "*"
   },
+  "require-dev": {
+    "phpstan/phpstan": "^1.2"
+  },
   "autoload": {
     "psr-4": {
       "Pimcore\\Bundle\\DataImporterBundle\\": "src/"

doc/01_Installation.md

@@ -5,7 +5,7 @@ to be installed first.
 To install Pimcore Data Importer use following commands:
 
 ```bash
-composer require pimcore/data-importer
+composer require pimcore/data-importer --with-all-dependencies
 ./bin/console pimcore:bundle:enable PimcoreDataImporterBundle
 ```
 
@@ -21,4 +21,4 @@ Configure following commands to be executed on a regular base. The actual interv
 # Process import queue items that need to be executed sequentially 
 */5 * * * * php /home/project/www/bin/console datahub:data-importer:process-queue-sequential 
 ```
-See [Import Execution Details](04_Import_Execution_Details.md) for more information about sequential and parallel execution. 
+See [Import Execution Details](04_Import_Execution_Details.md) for more information about sequential and parallel execution. 

doc/03_Configuration/02_File_Formats.md

@@ -93,4 +93,6 @@ below, this the sub elements are interpreted as array in one field (and needs to
 Internally the adapter uses [Symfony `XmlUtils`](https://github.com/symfony/config/blob/master/Util/XmlUtils.php) to read 
 and validate the data.
 
+### Custom File Formats
+You can import any file format using custom adapters.
 

phpstan-bootstrap.php

@@ -0,0 +1,19 @@
+<?php
+
+if (file_exists(__DIR__ . '/vendor/autoload.php')) {
+    define('PIMCORE_PROJECT_ROOT', __DIR__);
+} elseif (file_exists(__DIR__ . '/../../../vendor/autoload.php')) {
+    define('PIMCORE_PROJECT_ROOT', __DIR__ . '/../../..');
+} elseif (getenv('PIMCORE_PROJECT_ROOT')) {
+    define('PIMCORE_PROJECT_ROOT', getenv('PIMCORE_PROJECT_ROOT'));
+} else {
+    throw new \Exception('Unknown configuration! Pimcore project root not found, please set env variable PIMCORE_PROJECT_ROOT.');
+}
+
+include PIMCORE_PROJECT_ROOT . '/vendor/autoload.php';
+\Pimcore\Bootstrap::setProjectRoot();
+\Pimcore\Bootstrap::bootstrap();
+
+if (!defined('PIMCORE_TEST')) {
+    define('PIMCORE_TEST', true);
+}

phpstan.neon

@@ -0,0 +1,10 @@
+parameters:
+    level: 4
+    paths:
+        - src
+    bootstrapFiles:
+        - phpstan-bootstrap.php
+    excludePaths:
+        - src/Command/DummyDataCommand.php
+    stubFiles:
+        - stubs/ElementInterface.stub

src/Cleanup/CleanupStrategyFactory.php

@@ -37,14 +37,14 @@ public function __construct(array $cleanupStrategies)
     /**
      * @param string $type
      *
-     * @return mixed
+     * @return CleanupStrategyInterface
      *
      * @throws InvalidConfigurationException
      */
     public function loadCleanupStrategy(string $type)
     {
         if (empty($type) || !array_key_exists($type, $this->cleanupStrategies)) {
-            throw new InvalidConfigurationException('Unknown loader type `' . ($type ?? '') . '`');
+            throw new InvalidConfigurationException('Unknown loader type `' . $type . '`');
         }
 
         return $this->cleanupStrategies[$type];

src/Command/DummyDataCommand.php

@@ -80,7 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             'email',
         ];
 
-        $count = $input->getOption('items');
+        $count = (int) $input->getOption('items');
 
         for ($i = 0; $i < $count; $i++) {
             $output->writeln('Generating item ' . $i . ' ...');
@@ -143,6 +143,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             default:
                 throw new \Exception('Invalid format: ' . $format);
         }
+
+        return 0;
     }
 
     protected function writeCsv(string $filename, array $data)

src/Controller/ConfigDataObjectController.php

@@ -87,13 +87,19 @@ public function saveAction(Request $request): ?JsonResponse
             $name = $dataDecoded['general']['name'];
             $dataDecoded['general']['active'] = $dataDecoded['general']['active'] ?? false;
             $config = Dao::getByName($name);
-
-            $oldConfig = $config->getConfiguration();
-
+            if (!$config->isAllowed('update')) {
+                throw $this->createAccessDeniedHttpException();
+            }
             $config->setConfiguration($dataDecoded);
-            $config->save();
 
-            return $this->json(['success' => true, 'modificationDate' => Dao::getConfigModificationDate()]);
+            // @phpstan-ignore-next-line isAllowed return can changed now
+            if ($config->isAllowed('read') && $config->isAllowed('update')) {
+                $config->save();
+
+                return $this->json(['success' => true, 'modificationDate' => Dao::getConfigModificationDate()]);
+            } else {
+                return $this->json(['success' => false, 'permissionError' => true]);
+            }
         } catch (\Exception $e) {
             return $this->json(['success' => false, 'message' => $e->getMessage()]);
         }
@@ -143,6 +149,7 @@ public function getAction(Request $request,
             [
                 'name' => $name,
                 'configuration' => $config,
+                'userPermissions' => $config['userPermissions'],
                 'modificationDate' => Dao::getConfigModificationDate(),
                 'columnHeaders' => $this->loadAvailableColumnHeaders($name, $config, $interpreterFactory)
             ]

src/DataSource/Interpreter/DeltaChecker/DeltaChecker.php

@@ -35,7 +35,7 @@ public function __construct(Db\ConnectionInterface $connection)
     protected function createTableIfNotExisting(\Closure $callable = null)
     {
         $this->db->executeQuery(sprintf('CREATE TABLE IF NOT EXISTS %s (
-            configName varchar(50) NOT NULL,
+            configName varchar(80) NOT NULL,
             id varchar(50) NOT NULL,
             hash varchar(100) NOT NULL,
             PRIMARY KEY (configName, id))

src/DataSource/Interpreter/JsonFileInterpreter.php

@@ -21,11 +21,12 @@
 class JsonFileInterpreter extends AbstractInterpreter
 {
     /**
-     * @var array
+     * @var array|null
      */
     protected $cachedContent = null;
+
     /**
-     * @var string
+     * @var string|null
      */
     protected $cachedFilePath = null;
 
@@ -57,9 +58,9 @@ public function setSettings(array $settings): void
     /**
      * remove BOM bytes to have a proper UTF-8
      *
-     * @param $content
+     * @param string $content
      *
-     * @return false|mixed|string
+     * @return string
      */
     protected function prepareContent($content)
     {
@@ -132,10 +133,8 @@ public function previewData(string $path, int $recordNumber = 0, array $mappedCo
                 $previewData[$index] = $columnData;
             }
 
-            if (empty($columns)) {
-                $keys = array_keys($previewData);
-                $columns = array_combine($keys, $keys);
-            }
+            $keys = array_keys($previewData);
+            $columns = array_combine($keys, $keys);
         }
 
         return new PreviewData($columns, $previewData, $readRecordNumber, $mappedColumns);

src/DataSource/Interpreter/XmlFileInterpreter.php

@@ -25,21 +25,22 @@
 class XmlFileInterpreter extends AbstractInterpreter
 {
     /**
-     * @var string
+     * @var string|null
      */
     protected $xpath;
 
     /**
-     * @var string
+     * @var string|null
      */
     protected $schema;
 
     /**
-     * @var \DOMDocument
+     * @var \DOMDocument|null
      */
     protected $cachedContent = null;
+
     /**
-     * @var string
+     * @var string|null
      */
     protected $cachedFilePath = null;
 

src/DataSource/Loader/SftpLoader.php

@@ -17,6 +17,7 @@
 
 use League\Flysystem\Filesystem;
 use League\Flysystem\FilesystemException;
+use League\Flysystem\Local\LocalFilesystemAdapter;
 use League\Flysystem\PhpseclibV2\SftpAdapter;
 use League\Flysystem\PhpseclibV2\SftpConnectionProvider;
 use Pimcore\Bundle\DataImporterBundle\Exception\InvalidConfigurationException;
@@ -83,12 +84,18 @@ public function loadData(): string
         );
 
         $filesystem = new Filesystem(new SftpAdapter($connectionProvider, '/'));
+        $filesystemLocal = new Filesystem(new LocalFilesystemAdapter('/'));
         try {
-            $filesystem->copy($this->remotePath, $this->importFilePath);
+            $readStream = $filesystem->readStream($this->remotePath);
+            $filesystemLocal->writeStream($this->importFilePath, $readStream);
+
+            return $this->importFilePath;
         } catch (FilesystemException $e) {
             Logger::error($e);
             throw new InvalidConfigurationException(sprintf('Could not copy from remote location `%s` to local tmp file `%s`', $loggingRemoteUrl, $this->importFilePath));
         }
+
+        throw new \Exception(sprintf('Could not find any files to load in path `%s`', $this->remotePath));
     }
 
     public function cleanup(): void

src/DependencyInjection/PimcoreDataImporterExtension.php

@@ -17,15 +17,17 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
  * This is the class that loads and manages your bundle configuration.
  *
  * @link http://symfony.com/doc/current/cookbook/bundles/extension.html
  */
-class PimcoreDataImporterExtension extends Extension
+class PimcoreDataImporterExtension extends Extension implements PrependExtensionInterface
 {
     /**
      * {@inheritdoc}
@@ -38,4 +40,19 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');
     }
+
+    /**
+     * @param ContainerBuilder $container
+     */
+    public function prepend(ContainerBuilder $container)
+    {
+        if ($container->hasExtension('doctrine_migrations')) {
+            $loader = new YamlFileLoader(
+                $container,
+                new FileLocator(__DIR__ . '/../Resources/config')
+            );
+
+            $loader->load('doctrine_migrations.yml');
+        }
+    }
 }

src/EventListener/ConfigurationEventSubscriber.php

@@ -84,9 +84,7 @@ public static function getSubscribedEvents()
      */
     public function postDelete(GenericEvent $event)
     {
-        /**
-         * @var $config Configuration
-         */
+        /** @var Configuration $config */
         $config = $event->getSubject();
 
         if ($config->getType() === 'dataImporterDataObject') {
@@ -117,9 +115,7 @@ public function postDelete(GenericEvent $event)
 
     public function postSave(GenericEvent $event)
     {
-        /**
-         * @var $config Configuration
-         */
+        /** @var Configuration $config */
         $config = $event->getSubject();
 
         if ($config->getType() === 'dataImporterDataObject') {