implement import options, resolves #466 (#515)

solverat · web-flow · commit 0cf9c96a1e86 · 2025-03-07T11:14:13.000+01:00
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -4,6 +4,7 @@
 - **[IMPROVEMENT]** New field added to `form_builder_form_attributes`: `autocomplete`
 - **[BUGFIX]** Solidify check for empty value in output transformer [#486](https://github.com/dachcom-digital/pimcore-formbuilder/issues/508)
 - **[SECURITY FEATURE]** Math CAPTCHA Field [#511](https://github.com/dachcom-digital/pimcore-formbuilder/issues/511), read more about it [here](./docs/03_SpamProtection.md#math-captcha)
+- **[NEW FEATURE]** Form Import Options [#466](https://github.com/dachcom-digital/pimcore-formbuilder/issues/466)
 
 ## 5.2.0
 - **[LICENSE]** Dual-License with GPL and Dachcom Commercial License (DCL) added
diff --git a/config/pimcore/routing.yaml b/config/pimcore/routing.yaml
@@ -28,13 +28,20 @@ form_builder.controller.admin.load_form_mail_editor_data:
 form_builder.controller.admin.export_form:
     path: /admin/formbuilder/settings/export-form/{id}
     defaults: { _controller: FormBuilderBundle\Controller\Admin\ExportController::exportFormAction }
+    options:
+        expose: true
+
 form_builder.controller.admin.import_form:
     path: /admin/formbuilder/settings/import-form/{id}
     defaults: { _controller: FormBuilderBundle\Controller\Admin\ExportController::importFormAction }
+    options:
+        expose: true
 
 form_builder.controller.admin.csv_export.export:
     path: /admin/formbuilder/export/mail-csv-export/{id}
     defaults: { _controller: FormBuilderBundle\Controller\Admin\ExportController::exportFormEmailsAction }
+    options:
+        expose: true
 
 form_builder.controller.admin.get_group_templates:
     path: /admin/formbuilder/settings/get-group-templates
diff --git a/public/js/extjs/_form/tab/configPanel.js b/public/js/extjs/_form/tab/configPanel.js
@@ -942,7 +942,7 @@ Formbuilder.extjs.formPanel.config = Class.create({
         return toolbar;
     },
 
-    showFormDoubleOptInData: function() {
+    showFormDoubleOptInData: function () {
         new Formbuilder.extjs.extensions.formDoubleOptInData(this.formId, this.formConfig.doubleOptIn);
     },
 
@@ -1180,42 +1180,27 @@ Formbuilder.extjs.formPanel.config = Class.create({
         }
     },
 
-    /**
-     * Create Import Panel (Upload File)
-     */
     showImportPanel: function () {
-        Ext.Msg.confirm(t('export'), t('form_builder.import_note'), function (btn) {
 
-            if (btn !== 'yes') {
-                return;
-            }
+        var importPanel;
 
-            var importPanel = new Formbuilder.extjs.components.formImporter(this);
-            importPanel.showPanel();
-        }.bind(this));
+        importPanel = new Formbuilder.extjs.components.formImporter(this);
+        importPanel.showPanel();
     },
 
     importForm: function (formId) {
         this.formSelectionPanel.rebuildFormPanel(formId);
     },
 
-    /**
-     * Trigger browser download (if form is valid)
-     * -> for form export
-     */
     exportForm: function () {
 
         if (!this.formIsValid()) {
             return;
         }
 
-        pimcore.helpers.download('/admin/formbuilder/settings/export-form/' + this.formId);
+        pimcore.helpers.download(Routing.generate('form_builder.controller.admin.export_form', {id: this.formId}));
     },
 
-    /**
-     * Trigger browser download
-     * -> for csv export of sent emails
-     */
     exportFormEmailCsv: function () {
         var mailTypeField = this.exportPanel.query('combo'),
             mailTypeValue = 'all';
@@ -1224,7 +1209,9 @@ Formbuilder.extjs.formPanel.config = Class.create({
             mailTypeValue = mailTypeField[0].getValue();
         }
 
-        pimcore.helpers.download('/admin/formbuilder/export/mail-csv-export/' + this.formId + '?mailType=' + mailTypeValue);
+        pimcore.helpers.download(
+            Routing.generate('form_builder.controller.admin.csv_export.export', {id: this.formId, mailType: mailTypeValue})
+        );
     },
 
     save: function (ev) {
diff --git a/public/js/extjs/components/formImporterComponent.js b/public/js/extjs/components/formImporterComponent.js
@@ -13,69 +13,127 @@ Formbuilder.extjs.components.formImporter = Class.create({
 
     showPanel: function () {
 
-        var url = '/admin/formbuilder/settings/import-form/' + this.importId,
-            uploadForm, requestParams = {};
+        var uploadForm,
+            requestParams = {};
 
         this.uploadWindow = new Ext.Window({
             autoHeight: true,
             title: t('upload'),
             closeAction: 'close',
-            width: 400,
+            width: 600,
             modal: true
         });
 
         if (pimcore.hasOwnProperty('settings') && pimcore.settings.hasOwnProperty('csrfToken')) {
-            requestParams = {csrfToken: pimcore.settings['csrfToken'], formId: this.parentPanel.formId};
+            requestParams = {
+                csrfToken: pimcore.settings['csrfToken'],
+                formId: this.parentPanel.formId
+            };
         }
 
         uploadForm = new Ext.form.FormPanel({
             bodyStyle: 'padding:10px',
             border: false,
             fileUpload: true,
-            width: 400,
-            items: [{
-                xtype: 'fileuploadfield',
-                emptyText: t('form_builder_upload_configuration_file'),
-                fieldLabel: t('form_builder_file'),
-                width: 300,
-                name: 'formData',
-                buttonText: '',
-                buttonConfig: {
-                    iconCls: 'pimcore_icon_upload'
+            autoHeight: true,
+            items: [
+                {
+                    xtype: 'fieldset',
+                    title: t('form_builder_upload_configuration.section'),
+                    collapsible: false,
+                    collapsed: false,
+                    autoHeight: true,
+                    defaults: {
+                        labelWidth: 170
+                    },
+                    name: 'options',
+                    items: [
+                        {
+                            xtype: 'label',
+                            style: 'display:block; padding:5px; background:#fff; border:1px solid #eee; font-weight: 300;',
+                            text: t('form_builder.import_note')
+                        },
+                        {
+                            xtype: 'checkbox',
+                            value: true,
+                            inputValue: true,
+                            uncheckedValue: false,
+                            fieldLabel: t('form_builder_upload_configuration.section.output_workflows'),
+                            name: 'outputWorkflows',
+                        },
+                        {
+                            xtype: 'checkbox',
+                            value: true,
+                            inputValue: true,
+                            uncheckedValue: false,
+                            fieldLabel: t('form_builder_upload_configuration.section.conditional_logic'),
+                            name: 'conditionalLogic',
+                        }
+                    ]
+                },
+                {
+                    xtype: 'fileuploadfield',
+                    emptyText: t('form_builder_upload_configuration.file'),
+                    fieldLabel: t('form_builder_file'),
+                    name: 'formData',
+                    allowBlank: false,
+                    width: '100%',
+                    buttonConfig: {
+                        iconCls: 'pimcore_icon_upload'
+                    }
                 },
-                listeners: {
-                    change: function () {
+                {
+                    xtype: 'button',
+                    text: t('import'),
+                    iconCls: 'pimcore_icon_import',
+                    handler: function (b) {
+
+                        if (!uploadForm.isValid()) {
+                            return;
+                        }
+
+                        b.setDisabled(true);
+
                         uploadForm.getForm().submit({
-                            url: url,
-                            params: requestParams,
+                            url: Routing.generate('form_builder.controller.admin.import_form', {id: this.importId}),
+                            params: Ext.Object.merge(requestParams, uploadForm.getValues()),
                             waitMsg: t('please_wait'),
                             success: this.getImportComplete.bind(this),
                             failure: function (el, data) {
+
+                                var response;
+
                                 this.uploadWindow.close();
-                                var response = Ext.decode(data.response.responseText);
-                                Ext.Msg.alert(t('error'), response && response.hasOwnProperty('message') ? response.message : data.response.responseText);
+                                response = Ext.decode(data.response.responseText);
+
+                                Ext.Msg.alert(
+                                    t('error'),
+                                    response && response.hasOwnProperty('message')
+                                        ? response.message
+                                        : data.response.responseText
+                                );
                             }.bind(this)
                         });
                     }.bind(this)
                 }
-            }]
+            ]
         });
 
         this.uploadWindow.add(uploadForm);
         this.uploadWindow.show();
         this.uploadWindow.setWidth(400);
         this.uploadWindow.updateLayout();
-
     },
 
     getImportComplete: function (el, data) {
+
         var response = Ext.decode(data.response.responseText);
         this.uploadWindow.close();
+
         if (response.success === true) {
             this.parentPanel.importForm(response.formId);
         } else {
             Ext.Msg.alert(t('error'), response.message);
         }
     }
-
 });
diff --git a/src/Controller/Admin/ExportController.php b/src/Controller/Admin/ExportController.php
@@ -40,6 +40,7 @@ public function __construct(protected FormDefinitionManager $formDefinitionManag
     public function importFormAction(Request $request, ImportExportProcessor $importExportProcessor): JsonResponse
     {
         $formId = (int) $request->request->get('formId');
+
         /** @var UploadedFile $file */
         $file = $request->files->get('formData');
         $data = file_get_contents($file->getPathname());
@@ -55,14 +56,24 @@ public function importFormAction(Request $request, ImportExportProcessor $import
             'message' => null,
         ];
 
+        $importOptions = [
+            ImportExportProcessor::FORM_SECTION_OUTPUT_WORKFLOWS  => $request->request->get('outputWorkflows') === 'true',
+            ImportExportProcessor::FORM_SECTION_CONDITIONAL_LOGIC => $request->request->get('conditionalLogic') === 'true',
+        ];
+
         try {
-            $importExportProcessor->processYamlToFormDefinition($formId, $data);
+            $importExportProcessor->processYamlToFormDefinition($formId, $data, $importOptions);
         } catch (\Throwable $e) {
             $response['success'] = false;
             $response['message'] = sprintf('Error while importing form definition: %s', $e->getMessage());
         }
 
-        return new JsonResponse(json_encode($response, JSON_THROW_ON_ERROR), 200, ['Content-Type' => 'text/plain'], true);
+        return new JsonResponse(
+            json_encode($response, JSON_THROW_ON_ERROR),
+            200,
+            ['Content-Type' => 'text/plain'],
+            true
+        );
     }
 
     public function exportFormAction(Request $request, ImportExportProcessor $importExportProcessor): Response
@@ -102,10 +113,23 @@ public function exportFormEmailsAction(Request $request): Response
         }
 
         $emailLogs = new Email\Log\Listing();
-        $emailLogs->addConditionParam('params LIKE :form', ['form' => sprintf('%%%s%%', $this->generateFormIdQuery($formId))]);
+        $emailLogs->addConditionParam(
+            'params LIKE :form',
+            [
+                'form' => sprintf('%%%s%%', $this->generateFormIdQuery($formId))
+            ]
+        );
 
         if ($filter !== 'all') {
-            $emailLogs->addConditionParam('params LIKE :workflow', ['workflow' => sprintf('%%%s%%', $this->generateOutputWorkflowFilterQuery($formId, (int) $filter))]);
+            $emailLogs->addConditionParam(
+                'params LIKE :workflow',
+                [
+                    'workflow' => sprintf(
+                        '%%%s%%',
+                        $this->generateOutputWorkflowFilterQuery($formId, (int) $filter)
+                    )
+                ]
+            );
         }
 
         $response = new Response();
diff --git a/src/Tool/ImportExportProcessor.php b/src/Tool/ImportExportProcessor.php
@@ -24,6 +24,9 @@
 
 class ImportExportProcessor
 {
+    public const FORM_SECTION_OUTPUT_WORKFLOWS = 'outputWorkflows';
+    public const FORM_SECTION_CONDITIONAL_LOGIC = 'conditionalLogic';
+
     public function __construct(
         protected Connection $connection,
         protected FormDefinitionManager $formDefinitionManager,
@@ -36,7 +39,6 @@ public function __construct(
      */
     public function processFormDefinitionToYaml(int $formId): string
     {
-        // load raw entity
         $fQb = $this->connection->createQueryBuilder();
         $fQb
             ->select('*')
@@ -58,7 +60,7 @@ public function processFormDefinitionToYaml(int $formId): string
             ->setParameter('id', $formId);
 
         $outputWorkflows = [];
-        foreach ($fowQb->execute()->fetchAllAssociative() as $rawFormOutputWorkflowDefinition) {
+        foreach ($fowQb->executeQuery()->fetchAllAssociative() as $rawFormOutputWorkflowDefinition) {
             $fowChannelQb = $this->connection->createQueryBuilder();
             $fowChannelQb
                 ->select('*')
@@ -67,11 +69,11 @@ public function processFormDefinitionToYaml(int $formId): string
                 ->setParameter('id', $rawFormOutputWorkflowDefinition['id']);
 
             $channels = [];
-            foreach ($fowChannelQb->execute()->fetchAllAssociative() as $rawFormOutputWorkflowChannelDefinition) {
+            foreach ($fowChannelQb->executeQuery()->fetchAllAssociative() as $rawFormOutputWorkflowChannelDefinition) {
                 $channels[] = [
-                    'type'          => $rawFormOutputWorkflowChannelDefinition['type'],
-                    'name'          => $rawFormOutputWorkflowChannelDefinition['name'],
-                    'configuration' => is_string($rawFormOutputWorkflowChannelDefinition['configuration'])
+                    'type'           => $rawFormOutputWorkflowChannelDefinition['type'],
+                    'name'           => $rawFormOutputWorkflowChannelDefinition['name'],
+                    'configuration'  => is_string($rawFormOutputWorkflowChannelDefinition['configuration'])
                         ? unserialize($rawFormOutputWorkflowChannelDefinition['configuration'], ['allowed_classes' => false])
                         : null,
                     'funnel_actions' => is_string($rawFormOutputWorkflowChannelDefinition['funnel_actions'])
@@ -109,7 +111,7 @@ public function processFormDefinitionToYaml(int $formId): string
     /**
      * @throws \Throwable
      */
-    public function processYamlToFormDefinition(int $formId, mixed $data): void
+    public function processYamlToFormDefinition(int $formId, mixed $data, array $importOptions): void
     {
         $formContent = Yaml::parse($data);
 
@@ -124,14 +126,21 @@ public function processYamlToFormDefinition(int $formId, mixed $data): void
         }
 
         $data = [
-            'form_name'              => $formDefinition->getName(),
-            'form_config'            => $formContent['configuration'] ?? [],
-            'form_conditional_logic' => $formContent['conditional_logic'] ?? [],
-            'form_fields'            => $formContent['fields'] ? ['fields' => $formContent['fields']] : [],
+            'form_name'   => $formDefinition->getName(),
+            'form_config' => $formContent['configuration'] ?? [],
+            'form_fields' => $formContent['fields'] ? ['fields' => $formContent['fields']] : [],
         ];
 
+        if ($importOptions[self::FORM_SECTION_CONDITIONAL_LOGIC] === true) {
+            $data['form_conditional_logic'] = $formContent['conditional_logic'] ?? [];
+        }
+
         $this->formDefinitionManager->save($data, $formDefinition->getId());
 
+        if ($importOptions[self::FORM_SECTION_OUTPUT_WORKFLOWS] === false) {
+            return;
+        }
+
         // remove all workflows and channels first (yes, we informed users about that earlier)
         /** @var OutputWorkflowInterface $outputWorkflow */
         foreach ($formDefinition->getOutputWorkflows() as $outputWorkflow) {
diff --git a/tests/Acceptance/ExtJs/ImportExportCest.php b/tests/Acceptance/ExtJs/ImportExportCest.php
diff --git a/translations/admin.de.yml b/translations/admin.de.yml
diff --git a/translations/admin.en.yml b/translations/admin.en.yml
