Skip to content

Commit 0d4cc49

Browse files
rimi-itkrimi-itk
committed
Cleaned up settings form
1 parent fe1ff20 commit 0d4cc49

File tree

5 files changed

+81
-68
lines changed

5 files changed

+81
-68
lines changed

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,9 @@ run the checks locally.
122122

123123
```sh
124124
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer install
125-
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-check
126-
127125
# Fix (some) coding standards issues.
128126
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-apply
127+
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-check
129128
```
130129

131130
### Markdown

‎modules/os2forms_digital_post/src/Form/SettingsForm.php‎

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@
1919
final class SettingsForm extends FormBase {
2020
use StringTranslationTrait;
2121

22+
public const TEST_MODE = 'test_mode';
23+
public const SENDER = 'sender';
24+
public const CERTIFICATE = 'certificate';
25+
public const PROCESSING = 'processing';
26+
2227
/**
2328
* The queue storage.
2429
*
@@ -63,15 +68,15 @@ public function getFormId() {
6368
* @phpstan-param array<string, mixed> $form
6469
* @phpstan-return array<string, mixed>
6570
*/
66-
public function buildForm(array $form, FormStateInterface $form_state) {
67-
$form['test_mode'] = [
71+
public function buildForm(array $form, FormStateInterface $form_state): array {
72+
$form[self::TEST_MODE] = [
6873
'#type' => 'checkbox',
6974
'#title' => $this->t('Test mode'),
7075
'#default_value' => $this->settings->getTestMode(),
7176
];
7277

7378
$sender = $this->settings->getSender();
74-
$form['sender'] = [
79+
$form[self::SENDER] = [
7580
'#type' => 'fieldset',
7681
'#title' => $this->t('Sender'),
7782
'#tree' => TRUE,
@@ -102,24 +107,24 @@ public function buildForm(array $form, FormStateInterface $form_state) {
102107
];
103108

104109
$certificate = $this->settings->getCertificate();
105-
$form['certificate'] = [
110+
$form[self::CERTIFICATE] = [
106111
'#type' => 'fieldset',
107112
'#title' => $this->t('Certificate'),
108113
'#tree' => TRUE,
109114

110-
'locator_type' => [
115+
CertificateLocatorHelper::LOCATOR_TYPE => [
111116
'#type' => 'select',
112117
'#title' => $this->t('Certificate locator type'),
113118
'#options' => [
114119
CertificateLocatorHelper::LOCATOR_TYPE_KEY => $this->t('Key'),
115120
CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT => $this->t('Azure key vault'),
116121
CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM => $this->t('File system'),
117122
],
118-
'#default_value' => $certificate['locator_type'] ?? NULL,
123+
'#default_value' => $certificate[CertificateLocatorHelper::LOCATOR_TYPE] ?? NULL,
119124
],
120125
];
121126

122-
$form['certificate'][CertificateLocatorHelper::LOCATOR_TYPE_KEY] = [
127+
$form[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_TYPE_KEY] = [
123128
'#type' => 'container',
124129
'#states' => [
125130
'visible' => [':input[name="certificate[locator_type]"]' => ['value' => CertificateLocatorHelper::LOCATOR_TYPE_KEY]],
@@ -138,7 +143,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
138143
],
139144
];
140145

141-
$form['certificate'][CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT] = [
146+
$form[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT] = [
142147
'#type' => 'fieldset',
143148
'#title' => $this->t('Azure key vault'),
144149
'#states' => [
@@ -147,16 +152,16 @@ public function buildForm(array $form, FormStateInterface $form_state) {
147152
];
148153

149154
$settings = [
150-
'tenant_id' => ['title' => $this->t('Tenant id')],
151-
'application_id' => ['title' => $this->t('Application id')],
152-
'client_secret' => ['title' => $this->t('Client secret')],
153-
'name' => ['title' => $this->t('Name')],
154-
'secret' => ['title' => $this->t('Secret')],
155-
'version' => ['title' => $this->t('Version')],
155+
CertificateLocatorHelper::LOCATOR_AZURE_KEY_VAULT_TENANT_ID => ['title' => $this->t('Tenant id')],
156+
CertificateLocatorHelper::LOCATOR_AZURE_KEY_VAULT_APPLICATION_ID => ['title' => $this->t('Application id')],
157+
CertificateLocatorHelper::LOCATOR_AZURE_KEY_VAULT_CLIENT_SECRET => ['title' => $this->t('Client secret')],
158+
CertificateLocatorHelper::LOCATOR_AZURE_KEY_VAULT_NAME => ['title' => $this->t('Name')],
159+
CertificateLocatorHelper::LOCATOR_AZURE_KEY_VAULT_SECRET => ['title' => $this->t('Secret')],
160+
CertificateLocatorHelper::LOCATOR_AZURE_KEY_VAULT_VERSION => ['title' => $this->t('Version')],
156161
];
157162

158163
foreach ($settings as $key => $info) {
159-
$form['certificate'][CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT][$key] = [
164+
$form[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT][$key] = [
160165
'#type' => 'textfield',
161166
'#title' => $info['title'],
162167
'#default_value' => $certificate[CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT][$key] ?? NULL,
@@ -166,7 +171,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
166171
];
167172
}
168173

169-
$form['certificate'][CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM] = [
174+
$form[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM] = [
170175
'#type' => 'fieldset',
171176
'#title' => $this->t('File system'),
172177
'#states' => [
@@ -183,29 +188,29 @@ public function buildForm(array $form, FormStateInterface $form_state) {
183188
],
184189
];
185190

186-
$form['certificate']['passphrase'] = [
191+
$form[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_PASSPHRASE] = [
187192
'#type' => 'textfield',
188193
'#title' => $this->t('Passphrase'),
189-
'#default_value' => $certificate['passphrase'] ?? NULL,
190-
194+
'#default_value' => $certificate[CertificateLocatorHelper::LOCATOR_PASSPHRASE] ?? NULL,
191195
'#states' => [
192-
'visible' => [':input[name="certificate[locator_type]"]' => [
196+
'visible' => [
197+
':input[name="certificate[locator_type]"]' => [
193198
['value' => CertificateLocatorHelper::LOCATOR_TYPE_AZURE_KEY_VAULT],
194199
['value' => CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM],
195-
],
200+
],
196201
],
197202
],
198203
];
199204

200205
$processing = $this->settings->getProcessing();
201-
$form['processing'] = [
206+
$form[self::PROCESSING] = [
202207
'#type' => 'fieldset',
203208
'#title' => $this->t('Processing'),
204209
'#tree' => TRUE,
205210
];
206211

207212
$defaultValue = $processing['queue'] ?? 'os2forms_digital_post';
208-
$form['processing']['queue'] = [
213+
$form[self::PROCESSING]['queue'] = [
209214
'#type' => 'select',
210215
'#title' => $this->t('Queue'),
211216
'#options' => array_map(
@@ -247,8 +252,8 @@ public function validateForm(array &$form, FormStateInterface $formState): void
247252
}
248253

249254
$values = $formState->getValues();
250-
if (CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM === $values['certificate']['locator_type']) {
251-
$path = $values['certificate'][CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM]['path'] ?? NULL;
255+
if (CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM === $values[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_TYPE]) {
256+
$path = $values[self::CERTIFICATE][CertificateLocatorHelper::LOCATOR_TYPE_FILE_SYSTEM]['path'] ?? NULL;
252257
if (!file_exists($path)) {
253258
$formState->setErrorByName('certificate][file_system][path', $this->t('Invalid certificate path: %path', ['%path' => $path]));
254259
}
@@ -268,10 +273,11 @@ public function submitForm(array &$form, FormStateInterface $formState): void {
268273
}
269274

270275
try {
271-
$settings['test_mode'] = (bool) $formState->getValue('test_mode');
272-
$settings['sender'] = $formState->getValue('sender');
273-
$settings['certificate'] = $formState->getValue('certificate');
274-
$settings['processing'] = $formState->getValue('processing');
276+
$settings[self::TEST_MODE] = (bool) $formState->getValue(self::TEST_MODE);
277+
$settings[self::SENDER] = $formState->getValue(self::SENDER);
278+
$settings[self::CERTIFICATE] = $formState->getValue(self::CERTIFICATE);
279+
$settings[self::PROCESSING] = $formState->getValue(self::PROCESSING);
280+
275281
$this->settings->setSettings($settings);
276282
$this->messenger()->addStatus($this->t('Settings saved'));
277283
}
@@ -287,7 +293,7 @@ private function testCertificate(): void {
287293
try {
288294
$certificateLocator = $this->certificateLocatorHelper->getCertificateLocator();
289295
$certificateLocator->getCertificates();
290-
$this->messenger()->addStatus($this->t('Certificate succesfully tested'));
296+
$this->messenger()->addStatus($this->t('Certificate successfully tested'));
291297
}
292298
catch (\Throwable $throwable) {
293299
$message = $this->t('Error testing certificate: %message', ['%message' => $throwable->getMessage()]);

‎modules/os2forms_digital_post/src/Helper/CertificateLocatorHelper.php‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,25 @@
1717
* Certificate locator helper.
1818
*/
1919
class CertificateLocatorHelper {
20+
public const LOCATOR_TYPE = 'locator_type';
2021
public const LOCATOR_TYPE_AZURE_KEY_VAULT = 'azure_key_vault';
2122
public const LOCATOR_TYPE_FILE_SYSTEM = 'file_system';
2223
public const LOCATOR_TYPE_KEY = 'key';
24+
public const LOCATOR_PASSPHRASE = 'passphrase';
25+
public const LOCATOR_AZURE_KEY_VAULT_TENANT_ID = 'tenant_id';
26+
public const LOCATOR_AZURE_KEY_VAULT_APPLICATION_ID = 'application_id';
27+
public const LOCATOR_AZURE_KEY_VAULT_CLIENT_SECRET = 'client_secret';
28+
public const LOCATOR_AZURE_KEY_VAULT_NAME = 'name';
29+
public const LOCATOR_AZURE_KEY_VAULT_SECRET = 'secret';
30+
public const LOCATOR_AZURE_KEY_VAULT_VERSION = 'version';
31+
public const LOCATOR_FILE_SYSTEM_PATH = 'path';
2332

2433
/**
25-
* {@inheritdoc}
34+
* Constructor.
2635
*/
2736
public function __construct(
2837
private readonly Settings $settings,
29-
private readonly KeyRepositoryInterface $keyRepository
38+
private readonly KeyRepositoryInterface $keyRepository,
3039
) {
3140
}
3241

@@ -36,10 +45,10 @@ public function __construct(
3645
public function getCertificateLocator(): CertificateLocatorInterface {
3746
$certificateSettings = $this->settings->getCertificate();
3847

39-
$locatorType = $certificateSettings['locator_type'];
48+
$locatorType = $certificateSettings[self::LOCATOR_TYPE];
4049
$options = $certificateSettings[$locatorType];
4150
$options += [
42-
'passphrase' => $certificateSettings['passphrase'] ?: '',
51+
self::LOCATOR_PASSPHRASE => $certificateSettings[self::LOCATOR_PASSPHRASE] ?: '',
4352
];
4453

4554
switch ($locatorType) {
@@ -60,32 +69,31 @@ public function getCertificateLocator(): CertificateLocatorInterface {
6069
$vaultToken = new VaultToken($httpClient, $requestFactory);
6170

6271
$token = $vaultToken->getToken(
63-
$options['tenant_id'],
64-
$options['application_id'],
65-
$options['client_secret'],
72+
$options[self::LOCATOR_AZURE_KEY_VAULT_TENANT_ID],
73+
$options[self::LOCATOR_AZURE_KEY_VAULT_APPLICATION_ID],
74+
$options[self::LOCATOR_AZURE_KEY_VAULT_CLIENT_SECRET],
6675
);
6776

6877
$vault = new VaultSecret(
6978
$httpClient,
7079
$requestFactory,
71-
$options['name'],
80+
$options[self::LOCATOR_AZURE_KEY_VAULT_NAME],
7281
$token->getAccessToken()
7382
);
7483

7584
return new AzureKeyVaultCertificateLocator(
7685
$vault,
77-
$options['secret'],
78-
$options['version'],
79-
$options['passphrase'],
86+
$options[self::LOCATOR_AZURE_KEY_VAULT_SECRET],
87+
$options[self::LOCATOR_AZURE_KEY_VAULT_VERSION],
88+
$options[self::LOCATOR_PASSPHRASE],
8089
);
8190

8291
case self::LOCATOR_TYPE_FILE_SYSTEM:
83-
$certificatepath = realpath($options['path']) ?: null;
84-
if (null === $certificatepath) {
85-
throw new CertificateLocatorException(sprintf('Invalid certificate path %s', $options['path']));
92+
$certificatepath = realpath($options[self::LOCATOR_FILE_SYSTEM_PATH]) ?: NULL;
93+
if (NULL === $certificatepath) {
94+
throw new CertificateLocatorException(sprintf('Invalid certificate path %s', $options[self::LOCATOR_FILE_SYSTEM_PATH]));
8695
}
87-
88-
return new FilesystemCertificateLocator($certificatepath, $options['passphrase']);
96+
return new FilesystemCertificateLocator($certificatepath, $options[self::LOCATOR_PASSPHRASE]);
8997

9098
default:
9199
throw new CertificateLocatorException(sprintf('Invalid certificate locator type: %s', $locatorType));

‎modules/os2forms_digital_post/src/Helper/MemoryCertificateLocator.php‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,22 @@
55
use ItkDev\Serviceplatformen\Certificate\AbstractCertificateLocator;
66
use ItkDev\Serviceplatformen\Certificate\Exception\CertificateLocatorException;
77

8-
class MemoryCertificateLocator extends AbstractCertificateLocator
9-
{
8+
/**
9+
* Memory certificate locator.
10+
*/
11+
class MemoryCertificateLocator extends AbstractCertificateLocator {
12+
1013
public function __construct(
1114
// The passwordless certificate.
12-
private readonly string $certificate
13-
)
14-
{
15+
private readonly string $certificate,
16+
) {
1517
parent::__construct('');
1618
}
1719

1820
/**
1921
* {@inheritdoc}
2022
*/
21-
public function getCertificates(): array
22-
{
23+
public function getCertificates(): array {
2324
$certificates = [];
2425
if (!openssl_pkcs12_read($this->certificate, $certificates, $this->passphrase)) {
2526
throw new CertificateLocatorException('Could not read certificate.');
@@ -31,17 +32,15 @@ public function getCertificates(): array
3132
/**
3233
* {@inheritdoc}
3334
*/
34-
public function getCertificate(): string
35-
{
35+
public function getCertificate(): string {
3636
return $this->certificate;
3737
}
3838

3939
/**
4040
* {@inheritdoc}
4141
*/
42-
public function getAbsolutePathToCertificate(): string
43-
{
44-
throw new CertificateLocatorException(__METHOD__.' should not be used.');
42+
public function getAbsolutePathToCertificate(): string {
43+
throw new CertificateLocatorException(__METHOD__ . ' should not be used.');
4544
}
4645

4746
}

‎modules/os2forms_digital_post/src/Helper/Settings.php‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;
66
use Drupal\Core\KeyValueStore\KeyValueStoreInterface;
77
use Drupal\os2forms_digital_post\Exception\InvalidSettingException;
8+
use Drupal\os2forms_digital_post\Form\SettingsForm;
89
use Symfony\Component\OptionsResolver\OptionsResolver;
910

1011
/**
@@ -40,7 +41,7 @@ public function __construct(KeyValueFactoryInterface $keyValueFactory) {
4041
* Get test mode.
4142
*/
4243
public function getTestMode(): bool {
43-
return (bool) $this->get('test_mode', TRUE);
44+
return (bool) $this->get(SettingsForm::TEST_MODE, TRUE);
4445
}
4546

4647
/**
@@ -49,7 +50,7 @@ public function getTestMode(): bool {
4950
* @phpstan-return array<string, mixed>
5051
*/
5152
public function getSender(): array {
52-
$value = $this->get('sender');
53+
$value = $this->get(SettingsForm::SENDER);
5354
return is_array($value) ? $value : [];
5455
}
5556

@@ -59,7 +60,7 @@ public function getSender(): array {
5960
* @phpstan-return array<string, mixed>
6061
*/
6162
public function getCertificate(): array {
62-
$value = $this->get('certificate');
63+
$value = $this->get(SettingsForm::CERTIFICATE);
6364
return is_array($value) ? $value : [];
6465
}
6566

@@ -69,7 +70,7 @@ public function getCertificate(): array {
6970
* @phpstan-return array<string, mixed>
7071
*/
7172
public function getProcessing(): array {
72-
$value = $this->get('processing');
73+
$value = $this->get(SettingsForm::PROCESSING);
7374
return is_array($value) ? $value : [];
7475
}
7576

@@ -115,10 +116,10 @@ public function setSettings(array $settings): self {
115116
private function getSettingsResolver(): OptionsResolver {
116117
return (new OptionsResolver())
117118
->setDefaults([
118-
'test_mode' => TRUE,
119-
'sender' => [],
120-
'certificate' => [],
121-
'processing' => [],
119+
SettingsForm::TEST_MODE => TRUE,
120+
SettingsForm::SENDER => [],
121+
SettingsForm::CERTIFICATE => [],
122+
SettingsForm::PROCESSING => [],
122123
]);
123124
}
124125

0 commit comments

Comments
 (0)