feat: import export bundle

Author: erdnaxelaweb

components/ImportExportBundle/composer.json

@@ -29,6 +29,7 @@
     }
   },
   "suggest": {
+    "matthiasnoback/symfony-console-form": "Used to execute workflow from CLI",
     "phpoffice/phpspreadsheet": "Used for the XlsReader",
     "symfony/messenger": "Used to run job asynchronously"
   },

components/ImportExportBundle/src/bundle/Command/ExecuteWorkflowCommand.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AlmaviaCX\Bundle\IbexaImportExportBundle\Command;
+
+use AlmaviaCX\Bundle\IbexaImportExport\Monolog\WorkflowConsoleLogger;
+use AlmaviaCX\Bundle\IbexaImportExport\Workflow\Form\Type\WorkflowProcessConfigurationFormType;
+use AlmaviaCX\Bundle\IbexaImportExport\Workflow\WorkflowConfiguration;
+use AlmaviaCX\Bundle\IbexaImportExport\Workflow\WorkflowEvent;
+use AlmaviaCX\Bundle\IbexaImportExport\Workflow\WorkflowExecutor;
+use AlmaviaCX\Bundle\IbexaImportExport\Workflow\WorkflowRegistry;
+use InvalidArgumentException;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ExecuteWorkflowCommand extends Command
+{
+    protected WorkflowRegistry $workflowRegistry;
+    protected WorkflowExecutor $workflowExecutor;
+
+    protected static $defaultName = 'import_export:workflow:execute';
+
+    public function __construct(WorkflowRegistry $workflowRegistry, WorkflowExecutor $workflowExecutor)
+    {
+        $this->workflowExecutor = $workflowExecutor;
+        $this->workflowRegistry = $workflowRegistry;
+        parent::__construct();
+    }
+
+    protected function configure()
+    {
+        parent::configure();
+        $this->addArgument('identifier', InputArgument::REQUIRED, 'Workflow identifier');
+        $this->addOption('debug', null, InputOption::VALUE_NONE, 'Enable debug mode');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $workflowIdentifier = $input->getArgument('identifier');
+        $workflow = $this->workflowRegistry->getWorkflow($workflowIdentifier);
+        $baseConfiguration = $workflow::getDefaultConfig();
+        if (!$baseConfiguration->isAvailable(WorkflowConfiguration::AVAILABILITY_CLI)) {
+            throw new InvalidArgumentException(sprintf('Workflow %s is not available', $workflowIdentifier));
+        }
+
+        /** @var \Matthias\SymfonyConsoleForm\Console\Helper\FormHelper $formHelper */
+        $formHelper = $this->getHelper('form');
+        $runtimeProcessConfiguration = $formHelper->interactUsingForm(
+            WorkflowProcessConfigurationFormType::class,
+            $input,
+            $output,
+            ['default_configuration' => $baseConfiguration->getProcessConfiguration()]
+        );
+
+        $progressBar = new ProgressBar($output);
+
+        $workflow->addEventListener(WorkflowEvent::START, function (WorkflowEvent $event) use ($progressBar) {
+            $progressBar->start($event->getWorkflow()->getTotalItemsCount());
+        });
+        $workflow->addEventListener(WorkflowEvent::PROGRESS, function () use ($progressBar) {
+            $progressBar->advance();
+        });
+        $logger = new WorkflowConsoleLogger($output);
+        $workflow->setLogger($logger);
+        $workflow->setDebug($input->getOption('debug'));
+        ($this->workflowExecutor)($workflow, $runtimeProcessConfiguration);
+        $workflow->clean();
+
+        return Command::SUCCESS;
+    }
+}

components/ImportExportBundle/src/bundle/Resources/config/forms.yaml

@@ -15,7 +15,12 @@ services:
     AlmaviaCX\Bundle\IbexaImportExport\Job\Form\JobCreateFlow:
         parent: craue.form.flow
 
+    AlmaviaCX\Bundle\IbexaImportExport\Reader\File\FileReaderOptionsFormType:
+        tags:
+            - { name: form.type, alias: FileReaderOptionsFormType }
+
     AlmaviaCX\Bundle\IbexaImportExport\Reader\Csv\CsvReaderOptionsFormType:
+        parent: AlmaviaCX\Bundle\IbexaImportExport\Reader\File\FileReaderOptionsFormType
         tags:
             - { name: form.type, alias: CsvReaderOptionsFormType }
 
@@ -24,6 +29,7 @@ services:
             - { name: form.type, alias: IbexaContentListReaderOptionsFormType }
 
     AlmaviaCX\Bundle\IbexaImportExport\Reader\Xls\XlsReaderOptionsFormType:
+        parent: AlmaviaCX\Bundle\IbexaImportExport\Reader\File\FileReaderOptionsFormType
         tags:
             - { name: form.type, alias: XlsReaderOptionsFormType }
 

components/ImportExportBundle/src/bundle/Resources/config/item_value_transformer/transformers.yaml

@@ -20,3 +20,19 @@ services:
     AlmaviaCX\Bundle\IbexaImportExport\Item\ValueTransformer\Utils\SprintfTransformer:
         tags:
             - { name: almaviacx.import_export.item.value_transformer, alias: almaviacx.import_export.item.value_transformer.sprintf}
+
+    AlmaviaCX\Bundle\IbexaImportExport\Item\ValueTransformer\Utils\ToStringTransformer:
+        tags:
+            - { name: almaviacx.import_export.item.value_transformer, alias: almaviacx.import_export.item.value_transformer.to_string}
+
+    AlmaviaCX\Bundle\IbexaImportExport\Item\ValueTransformer\Ibexa\HtmlToRichtextTransformer:
+        arguments:
+            $richtextInputHandler: '@Ibexa\FieldTypeRichText\RichText\InputHandler'
+        tags:
+            - { name: almaviacx.import_export.item.value_transformer, alias: almaviacx.import_export.item.value_transformer.html_to_richtext}
+
+    AlmaviaCX\Bundle\IbexaImportExport\Item\ValueTransformer\Ibexa\TextToRichtextTransformer:
+        arguments:
+            $htmlToRichtextTransformer: '@AlmaviaCX\Bundle\IbexaImportExport\Item\ValueTransformer\Ibexa\HtmlToRichtextTransformer'
+        tags:
+            - { name: almaviacx.import_export.item.value_transformer, alias: almaviacx.import_export.item.value_transformer.text_to_richtext}

components/ImportExportBundle/src/bundle/Resources/config/services.yaml

@@ -24,3 +24,10 @@ services:
             $router: '@router'
         tags:
             - { name: ibexa.notification.renderer, alias: import_export:notification:default }
+
+    AlmaviaCX\Bundle\IbexaImportExportBundle\Command\ExecuteWorkflowCommand:
+        arguments:
+            $workflowExecutor: '@AlmaviaCX\Bundle\IbexaImportExport\Workflow\WorkflowExecutor'
+            $workflowRegistry: '@AlmaviaCX\Bundle\IbexaImportExport\Workflow\WorkflowRegistry'
+        tags:
+            - console.command

components/ImportExportBundle/src/bundle/Resources/config/workflow/component/reader.yaml

@@ -9,6 +9,7 @@ services:
     AlmaviaCX\Bundle\IbexaImportExport\Reader\Csv\CsvReader:
         arguments:
             $fileHandler: '@AlmaviaCX\Bundle\IbexaImportExport\File\FileHandler'
+            $slugConverter: '@Ibexa\Core\Persistence\Legacy\Content\UrlAlias\SlugConverter'
         tags:
             - { name: almaviacx.import_export.reader, alias: reader.csv}
 

components/ImportExportBundle/src/lib/Accessor/ArrayAccessor.php

@@ -6,6 +6,7 @@
 
 use AlmaviaCX\Bundle\IbexaImportExport\Item\ItemAccessorInterface;
 use ArrayAccess;
+use Exception;
 
 class ArrayAccessor implements ItemAccessorInterface, ArrayAccess
 {
@@ -25,14 +26,27 @@ public function __construct(array $array)
      */
     public function offsetExists($offset): bool
     {
-        return isset($this->array, $offset);
+        return isset($this->array[$offset]);
     }
 
     /**
      * @param $offset
      */
     public function offsetGet($offset)
     {
+        if (!$this->offsetExists($offset)) {
+            throw new Exception(
+                sprintf(
+                    'Undefined offset: %s. 
+Available offsets are %s',
+                    $offset,
+                    implode(' / ', array_map(function ($value) {
+                        return "'$value'";
+                    }, array_keys($this->array)))
+                )
+            );
+        }
+
         return $this->array[$offset];
     }
 

components/ImportExportBundle/src/lib/Component/AbstractComponent.php

@@ -39,4 +39,8 @@ public function getOptions(): ComponentOptions
     {
         return $this->options;
     }
+
+    public function clean(): void
+    {
+    }
 }

components/ImportExportBundle/src/lib/Component/ComponentInterface.php

@@ -23,4 +23,6 @@ public static function getOptionsType(): ?string;
     public function setOptions(ComponentOptions $options): void;
 
     public function getOptions(): ComponentOptions;
+
+    public function clean(): void;
 }

components/ImportExportBundle/src/lib/Item/ItemMapper.php

@@ -80,7 +80,9 @@ protected function getPropertyValue($objectOrArray, $source)
                     return $this->getPropertyMultipleValue($objectOrArray, $source);
                 }
 
-                return $this->propertyAccessor->getValue($objectOrArray, $source);
+                $value = $this->propertyAccessor->getValue($objectOrArray, $source);
+
+                return is_string($value) ? trim($value) : $value;
             }
         } catch (NoSuchIndexException|NoSuchPropertyException  $exception) {
             return null;