ServiceplatformenCPR.php

<?php

namespace Drupal\os2web_datalookup\Plugin\os2web\DataLookup;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Render\Markup;
use Drupal\os2web_datalookup\LookupResult\CprLookupResult;

/**
 * Defines a plugin for ServiceplatformenCPR.
 *
 * @DataLookup(
 *   id = "serviceplatformen_cpr",
 *   label = @Translation("Serviceplatformen CPR (SF6008)"),
 *   group = "cpr_lookup"
 * )
 */
class ServiceplatformenCPR extends ServiceplatformenBase implements DataLookupCprInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration(): array {
    return array_merge(parent::defaultConfiguration(), [
      'test_mode_fixed_cpr' => '',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state): array {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['mode_fieldset']['test_mode_fixed_cpr'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Fixed test CPR'),
      '#default_value' => $this->configuration['test_mode_fixed_cpr'],
      '#description' => $this->t('Fixed CPR that will be used for all requests to the serviceplatformen instead of the provided CPR.'),
      '#states' => [
        // Show the element only when running in test mode.
        'visible' => [
          'input[name="mode_selector"]' => ['value' => 1],
        ],
      ],
    ];
    $form['test_cpr'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Test CPR nr.'),
      '#states' => [
        'invisible' => [
          'input[name="test_mode_fixed_cpr"]' => ['filled' => TRUE],
          'input[name="mode_selector"]' => ['value' => 1],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state): void {
    if ($form_state->getValue('mode_selector') == 0) {
      $form_state->setValue('test_mode_fixed_cpr', '');
    }

    parent::submitConfigurationForm($form, $form_state);

    if (!empty($form_state->getValue('test_cpr'))) {
      $cpr = $form_state->getValue('test_cpr');
    }

    if ($this->configuration['mode_selector'] == 1 && $form_state->getValue('test_mode_fixed_cpr')) {
      $cpr = $form_state->getValue('test_mode_fixed_cpr');
    }

    if (!empty($cpr)) {
      $response = $this->cprBasicInformation($cpr);
      \Drupal::messenger()->addMessage(
        Markup::create('<pre>' . print_r($response, 1) . '</pre>'),
        $response['status'] ? MessengerInterface::TYPE_STATUS : MessengerInterface::TYPE_WARNING
      );
    }
  }

  /**
   * Implementation of callCPRBasicInformationService call.
   *
   * @param string $cpr
   *   Requested PSN (cpr) ([0-9]{6}\-[0-9]{4}).
   *
   * @return array
   *   [status] => TRUE/FALSE
   *   [error] => Descriptive text shown when CPR doesn't validate
   */
  public function cprBasicInformation(string $cpr): array {
    \Drupal::logger('os2web_datalookup')->warning('"Serviceplatformen CPR (SF6008)" is obsolete and will be phased out. Please switch to "Serviceplatformen CPR - extended (SF1520)" as soon as possible');

    $request = $this->prepareRequest();
    $request['PNR'] = str_replace('-', '', $cpr);
    return $this->query('callCPRBasicInformationService', $request);
  }

  /**
   * Validate cpr callback.
   *
   * @param string $cpr
   *   PSN (cpr) ([0-9]{6}\-[0-9]{4})
   *
   * @return array
   *   [status] => TRUE/FALSE
   *   [error] => Descriptive text shown when CPR doesn't validate
   */
  public function validateCpr(string $cpr): array {
    return $this->cprBasicInformation($cpr);
  }

  /**
   * Fetch address for the specified CPR.
   *
   * You should not use this function, but use lookup.
   *
   * @param string $cpr
   *   String - PSN (cpr) ([0-9]{6}\-[0-9]{4}).
   *
   * @return array<string, mixed>
   *   Address information.
   */
  public function getAddress(string $cpr): array {
    \Drupal::logger('os2web_datalookup')->notice('Calling \'getAddress()\' directly is deprecated, use DataLookupCprInterface::lookup() method.');

    $result = $this->cprBasicInformation($cpr);

    // If all goes well, we return an address array.
    if ($result['status']) {
      return [
        'status' => $result['status'],
        'cpr' => $cpr,
        'name' => $result['adresseringsnavn'] ?? '',
        'road' => $result['vejadresseringsnavn'] ?? '',
        'road_no' => isset($result['husnummer']) ? ltrim($result['husnummer'], '0') : '',
        'floor' => $result['etage'] ?? '',
        'door' => isset($result['sidedoer']) ? ltrim($result['sidedoer'], '0') : '',
        'zipcode' => $result['postnummer'] ?? '',
        'city' => $result['postdistrikt'] ?? '',
        'coname' => $result['conavn'] ?? '',
        'kommunekode' => $result['kommunekode'] ?? '',
        'name_address_protected' => $result['navneOgAdressebeskyttelse'] ?? '',
      ];
    }

    return $result;
  }

  /**
   * {@inheritDoc}
   */
  public function lookup(string $cpr): CprLookupResult {
    $result = $this->cprBasicInformation($cpr);

    $cprResult = new CprLookupResult();

    // If all goes well, we return an address array.
    if ($result['status']) {
      $cprResult->setSuccessful();
      // @todo Use a value from from $result to set CPR. But which key?
      $cprResult->setCpr($cpr);
      $cprResult->setName($result['adresseringsnavn'] ?? '');
      $cprResult->setStreet($result['vejadresseringsnavn'] ?? '');
      $cprResult->setHouseNr(isset($result['husnummer']) ? ltrim($result['husnummer'], '0') : '');
      $cprResult->setFloor($result['etage'] ?? '');
      $cprResult->setApartmentNr(isset($result['sidedoer']) ? ltrim($result['sidedoer'], '0') : '');
      $cprResult->setPostalCode($result['postnummer'] ?? '');
      $cprResult->setCity($result['postdistrikt'] ?? '');
      $cprResult->setMunicipalityCode($result['kommunekode'] ?? '');
      $cprResult->setAddress($cprResult->getStreet() . ' ' . $cprResult->getHouseNr() . ', ' . $cprResult->getFloor() . ', ' . $cprResult->getApartmentNr());
      $cprResult->setCoName($result['conavn'] ?? '');
      $cprResult->setNameAddressProtected($result['navneOgAdressebeskyttelse'] ?? '');
    }
    else {
      $cprResult->setSuccessful(FALSE);
      $cprResult->setErrorMessage($result['error']);
    }

    return $cprResult;
  }

}