Feature/digital signature modifications

CHANGELOG.md

@@ -11,6 +11,13 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 
 ## [Unreleased]
 
+- Added the ability to configure on which submission states handlers should run.
+  The default option is to run on the completed state. Changes was made to the
+  following handlers:
+  - Digital post
+  - Fasit
+  - FBS
+- Made submission have state draft during digital signature flow.
 - [PR-315](https://github.com/OS2Forms/os2forms/pull/315)
   Added “Display on“ options to Map element
 

modules/os2forms_digital_post/os2forms_digital_post.install

@@ -6,6 +6,7 @@
  */
 
 use Drupal\os2forms_digital_post\Helper\BeskedfordelerHelper;
+use Drupal\webform\WebformSubmissionInterface;
 
 /**
  * Implements hook_schema().
@@ -26,3 +27,34 @@ function os2forms_digital_post_update_9001(): void {
     'os2web_key',
   ], TRUE);
 }
+
+/**
+ * Set states config to completed on existing digital post handlers.
+ */
+function os2forms_digital_post_update_10001(): void {
+  // To avoid having to load full webforms we load and update webform configs.
+  $configFactory = \Drupal::configFactory();
+
+  foreach ($configFactory->listAll('webform.webform.') as $name) {
+    $config = $configFactory->getEditable($name);
+    $handlers = $config->get('handlers');
+    if (!is_array($handlers)) {
+      continue;
+    }
+
+    $changed = FALSE;
+
+    foreach ($handlers as $handlerKey => $handler) {
+      // $handler['id'] is the handler plugin id.
+      if (($handler['id'] ?? NULL) !== 'digital_post_sf1601') {
+        continue;
+      }
+      $handlers[$handlerKey]['settings']['additional']['states'] = [WebformSubmissionInterface::STATE_COMPLETED];
+      $changed = TRUE;
+    }
+
+    if ($changed) {
+      $config->set('handlers', $handlers)->save();
+    }
+  }
+}

modules/os2forms_digital_post/src/Plugin/WebformHandler/WebformHandlerSF1601.php

@@ -32,6 +32,8 @@ final class WebformHandlerSF1601 extends WebformHandlerBase {
   public const RECIPIENT_ELEMENT = 'recipient_element';
   public const ATTACHMENT_ELEMENT = 'attachment_element';
   public const SENDER_ADDRESS = 'sender_address';
+  private const string ADDITIONAL = 'additional';
+  private const string STATES = 'states';
 
   /**
    * Maximum length of sender label.
@@ -76,6 +78,9 @@ public static function create(ContainerInterface $container, array $configuratio
   public function defaultConfiguration() {
     return [
       'debug' => FALSE,
+      self::ADDITIONAL => [
+        self::STATES => [WebformSubmissionInterface::STATE_COMPLETED],
+      ],
     ];
   }
 
@@ -203,6 +208,31 @@ public function buildConfigurationForm(array $form, FormStateInterface $formStat
       '#default_value' => $this->configuration['debug'] ?? NULL,
     ];
 
+    // Additional.
+    // Lifted from EmailWebformHandler::buildConfigurationForm().
+    $resultsDisabled = (bool) $this->getWebform()->getSetting('results_disabled');
+    $form[self::ADDITIONAL] = [
+      '#type' => 'fieldset',
+      '#title' => $this->t('Additional settings'),
+    ];
+    // Settings: States.
+    $states = (array) ($this->configuration[self::ADDITIONAL][self::STATES] ?? NULL);
+    $form[self::ADDITIONAL][self::STATES] = [
+      '#type' => 'checkboxes',
+      '#title' => $this->t('Run handler when …'),
+      '#options' => [
+        WebformSubmissionInterface::STATE_DRAFT_CREATED => $this->t('<b>draft is created</b>.'),
+        WebformSubmissionInterface::STATE_DRAFT_UPDATED => $this->t('<b>draft is updated</b>.'),
+        WebformSubmissionInterface::STATE_CONVERTED => $this->t('anonymous <b>submission is converted</b> to authenticated.'),
+        WebformSubmissionInterface::STATE_COMPLETED => $this->t('<b>submission is completed</b>.'),
+        WebformSubmissionInterface::STATE_UPDATED => $this->t('<b>submission is updated</b>.'),
+        WebformSubmissionInterface::STATE_DELETED => $this->t('<b>submission is deleted</b>.'),
+        WebformSubmissionInterface::STATE_LOCKED => $this->t('<b>submission is locked</b>.'),
+      ],
+      '#access' => !$resultsDisabled,
+      '#default_value' => $resultsDisabled ? [WebformSubmissionInterface::STATE_COMPLETED] : $states,
+    ];
+
     return $this->setSettingsParents($form);
   }
 
@@ -333,6 +363,11 @@ static function (array $action) {
     $this->configuration[self::MEMO_ACTIONS] = $actions;
 
     $this->configuration['debug'] = (bool) $formState->getValue('debug');
+
+    $additional = $formState->getValue(self::ADDITIONAL);
+    // Clean up states.
+    $additional[self::STATES] = array_values(array_filter($additional[self::STATES]));
+    $this->configuration[self::ADDITIONAL] = $additional;
   }
 
   /**
@@ -341,6 +376,12 @@ static function (array $action) {
    * @phpstan-return void
    */
   public function postSave(WebformSubmissionInterface $webformSubmission, $update = TRUE) {
+    $submissionState = $webformSubmission->getWebform()->getSetting('results_disabled') ? WebformSubmissionInterface::STATE_COMPLETED : $webformSubmission->getState();
+    $enabledStates = (array) ($this->configuration[self::ADDITIONAL][self::STATES] ?? NULL);
+    if (!in_array($submissionState, $enabledStates)) {
+      return;
+    }
+
     $this->helper->createJob($webformSubmission, $this->configuration);
   }
 

modules/os2forms_digital_signature/src/Controller/DigitalSignatureController.php

@@ -136,6 +136,8 @@ public function signCallback($uuid, $hash, $fid = NULL) {
       $this->fileSystem->saveData($signedFileContent, $expectedFileUri, FileExists::Replace);
 
       // Updating webform submission.
+      $this->signingService->setSubmissionCompleted($webformSubmission);
+
       $webformSubmission->setLocked(TRUE);
       $webformSubmission->save();
 

modules/os2forms_digital_signature/src/Plugin/WebformHandler/DigitalSignatureWebformHandler.php

@@ -115,6 +115,8 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
       return;
     }
 
+    $this->signingService->setSubmissionDraft($webform_submission);
+
     $attachment = $this->getSubmissionAttachment($webform_submission);
     if (!$attachment) {
       $this->logger->error('Attachment cannot be created webform: %webform, webform_submission: %webform_submission',

modules/os2forms_digital_signature/src/Service/SigningService.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\os2forms_digital_signature\Service;
 
+use Drupal\webform\WebformSubmissionInterface;
 use Drupal\Component\Datetime\TimeInterface;
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Config\ImmutableConfig;
@@ -256,4 +257,34 @@ public function getServiceUrl() : string {
     return $url;
   }
 
+  /**
+   * Configure the webform submission as draft.
+   *
+   * This is the complementary function to setSubmissionCompleted.
+   *
+   * @param \Drupal\webform\WebformSubmissionInterface $webformSubmission
+   *   A webform submission.
+   *
+   * @see self::setSubmissionCompleted()
+   */
+  public function setSubmissionDraft(WebformSubmissionInterface $webformSubmission): void {
+    $webformSubmission->set('in_draft', TRUE);
+    $webformSubmission->setCompletedTime(0);
+  }
+
+  /**
+   * Configure the webform submission as completed.
+   *
+   * This is the complementary function to setSubmissionDraft.
+   *
+   * @param \Drupal\webform\WebformSubmissionInterface $webformSubmission
+   *   A webform submission.
+   *
+   * @see self::setSubmissionDraft()
+   */
+  public function setSubmissionCompleted(WebformSubmissionInterface $webformSubmission): void {
+    $webformSubmission->set('in_draft', FALSE);
+    $webformSubmission->setCompletedTime($this->time->getRequestTime());
+  }
+
 }

modules/os2forms_fasit/os2forms_fasit.install

@@ -5,6 +5,8 @@
  * Install hooks for os2forms_fasit.
  */
 
+use Drupal\webform\WebformSubmissionInterface;
+
 /**
  * Install Key module.
  */
@@ -13,3 +15,34 @@ function os2forms_fasit_update_9001(): void {
     'key',
   ], TRUE);
 }
+
+/**
+ * Set states config to completed on existing fasit handlers.
+ */
+function os2forms_fasit_update_10001(): void {
+  // To avoid having to load full webforms we load and update webform configs.
+  $configFactory = \Drupal::configFactory();
+
+  foreach ($configFactory->listAll('webform.webform.') as $name) {
+    $config = $configFactory->getEditable($name);
+    $handlers = $config->get('handlers');
+    if (!is_array($handlers)) {
+      continue;
+    }
+
+    $changed = FALSE;
+
+    foreach ($handlers as $handlerKey => $handler) {
+      // $handler['id'] is the handler plugin id.
+      if (($handler['id'] ?? NULL) !== 'os2forms_fasit') {
+        continue;
+      }
+      $handlers[$handlerKey]['settings']['additional']['states'] = [WebformSubmissionInterface::STATE_COMPLETED];
+      $changed = TRUE;
+    }
+
+    if ($changed) {
+      $config->set('handlers', $handlers)->save();
+    }
+  }
+}

modules/os2forms_fasit/src/Plugin/WebformHandler/FasitWebformHandler.php

@@ -35,6 +35,8 @@ class FasitWebformHandler extends WebformHandlerBase {
   public const FASIT_HANDLER_DOCUMENT_DESCRIPTION = 'document_description';
   public const FASIT_HANDLER_CPR_ELEMENT = 'cpr_element';
   public const FASIT_HANDLER_ATTACHMENT_ELEMENT = 'attachment_element';
+  private const string ADDITIONAL = 'additional';
+  private const string STATES = 'states';
 
   /**
    * The submission logger.
@@ -79,6 +81,19 @@ public static function create(ContainerInterface $container, array $configuratio
     );
   }
 
+  /**
+   * {@inheritdoc}
+   *
+   * @phpstan-return array<string, mixed>
+   */
+  public function defaultConfiguration() {
+    return [
+      self::ADDITIONAL => [
+        self::STATES => [WebformSubmissionInterface::STATE_COMPLETED],
+      ],
+    ];
+  }
+
   /**
    * {@inheritdoc}
    *
@@ -129,6 +144,31 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
       '#size' => 5,
     ];
 
+    // Additional.
+    // Lifted from EmailWebformHandler::buildConfigurationForm().
+    $resultsDisabled = (bool) $this->getWebform()->getSetting('results_disabled');
+    $form[self::ADDITIONAL] = [
+      '#type' => 'fieldset',
+      '#title' => $this->t('Additional settings'),
+    ];
+    // Settings: States.
+    $states = (array) ($this->configuration[self::ADDITIONAL][self::STATES] ?? NULL);
+    $form[self::ADDITIONAL][self::STATES] = [
+      '#type' => 'checkboxes',
+      '#title' => $this->t('Run handler when …'),
+      '#options' => [
+        WebformSubmissionInterface::STATE_DRAFT_CREATED => $this->t('<b>draft is created</b>.'),
+        WebformSubmissionInterface::STATE_DRAFT_UPDATED => $this->t('<b>draft is updated</b>.'),
+        WebformSubmissionInterface::STATE_CONVERTED => $this->t('anonymous <b>submission is converted</b> to authenticated.'),
+        WebformSubmissionInterface::STATE_COMPLETED => $this->t('<b>submission is completed</b>.'),
+        WebformSubmissionInterface::STATE_UPDATED => $this->t('<b>submission is updated</b>.'),
+        WebformSubmissionInterface::STATE_DELETED => $this->t('<b>submission is deleted</b>.'),
+        WebformSubmissionInterface::STATE_LOCKED => $this->t('<b>submission is locked</b>.'),
+      ],
+      '#access' => !$resultsDisabled,
+      '#default_value' => $resultsDisabled ? [WebformSubmissionInterface::STATE_COMPLETED] : $states,
+    ];
+
     return $this->setSettingsParents($form);
   }
 
@@ -143,12 +183,23 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
     $this->configuration[self::FASIT_HANDLER_GENERAL][self::FASIT_HANDLER_DOCUMENT_DESCRIPTION] = $form_state->getValue(self::FASIT_HANDLER_GENERAL)[self::FASIT_HANDLER_DOCUMENT_DESCRIPTION];
     $this->configuration[self::FASIT_HANDLER_GENERAL][self::FASIT_HANDLER_CPR_ELEMENT] = $form_state->getValue(self::FASIT_HANDLER_GENERAL)[self::FASIT_HANDLER_CPR_ELEMENT];
     $this->configuration[self::FASIT_HANDLER_GENERAL][self::FASIT_HANDLER_ATTACHMENT_ELEMENT] = $form_state->getValue(self::FASIT_HANDLER_GENERAL)[self::FASIT_HANDLER_ATTACHMENT_ELEMENT];
+
+    $additional = $form_state->getValue(self::ADDITIONAL);
+    // Clean up states.
+    $additional[self::STATES] = array_values(array_filter($additional[self::STATES]));
+    $this->configuration[self::ADDITIONAL] = $additional;
   }
 
   /**
    * {@inheritdoc}
    */
   public function postSave(WebformSubmissionInterface $webform_submission, $update = TRUE): void {
+    $submissionState = $webform_submission->getWebform()->getSetting('results_disabled') ? WebformSubmissionInterface::STATE_COMPLETED : $webform_submission->getState();
+    $enabledStates = (array) ($this->configuration[self::ADDITIONAL][self::STATES] ?? NULL);
+    if (!in_array($submissionState, $enabledStates)) {
+      return;
+    }
+
     $queueStorage = $this->entityTypeManager->getStorage('advancedqueue_queue');
     /** @var \Drupal\advancedqueue\Entity\Queue $queue */
     $queue = $queueStorage->load('fasit_queue');

modules/os2forms_fbs_handler/os2forms_fbs_handler.install

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * @file
+ * Install hooks for os2forms_fbs_handler.
+ */
+
+use Drupal\webform\WebformSubmissionInterface;
+
+/**
+ * Set states config to completed on existing fbs handlers.
+ */
+function os2forms_fbs_handler_update_10001(): void {
+  // To avoid having to load full webforms we load and update webform configs.
+  $configFactory = \Drupal::configFactory();
+
+  foreach ($configFactory->listAll('webform.webform.') as $name) {
+    $config = $configFactory->getEditable($name);
+    $handlers = $config->get('handlers');
+    if (!is_array($handlers)) {
+      continue;
+    }
+
+    $changed = FALSE;
+
+    foreach ($handlers as $handlerKey => $handler) {
+      // $handler['id'] is the handler plugin id.
+      if (($handler['id'] ?? NULL) !== 'os2forms_fbs') {
+        continue;
+      }
+      $handlers[$handlerKey]['settings']['additional']['states'] = [WebformSubmissionInterface::STATE_COMPLETED];
+      $changed = TRUE;
+    }
+
+    if ($changed) {
+      $config->set('handlers', $handlers)->save();
+    }
+  }
+}