OS-110 refactoring

Author: stankut

modules/os2forms_digital_signature/src/Form/SettingsForm.php

@@ -37,10 +37,10 @@ protected function getEditableConfigNames() {
    * {@inheritdoc}
    */
   public function buildForm(array $form, FormStateInterface $form_state) {
-    $form['os2forms_digital_signature_remove_service_url'] = [
+    $form['os2forms_digital_signature_remote_service_url'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Signature server URL'),
-      '#default_value' => $this->config(self::$configName)->get('os2forms_digital_signature_remove_service_url'),
+      '#default_value' => $this->config(self::$configName)->get('os2forms_digital_signature_remote_service_url'),
       '#description' => $this->t('E.g. https://signering.bellcom.dk/sign.php?'),
     ];
     $form['os2forms_digital_signature_sign_hash_salt'] = [

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

@@ -3,11 +3,18 @@
 namespace Drupal\os2forms_digital_signature\Plugin\WebformHandler;
 
 use Drupal\Component\Utility\Crypt;
+use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\File\FileExists;
 use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\File\FileUrlGeneratorInterface;
+use Drupal\Core\Site\Settings;
 use Drupal\Core\Url;
+use Drupal\file\FileRepositoryInterface;
+use Drupal\os2forms_digital_signature\Service\SigningService;
+use Drupal\webform\Plugin\WebformElementManagerInterface;
 use Drupal\webform\Plugin\WebformHandlerBase;
 use Drupal\webform\WebformSubmissionInterface;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -30,29 +37,56 @@ class DigitalSignatureWebformHandler extends WebformHandlerBase {
    *
    * @var \Drupal\Core\Extension\ModuleHandlerInterface
    */
-  protected $moduleHandler;
+  private readonly ModuleHandlerInterface $moduleHandler;
 
   /**
    * The webform element plugin manager.
    *
    * @var \Drupal\webform\Plugin\WebformElementManagerInterface
    */
-  protected $elementManager;
+  private readonly WebformElementManagerInterface $elementManager;
 
   /**
    * Logger for channel - os2forms_digital_signature.
    *
-   * @var \Drupal\Core\Logger\LoggerChannelInterface
+   * @var \Psr\Log\LoggerInterface
    */
-  protected $logger;
+  private readonly LoggerInterface $logger;
 
   /**
-   * {@inheritdoc}
+   * File system interface.
+   *
+   * @var \Drupal\Core\File\FileSystemInterface
    */
-  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
-    parent::__construct($configuration, $plugin_id, $plugin_definition);
-    $this->logger = \Drupal::logger('os2forms_digital_signature');
-  }
+  private readonly FileSystemInterface $fileSystem;
+
+  /**
+   * File repository.
+   *
+   * @var \Drupal\file\FileRepositoryInterface
+   */
+  private readonly FileRepositoryInterface $fileRepository;
+
+  /**
+   * File URL generator.
+   *
+   * @var \Drupal\Core\File\FileUrlGeneratorInterface
+   */
+  private readonly FileUrlGeneratorInterface $fileUrlGenerator;
+
+  /**
+   * OS2Forms signing service.
+   *
+   * @var \Drupal\os2forms_digital_signature\Service\SigningService
+   */
+  private readonly SigningService $signingService;
+
+  /**
+   * Settings service.
+   *
+   * @var \Drupal\Core\Site\Settings
+   */
+  private readonly Settings $settings;
 
   /**
    * {@inheritdoc}
@@ -61,6 +95,12 @@ public static function create(ContainerInterface $container, array $configuratio
     $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
     $instance->moduleHandler = $container->get('module_handler');
     $instance->elementManager = $container->get('plugin.manager.webform.element');
+    $instance->logger = $container->get('logger.channel.os2forms_digital_signature');
+    $instance->fileSystem = $container->get('file_system');
+    $instance->fileRepository = $container->get('file.repository');
+    $instance->fileUrlGenerator = $container->get('file_url_generator');
+    $instance->signingService = $container->get('os2forms_digital_signature.signing_service');
+    $instance->settings = $container->get('settings');
 
     return $instance;
   }
@@ -87,7 +127,7 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
     }
 
     $destinationDir = 'private://signing';
-    if (!\Drupal::service('file_system')->prepareDirectory($destinationDir, FileSystemInterface::CREATE_DIRECTORY)) {
+    if (!$this->fileSystem->prepareDirectory($destinationDir, FileSystemInterface::CREATE_DIRECTORY)) {
       $this->logger->error('File directory cannot be created: %filedirectory', ['%filedirectory' => $destinationDir]);
       return;
     }
@@ -96,8 +136,7 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
 
     // Save the file data.
     try {
-      /** @var \Drupal\file\FileInterface $fileToSign */
-      $fileToSign = \Drupal::service('file.repository')->writeData($attachment['filecontent'], $fileUri, FileExists::Replace);
+      $fileToSign = $this->fileRepository->writeData($attachment['filecontent'], $fileUri, FileExists::Replace);
     }
     catch (\Exception $e) {
       $this->logger->error('File cannot be saved: %fileUri, error: %error',
@@ -109,19 +148,16 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
     }
 
     $fileToSign->save();
-    $fileToSignPublicUrl = \Drupal::service('file_url_generator')->generateAbsoluteString($fileToSign->getFileUri());
-
-    /** @var \Drupal\os2forms_digital_signature\Service\SigningService $signingService */
-    $signingService = \Drupal::service('os2forms_digital_signature.signing_service');
+    $fileToSignPublicUrl = $this->fileUrlGenerator->generateAbsoluteString($fileToSign->getFileUri());
 
-    $cid = $signingService->getCid();
+    $cid = $this->signingService->getCid();
     if (empty($cid)) {
       $this->logger->error('Failed to obtain cid. Is server running?');
       return;
     }
 
     // Creating hash.
-    $salt = \Drupal::service('settings')->get('hash_salt');
+    $salt = $this->settings->get('hash_salt');
     $hash = Crypt::hashBase64($webform_submission->uuid() . $webform->id() . $salt);
 
     $attachmentFid = $attachment['fid'] ?? NULL;
@@ -135,7 +171,7 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
 
     // Starting signing, if everything is correct - this funcition will start
     // redirect.
-    $signingService->sign($fileToSignPublicUrl, $cid, $signatureCallbackUrl->setAbsolute()->toString());
+    $this->signingService->sign($fileToSignPublicUrl, $cid, $signatureCallbackUrl->setAbsolute()->toString());
   }
 
   /**

modules/os2forms_digital_signature/src/Service/SigningService.php

@@ -29,14 +29,14 @@ class SigningService {
    *
    * @var \Drupal\Core\Entity\EntityStorageInterface
    */
-  protected EntityStorageInterface $webformStorage;
+  private readonly EntityStorageInterface $webformStorage;
 
   /**
    * WebformSubmission storage.
    *
    * @var \Drupal\Core\Entity\EntityStorageInterface
    */
-  protected EntityStorageInterface $webformSubmissionStorage;
+  private readonly EntityStorageInterface $webformSubmissionStorage;
 
   public function __construct(
     private readonly ClientInterface $httpClient,
@@ -57,7 +57,7 @@ public function __construct(
    *   The correlation id.
    */
   public function getCid() : ?string {
-    $url = $this->config->get('os2forms_digital_signature_remove_service_url') . 'action=getcid';
+    $url = $this->getServiceUrl() . http_build_query(['action' => 'getcid']);
     $response = $this->httpClient->request('GET', $url);
     $result = $response->getBody()->getContents();
 
@@ -104,7 +104,7 @@ public function sign(string $document_uri, string $cid, string $forward_url):voi
       'uri' => base64_encode($document_uri),
       'forward_url' => base64_encode($forward_url),
     ];
-    $url = $this->config->get('os2forms_digital_signature_remove_service_url') . http_build_query($params);
+    $url = $this->getServiceUrl() . http_build_query($params);
 
     $response = new RedirectResponse($url);
     $response->send();
@@ -145,7 +145,7 @@ public function download(string $filename, $leave = FALSE, $annotate = FALSE, $a
       'annotate' => $annotate,
       'attributes' => $attributes,
     ];
-    $url = $this->config->get('os2forms_digital_signature_remove_service_url') . http_build_query($params);
+    $url = $this->getServiceUrl() . http_build_query($params);
 
     $response = $this->httpClient->request('GET', $url);
     $return = $response->getBody()->getContents();
@@ -239,4 +239,21 @@ public function deleteStalledSubmissions() : void {
     }
   }
 
+  /**
+   * Returns Remove service URL.
+   *
+   * @return string
+   *   Remote Service URL, if missing '?' or '&', '?' will be added
+   *   automatically.
+   */
+  public function getServiceUrl() : string {
+    $url = $this->config->get('os2forms_digital_signature_remote_service_url');
+    // Handling URL, if it does not end with '?' or '&'.
+    if (!str_ends_with($url, '?') && !str_ends_with($url, '&')) {
+      return $url . '?';
+    }
+
+    return $url;
+  }
+
 }