Merge pull request #413 from itk-dev/feature/4239-maestro-task-console-bug

4239: Maestro bycontentfunction function validation

Author: jeppekroghitk

CHANGELOG.md

@@ -6,6 +6,9 @@ Nedenfor ses dato for release og beskrivelse af opgaver som er implementeret.
 
 ## [Under udvikling]
 
+* Tilføjede apostrof-regel til kodestandarder [PR-414](https://github.com/itk-dev/os2forms_selvbetjening/pull/414)
+* Tilføjede maestro bycontentfunction validation [PR-413](https://github.com/itk-dev/os2forms_selvbetjening/pull/413).
+
 ## [4.1.0] 2025-04-08
 
 * Ændrede PDF tabel visning [PR-404](https://github.com/itk-dev/os2forms_selvbetjening/pull/404)

config/sync/maestro.settings.yml

@@ -1,5 +1,5 @@
 maestro_send_notifications: 1
-maestro_orchestrator_task_console: 1
+maestro_orchestrator_task_console: 0
 maestro_redirect_location: /taskconsole
 maestro_orchestrator_token: AvfWr5bXdQcMpGTw4NHCMdjY44JXC8w0WOJUnq5s2zA3jh45TRHhCJfxcob0AqS
 maestro_orchestrator_lock_execution_time: '30'

phpcs.xml.dist

@@ -21,4 +21,5 @@
   </rule>
 
   <rule ref="DrupalPractice"/>
+  <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired"/>
 </ruleset>

web/modules/custom/os2forms_email_handler/src/Plugin/WebformHandler/OS2FormsEmailWebformHandler.php

@@ -214,7 +214,7 @@ private function convertToBytes(string $threshold): int {
     $units = ['KB', 'MB', 'GB'];
 
     // Get number of units and units from threshold.
-    preg_match("/(?<num>\d+)(?<units>kb|mb|gb)$/i", $threshold, $matches);
+    preg_match('/(?<num>\d+)(?<units>kb|mb|gb)$/i', $threshold, $matches);
 
     $size = (int) $matches['num'];
     $unit = strtoupper($matches['units']);
@@ -272,7 +272,7 @@ private function sendFileSizeNotification(WebformSubmissionInterface $webform_su
         $notificationMessage['subject'] = $this->t('File size submission warning');
 
         $notificationMessage['body'] = $this->t(
-          "<p>Dear @name</p><p>Submission @submission attempted sending an email with a large total file size of attachments surpassing @threshold for handler @handler (@handler_id) on form @form (@form_id).</p>", [
+          '<p>Dear @name</p><p>Submission @submission attempted sending an email with a large total file size of attachments surpassing @threshold for handler @handler (@handler_id) on form @form (@form_id).</p>', [
             '@name' => $emailAddress,
             '@submission' => $context['link'],
             '@handler' => $context['@handler'],

web/modules/custom/os2forms_selvbetjening/os2forms_selvbetjening.services.yml

@@ -1,4 +1,7 @@
 services:
+  logger.channel.os2forms_selvbetjening:
+    parent: logger.channel_base
+    arguments: [ 'os2forms_selvbetjening' ]
 
   Drupal\os2forms_selvbetjening\Helper\WebformConfigurationExporter:
     arguments:
@@ -8,6 +11,7 @@ services:
   Drupal\os2forms_selvbetjening\Helper\FormHelper:
     arguments:
       - '@current_user'
+      - '@logger.channel.os2forms_selvbetjening'
 
   Drupal\Drupal\os2forms_selvbetjening\Form\SettingsForm:
     arguments:

web/modules/custom/os2forms_selvbetjening/src/Helper/FormHelper.php

@@ -4,6 +4,7 @@
 
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Link;
+use Drupal\Core\Logger\LoggerChannel;
 use Drupal\Core\Render\Element;
 use Drupal\Core\Session\AccountInterface;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
@@ -21,8 +22,10 @@ class FormHelper {
    *
    * @param \Drupal\Core\Session\AccountInterface $account
    *   Current user.
+   * @param \Drupal\Core\Logger\LoggerChannel $logger
+   *   Logger.
    */
-  public function __construct(private readonly AccountInterface $account) {
+  public function __construct(private readonly AccountInterface $account, private readonly LoggerChannel $logger) {
   }
 
   /**
@@ -99,6 +102,91 @@ public function formAlter(array &$form, FormStateInterface $form_state, string $
       ];
     }
 
+    if ('template_edit_task' === $form_id) {
+      $form['#validate'][] = [$this, 'validateByContentFunction'];
+    }
+  }
+
+  /**
+   * Validates form input by checking a user-defined function.
+   *
+   * This method ensures that:
+   * - The specified function exists.
+   * - The number of provided parameters matches
+   * the defined function's requirements,
+   *   adjusted for additional parameters added during execution.
+   *
+   * @param array $form
+   *   The form structure.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The current state of the form.
+   */
+  public function validateByContentFunction(array &$form, FormStateInterface $form_state): void {
+    if ('bycontentfunction' === $form_state->getValue(['spv', 'method'])) {
+
+      // Get function name and parameters defined in the flow task.
+      $value = $form_state->getValue(['spv', 'variable_value']);
+
+      // Split function name and parameters (format: function:param1,param2).
+      $functionParts = explode(':', $value, 2);
+
+      // Get function name and parameters.
+      $functionName = $functionParts[0];
+      $functionParams = isset($functionParts[1]) ? explode(',', $functionParts[1]) : [];
+
+      // Get number of parameters.
+      $paramCount = count($functionParams);
+
+      if (!function_exists($functionName)) {
+        $form_state->setError($form['spv'], $this->t('Function %function_name does not exist', ['%function_name' => $functionName]));
+        return;
+      }
+
+      // Get the number of parameters for the defined function.
+      try {
+        $functionParamCount = (new \ReflectionFunction($functionName))->getNumberOfRequiredParameters();
+      }
+      catch (\ReflectionException $e) {
+        $form_state->setError(
+          $form['spv'],
+          $this->t('Invalid function %function_name', [
+            '%function_name' => $functionName,
+          ])
+        );
+        $this->logger->error('Error reflecting function %function_name: %message', [
+          '%function_name' => $functionName,
+          '%message' => $e->getMessage(),
+           // Add the full exception to the context for future reference.
+          'exception' => $e,
+        ]);
+        return;
+      }
+
+      // The maestro execute method always adds 2 parameters
+      // (queueID and processID) when handling the "bycontentfunction" case.
+      // @see MaestroSetProcessVariableTask::execute()
+      $functionParamCount -= 2;
+
+      if ($functionParamCount < 0) {
+        $form_state->setError($form['spv'], $this->t('Function %function_name is required to take at least 2 arguments.', ['%function_name' => $functionName]));
+        return;
+      }
+
+      // Check if the number of parameters matches.
+      if ($paramCount !== $functionParamCount) {
+        $form_state->setError(
+          $form['spv'],
+          $this->t(
+            'Function %function_name expects %function_parameter_count parameters. %parameter_defined_count given.',
+            [
+              '%function_name' => $functionName,
+              '%function_parameter_count' => $functionParamCount,
+              '%parameter_defined_count' => $paramCount,
+            ]
+          )
+        );
+      }
+    }
   }
 
 }