forked from ProcessMaker/processmaker
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathProcessRequestToken.php
More file actions
587 lines (530 loc) · 16.2 KB
/
Copy pathProcessRequestToken.php
File metadata and controls
587 lines (530 loc) · 16.2 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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
<?php
namespace ProcessMaker\Models;
use Carbon\Carbon;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Database\Eloquent\Model;
use Log;
use ProcessMaker\Models\User;
use ProcessMaker\Nayra\Bpmn\TokenTrait;
use ProcessMaker\Nayra\Contracts\Bpmn\FlowElementInterface;
use ProcessMaker\Nayra\Contracts\Bpmn\TokenInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Throwable;
/**
* ProcessRequestToken is used to store the state of a token of the
* Nayra engine
*
* @property string $id
* @property string $process_request_id
* @property string $user_id
* @property string $element_id
* @property string $element_type
* @property string $status
* @property \Carbon\Carbon $completed_at
* @property \Carbon\Carbon $due_at
* @property \Carbon\Carbon $initiated_at
* @property \Carbon\Carbon $riskchanges_at
* @property \Carbon\Carbon $updated_at
* @property \Carbon\Carbon $created_at
* @property ProcessRequest $request
*
* @OA\Schema(
* schema="processRequestTokenEditable",
* @OA\Property(property="user_id", type="string", format="id"),
* @OA\Property(property="status", type="string"),
* @OA\Property(property="due_at", type="date-time"),
* @OA\Property(property="initiated_at", type="string", format="date-time"),
* @OA\Property(property="riskchanges_at", type="string", format="date-time"),
* @OA\Property(property="subprocess_start_event_id", type="string"),
* ),
* @OA\Schema(
* schema="processRequestToken",
* allOf={
* @OA\Schema(ref="#/components/schemas/processRequestTokenEditable"),
* @OA\Schema(
* @OA\Property(property="id", type="string", format="id"),
* @OA\Property(property="process_id", type="string", format="id"),
* @OA\Property(property="process_request_id", type="string", format="id"),
* @OA\Property(property="element_id", type="string", format="id"),
* @OA\Property(property="element_type", type="string", format="id"),
* @OA\Property(property="element_index", type="string"),
* @OA\Property(property="element_name", type="string"),
* @OA\Property(property="created_at", type="string", format="date-time"),
* @OA\Property(property="updated_at", type="string", format="date-time"),
* @OA\Property(property="initiated_at", type="string", format="date-time"),
* @OA\Property(property="advanceStatus", type="string"),
* @OA\Property(property="due_notified", type="integer"),
* )
* }
* )
*/
class ProcessRequestToken extends Model implements TokenInterface
{
use ExtendedPMQL;
use TokenTrait;
use SerializeToIso8601;
protected $connection = 'processmaker';
/**
* Attributes that are not mass assignable.
*
* @var array $guarded
*/
protected $guarded = [
'id',
'updated_at',
'created_at',
'data',
];
/**
* The attributes that should be hidden for serialization.
*
* BPMN data will be hidden. It will be able by its getter.
*
* @var array
*/
protected $hidden = [
'bpmn',
'data',
];
/**
* The binary UUID attributes that should be converted to text.
*
* @var array
*/
protected $ids = [
'process_id',
'process_request_id',
'user_id',
];
/**
* The accessors to append to the model's array form.
*
* @var array
*/
protected $appends = [
'advanceStatus'
];
/**
* The attributes that should be mutated to dates.
*
* @var array
*/
protected $dates = [
'completed_at',
'due_at',
'initiated_at',
'riskchanges_at',
];
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'data' => 'array',
'self_service_groups' => 'array',
];
/**
* Boot application as a process instance.
*
* @param array $argument
*/
public function __construct(array $argument=[])
{
parent::__construct($argument);
$this->bootElement([]);
}
/**
* Notification settings of the process.
*
* @param string $entity
* @param string $notificationType
*
* @return array
*/
public function getNotifiables($notificationType)
{
$userIds = collect([]);
$process = $this->process()->first();
$notifiableTypes = $process->notification_settings()
->where('notification_type', $notificationType)
->where('element_id', $this->element_id)
->get()->pluck('notifiable_type');
foreach ($notifiableTypes as $notifiableType) {
$userIds = $userIds->merge($this->getNotifiableUserIds($notifiableType));
}
$userIds = $userIds->unique();
$notifiables = $notifiableTypes->implode(', ');
$users = $userIds->implode(', ');
Log::debug("Sending task $notificationType notification to $notifiables (users: $users)");
return User::whereIn('id', $userIds)->get();
}
public function getNotifiableUserIds($notifiableType)
{
switch ($notifiableType) {
case 'requester':
return collect([$this->processRequest->user_id]);
break;
case 'assignee':
return collect([$this->user_id]);
break;
case 'participants':
return $this->processRequest->participants()->get()->pluck('id');
break;
default:
return collect([]);
}
}
/**
* Get the process to which this version points to.
*
*/
public function process()
{
return $this->belongsTo(Process::class, 'process_id');
}
/**
* Get the request of the token.
*
*/
public function processRequest()
{
return $this->belongsTo(ProcessRequest::class, 'process_request_id');
}
/**
* Get the creator/author of this request.
*
*/
public function user()
{
return $this->belongsTo(User::class, 'user_id');
}
/**
* Get the creator/author of this request.
*
*/
public function assignableUsers()
{
$query = $this->newQuery()->where('id', $this->getKey());
return new TokenAssignableUsers($query, $this);
}
/**
* Get the BPMN definition of the element where the token is.
*
* @return array
*/
public function getDefinition($asObject = false)
{
$process = $this->processRequest->processVersion ?: $this->processRequest->process;
$definitions = $process->getDefinitions();
$element = $definitions->findElementById($this->element_id);
if (!$element) {
return [];
}
return $asObject ? $element->getBpmnElementInstance() : $element->getBpmnElementInstance()->getProperties();
}
/**
* Get the BPMN element node where the token is currently located.
*
* @return \ProcessMaker\Nayra\Storage\BpmnElement
*/
public function getBpmnDefinition()
{
$definitions = $this->processRequest->process->getDefinitions();
return $definitions->findElementById($this->element_id);
}
/**
* Get the form assigned to the task.
*
* @return Screen
*/
public function getScreen()
{
$definition = $this->getDefinition();
return empty($definition['screenRef']) ? null : Screen::find($definition['screenRef']);
}
/**
* Get the script assigned to the task.
*
* @return Screen
*/
public function getScript()
{
$definition = $this->getDefinition();
return empty($definition['scriptRef']) ? null : Script::find($definition['scriptRef']);
}
/**
* Get the form assigned to the task.
*
* @return Screen
*/
public function getScreenVersion()
{
return ScreenVersion::find($this->version_id);
}
/**
* Returns the state of the advance of the request token (open, completed, overdue)
*
* @return string
*/
public function getAdvanceStatusAttribute()
{
$result = 'open';
$isOverdue = Carbon::now()->gte(Carbon::parse($this->due_at));
if ($isOverdue && $this->status === 'ACTIVE') {
$result = 'overdue';
}
if (!$isOverdue && $this->status === 'ACTIVE') {
$result = 'open';
}
if ($this->status === 'CLOSED') {
$result = 'completed';
}
if ($this->status === 'TRIGGERED') {
$result = 'triggered';
}
return $result;
}
/**
* Check if the user has access to reassign this task
*
* @param \ProcessMaker\Models\User $user
*/
public function authorizeReassignment(User $user)
{
if ($user->can('update', $this)) {
$definitions = $this->getDefinition();
if (empty($definitions['allowReassignment'])) {
throw new AuthorizationException("Not authorized to reassign this task");
}
return true;
} else {
throw new AuthorizationException("Not authorized to view this task");
}
}
/**
* Scheduled task for this token
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function scheduledTasks()
{
return $this->hasMany(ScheduledTask::class, 'process_request_token_id');
}
/**
* Get the sub-process request associated to the token.
*
*/
public function subProcessRequest()
{
return $this->belongsTo(ProcessRequest::class, 'subprocess_request_id');
}
/**
* PMQL field alias (started = created_at)
*
* @return string
*/
public function fieldAliasStarted()
{
return 'created_at';
}
/**
* PMQL field alias (created = created_at)
*
* @return string
*/
public function fieldAliasCreated()
{
return 'created_at';
}
/**
* PMQL field alias (modified = updated_at)
*
* @return string
*/
public function fieldAliasModified()
{
return 'updated_at';
}
/**
* PMQL field alias (due = due_at)
*
* @return string
*/
public function fieldAliasDue()
{
return 'due_at';
}
/**
* PMQL field alias (completed = completed_at)
*
* @return string
*/
public function fieldAliasCompleted()
{
return 'completed_at';
}
/**
* PMQL value alias for status field
*
* @param string $value
*
* @return callback
*/
public function valueAliasStatus($value)
{
$statusMap = [
'in progress' => 'ACTIVE',
'completed' => 'CLOSED',
];
$value = mb_strtolower($value);
return function($query) use ($value, $statusMap) {
if ($value === 'self service') {
$query->where('status', 'ACTIVE')
->where('is_self_service', 1);
} elseif (array_key_exists($value, $statusMap)) {
$query->where('status', $statusMap[$value])
->where('is_self_service', 0);
} else {
$query->where('status', $value)
->where('is_self_service', 0);
}
};
}
/**
* PMQL value alias for request field
*
* @param string $value
* @param ProcessMaker\Query\Expression $expression
*
* @return callback
*/
public function valueAliasRequest($value, $expression)
{
return function($query) use($expression, $value) {
$processRequests = ProcessRequest::where('name', $value)->get();
$query->whereIn('process_request_tokens.process_request_id', $processRequests->pluck('id'));
};
}
/**
* PMQL value alias for task field
*
* @param string $value
* @param ProcessMaker\Query\Expression $expression
*
* @return callback
*/
public function valueAliasTask($value, $expression)
{
return function($query) use($expression, $value) {
$query->where('process_request_tokens.element_name', $value);
};
}
/**
* PMQL wildcard for process request & data fields
*
* @param string $value
* @param ProcessMaker\Query\Expression $expression
*
* @return mixed
*/
public function fieldWildcard($value, $expression)
{
if (is_object($expression->field->field())) {
return function($query) use ($expression, $value) {
$field = $expression->field->toEloquent();
$operator = $expression->operator;
$requests = ProcessRequest::where($field, $operator, $value)->get();
$query->whereIn('process_request_id', $requests->pluck('id'));
};
} else {
if (stripos($expression->field->field(), 'data.') === 0) {
$field = $expression->field->field();
$operator = $expression->operator;
if (is_string($value)) {
$value = '"' . $value . '"';
}
$pmql = "$field $operator $value";
return function($query) use ($pmql) {
$requests = ProcessRequest::pmql($pmql)->get();
$query->whereIn('process_request_id', $requests->pluck('id'));
};
}
}
}
/**
* Save version of the executable artifact (screen, script)
*
*/
public function saveVersion()
{
$screen = $this->getScreen();
$script = $this->getScript();
if ($screen) {
$this->version_id = $screen->getLatestVersion()->getKey();
$this->version_type = ScreenVersion::class;
} elseif ($script) {
$this->version_id = $script->getLatestVersion()->getKey();
$this->version_type = ScriptVersion::class;
}
}
/**
* Get the assignment rule for the token.
*
* @return string
*/
public function getAssignmentRule()
{
$activity = $this->getBpmnDefinition()->getBpmnElementInstance();
$assignmentRules = $activity->getProperty('assignmentRules', null);
$instanceData = $assignmentRules ? $this->getInstance()->getDataStore()->getData() : null;
if ($assignmentRules && $instanceData) {
$list = json_decode($assignmentRules);
$list = ($list === null) ? [] : $list;
foreach ($list as $item) {
$formalExp = new FormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($item->expression);
$eval = $formalExp($instanceData);
if ($eval) {
return $item->type;
}
}
}
return $activity->getProperty('assignment', null);
}
/**
* Get Interstitial properties
*
* @return array
*/
public function getInterstitial()
{
$definition = $this->getDefinition();
$interstitialScreen = new Screen();
$allowInterstitial = false;
if (array_key_exists('allowInterstitial', $definition)) {
$allowInterstitial = !!json_decode($definition['allowInterstitial']);
if (array_key_exists('interstitialScreenRef', $definition) && $definition['interstitialScreenRef']) {
$interstitialScreen = Screen::find($definition['interstitialScreenRef']);
} else {
$interstitialScreen = Screen::where('key', 'interstitial')->first();
}
}
return [
'allow_interstitial' => $allowInterstitial,
'interstitial_screen' => $interstitialScreen
];
}
/**
* Log an error when executing the token
*
* @param \Throwable $error
* @param \ProcessMaker\Nayra\Contracts\Bpmn\FlowElementInterface $bpmnElement
*/
public function logError(Throwable $error, FlowElementInterface $bpmnElement)
{
$this->getInstance()->logError($error, $bpmnElement);
}
}