forked from ProcessMaker/processmaker
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFilter.php
More file actions
269 lines (221 loc) · 7.36 KB
/
Filter.php
File metadata and controls
269 lines (221 loc) · 7.36 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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?php
namespace ProcessMaker\Filters;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Arr;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Models\User;
use ProcessMaker\Query\BaseField;
use ProcessMaker\Query\Expression;
class Filter
{
const TYPE_PARTICIPANTS = 'Participants';
const TYPE_PARTICIPANTS_FULLNAME = 'ParticipantsFullName';
const TYPE_ASSIGNEES_FULLNAME = 'AssigneesFullName';
const TYPE_STATUS = 'Status';
const TYPE_FIELD = 'Field';
const TYPE_PROCESS = 'Process';
const TYPE_RELATIONSHIP = 'Relationship';
public string|null $subjectValue;
public string $subjectType;
public string $operator;
public $value;
public array $or;
public static function filter(Builder $query, string $filterDefinitions)
{
$filterDefinitions = json_decode($filterDefinitions, true);
if (!isset($filterDefinitions)) {
// If the value is incorrect, we return a filter that produces an empty result.
$default = '{"subject":{"type":"Field","value":"id"},"operator":"=","value":""}';
$filterDefinitions = [json_decode($default, true)];
}
$query->where(function ($query) use ($filterDefinitions) {
foreach ($filterDefinitions as $filter) {
(new self($filter))->addToQuery($query);
}
});
}
public function __construct($definition)
{
$this->subjectType = $definition['subject']['type'];
$this->subjectValue = Arr::get($definition, 'subject.value');
$this->operator = $definition['operator'];
$this->value = $definition['value'];
$this->or = Arr::get($definition, 'or', []);
}
public function addToQuery(Builder $query)
{
if (!empty($this->or)) {
$query->where(function ($query) {
$this->apply($query);
});
} else {
$this->apply($query);
}
}
private function apply($query)
{
if ($valueAliasMethod = $this->valueAliasMethod()) {
$this->valueAliasAdapter($valueAliasMethod, $query);
} elseif ($this->subjectType === self::TYPE_PROCESS) {
$this->filterByProcessId($query);
} elseif ($this->subjectType === self::TYPE_RELATIONSHIP) {
$this->filterByRelationship($query);
} else {
$this->applyQueryBuilderMethod($query);
}
if (!empty($this->or)) {
$query->orWhere(function ($orQuery) {
foreach ($this->or as $or) {
(new self($or))->addToQuery($orQuery);
}
});
}
}
private function applyQueryBuilderMethod($query)
{
$method = $this->method();
if (in_array($method, ['whereIn', 'whereBetween', 'whereJsonContains'])) {
$query->$method(
$this->subject(),
$this->value(),
);
} else {
$query->$method(
$this->subject(),
$this->operator(),
$this->value(),
);
}
}
private function operator()
{
if ($this->operator === 'contains' || $this->operator === 'starts_with') {
return 'like';
}
if ($this->operator === 'regex') {
$this->operator = 'REGEXP';
}
return $this->operator;
}
private function method()
{
switch($this->operator) {
case 'in':
$method = 'whereIn';
if ($this->isJsonData()) {
$method = 'whereJsonContains';
}
break;
case 'between':
$method = 'whereBetween';
break;
default:
$method = 'where';
}
return $method;
}
private function isJsonData()
{
return $this->subjectType === self::TYPE_FIELD && str_starts_with($this->subjectValue, 'data.');
}
private function subject()
{
if ($this->isJsonData()) {
return str_replace('.', '->', $this->subjectValue);
}
if ($this->subjectType === self::TYPE_PARTICIPANTS) {
return 'user_id';
}
if ($this->subjectType === self::TYPE_PROCESS) {
return 'process_id';
}
if ($this->subjectType === self::TYPE_RELATIONSHIP) {
return $this->relationshipSubjectTypeParts()[1];
}
return $this->subjectValue;
}
private function relationshipSubjectTypeParts()
{
return explode('.', $this->subjectValue);
}
private function value()
{
if ($this->operator === 'contains') {
return '%' . $this->value . '%';
}
if ($this->operator === 'starts_with') {
return $this->value . '%';
}
return $this->value;
}
/**
* Forward Status and Participant subjects to PMQL methods on the models.
*
* For now, we only need Participants and Status because Request and Requester
* are columns on the tables (process_request_id and user_id).
*/
private function valueAliasMethod()
{
$method = null;
switch ($this->subjectType) {
case self::TYPE_PARTICIPANTS:
$method = 'valueAliasParticipant';
break;
case self::TYPE_PARTICIPANTS_FULLNAME:
$method = 'valueAliasParticipantByFullName';
break;
case self::TYPE_ASSIGNEES_FULLNAME:
$method = 'valueAliasAssigneeByFullName';
break;
case self::TYPE_STATUS:
$method = 'valueAliasStatus';
break;
}
return $method;
}
private function valueAliasAdapter(string $method, Builder $query)
{
$operator = $this->operator();
if ($operator === 'in') {
$operator = '=';
}
$values = (array) $this->value();
$expression = (object) ['operator' => $operator];
$model = $query->getModel();
if ($method === 'valueAliasParticipant') {
$values = $this->convertUserIdsToUsernames($values);
}
foreach ($values as $i => $value) {
if ($i === 0) {
$query->where($model->$method($value, $expression));
} else {
$query->orWhere($model->$method($value, $expression));
}
}
}
private function convertUserIdsToUsernames($values)
{
return array_map(function ($value) {
$username = User::find($value)?->username;
return isset($username) ? $username : $value;
}, $values);
}
private function filterByProcessId(Builder $query)
{
if ($query->getModel() instanceof ProcessRequestToken) {
$query->whereIn('process_request_id', function ($query) {
$query->select('id')->from('process_requests')
->whereIn('process_id', (array) $this->value());
});
} else {
$this->applyQueryBuilderMethod($query);
}
}
private function filterByRelationship(Builder $query)
{
$relationshipName = $this->relationshipSubjectTypeParts()[0];
$query->whereHas($relationshipName, function ($rel) {
$this->applyQueryBuilderMethod($rel);
});
}
}