-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUserProfileFieldCheck.php
More file actions
241 lines (204 loc) · 7.39 KB
/
UserProfileFieldCheck.php
File metadata and controls
241 lines (204 loc) · 7.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<?php
/**
* SPDX-FileCopyrightText: 2026 LibreCode coop and LibreCode contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
declare(strict_types=1);
namespace OCA\ProfileFields\Workflow;
use InvalidArgumentException;
use JsonException;
use OCA\ProfileFields\Db\FieldDefinition;
use OCA\ProfileFields\Db\FieldValue;
use OCA\ProfileFields\Enum\FieldType;
use OCA\ProfileFields\Service\FieldDefinitionService;
use OCA\ProfileFields\Service\FieldValueService;
use OCP\IL10N;
use OCP\IUser;
use OCP\IUserSession;
use OCP\WorkflowEngine\ICheck;
use OCP\WorkflowEngine\IManager;
class UserProfileFieldCheck implements ICheck {
private const OPERATOR_IS_SET = 'is-set';
private const OPERATOR_IS_NOT_SET = '!is-set';
private const TEXT_OPERATORS = [
self::OPERATOR_IS_SET,
self::OPERATOR_IS_NOT_SET,
'is',
'!is',
'contains',
'!contains',
];
private const NUMBER_OPERATORS = [
self::OPERATOR_IS_SET,
self::OPERATOR_IS_NOT_SET,
'is',
'!is',
'less',
'!greater',
'greater',
'!less',
];
private const SELECT_OPERATORS = [
self::OPERATOR_IS_SET,
self::OPERATOR_IS_NOT_SET,
'is',
'!is',
];
public function __construct(
private IUserSession $userSession,
private IL10N $l10n,
private FieldDefinitionService $fieldDefinitionService,
private FieldValueService $fieldValueService,
private ProfileFieldValueSubjectContext $workflowSubjectContext,
) {
}
#[\Override]
public function executeCheck($operator, $value) {
try {
$workflowSubject = $this->workflowSubjectContext->get();
$config = $this->parseConfig((string)$value);
$definition = $this->resolveDefinition($config['field_key']);
if ($definition === null || !$this->isOperatorSupported($definition, (string)$operator)) {
return false;
}
$userUid = $workflowSubject?->getUserUid();
if ($userUid === null) {
$user = $this->userSession->getUser();
if (!$user instanceof IUser) {
return $operator === self::OPERATOR_IS_NOT_SET;
}
$userUid = $user->getUID();
}
if ($userUid === '') {
return $operator === self::OPERATOR_IS_NOT_SET;
}
$storedValue = $this->fieldValueService->findByFieldDefinitionIdAndUserUid($definition->getId(), $userUid);
$actualValue = $this->extractActualValue($storedValue);
return $this->evaluate($definition, (string)$operator, $config['value'], $actualValue);
} catch (\Throwable) {
return false;
}
}
#[\Override]
public function validateCheck($operator, $value) {
$config = $this->parseConfig((string)$value);
$definition = $this->resolveDefinition($config['field_key']);
if ($definition === null) {
throw new \UnexpectedValueException($this->l10n->t('The selected profile field does not exist'), 2);
}
if (!$this->isOperatorSupported($definition, (string)$operator)) {
throw new \UnexpectedValueException($this->l10n->t('The selected operator is not supported for this profile field'), 3);
}
if ($this->operatorRequiresValue((string)$operator)) {
try {
$this->fieldValueService->normalizeValue($definition, $config['value']);
} catch (InvalidArgumentException $exception) {
throw new \UnexpectedValueException($this->l10n->t('The configured comparison value is invalid'), 4, $exception);
}
}
}
#[\Override]
public function supportedEntities(): array {
return [];
}
#[\Override]
public function isAvailableForScope(int $scope): bool {
return $scope === IManager::SCOPE_ADMIN;
}
/**
* @return array{field_key: string, value: string|int|float|bool|null}
*/
private function parseConfig(string $value): array {
try {
$decoded = json_decode($value, true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $exception) {
throw new \UnexpectedValueException($this->l10n->t('The workflow check configuration is invalid'), 1, $exception);
}
if (!is_array($decoded) || !is_string($decoded['field_key'] ?? null) || trim($decoded['field_key']) === '') {
throw new \UnexpectedValueException($this->l10n->t('The workflow check configuration is invalid'), 1);
}
$valueCandidate = $decoded['value'] ?? null;
if (is_array($valueCandidate) || is_object($valueCandidate)) {
throw new \UnexpectedValueException($this->l10n->t('The workflow check configuration is invalid'), 1);
}
return [
'field_key' => trim($decoded['field_key']),
'value' => $valueCandidate,
];
}
private function resolveDefinition(string $fieldKey): ?FieldDefinition {
$definition = $this->fieldDefinitionService->findByFieldKey($fieldKey);
if ($definition === null || !$definition->getActive()) {
return null;
}
return $definition;
}
private function isOperatorSupported(FieldDefinition $definition, string $operator): bool {
$operators = match (FieldType::from($definition->getType())) {
FieldType::TEXT => self::TEXT_OPERATORS,
FieldType::NUMBER => self::NUMBER_OPERATORS,
FieldType::SELECT => self::SELECT_OPERATORS,
};
return in_array($operator, $operators, true);
}
private function operatorRequiresValue(string $operator): bool {
return !in_array($operator, [self::OPERATOR_IS_SET, self::OPERATOR_IS_NOT_SET], true);
}
private function extractActualValue(?FieldValue $value): string|int|float|bool|null {
if ($value === null) {
return null;
}
$serialized = $this->fieldValueService->serializeForResponse($value);
$payload = $serialized['value']['value'] ?? null;
return is_array($payload) || is_object($payload) ? null : $payload;
}
private function evaluate(FieldDefinition $definition, string $operator, string|int|float|bool|null $expectedRawValue, string|int|float|bool|null $actualValue): bool {
$isSet = $actualValue !== null && $actualValue !== '';
if ($operator === self::OPERATOR_IS_SET) {
return $isSet;
}
if ($operator === self::OPERATOR_IS_NOT_SET) {
return !$isSet;
}
if (!$isSet) {
return false;
}
$normalizedExpected = $this->fieldValueService->normalizeValue($definition, $expectedRawValue);
$expectedValue = $normalizedExpected['value'] ?? null;
return match (FieldType::from($definition->getType())) {
FieldType::TEXT,
FieldType::SELECT => $this->evaluateTextOperator($operator, (string)$expectedValue, (string)$actualValue),
FieldType::NUMBER => $this->evaluateNumberOperator(
$operator,
$this->normalizeNumericComparisonOperand($expectedValue),
$this->normalizeNumericComparisonOperand($actualValue),
),
};
}
private function normalizeNumericComparisonOperand(string|int|float|bool|null $value): int|float {
if (is_int($value) || is_float($value)) {
return $value;
}
return str_contains((string)$value, '.') ? (float)$value : (int)$value;
}
private function evaluateTextOperator(string $operator, string $expectedValue, string $actualValue): bool {
return match ($operator) {
'is' => $actualValue === $expectedValue,
'!is' => $actualValue !== $expectedValue,
'contains' => $expectedValue !== '' && mb_stripos($actualValue, $expectedValue) !== false,
'!contains' => $expectedValue === '' || mb_stripos($actualValue, $expectedValue) === false,
default => false,
};
}
private function evaluateNumberOperator(string $operator, int|float $expectedValue, int|float $actualValue): bool {
return match ($operator) {
'is' => $actualValue === $expectedValue,
'!is' => $actualValue !== $expectedValue,
'less' => $actualValue < $expectedValue,
'!greater' => $actualValue <= $expectedValue,
'greater' => $actualValue > $expectedValue,
'!less' => $actualValue >= $expectedValue,
default => false,
};
}
}