Validate "Command options" #222

Author: ctippler

src/Controller/ConfigController.php

@@ -153,6 +153,7 @@ public function save(Request $request): JsonResponse
         $configuration->setExecutorSettings($executorClass->getStorageValue());
 
         try {
+            $executorClass->validateConfiguration($configuration);
             $configuration->save(['oldId' => $request_configuration]);
         } catch (\Exception $e) {
             return $this->jsonResponse(['success' => false, 'message' => $e->getMessage()]);

src/Executor/AbstractExecutor.php

@@ -268,4 +268,12 @@ public function setDataFromResource(Configuration $configuration): Configuration
 
         return $configuration;
     }
+
+    /**
+     * Validate the configuration settings and throw exception if something is wrong
+     */
+    public function validateConfiguration(Configuration $configuration): void
+    {
+
+    }
 }

src/Executor/PimcoreCommand.php

@@ -7,8 +7,10 @@
 
 namespace Elements\Bundle\ProcessManagerBundle\Executor;
 
+use Elements\Bundle\ProcessManagerBundle\Model\Configuration;
 use Elements\Bundle\ProcessManagerBundle\Model\MonitoringItem;
 use Elements\Bundle\ProcessManagerBundle\Service\CommandsValidator;
+use Exception;
 use Pimcore\Tool\Console;
 
 class PimcoreCommand extends AbstractExecutor
@@ -22,6 +24,7 @@ class PimcoreCommand extends AbstractExecutor
      * @param null | MonitoringItem $monitoringItem
      *
      * @return mixed
+     * @throws Exception
      */
     public function getCommand($callbackSettings = [], $monitoringItem = null)
     {
@@ -37,7 +40,7 @@ public function getCommand($callbackSettings = [], $monitoringItem = null)
             $commands = \Pimcore::getKernel()->getContainer()->get(CommandsValidator::class)->getValidCommands();
 
             if (!array_key_exists($this->getValues()['command'], $commands)) {
-                throw new \Exception('Invalid command - not in valid commands');
+                throw new Exception('Invalid command - not in valid commands');
             }
             /**
              * @var \Pimcore\Console\AbstractCommand $commandObject
@@ -55,4 +58,21 @@ public function getCommand($callbackSettings = [], $monitoringItem = null)
 
         return $command;
     }
+
+    public function validateConfiguration(Configuration $configuration): void
+    {
+
+        if($configuration->getExecutorSettings()){
+            $settings = $configuration->getExecutorSettingsAsArray();
+            $values = $settings['values'];
+            if(!$values['command']){
+                throw new Exception('Please provide a command.');
+            }
+            $commandValidator = \Pimcore::getKernel()->getContainer()->get(CommandsValidator::class);
+            $commands = \Pimcore::getKernel()->getContainer()->get(CommandsValidator::class)->getValidCommands();
+            $commandValidator->validateCommandConfiguration($commands[$values['command']], $configuration);
+
+
+        }
+    }
 }

src/Model/Configuration.php

@@ -139,6 +139,12 @@ public function getExecutorSettings(): string
         return $this->executorSettings;
     }
 
+    public function getExecutorSettingsAsArray(): array
+    {
+        return json_decode($this->getExecutorSettings(), true);
+    }
+
+
     /**
      * @return $this
      */

src/Resources/public/js/executor/class/abstractExecutor.js

@@ -278,7 +278,11 @@ pimcore.plugin.processmanager.executor.class.abstractExecutor = Class.create(pim
                         Ext.getCmp('plugin_pm_config_list_panel').store.reload();
                     }
                     else {
-                        pimcore.helpers.showNotification(t("error"), t("plugin_pm_config_saved_error"), "error", t(rdata.message));
+                        let errorMessage = t("plugin_pm_config_saved_error");
+                        if(rdata.message) {
+                            errorMessage += ': ' + rdata.message
+                        }
+                        pimcore.helpers.showNotification(t("error"),  errorMessage , "error");
                     }
                 } catch (e) {
                     pimcore.helpers.showNotification(t("error"), t("plugin_pm_config_saved_error"), "error");

src/Resources/public/js/executor/class/pimcoreCommand.js

@@ -17,7 +17,6 @@ pimcore.plugin.processmanager.executor.class.pimcoreCommand = Class.create(pimco
         }
 
         this.command = {
-            fieldLabel: t("plugin_pm_command"),
             xtype: "combo",
             editable: false,
             name: "command",
@@ -26,8 +25,10 @@ pimcore.plugin.processmanager.executor.class.pimcoreCommand = Class.create(pimco
             store: store,
             mode: "local",
             width: "100%",
-            triggerAction: "all"
+            triggerAction: "all",
+            mandatory: true
         }
+        this.command.fieldLabel = this.getFieldLabel('command',this.command)
         return this.command;
     },
 

src/Service/CommandsValidator.php

@@ -8,6 +8,8 @@
 namespace Elements\Bundle\ProcessManagerBundle\Service;
 
 use Elements\Bundle\ProcessManagerBundle\ExecutionTrait;
+use Elements\Bundle\ProcessManagerBundle\Model\Configuration;
+use Exception;
 use Pimcore\Console\Application;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\LazyCommand;
@@ -40,6 +42,22 @@ public function __construct(string $strategy = 'default', array $whiteList = [],
         $this->setBlackList($blackList);
     }
 
+    public function validateCommandConfiguration(LazyCommand | Command $command, Configuration $configuration): void
+    {
+
+        $settings = $configuration->getExecutorSettingsAsArray();
+        $values = $settings['values'];
+
+        $commandOptions = $values['commandOptions'] ?? '';
+
+
+
+        //Todo: check if command options are valid
+        //and throw an error if they are not valid
+
+#        throw new Exception('Command options are not valid');
+
+    }
     /**
      * @return array<mixed>
      */