Merge commit '7ace38332357344358eca1935f43ae2a30c23fa4' into f/OS-110

* commit '7ace38332357344358eca1935f43ae2a30c23fa4': (31 commits)
  Release 3.22.1
  Preparing 3.22.0 release
  OS-143 - Removed image_widget_crop
  Simplified validation
  Changed validation to check for empty string instead of null
  Conditional inclusion of patron phone number, since field is not required
  Updated changelog
  renamed fbs class
  Coding standards
  Add barn_tlf as an incoming field in FbsWebformHandler
  Handle phoneNumber assignment in advanced queue job
  Make phoneNumber a writeable property in Patron model
  Add support for phone numbers in FBS payloads
  Updating os2web_simplesaml to D10 compatible version
  Prepare release 3.21.2
  Add missing iterable type specifications
  Run code analysis on fbs handler
  Add and use http-message-util
  Release 3.21.1
  ITKDEV: Used configured format in maestro notification
  ...

Author: stankut

CHANGELOG.md

@@ -11,6 +11,34 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 
 ## [Unreleased]
 
+## [3.22.1] 2025-02-10
+
+- Updated `os2forms_fbs_handler` to include and correct set phone number [#161](https://github.com/OS2Forms/os2forms/pull/161)
+
+## [3.22.0] 2025-02-03
+
+- Removed modules ldap_auth, logging_alerts, maillog [#151](https://github.com/OS2Forms/os2forms/pull/151)
+- Removed module image_widget_crop [#OS-143](https://github.com/OS2Forms/os2forms/pull/159)
+
+## [3.21.2] 2025-01-07
+
+- Adds missing `http-message-util` requirement and use statement.
+- Runs code-analysis on `os2forms_fbs_handler` module.
+
+## [3.21.1] 2025-01-06
+
+- Updated Maestro notification handler assignment message format.
+- Updated `os2forms_fbs_handler` to use latest endpoints and operations.
+
+## [3.21.0] 2024-12-17
+
+- Updated `os2web_audit`.
+- Added patch to get `hook_webform_post_load_data` in webform submissions.
+
+## [3.20.1] 2024-12-10
+
+- Avoided accessing non-initialized property when logging in `os2forms_nemid`.
+
 ## [3.20.0] 2024-12-09
 
 - Added webform ID to digital post audit logging messages.
@@ -314,7 +342,13 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 - Security in case of vulnerabilities.
 ```
 
-[Unreleased]: https://github.com/OS2Forms/os2forms/compare/3.20.0...HEAD
+[Unreleased]: https://github.com/OS2Forms/os2forms/compare/3.22.1...HEAD
+[3.22.1]: https://github.com/OS2Forms/os2forms/compare/3.22.0...3.22.1
+[3.22.0]: https://github.com/OS2Forms/os2forms/compare/3.21.2...3.22.0
+[3.21.2]: https://github.com/OS2Forms/os2forms/compare/3.21.1...3.21.2
+[3.21.1]: https://github.com/OS2Forms/os2forms/compare/3.21.0...3.21.1
+[3.21.0]: https://github.com/OS2Forms/os2forms/compare/3.20.1...3.21.0
+[3.20.1]: https://github.com/OS2Forms/os2forms/compare/3.20.0...3.20.1
 [3.20.0]: https://github.com/OS2Forms/os2forms/compare/3.19.0...3.20.0
 [3.19.0]: https://github.com/OS2Forms/os2forms/compare/3.18.0...3.19.0
 [3.18.0]: https://github.com/OS2Forms/os2forms/compare/3.17.0...3.18.0

composer.json

@@ -23,6 +23,7 @@
         "dompdf/dompdf": "^2.0",
         "drupal/admin_toolbar": "^3.0",
         "drupal/advancedqueue": "^1.0",
+        "drupal/cache_control_override": "^1.1|^2.0",
         "drupal/clientside_validation": "^4.0",
         "drupal/coc_forms_auto_export": "^2.0@alpha",
         "drupal/config_entity_revisions": "dev-2.0.x",
@@ -31,14 +32,12 @@
         "drupal/entity_print": "^2.1",
         "drupal/eu_cookie_compliance": "^1.8",
         "drupal/events_logging": "^2.0@beta",
+        "drupal/gin": "^3.0-rc",
         "drupal/honeypot": "^2.0",
-        "drupal/image_widget_crop": "^2.3",
         "drupal/ldap": "^4.2",
-        "drupal/ldap_auth": "^1.17",
         "drupal/leaflet": "^10.0",
         "drupal/leaflet_layers": "^1.1",
         "drupal/libraries": "^4.0",
-        "drupal/logging_alerts": "^2.0",
         "drupal/maestro": "^3.1",
         "drupal/mailsystem": "^4.1",
         "drupal/masquerade": "^2.0@RC",
@@ -65,12 +64,14 @@
         "drupal/webform_validation": "^2.0",
         "drupal/webform_views": "^5.0@alpha",
         "drupal/workflow_participants": "^3.0@RC",
+        "fig/http-message-util": "^1.1",
         "http-interop/http-factory-guzzle": "^1.0.0",
         "itk-dev/beskedfordeler-drupal": "^1.0",
         "itk-dev/serviceplatformen": "^1.5",
-        "os2web/os2web_audit": "^0.1.1",
+        "os2web/os2web_audit": "^0.1.6",
         "os2web/os2web_datalookup": "^2.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",
@@ -82,7 +83,6 @@
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
         "drupal/coder": "^8.3",
-        "drupal/maillog": "^1.0",
         "mglaman/phpstan-drupal": "^1.1",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan-deprecation-rules": "^1.1",
@@ -98,7 +98,9 @@
             },
             "drupal/webform": {
                 "Unlock possibility of using Entity print module export to Word": "https://www.drupal.org/files/issues/2020-02-29/3096552-6.patch",
-                "Webform computed element post save alter": "https://www.drupal.org/files/issues/2024-06-25/webform_computed_post_save_field_alter.patch"
+                "Webform computed element post save alter": "https://www.drupal.org/files/issues/2024-06-25/webform_computed_post_save_field_alter.patch",
+                "Add custom hook (hook_webform_post_load_data) for audit logging": "https://gist.githubusercontent.com/cableman/d26898fc8f65ee0a31001bf391583b59/raw/6189dc4c2ceaabb19d25cc4b98b0b3028a6b0e1e/gistfile1.txt"
+
             },
             "drupal/coc_forms_auto_export": {
                 "3240592 - Problem with phpseclib requirement in 2.x (https://www.drupal.org/project/coc_forms_auto_export/issues/3240592)": "https://www.drupal.org/files/issues/2021-10-04/requirement-namespace-3240592-1.patch",

modules/os2forms_fbs_handler/src/Client/FBS.php renamed to modules/os2forms_fbs_handler/src/Client/Fbs.php

@@ -4,13 +4,14 @@
 
 use Drupal\os2forms_fbs_handler\Client\Model\Guardian;
 use Drupal\os2forms_fbs_handler\Client\Model\Patron;
+use Fig\Http\Message\RequestMethodInterface;
 use GuzzleHttp\Client;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Minimalistic client to create user with guardians at FBS.
  */
-class FBS {
+class Fbs {
 
   /**
    * FBS session key.
@@ -75,34 +76,22 @@ public function isLoggedIn(): bool {
    * @param string $cpr
    *   The users personal security number.
    *
-   * @return \Drupal\os2forms_fbs_handler\Client\Model\Patron|null
-   *   NULL if not else the Patron.
+   * @return string|null
+   *   NULL if not else the PatronId.
    *
    * @throws \GuzzleHttp\Exception\GuzzleException
    * @throws \JsonException
    */
-  public function doUserExists(string $cpr): ?Patron {
+  public function authenticatePatron(string $cpr): ?string {
     // Check if session has been created with FBS and if not creates it.
     if (!$this->isLoggedIn()) {
       $this->login();
     }
 
-    // Try pre-authenticate the user/parent.
-    $json = $this->request('/external/{agency_id}/patrons/preauthenticated/v9', $cpr);
+    // Authenticate the patron.
+    $json = $this->request('/external/{agency_id}/patrons/preauthenticated/v10', $cpr);
     if ($json->authenticateStatus === $this::AUTHENTICATE_STATUS_VALID) {
-      return new Patron(
-        $json->patron->patronId,
-        (bool) $json->patron->receiveSms,
-        (bool) $json->patron->receivePostalMail,
-        $json->patron->notificationProtocols,
-        $json->patron->phoneNumber,
-        is_null($json->patron->onHold) ? $json->patron->onHold : (array) $json->patron->onHold,
-        $json->patron->preferredLanguage,
-        (bool) $json->patron->guardianVisibility,
-        $json->patron->emailAddress,
-        (bool) $json->patron->receiveEmail,
-        $json->patron->preferredPickupBranch
-      );
+      return $json->patronId;
     }
 
     return NULL;
@@ -123,17 +112,67 @@ public function doUserExists(string $cpr): ?Patron {
    * @throws \JsonException
    */
   public function createPatronWithGuardian(Patron $patron, Guardian $guardian) {
-    $uri = '/external/{agency_id}/patrons/withGuardian/v1';
+    $uri = '/external/{agency_id}/patrons/withGuardian/v4';
     $payload = [
-      'cprNumber' => $patron->cpr,
+      'personId' => $patron->personId,
       'pincode' => $patron->pincode,
       'preferredPickupBranch' => $patron->preferredPickupBranch,
       'name' => 'Unknown Name',
-      'email' => $patron->emailAddress,
+      'emailAddresses' => $patron->emailAddresses ?? [],
       'guardian' => $guardian->toArray(),
+      'phoneNumbers' => $patron->phoneNumber ? [
+        [
+          'receiveNotification' => TRUE,
+          'phoneNumber' => $patron->phoneNumber,
+        ],
+      ] : [],
     ];
 
-    return $this->request($uri, $payload,);
+    return $this->request($uri, $payload);
+  }
+
+  /**
+   * Get patron information.
+   *
+   * @param string $patronId
+   *   The patron to update.
+   *
+   * @return \Drupal\os2forms_fbs_handler\Client\Model\Patron
+   *   Patron object
+   *
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   * @throws \JsonException
+   */
+  public function getPatron(string $patronId): ?Patron {
+    $uri = '/external/{agency_id}/patrons/' . $patronId . '/v4';
+
+    $json = $this->request($uri, [], RequestMethodInterface::METHOD_GET);
+
+    if ($json->authenticateStatus === "VALID") {
+      return new Patron(
+        $json->patron->patronId,
+        (bool) $json->patron->receiveSms,
+        (bool) $json->patron->receivePostalMail,
+        $json->patron->notificationProtocols,
+        is_null($json->patron->onHold) ? $json->patron->onHold : (array) $json->patron->onHold,
+        $json->patron->preferredLanguage,
+        (bool) $json->patron->guardianVisibility,
+        $json->patron->defaultInterestPeriod,
+        (bool) $json->patron->resident,
+        $json->patron->phoneNumber,
+
+        [
+          [
+            'emailAddress' => $json->patron->emailAddress,
+            'receiveNotification' => $json->patron->receiveEmail,
+          ],
+        ],
+        (bool) $json->patron->receiveEmail,
+        $json->patron->preferredPickupBranch
+      );
+    }
+
+    return NULL;
   }
 
   /**
@@ -149,19 +188,27 @@ public function createPatronWithGuardian(Patron $patron, Guardian $guardian) {
    * @throws \JsonException
    */
   public function updatePatron(Patron $patron): bool {
-    $uri = '/external/{agency_id}/patrons/' . $patron->patronId . '/v6';
+    $uri = '/external/{agency_id}/patrons/' . $patron->patronId . '/v8';
     $payload = [
-      'patronid' => $patron->patronId,
-      'patron' => $patron->toArray(),
+      'patron' => [
+        'preferredPickupBranch' => $patron->preferredPickupBranch,
+        'emailAddresses' => $patron->emailAddresses ?? [],
+        'guardianVisibility' => $patron->guardianVisibility,
+        'receivePostalMail' => $patron->receiveEmail,
+        'phoneNumbers' => $patron->phoneNumber ? [
+          [
+            'receiveNotification' => TRUE,
+            'phoneNumber' => $patron->phoneNumber,
+          ],
+        ] : [],
+      ],
       'pincodeChange' => [
         'pincode' => $patron->pincode,
-        'libraryCardNumber' => $patron->cpr,
+        'libraryCardNumber' => $patron->personId,
       ],
     ];
 
-    $json = $this->request($uri, $payload, Request::METHOD_PUT);
-
-    return $json->authenticateStatus === $this::AUTHENTICATE_STATUS_VALID;
+    return $this->request($uri, $payload, RequestMethodInterface::METHOD_PUT);
   }
 
   /**
@@ -179,7 +226,7 @@ public function updatePatron(Patron $patron): bool {
    * @throws \JsonException
    */
   public function createGuardian(Patron $patron, Guardian $guardian): int {
-    $uri = '/external/{agency_id}/patrons/withGuardian/v1';
+    $uri = '/external/{agency_id}/patrons/withGuardian/v2';
     $payload = [
       'patronId' => $patron->patronId,
       'guardian' => $guardian->toArray(),
@@ -199,10 +246,12 @@ public function createGuardian(Patron $patron, Guardian $guardian): int {
    *   The type of request to send (Default: POST).
    *
    * @return mixed
-   *   Json response from FBS.
+   *   Json response from FBS or TRUE on updatePatron response.
    *
    * @throws \GuzzleHttp\Exception\GuzzleException
    * @throws \JsonException
+   *
+   * @phpstan-param array<mixed>|string $data
    */
   private function request(string $uri, array|string $data, string $method = Request::METHOD_POST): mixed {
     $url = rtrim($this->endpoint, '/\\');
@@ -230,6 +279,10 @@ private function request(string $uri, array|string $data, string $method = Reque
 
     $response = $this->client->request($method, $url, $options);
 
+    if ($response->getStatusCode() === 204) {
+      return TRUE;
+    }
+
     return json_decode($response->getBody(), FALSE, 512, JSON_THROW_ON_ERROR);
   }
 

modules/os2forms_fbs_handler/src/Client/Model/Guardian.php

@@ -22,10 +22,12 @@ public function __construct(
    *
    * @return array
    *   Array with field required by FBS calls.
+   *
+   * @phpstan-return array<string, string>
    */
   public function toArray(): array {
     return [
-      'cprNumber' => $this->cpr,
+      'personIdentifier' => $this->cpr,
       'name' => $this->name,
       'email' => $this->email,
     ];

modules/os2forms_fbs_handler/src/Client/Model/Patron.php

@@ -9,21 +9,27 @@ final class Patron {
 
   /**
    * Default constructor.
+   *
+   * @phpstan-param array<mixed>|null $notificationProtocols
+   * @phpstan-param array<mixed>|null $onHold
+   * @phpstan-param array<mixed>|null $emailAddresses
    */
   public function __construct(
     public readonly ?string $patronId = NULL,
     public readonly ?bool $receiveSms = FALSE,
     public readonly ?bool $receivePostalMail = FALSE,
     public readonly ?array $notificationProtocols = NULL,
-    public readonly ?string $phoneNumber = NULL,
     public readonly ?array $onHold = NULL,
     public readonly ?string $preferredLanguage = NULL,
     public readonly ?bool $guardianVisibility = NULL,
+    public readonly ?int $defaultInterestPeriod = NULL,
+    public readonly ?bool $resident = NULL,
     // Allow these properties below to be updatable.
-    public ?string $emailAddress = NULL,
+    public ?string $phoneNumber = NULL,
+    public ?array $emailAddresses = NULL,
     public ?bool $receiveEmail = NULL,
     public ?string $preferredPickupBranch = NULL,
-    public ?string $cpr = NULL,
+    public ?string $personId = NULL,
     public ?string $pincode = NULL,
   ) {
   }
@@ -33,19 +39,24 @@ public function __construct(
    *
    * @return array
    *   Array with field required by FBS calls.
+   *
+   * @phpstan-return array<string, string>
    */
   public function toArray(): array {
     return [
+      'patronId' => $this->patronId,
       'receiveEmail' => $this->receiveEmail,
       'receiveSms' => $this->receiveSms,
       'receivePostalMail' => $this->receivePostalMail,
-      'emailAddress' => $this->emailAddress,
+      'emailAddresses' => $this->emailAddresses,
       'notificationProtocols' => $this->notificationProtocols,
       'phoneNumber' => $this->phoneNumber,
       'preferredPickupBranch' => $this->preferredPickupBranch,
       'onHold' => $this->onHold,
       'preferredLanguage' => $this->preferredLanguage,
       'guardianVisibility' => $this->guardianVisibility,
+      'defaultInterestPeriod' => $this->defaultInterestPeriod,
+      'resident' => $this->resident,
     ];
   }