5124: Refactored settings

Author: rimi-itk

web/profiles/custom/os2loop/modules/os2loop_cura_login/os2loop_cura_login.services.yml

@@ -1,4 +1,9 @@
 services:
+  _defaults:
+    autowire: true
+
   logger.channel.os2loop_cura_login:
     parent: logger.channel_base
     arguments: ["os2loop_cura_login"]
+
+  Drupal\os2loop_cura_login\Settings:

web/profiles/custom/os2loop/modules/os2loop_cura_login/src/Controller/Os2loopCuraLoginController.php

@@ -5,11 +5,11 @@
 namespace Drupal\os2loop_cura_login\Controller;
 
 use Drupal\Component\Datetime\TimeInterface;
-use Drupal\Core\Config\ImmutableConfig;
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Logger\RfcLogLevel;
 use Drupal\Core\Routing\TrustedRedirectResponse;
 use Drupal\Core\Url;
+use Drupal\os2loop_cura_login\Settings;
 use Drupal\user\Entity\User;
 use Drupal\user\UserStorageInterface;
 use Firebase\JWT\JWT;
@@ -37,21 +37,16 @@ final class Os2loopCuraLoginController extends ControllerBase {
    */
   private readonly UserStorageInterface $userStorage;
 
-  /**
-   * The module config.
-   */
-  private readonly ImmutableConfig $config;
-
   /**
    * Constructor.
    */
   public function __construct(
+    private readonly Settings $settings,
     private readonly TimeInterface $time,
     #[Autowire(service: 'logger.channel.os2loop_cura_login')]
     private readonly LoggerInterface $logger,
   ) {
     $this->userStorage = $this->entityTypeManager()->getStorage('user');
-    $this->config = $this->config('os2loop_cura_login.settings');
   }
 
   /**
@@ -75,7 +70,7 @@ public function start(Request $request, ?string $jwt): Response {
       ]);
 
       if (empty($jwt)) {
-        $name = $this->config->get('payload_name') ?? 'payload';
+        $name = $this->settings->getPayloadName();
         $jwt = Request::METHOD_POST === $request->getMethod()
           ? $request->request->getString($name)
           : $request->query->getString($name);
@@ -91,16 +86,16 @@ public function start(Request $request, ?string $jwt): Response {
         throw new BadRequestHttpException('Missing or empty JWT');
       }
 
-      $secret = $this->config->get('signing_secret');
+      $secret = $this->settings->getSigningSecret();
       // @todo Get rid of the double base64 encoding.
       $secret = base64_decode($secret);
 
       $originalLeeway = JWT::$leeway;
-      $leeway = (int) $this->config->get('jwt_leeway');
+      $leeway = $this->settings->getJwtLeeway();
       if ($leeway > 0) {
         JWT::$leeway = $leeway;
       }
-      $payload = (array) JWT::decode($jwt, new Key($secret, $this->config->get('signing_algorithm')));
+      $payload = (array) JWT::decode($jwt, new Key($secret, $this->settings->getSigningAlgorithm()));
       JWT::$leeway = $originalLeeway;
 
       $this->debug('@debug', [
@@ -253,7 +248,7 @@ public function log($level, \Stringable|string $message, array $context = []): v
       LogLevel::DEBUG => RfcLogLevel::DEBUG,
     ];
     $rfcLogLevel = $levels[$level] ?? RfcLogLevel::ERROR;
-    if ((int) $this->config->get('log_level') >= $rfcLogLevel) {
+    if ((int) $this->settings->getLogLevel() >= $rfcLogLevel) {
       $this->logger->log($level, $message, $context);
     }
   }

web/profiles/custom/os2loop/modules/os2loop_cura_login/src/Drush/Commands/Os2loopCuraLoginCommands.php

@@ -34,9 +34,10 @@ public function __construct(
   #[CLI\Argument(name: 'username', description: 'The username.')]
   #[CLI\Option(name: 'post', description: 'Use POST to get the login URL')]
   #[CLI\Usage(name: 'os2loop-cura-login:get-login-url [email protected]', description: 'Get login URL')]
-  public function commandName(
+  public function getLoginUrl(
     $username,
     $options = [
+      'linkUrl' => NULL,
       'get' => NULL,
       'secret' => NULL,
       'algorithm' => 'HS256',
@@ -60,7 +61,7 @@ public function commandName(
     }
     else {
       $method = Request::METHOD_POST;
-      $requestOptions['body'] = $jwt;
+      $requestOptions['body'] = ['payload' => $jwt];
     }
     $url = Url::fromRoute('os2loop_cura_login.start', $routeParameters)->setAbsolute()->toString(TRUE)->getGeneratedUrl();
     $this->io()->writeln($method === Request::METHOD_POST

web/profiles/custom/os2loop/modules/os2loop_cura_login/src/Form/SettingsForm.php

@@ -5,15 +5,26 @@
 namespace Drupal\os2loop_cura_login\Form;
 
 use Drupal\Component\Utility\Random;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\DependencyInjection\AutowireTrait;
 use Drupal\Core\Form\ConfigFormBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Logger\RfcLogLevel;
 use Drupal\Core\Url;
+use Drupal\os2loop_cura_login\Settings;
 
 /**
  * Configure OS2Loop Cura login settings for this site.
  */
 final class SettingsForm extends ConfigFormBase {
+  use AutowireTrait;
+
+  public function __construct(
+    ConfigFactoryInterface $config_factory,
+    private readonly Settings $settings,
+  ) {
+    parent::__construct($config_factory);
+  }
 
   /**
    * {@inheritdoc}
@@ -26,34 +37,30 @@ public function getFormId(): string {
    * {@inheritdoc}
    */
   protected function getEditableConfigNames(): array {
-    return ['os2loop_cura_login.settings'];
+    return [Settings::CONFIG_NAME];
   }
 
   /**
    * {@inheritdoc}
    */
   public function buildForm(array $form, FormStateInterface $form_state): array {
-    $config = $this->config('os2loop_cura_login.settings');
+    $settings = \Drupal::service(Settings::class);
     $form['signing_algorithm'] = [
       '#required' => TRUE,
       '#type' => 'select',
-      '#options' => [
-        'HS256' => 'HS256',
-        'HS384' => 'HS384',
-        'HS512' => 'HS512',
-      ],
+      '#options' => Settings::SIGNING_ALGORITHMS,
       '#title' => $this->t('Signing algorithm'),
-      '#default_value' => $config->get('signing_algorithm'),
+      '#default_value' => $this->settings->getSigningAlgorithm(),
     ];
 
-    $hasSigningSecret = !empty($config->get('signing_secret'));
+    $hasSigningSecret = !empty($this->settings->getSigningSecret());
 
     $form['signing_secret'] = [
       '#type' => 'textfield',
       '#size' => 128,
       '#required' => $hasSigningSecret,
       '#title' => $this->t('Signing secret'),
-      '#default_value' => $config->get('signing_secret'),
+      '#default_value' => $this->settings->getSigningSecret(),
       '#description' => !$hasSigningSecret
         ? $this->t('Save the configuration to generate a random secret.')
         : '',
@@ -69,21 +76,21 @@ public function buildForm(array $form, FormStateInterface $form_state): array {
     $form['payload_name'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Payload name'),
-      '#default_value' => $config->get('payload_name') ?? 'payload',
+      '#default_value' => $this->settings->getPayloadName(),
       '#description' => $this->t('Name of parameter used for payload'),
     ];
 
     $form['jwt_leeway'] = [
       '#type' => 'textfield',
       '#title' => $this->t('JWT leeway'),
-      '#default_value' => $config->get('jwt_leeway') ?? 0,
+      '#default_value' => $this->settings->getJwtLeeway(),
     ];
 
     $form['log_level'] = [
       '#type' => 'select',
       '#options' => RfcLogLevel::getLevels(),
       '#title' => $this->t('Log level'),
-      '#default_value' => $config->get('log_level') ?? RfcLogLevel::ERROR,
+      '#default_value' => $this->settings->getLogLevel(),
     ];
 
     $authenticationStartUrl = Url::fromRoute('os2loop_cura_login.start')->setAbsolute()->toString(TRUE)->getGeneratedUrl();
@@ -100,7 +107,7 @@ public function buildForm(array $form, FormStateInterface $form_state): array {
       '#markup' => $this->t('Use <a href=":url">:url</a> as <code>linkURL</code> for <core><code>postToGetLinkURL ≡ false</code>.', [':url' => $authenticationStartUrl]),
     ];
 
-    if ($name = $config->get('payload_name')) {
+    if ($name = $this->settings->getPayloadName()) {
       $authenticationStartUrl = Url::fromRoute('os2loop_cura_login.start', [$name => '…'])->setAbsolute()->toString(TRUE)->getGeneratedUrl();
       $authenticationStartUrl = str_replace(urlencode('…'), '', $authenticationStartUrl);
       $form['info']['#items'][] = [
@@ -117,15 +124,12 @@ public function buildForm(array $form, FormStateInterface $form_state): array {
   public function submitForm(array &$form, FormStateInterface $form_state): void {
     $secret = $form_state->getValue('signing_secret');
     if ($form_state->getValue('generate_new_secret')) {
-      $secret = base64_encode((new Random())->string(64));
+      $form_state->setValue('signing_secret', base64_encode((new Random())->string(64)));
     }
-    $this->config('os2loop_cura_login.settings')
-      ->set('signing_algorithm', $form_state->getValue('signing_algorithm'))
-      ->set('signing_secret', $secret)
-      ->set('payload_name', $form_state->getValue('payload_name'))
-      ->set('jwt_leeway', $form_state->getValue('jwt_leeway'))
-      ->set('log_level', $form_state->getValue('log_level'))
-      ->save();
+    /** @var \Drupal\os2loop_cura_login\Settings $settings */
+    $settings = \Drupal::service(Settings::class);
+    $settings->saveSettings($form_state);
+
     parent::submitForm($form, $form_state);
   }
 

web/profiles/custom/os2loop/modules/os2loop_cura_login/src/Settings.php

@@ -0,0 +1,101 @@
+<?php
+
+namespace Drupal\os2loop_cura_login;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Config\ImmutableConfig;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Logger\RfcLogLevel;
+
+/**
+ * Settings for OS2Loop Cura login.
+ */
+final class Settings {
+  const string CONFIG_NAME = 'os2loop_cura_login.settings';
+
+  private const SETTING_SIGNING_SECRET = 'signing_secret';
+  private const SETTING_SIGNING_ALGORITHM = 'signing_algorithm';
+  private const SETTING_PAYLOAD_NAME = 'payload_name';
+  private const SETTING_JWT_LEEWAY = 'jwt_leeway';
+  private const SETTING_LOG_LEVEL = 'log_level';
+
+  const array SIGNING_ALGORITHMS = [
+    'HS256' => 'HS256',
+    'HS384' => 'HS384',
+    'HS512' => 'HS512',
+  ];
+
+  /**
+   * The config.
+   */
+  private readonly ImmutableConfig $config;
+
+  /**
+   * Constructor.
+   */
+  public function __construct(
+    private readonly ConfigFactoryInterface $configFactory,
+  ) {
+    $this->config = $configFactory->get(self::CONFIG_NAME);
+  }
+
+  /**
+   * Get payload name.
+   */
+  public function getPayloadName(): string {
+    return $this->config->get('payload_name') ?? 'payload';
+  }
+
+  /**
+   * Get signing algorithm.
+   */
+  public function getSigningAlgorithm(): string {
+    return $this->config->get('signing_algorithm') ?? self::SIGNING_ALGORITHMS[array_key_first(self::SIGNING_ALGORITHMS)];
+  }
+
+  /**
+   * Get signing secret.
+   */
+  public function getSigningSecret(): string {
+    return $this->config->get('signing_secret') ?? '';
+  }
+
+  /**
+   * Get JWT leeway.
+   */
+  public function getJwtLeeway(): int {
+    return (int) $this->config->get('jwt_leeway');
+  }
+
+  /**
+   * Get log level.
+   */
+  public function getLogLevel() {
+    return (int) $this->config->get('log_level') ?? RfcLogLevel::ERROR;
+  }
+
+  /**
+   * Save settings.
+   */
+  public function saveSettings(array|FormStateInterface $values): array {
+    if ($values instanceof FormStateInterface) {
+      $values = [
+        self::SETTING_SIGNING_ALGORITHM => $values->getValue(self::SETTING_SIGNING_ALGORITHM),
+        self::SETTING_SIGNING_SECRET => $values->getValue(self::SETTING_SIGNING_SECRET),
+        self::SETTING_PAYLOAD_NAME => $values->getValue(self::SETTING_PAYLOAD_NAME),
+        self::SETTING_JWT_LEEWAY => $values->getValue(self::SETTING_JWT_LEEWAY),
+        self::SETTING_LOG_LEVEL => $values->getValue(self::SETTING_LOG_LEVEL),
+      ];
+    }
+
+    // @todo validate values
+    $config = $this->configFactory->getEditable(self::CONFIG_NAME);
+    foreach ($values as $key => $value) {
+      $config->set($key, $value);
+    }
+    $config->save();
+
+    return $config->get();
+  }
+
+}