Merge branch 'develop' into hotfix/add-missing-handler-condition

Author: martinyde

CHANGELOG.md

@@ -11,7 +11,19 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 
 ## [Unreleased]
 
-- Added condition to maestro notification submission handler
+- [PR-215](https://github.com/OS2Forms/os2forms/pull/215)
+  Added condition to maestro notification submission handler
+- [PR-101](https://github.com/OS2Forms/os2forms/pull/101)
+  - Added support for `os2web_key` in Digital post
+    - Switched from saving settings in key value store to config, i.e
+      the module needs to be reconfigured.
+  - Added support for `os2web_key` in Fasit handler.
+    - Switched from saving settings in key value store to config, i.e
+      the module needs to be reconfigured.
+- [PR-179](https://github.com/OS2Forms/os2forms/pull/179)
+  Remove unused and abandoned package `webmozart/path-util`.
+- [PR-167](https://github.com/OS2Forms/os2forms/pull/167)
+  Adding os2forms_digital_signature module
 
 ## [4.1.0] 2025-06-03
 

composer.json

@@ -58,13 +58,13 @@
         "itk-dev/serviceplatformen": "^1.5",
         "mglaman/composer-drupal-lenient": "^1.0",
         "os2web/os2web_audit": "^1.0",
-        "os2web/os2web_datalookup": "^2.0",
+        "os2web/os2web_datalookup": "^3.0",
+        "os2web/os2web_key": "^1.0",
         "os2web/os2web_nemlogin": "^1.0",
         "os2web/os2web_simplesaml": "dev-master",
         "php-http/guzzle7-adapter": "^1.0",
         "phpoffice/phpword": "^0.18.2",
         "symfony/options-resolver": "^5.4 || ^6.0",
-        "webmozart/path-util": "^2.3",
         "wsdltophp/packagebase": "^5.0",
         "zaporylie/composer-drupal-optimizations": "^1.2"
     },

modules/os2forms_attachment/os2forms_attachment.services.yml

@@ -1,4 +1,4 @@
 services:
   os2forms_attachment.print_builder:
     class: Drupal\os2forms_attachment\Os2formsAttachmentPrintBuilder
-    arguments: ['@entity_print.renderer_factory', '@event_dispatcher', '@string_translation']
+    arguments: ['@entity_print.renderer_factory', '@event_dispatcher', '@string_translation', '@file_system']

modules/os2forms_attachment/src/Element/AttachmentElement.php

@@ -20,6 +20,7 @@ public function getInfo() {
     return parent::getInfo() + [
       '#view_mode' => 'html',
       '#export_type' => 'pdf',
+      '#digital_signature' => FALSE,
       '#template' => '',
     ];
   }
@@ -28,6 +29,8 @@ public function getInfo() {
    * {@inheritdoc}
    */
   public static function getFileContent(array $element, WebformSubmissionInterface $webform_submission) {
+    $submissionUuid = $webform_submission->uuid();
+
     // Override webform settings.
     static::overrideWebformSettings($element, $webform_submission);
 
@@ -51,18 +54,43 @@ public static function getFileContent(array $element, WebformSubmissionInterface
     \Drupal::request()->request->set('_webform_submissions_view_mode', $view_mode);
 
     if ($element['#export_type'] === 'pdf') {
-      // Get scheme.
-      $scheme = 'temporary';
-
-      // Get filename.
-      $file_name = 'webform-entity-print-attachment--' . $webform_submission->getWebform()->id() . '-' . $webform_submission->id() . '.pdf';
-
-      // Save printable document.
-      $print_engine = $print_engine_manager->createSelectedInstance($element['#export_type']);
-      $temporary_file_path = $print_builder->savePrintable([$webform_submission], $print_engine, $scheme, $file_name);
-      if ($temporary_file_path) {
-        $contents = file_get_contents($temporary_file_path);
-        \Drupal::service('file_system')->delete($temporary_file_path);
+      $file_path = NULL;
+
+      // If attachment with digital signatur, check if we already have one.
+      if (isset($element['#digital_signature']) && $element['#digital_signature']) {
+        // Get scheme.
+        $scheme = 'private';
+
+        // Get filename.
+        $file_name = 'webform/' . $webform_submission->getWebform()->id() . '/digital_signature/' . $submissionUuid . '.pdf';
+        $file_path = "$scheme://$file_name";
+      }
+
+      if (!$file_path || !file_exists($file_path)) {
+        // Get scheme.
+        $scheme = 'temporary';
+        // Get filename.
+        $file_name = 'webform-entity-print-attachment--' . $webform_submission->getWebform()->id() . '-' . $webform_submission->id() . '.pdf';
+
+        // Save printable document.
+        $print_engine = $print_engine_manager->createSelectedInstance($element['#export_type']);
+
+        // Adding digital signature.
+        if (isset($element['#digital_signature']) && $element['#digital_signature']) {
+          $file_path = $print_builder->savePrintableDigitalSignature([$webform_submission], $print_engine, $scheme, $file_name);
+        }
+        else {
+          $file_path = $print_builder->savePrintable([$webform_submission], $print_engine, $scheme, $file_name);
+        }
+      }
+
+      if ($file_path) {
+        $contents = file_get_contents($file_path);
+
+        // Deleting temporary file.
+        if ($scheme == 'temporary') {
+          \Drupal::service('file_system')->delete($file_path);
+        }
       }
       else {
         // Log error.

modules/os2forms_attachment/src/Os2formsAttachmentPrintBuilder.php

@@ -3,14 +3,28 @@
 namespace Drupal\os2forms_attachment;
 
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\File\FileExists;
+use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\StringTranslation\TranslationInterface;
+use Drupal\entity_print\Event\PreSendPrintEvent;
+use Drupal\entity_print\Event\PrintEvents;
 use Drupal\entity_print\Plugin\PrintEngineInterface;
 use Drupal\entity_print\PrintBuilder;
+use Drupal\entity_print\Renderer\RendererFactoryInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
  * The OS2Forms attachment print builder service.
  */
 class Os2formsAttachmentPrintBuilder extends PrintBuilder {
 
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(RendererFactoryInterface $renderer_factory, EventDispatcherInterface $event_dispatcher, TranslationInterface $string_translation, protected readonly FileSystemInterface $file_system) {
+    parent::__construct($renderer_factory, $event_dispatcher, $string_translation);
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -27,10 +41,56 @@ public function printHtml(EntityInterface $entity, $use_default_css = TRUE, $opt
     return $renderer->generateHtml([$entity], $render, $use_default_css, $optimize_css);
   }
 
+  /**
+   * Modified version of the original savePrintable() function.
+   *
+   * The only difference is modified call to prepareRenderer with digitalPost
+   * flag TRUE.
+   *
+   * @see PrintBuilder::savePrintable()
+   *
+   * @return string
+   *   FALSE or the URI to the file. E.g. public://my-file.pdf.
+   */
+  public function savePrintableDigitalSignature(array $entities, PrintEngineInterface $print_engine, $scheme = 'public', $filename = FALSE, $use_default_css = TRUE) {
+    $renderer = $this->prepareRenderer($entities, $print_engine, $use_default_css, TRUE);
+
+    // Allow other modules to alter the generated Print object.
+    $this->dispatcher->dispatch(new PreSendPrintEvent($print_engine, $entities), PrintEvents::PRE_SEND);
+
+    // If we didn't have a URI passed in the generate one.
+    if (!$filename) {
+      $filename = $renderer->getFilename($entities) . '.' . $print_engine->getExportType()->getFileExtension();
+    }
+
+    $uri = "$scheme://$filename";
+
+    // Save the file.
+    return $this->file_system->saveData($print_engine->getBlob(), $uri, FileExists::Replace);
+  }
+
   /**
    * {@inheritdoc}
    */
-  protected function prepareRenderer(array $entities, PrintEngineInterface $print_engine, $use_default_css) {
+
+  /**
+   * Override prepareRenderer() the print engine with the passed entities.
+   *
+   * @param array $entities
+   *   An array of entities.
+   * @param \Drupal\entity_print\Plugin\PrintEngineInterface $print_engine
+   *   The print engine.
+   * @param bool $use_default_css
+   *   TRUE if we want the default CSS included.
+   * @param bool $digitalSignature
+   *   If the digital signature message needs to be added.
+   *
+   * @return \Drupal\entity_print\Renderer\RendererInterface
+   *   A print renderer.
+   *
+   * @see PrintBuilder::prepareRenderer
+   */
+  protected function prepareRenderer(array $entities, PrintEngineInterface $print_engine, $use_default_css, $digitalSignature = FALSE) {
     if (empty($entities)) {
       throw new \InvalidArgumentException('You must pass at least 1 entity');
     }
@@ -50,6 +110,9 @@ protected function prepareRenderer(array $entities, PrintEngineInterface $print_
     // structure. That margin is automatically added in PDF and PDF only.
     $generatedHtml = (string) $renderer->generateHtml($entities, $render, $use_default_css, TRUE);
     $generatedHtml .= "<style>fieldset legend {margin-left: -12px;}</style>";
+    if ($digitalSignature) {
+      $generatedHtml .= $this->t('You can validate the signature on this PDF file via validering.nemlog-in.dk.');
+    }
 
     $print_engine->addPage($generatedHtml);
 

modules/os2forms_attachment/src/Plugin/WebformElement/AttachmentElement.php

@@ -27,6 +27,7 @@ protected function defineDefaultProperties() {
       'view_mode' => 'html',
       'template' => '',
       'export_type' => '',
+      'digital_signature' => '',
       'exclude_empty' => '',
       'exclude_empty_checkbox' => '',
       'excluded_elements' => '',
@@ -88,6 +89,11 @@ public function form(array $form, FormStateInterface $form_state) {
         'html' => $this->t('HTML'),
       ],
     ];
+    $form['attachment']['digital_signature'] = [
+      '#type' => 'checkbox',
+      '#title' => $this->t('Digital signature'),
+    ];
+
     // Set #access so that help is always visible.
     WebformElementHelper::setPropertyRecursive($form['attachment']['help'], '#access', TRUE);
 

modules/os2forms_dawa/src/Plugin/os2web/DataLookup/DatafordelerDataLookup.php

@@ -3,8 +3,10 @@
 namespace Drupal\os2forms_dawa\Plugin\os2web\DataLookup;
 
 use Drupal\Component\Utility\NestedArray;
+use Drupal\Core\File\FileSystem;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\key\KeyRepositoryInterface;
 use Drupal\os2forms_dawa\Entity\DatafordelerMatrikula;
 use Drupal\os2web_audit\Service\Logger;
 use Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupBase;
@@ -30,20 +32,31 @@ public function __construct(
     $plugin_definition,
     protected ClientInterface $httpClient,
     Logger $auditLogger,
+    KeyRepositoryInterface $keyRepository,
+    FileSystem $fileSystem,
   ) {
-    parent::__construct($configuration, $plugin_id, $plugin_definition, $auditLogger);
+    parent::__construct($configuration, $plugin_id, $plugin_definition, $auditLogger, $keyRepository, $fileSystem);
   }
 
   /**
    * {@inheritdoc}
    */
   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    /** @var \Drupal\os2web_audit\Service\Logger $auditLogger */
+    $auditLogger = $container->get('os2web_audit.logger');
+    /** @var \Drupal\key\KeyRepositoryInterface $keyRepository */
+    $keyRepository = $container->get('key.repository');
+    /** @var \Drupal\Core\File\FileSystem $fileSystem */
+    $fileSystem = $container->get('file_system');
+
     return new static(
       $configuration,
       $plugin_id,
       $plugin_definition,
       $container->get('http_client'),
-      $container->get('os2web_audit.logger'),
+      $auditLogger,
+      $keyRepository,
+      $fileSystem,
     );
   }
 

modules/os2forms_digital_post/README.md

@@ -31,6 +31,11 @@ examples](modules/os2forms_digital_post_examples/README.md).
 Go to `/admin/os2forms_digital_post/settings` to set up global settings for
 digital post.
 
+### Key
+
+We use [os2web_key](https://github.com/OS2web/os2web_key) to provide the certificate for sending digital post, and the
+key must be of type "[Certificate](https://github.com/os2web/os2web_key?tab=readme-ov-file#certificate)".
+
 ### Queue
 
 The actual sending of digital post is handled by jobs in an [Advanced

modules/os2forms_digital_post/os2forms_digital_post.info.yml

@@ -7,6 +7,7 @@ dependencies:
   - 'beskedfordeler:beskedfordeler'
   - 'drupal:advancedqueue'
   - 'os2web_datalookup:os2web_datalookup'
+  - 'os2web_key:os2web_key'
   - 'webform:webform'
   - 'webform:webform_submission_log'
   - 'os2web:os2web_audit'

modules/os2forms_digital_post/os2forms_digital_post.install

@@ -17,3 +17,12 @@ use Drupal\os2forms_digital_post\Helper\BeskedfordelerHelper;
 function os2forms_digital_post_schema() {
   return Drupal::service(BeskedfordelerHelper::class)->schema();
 }
+
+/**
+ * Install OS2Web key module.
+ */
+function os2forms_digital_post_update_9001(): void {
+  \Drupal::service('module_installer')->install([
+    'os2web_key',
+  ], TRUE);
+}