X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/c7a2d568bf693add30c8402d68d1f46f09a44c5b..refs/pull/2734/head:/app/Auth/User.php diff --git a/app/Auth/User.php b/app/Auth/User.php index 32179a1fb..9855ab4e7 100644 --- a/app/Auth/User.php +++ b/app/Auth/User.php @@ -1,25 +1,30 @@ 'datetime']; + /** * The attributes excluded from the model's JSON form. * @var array @@ -56,7 +64,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon /** * This holds the user's permissions when loaded. - * @var array + * @var ?Collection */ protected $permissions; @@ -68,23 +76,21 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon /** * Returns the default public user. - * @return User */ - public static function getDefault() + public static function getDefault(): User { if (!is_null(static::$defaultUser)) { return static::$defaultUser; } - static::$defaultUser = static::where('system_name', '=', 'public')->first(); + static::$defaultUser = static::query()->where('system_name', '=', 'public')->first(); return static::$defaultUser; } /** * Check if the user is the default public user. - * @return bool */ - public function isDefault() + public function isDefault(): bool { return $this->system_name === 'public'; } @@ -111,12 +117,10 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon /** * Check if the user has a role. - * @param $role - * @return mixed */ - public function hasSystemRole($role) + public function hasSystemRole(string $roleSystemName): bool { - return $this->roles->pluck('system_name')->contains($role); + return $this->roles->pluck('system_name')->contains($roleSystemName); } /** @@ -130,35 +134,44 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon } } + /** + * Check if the user has a particular permission. + */ + public function can(string $permissionName): bool + { + if ($this->email === 'guest') { + return false; + } + + return $this->permissions()->contains($permissionName); + } + /** * Get all permissions belonging to a the current user. - * @param bool $cache - * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough */ - public function permissions($cache = true) + protected function permissions(): Collection { - if (isset($this->permissions) && $cache) { + if (isset($this->permissions)) { return $this->permissions; } - $this->load('roles.permissions'); - $permissions = $this->roles->map(function ($role) { - return $role->permissions; - })->flatten()->unique(); - $this->permissions = $permissions; - return $permissions; + + $this->permissions = $this->newQuery()->getConnection()->table('role_user', 'ru') + ->select('role_permissions.name as name')->distinct() + ->leftJoin('permission_role', 'ru.role_id', '=', 'permission_role.role_id') + ->leftJoin('role_permissions', 'permission_role.permission_id', '=', 'role_permissions.id') + ->where('ru.user_id', '=', $this->id) + ->get() + ->pluck('name'); + + return $this->permissions; } /** - * Check if the user has a particular permission. - * @param $permissionName - * @return bool + * Clear any cached permissions on this instance. */ - public function can($permissionName) + public function clearPermissionCache() { - if ($this->email === 'guest') { - return false; - } - return $this->permissions()->pluck('name')->contains($permissionName); + $this->permissions = null; } /** @@ -171,9 +184,8 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon /** * Get the social account associated with this user. - * @return \Illuminate\Database\Eloquent\Relations\HasMany */ - public function socialAccounts() + public function socialAccounts(): HasMany { return $this->hasMany(SocialAccount::class); } @@ -194,11 +206,9 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon } /** - * Returns the user's avatar, - * @param int $size - * @return string + * Returns a URL to the user's avatar */ - public function getAvatar($size = 50) + public function getAvatar(int $size = 50): string { $default = url('/http/source.bookstackapp.com/user_avatar.png'); $imageId = $this->image_id; @@ -208,7 +218,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon try { $avatar = $this->avatar ? url($this->avatar->getThumb($size, $size, false)) : $default; - } catch (\Exception $err) { + } catch (Exception $err) { $avatar = $default; } return $avatar; @@ -216,9 +226,8 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon /** * Get the avatar for the user. - * @return \Illuminate\Database\Eloquent\Relations\BelongsTo */ - public function avatar() + public function avatar(): BelongsTo { return $this->belongsTo(Image::class, 'image_id'); } @@ -232,11 +241,16 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon } /** - * Get the latest activity instance for this user. + * Get the last activity time for this user. */ - public function latestActivity(): HasOne + public function scopeWithLastActivityAt(Builder $query) { - return $this->hasOne(Activity::class)->latest(); + $query->addSelect(['activities.created_at as last_activity_at']) + ->leftJoinSub(function (\Illuminate\Database\Query\Builder $query) { + $query->from('activities')->select('user_id') + ->selectRaw('max(created_at) as created_at') + ->groupBy('user_id'); + }, 'activities', 'users.id', '=', 'activities.user_id'); } /** @@ -253,15 +267,13 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon */ public function getProfileUrl(): string { - return url('/http/source.bookstackapp.com/user/' . $this->id); + return url('/http/source.bookstackapp.com/user/' . $this->slug); } /** * Get a shortened version of the user's name. - * @param int $chars - * @return string */ - public function getShortName($chars = 8) + public function getShortName(int $chars = 8): string { if (mb_strlen($this->name) <= $chars) { return $this->name; @@ -292,4 +304,13 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon { return "({$this->id}) {$this->name}"; } + + /** + * @inheritDoc + */ + public function refreshSlug(): string + { + $this->slug = app(SlugGenerator::class)->generate($this); + return $this->slug; + } }