Repository navigation
Expand file tree
/
Copy pathUser.php
More file actions
606 lines (534 loc) · 18.3 KB
/
Copy pathUser.php
File metadata and controls
606 lines (534 loc) · 18.3 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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
<?php
namespace ProcessMaker\Models;
use Exception;
use Illuminate\Container\Container;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Support\Facades\Cache;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Password;
use Laravel\Passport\HasApiTokens;
use ProcessMaker\Models\EmptyModel;
use ProcessMaker\Notifications\ResetPassword as ResetPasswordNotification;
use ProcessMaker\Query\Traits\PMQL;
use ProcessMaker\Rules\StringHasAtLeastOneUpperCaseCharacter;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\HasAuthorization;
use ProcessMaker\Traits\HideSystemResources;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;
class User extends Authenticatable implements HasMedia
{
use PMQL;
use HasApiTokens;
use Notifiable;
use InteractsWithMedia;
use HasAuthorization;
use SerializeToIso8601;
use SoftDeletes;
use HideSystemResources;
use HasFactory;
use Exportable;
protected $connection = 'processmaker';
// Disk
public const DISK_PROFILE = 'profile';
// collection media library
public const COLLECTION_PROFILE = 'profile';
// Session key to save request ids that the user started
public const REQUESTS_SESSION_KEY = 'web-entry-request-ids';
/**
* The attributes that are mass assignable.
*
* @var array
*
* @OA\Schema(
* schema="usersEditable",
* @OA\Property(property="email", type="string", format="email"),
* @OA\Property(property="firstname", type="string"),
* @OA\Property(property="lastname", type="string"),
* @OA\Property(property="username", type="string"),
* @OA\Property(property="password", type="string"),
* @OA\Property(property="address", type="string"),
* @OA\Property(property="city", type="string"),
* @OA\Property(property="state", type="string"),
* @OA\Property(property="postal", type="string"),
* @OA\Property(property="country", type="string"),
* @OA\Property(property="phone", type="string"),
* @OA\Property(property="fax", type="string"),
* @OA\Property(property="cell", type="string"),
* @OA\Property(property="title", type="string"),
* @OA\Property(property="timezone", type="string"),
* @OA\Property(property="datetime_format", type="string"),
* @OA\Property(property="language", type="string"),
* @OA\Property(property="is_administrator", type="boolean"),
* @OA\Property(property="expires_at", type="string"),
* @OA\Property(property="loggedin_at", type="string"),
* @OA\Property(property="remember_token", type="string"),
* @OA\Property(property="status",type="string",enum={"ACTIVE","INACTIVE","SCHEDULED","OUT_OF_OFFICE","BLOCKED"}),
* @OA\Property(property="fullname", type="string"),
* @OA\Property(property="avatar", type="string"),
* @OA\Property(property="media", type="array", @OA\Items(ref="#/components/schemas/media")),
* @OA\Property(property="birthdate", type="string", format="date"),
* @OA\Property(property="delegation_user_id", type="string", format="id"),
* @OA\Property(property="manager_id", type="string", format="id"),
* @OA\Property(property="meta", type="object", additionalProperties=true),
* @OA\Property(property="force_change_password", type="boolean"),
* @OA\Property(property="email_task_notification", type="boolean"),
* ),
* @OA\Schema(
* schema="users",
* allOf={
* @OA\Schema(ref="#/components/schemas/usersEditable"),
* @OA\Schema(
* type="object",
* @OA\Property(property="id", type="integer"),
* @OA\Property(property="created_at", type="string", format="date-time"),
* @OA\Property(property="updated_at", type="string", format="date-time"),
* @OA\Property(property="deleted_at", type="string", format="date-time"),
* )
* },
* )
*/
protected $fillable = [
'username',
'email',
'password',
'firstname',
'lastname',
'status',
'address',
'city',
'state',
'postal',
'country',
'phone',
'fax',
'cell',
'title',
'birthdate',
'timezone',
'datetime_format',
'language',
'meta',
'delegation_user_id',
'manager_id',
'schedule',
'force_change_password',
'password_changed_at',
'connected_accounts',
'preferences_2fa',
'email_task_notification',
];
protected $appends = [
'fullname',
];
protected $casts = [
'is_administrator' => 'bool',
'meta' => 'object',
'active_at' => 'datetime',
'loggedin_at' => 'datetime',
'schedule' => 'array',
'preferences_2fa' => 'array',
];
/**
* Register any model events
*
* @return void
*/
public static function boot()
{
parent::boot();
static::deleting(function ($user) {
$user->status = 'INACTIVE';
$user->save();
});
static::restoring(function ($user) {
$user->status = 'ACTIVE';
$user->save();
});
static::deleted(function ($user) {
$user->status = 'INACTIVE';
$user->removeFromGroups();
});
}
/**
* Validation rules
*
* @param User|null $existing
*
* @return array
*/
public static function rules(self $existing = null)
{
$unique = Rule::unique('users')->ignore($existing);
return [
// The following characters where not included in the regexp: & % ' " ? /
'username' /****/ => ['required', 'regex:/^[a-zA-Z0-9.!#$*+=^_`|~\-@]+$/', 'min:2', 'max:255', $unique],
'firstname' /***/ => ['required', 'max:50'],
'lastname' /****/ => ['required', 'max:50'],
'email' /*******/ => ['required', 'email'],
'birthdate' /***/ => ['nullable', 'date'],
'phone' /*******/ => ['nullable', 'regex:/^[+\.0-9x\)\(\-\s\/]*$/'],
'fax' /*********/ => ['nullable', 'regex:/^[+\.0-9x\)\(\-\s\/]*$/'],
'cell' /********/ => ['nullable', 'regex:/^[+\.0-9x\)\(\-\s\/]*$/'],
'status' /******/ => ['required', 'in:ACTIVE,INACTIVE,OUT_OF_OFFICE,SCHEDULED,BLOCKED'],
'password' /****/ => static::passwordRules($existing),
];
}
/**
* Validation rules specifically for the password
*
* @param User|null $existing
*
* @return array
*/
public static function passwordRules(self $existing = null)
{
// Mandatory policies
$passwordPolicies = [
'required',
$existing ? 'sometimes' : '',
];
// Configurable policies
$passwordRules = Password::min((int) config('password-policies.minimum_length', 8));
if (config('password-policies.maximum_length', false)) {
$passwordPolicies[] = 'max:' . config('password-policies.maximum_length');
}
if (config('password-policies.numbers', true)) {
$passwordRules->numbers();
}
if (config('password-policies.uppercase', true)) {
$passwordPolicies[] = new StringHasAtLeastOneUpperCaseCharacter();
}
if (config('password-policies.special', true)) {
$passwordRules->symbols();
}
$passwordPolicies[] = $passwordRules;
return $passwordPolicies;
}
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = [
'password',
'groupMembersFromMemberable',
'permissions',
];
/**
* Scope to only return active users.
*
* @var Builder
*/
public function scopeActive($query)
{
return $query->where('status', 'ACTIVE');
}
/**
* Return the full name for this user which is the first name and last
* name separated with a space.
*
* @return string
*/
public function getFullName()
{
return implode(' ', [
$this->firstname,
$this->lastname,
]);
}
public function hasPermissionsFor(...$resources)
{
if ($this->is_administrator) {
$perms = Permission::all(['name'])->pluck('name');
} else {
$perms = collect(session('permissions'));
}
$filtered = $perms->filter(function ($value) use ($resources) {
foreach ($resources as $resource) {
$match = preg_match("/(.+)-{$resource}/", $value);
if ($match === 1) {
return true;
}
}
});
if ($this->is_administrator) {
$filtered->push('admin');
}
return $filtered->values();
}
public function groupMembersFromMemberable()
{
return $this->morphMany(GroupMember::class, 'member', null, 'member_id');
}
public function groups()
{
return $this->morphToMany('ProcessMaker\Models\Group', 'member', 'group_members');
}
public function projectMembers()
{
if (class_exists('ProcessMaker\Package\Projects\Models\ProjectMember')) {
return $this->hasMany('ProcessMaker\Package\Projects\Models\ProjectMember', 'member_id', 'id')->where('member_type', self::class);
} else {
// Handle the case where the ProjectMember class doesn't exist.
return $this->hasMany(EmptyModel::class);
}
}
public function permissions()
{
return $this->morphToMany('ProcessMaker\Models\Permission', 'assignable');
}
public function processesFromProcessable()
{
return $this->morphToMany('ProcessMaker\Models\Process', 'processable');
}
/**
* Get the full name as an attribute.
*
* @return string
*/
public function getFullnameAttribute()
{
return $this->getFullName();
}
/**
* Get url Avatar
*
* @return string
*/
public function getAvatar()
{
$media = $this->getMedia(self::COLLECTION_PROFILE);
$lastUpload = $media->last();
$url = $lastUpload ? $lastUpload->getFullUrl() : '';
return $url;
}
/**
* Set the user's timezone.
*/
public function setTimezoneAttribute(string $value = ''): void
{
$this->attributes['timezone'] = $value ?: $this->getDefaultTimezone();
}
/**
* Get default timezone for new users.
*/
public function getDefaultTimezone(): string
{
$setting = Setting::byKey('users.timezone');
if ($setting === null) {
return config('app.timezone');
}
$config = (object) $setting->config;
return $config->timezone;
}
/**
* Returns the list of notifications not read by the user
*
* @return \Illuminate\Support\Collection
*/
public function activeNotifications()
{
$notifications = Notification::query()
->where('notifiable_type', self::class)
->where('notifiable_id', $this->id)
->whereNull('read_at')
->get();
$data = [];
foreach ($notifications as $notification) {
$notificationData = json_decode($notification->data, false);
$notificationData->id = $notification->id;
$data[] = $notificationData;
}
return collect($data);
}
/**
* User as assigned.
*
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function assigned()
{
return $this->morphMany(ProcessTaskAssignment::class, 'assigned', 'assignment_type', 'assignment_id');
}
/**
* Check if the user can do any of the listed permissions.
*/
public function canAny($permissions, $arguments = []): bool
{
return parent::canAny(explode('|', $permissions), $arguments);
}
/**
* Check if the user can do any of the listed permissions.
* If so, return the permission name, otherwise false
*/
public function canAnyFirst($permissions): bool|string
{
foreach (explode('|', $permissions) as $permission) {
if ($this->can($permission)) {
return $permission;
}
}
return false;
}
/**
* Find the user instance for the given username.
* This ensures we are utilizing our username field for grants for oauth.
*
* @param string $username
* @return \App\User
*/
public function findForPassport($username)
{
return $this->where('username', $username)->first();
}
/**
* Check if the user can self-serve themselves a task
*
* @param ProcessRequestToken $task
* @return bool
*/
public function canSelfServe(ProcessRequestToken $task)
{
if (!$task->is_self_service) {
return false;
}
if (array_key_exists('users', $task->self_service_groups) && in_array(\Auth::user()->id, $task->self_service_groups['users'])) {
return true;
} elseif (array_key_exists('groups', $task->self_service_groups)) {
return collect($task->self_service_groups['groups'])
->intersect(
$this->groups()->pluck('groups.id')
)->count() > 0;
} else {
// For older processes
return collect($task->self_service_groups)
->intersect(
$this->groups()->pluck('groups.id')
)->count() > 0;
}
}
public function removeFromGroups()
{
$this->groups()->detach();
}
public function availableSelfServiceTasksQuery()
{
$groupIds = $this->groups()->pluck('groups.id');
$taskQuery = ProcessRequestToken::select(['process_request_tokens.id'])
->where([
'is_self_service' => true,
'status' => 'ACTIVE',
'user_id' => null,
]);
$taskQuery->where(function ($query) use ($groupIds) {
// Check if `self_service_groups` contains any of the user's groups
foreach ($groupIds as $groupId) {
$query->orWhereJsonContains('self_service_groups->groups', (int) $groupId);
// keep compatibility
$query->orWhereJsonContains('self_service_groups->groups', (string) $groupId);
$query->orWhereJsonContains('self_service_groups', (int) $groupId);
$query->orWhereJsonContains('self_service_groups', (string) $groupId);
}
$query->orWhereJsonContains('self_service_groups->users', (int) $this->id);
$query->orWhereJsonContains('self_service_groups->users', (string) $this->id);
});
return $taskQuery;
}
public function availableSelfServiceTaskIds()
{
return $this->availableSelfServiceTasksQuery()->pluck('id');
}
/**
* User's Delegation are user associations that allow for automatic reassignment based on specific availability of a user.
*
* @return User
*/
public function delegationUser()
{
return $this->belongsTo(self::class);
}
/**
* User's Manager are user associations that allow for automatic reassignment based on specific rules in the task assignment.
*
* @return User
*/
public function manager()
{
return $this->belongsTo(self::class);
}
/**
* Send the password reset notification.
*
* @param string $token
* @return void
*/
public function sendPasswordResetNotification($token)
{
$this->notify(new ResetPasswordNotification($token));
}
public static function whereFullname($value)
{
return self::whereRaw("CONCAT(firstname, ' ', lastname) LIKE ?", ["%$value%"]);
}
public function removeOldRunScriptTokens()
{
// Remove old tokens more that one week old
return $this->tokens()
->where('name', 'script-runner')
->where('created_at', '<', now()->subWeek())
->delete();
}
public function sessions(): HasMany
{
return $this->hasMany(UserSession::class);
}
public function getValid2FAPreferences(): array
{
// Get global and user values
$global2FAEnabled = config('password-policies.2fa_method', []);
$user2FAEnabled = !is_null($this->preferences_2fa) ? $this->preferences_2fa : [];
// Get valid values
$aux = array_intersect($global2FAEnabled, $user2FAEnabled);
return !empty($aux) ? array_values($aux) : $global2FAEnabled;
}
public function in2FAGroupOrIndependent()
{
$userGroups = $this->groups;
$groupCount = $userGroups->count();
if ($groupCount === 0) {
return true;
}
$groupsWith2fa = $userGroups->where('enabled_2fa', true);
// Check if the only group has 2fa enabled, if so, ask for 2fa
$hasSingleGroupWith2fa = $groupCount === 1 && $groupsWith2fa->count() === 1;
// Check if at least one group has 2fa enabled, if so, ask for 2fa
$hasMultipleGroupsWithAtLeastOne2fa = $groupCount > 1 && $groupsWith2fa->count() > 0;
// Check if all groups don't have 2fa enabled, if so, ask for 2fa if the 2fa setting is enabled
$independent = $groupCount === 0;
if ($hasSingleGroupWith2fa || $hasMultipleGroupsWithAtLeastOne2fa || $independent) {
return true;
}
return false;
}
public function refresh()
{
parent::refresh();
// Clear permissions and user_permissions
Cache::forget('permissions');
app(\ProcessMaker\Services\PermissionCacheService::class)->forgetLegacyUserPermissions($this->id);
// return the refreshed user instance
return $this;
}
public function activeTasks()
{
return $this->hasMany(ProcessRequestToken::class, 'user_id')
->where('status', 'ACTIVE')
->where('element_type', 'task');
}
}