X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/e15fcf5b50e1831a90a04ded09f24e0c7b31d02e..refs/pull/2487/head:/app/Auth/UserRepo.php diff --git a/app/Auth/UserRepo.php b/app/Auth/UserRepo.php index cfa7bfce1..29a0ebc14 100644 --- a/app/Auth/UserRepo.php +++ b/app/Auth/UserRepo.php @@ -1,31 +1,32 @@ user = $user; - $this->role = $role; + $this->userAvatar = $userAvatar; } /** @@ -33,36 +34,36 @@ class UserRepo */ public function getByEmail(string $email): ?User { - return $this->user->where('email', '=', $email)->first(); + return User::query()->where('email', '=', $email)->first(); } /** - * @param int $id - * @return User + * Get a user by their ID. */ - public function getById($id) + public function getById(int $id): User { - return $this->user->newQuery()->findOrFail($id); + return User::query()->findOrFail($id); } /** * Get all the users with their permissions. - * @return Builder|static */ - public function getAllUsers() + public function getAllUsers(): Collection { - return $this->user->with('roles', 'avatar')->orderBy('name', 'asc')->get(); + return User::query()->with('roles', 'avatar')->orderBy('name', 'asc')->get(); } /** * Get all the users with their permissions in a paginated format. - * @param int $count - * @param $sortData - * @return Builder|static */ - public function getAllUsersPaginatedAndSorted($count, $sortData) + public function getAllUsersPaginatedAndSorted(int $count, array $sortData): LengthAwarePaginator { - $query = $this->user->with('roles', 'avatar')->orderBy($sortData['sort'], $sortData['order']); + $sort = $sortData['sort']; + + $query = User::query()->select(['*']) + ->withLastActivityAt() + ->with(['roles', 'avatar']) + ->orderBy($sort, $sortData['order']); if ($sortData['search']) { $term = '%' . $sortData['search'] . '%'; @@ -89,14 +90,12 @@ class UserRepo /** * Assign a user to a system-level role. - * @param User $user - * @param $systemRoleName * @throws NotFoundException */ - public function attachSystemRole(User $user, $systemRoleName) + public function attachSystemRole(User $user, string $systemRoleName) { - $role = $this->role->newQuery()->where('system_name', '=', $systemRoleName)->first(); - if ($role === null) { + $role = Role::getSystemRole($systemRoleName); + if (is_null($role)) { throw new NotFoundException("Role '{$systemRoleName}' not found"); } $user->attachRole($role); @@ -104,26 +103,23 @@ class UserRepo /** * Checks if the give user is the only admin. - * @param User $user - * @return bool */ - public function isOnlyAdmin(User $user) + public function isOnlyAdmin(User $user): bool { if (!$user->hasSystemRole('admin')) { return false; } - $adminRole = $this->role->getSystemRole('admin'); - if ($adminRole->users->count() > 1) { + $adminRole = Role::getSystemRole('admin'); + if ($adminRole->users()->count() > 1) { return false; } + return true; } /** * Set the assigned user roles via an array of role IDs. - * @param User $user - * @param array $roles * @throws UserUpdateException */ public function setUserRoles(User $user, array $roles) @@ -138,14 +134,11 @@ class UserRepo /** * Check if the given user is the last admin and their new roles no longer * contains the admin role. - * @param User $user - * @param array $newRoles - * @return bool */ protected function demotingLastAdmin(User $user, array $newRoles) : bool { if ($this->isOnlyAdmin($user)) { - $adminRole = $this->role->getSystemRole('admin'); + $adminRole = Role::getSystemRole('admin'); if (!in_array(strval($adminRole->id), $newRoles)) { return true; } @@ -159,41 +152,59 @@ class UserRepo */ public function create(array $data, bool $emailConfirmed = false): User { - return $this->user->forceCreate([ + $details = [ 'name' => $data['name'], 'email' => $data['email'], 'password' => bcrypt($data['password']), 'email_confirmed' => $emailConfirmed, 'external_auth_id' => $data['external_auth_id'] ?? '', - ]); + ]; + return User::query()->forceCreate($details); } /** * Remove the given user from storage, Delete all related content. - * @param User $user * @throws Exception */ - public function destroy(User $user) + public function destroy(User $user, ?int $newOwnerId = null) { $user->socialAccounts()->delete(); $user->apiTokens()->delete(); $user->delete(); // Delete user profile images - $profileImages = Image::where('type', '=', 'user')->where('uploaded_to', '=', $user->id)->get(); + $profileImages = Image::query()->where('type', '=', 'user') + ->where('uploaded_to', '=', $user->id) + ->get(); + foreach ($profileImages as $image) { Images::destroy($image); } + + if (!empty($newOwnerId)) { + $newOwner = User::query()->find($newOwnerId); + if (!is_null($newOwner)) { + $this->migrateOwnership($user, $newOwner); + } + } + } + + /** + * Migrate ownership of items in the system from one user to another. + */ + protected function migrateOwnership(User $fromUser, User $toUser) + { + $entities = (new EntityProvider)->all(); + foreach ($entities as $instance) { + $instance->newQuery()->where('owned_by', '=', $fromUser->id) + ->update(['owned_by' => $toUser->id]); + } } /** * Get the latest activity for a user. - * @param User $user - * @param int $count - * @param int $page - * @return array */ - public function getActivity(User $user, $count = 20, $page = 0) + public function getActivity(User $user, int $count = 20, int $page = 0): array { return Activity::userActivity($user, $count, $page); } @@ -234,33 +245,22 @@ class UserRepo /** * Get the roles in the system that are assignable to a user. - * @return mixed */ - public function getAllRoles() + public function getAllRoles(): Collection { - return $this->role->newQuery()->orderBy('name', 'asc')->get(); + return Role::query()->orderBy('display_name', 'asc')->get(); } /** * Get an avatar image for a user and set it as their avatar. * Returns early if avatars disabled or not set in config. - * @param User $user - * @return bool */ - public function downloadAndAssignUserAvatar(User $user) + public function downloadAndAssignUserAvatar(User $user): void { - if (!Images::avatarFetchEnabled()) { - return false; - } - try { - $avatar = Images::saveUserAvatar($user); - $user->avatar()->associate($avatar); - $user->save(); - return true; + $this->userAvatar->fetchAndAssignToUser($user); } catch (Exception $e) { Log::error('Failed to save user avatar image'); - return false; } } }