X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/a274406038e13cf678e14d65dfa70d04ead67206..refs/pull/3365/head:/app/Auth/UserRepo.php diff --git a/app/Auth/UserRepo.php b/app/Auth/UserRepo.php index e1a040fc2..28ce96c49 100644 --- a/app/Auth/UserRepo.php +++ b/app/Auth/UserRepo.php @@ -2,31 +2,29 @@ namespace BookStack\Auth; -use Activity; +use BookStack\Actions\ActivityType; +use BookStack\Auth\Access\UserInviteService; use BookStack\Entities\EntityProvider; -use BookStack\Entities\Models\Book; -use BookStack\Entities\Models\Bookshelf; -use BookStack\Entities\Models\Chapter; -use BookStack\Entities\Models\Page; -use BookStack\Exceptions\NotFoundException; +use BookStack\Exceptions\NotifyException; use BookStack\Exceptions\UserUpdateException; +use BookStack\Facades\Activity; use BookStack\Uploads\UserAvatars; use Exception; -use Illuminate\Database\Eloquent\Builder; -use Illuminate\Database\Eloquent\Collection; -use Illuminate\Pagination\LengthAwarePaginator; -use Log; +use Illuminate\Support\Facades\Log; +use Illuminate\Support\Str; class UserRepo { - protected $userAvatar; + protected UserAvatars $userAvatar; + protected UserInviteService $inviteService; /** * UserRepo constructor. */ - public function __construct(UserAvatars $userAvatar) + public function __construct(UserAvatars $userAvatar, UserInviteService $inviteService) { $this->userAvatar = $userAvatar; + $this->inviteService = $inviteService; } /** @@ -54,127 +52,89 @@ class UserRepo } /** - * Get all the users with their permissions. + * Create a new basic instance of user with the given pre-validated data. + * + * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data */ - public function getAllUsers(): Collection + public function createWithoutActivity(array $data, bool $emailConfirmed = false): User { - return User::query()->with('roles', 'avatar')->orderBy('name', 'asc')->get(); - } + $user = new User(); + $user->name = $data['name']; + $user->email = $data['email']; + $user->password = bcrypt(empty($data['password']) ? Str::random(32) : $data['password']); + $user->email_confirmed = $emailConfirmed; + $user->external_auth_id = $data['external_auth_id'] ?? ''; - /** - * Get all the users with their permissions in a paginated format. - */ - public function getAllUsersPaginatedAndSorted(int $count, array $sortData): LengthAwarePaginator - { - $sort = $sortData['sort']; - - $query = User::query()->select(['*']) - ->withLastActivityAt() - ->with(['roles', 'avatar']) - ->withCount('mfaValues') - ->orderBy($sort, $sortData['order']); - - if ($sortData['search']) { - $term = '%' . $sortData['search'] . '%'; - $query->where(function ($query) use ($term) { - $query->where('name', 'like', $term) - ->orWhere('email', 'like', $term); - }); + $user->refreshSlug(); + $user->save(); + + if (!empty($data['language'])) { + setting()->putUser($user, 'language', $data['language']); } - return $query->paginate($count); - } + if (isset($data['roles'])) { + $this->setUserRoles($user, $data['roles']); + } - /** - * Creates a new user and attaches a role to them. - */ - public function registerNew(array $data, bool $emailConfirmed = false): User - { - $user = $this->create($data, $emailConfirmed); - $user->attachDefaultRole(); $this->downloadAndAssignUserAvatar($user); return $user; } /** - * Assign a user to a system-level role. + * As per "createWithoutActivity" but records a "create" activity. * - * @throws NotFoundException + * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data */ - public function attachSystemRole(User $user, string $systemRoleName) + public function create(array $data, bool $sendInvite = false): User { - $role = Role::getSystemRole($systemRoleName); - if (is_null($role)) { - throw new NotFoundException("Role '{$systemRoleName}' not found"); - } - $user->attachRole($role); - } + $user = $this->createWithoutActivity($data, true); - /** - * Checks if the give user is the only admin. - */ - public function isOnlyAdmin(User $user): bool - { - if (!$user->hasSystemRole('admin')) { - return false; + if ($sendInvite) { + $this->inviteService->sendInvitation($user); } - $adminRole = Role::getSystemRole('admin'); - if ($adminRole->users()->count() > 1) { - return false; - } + Activity::add(ActivityType::USER_CREATE, $user); - return true; + return $user; } /** - * Set the assigned user roles via an array of role IDs. + * Update the given user with the given data. + * + * @param array{name: ?string, email: ?string, external_auth_id: ?string, password: ?string, roles: ?array, language: ?string} $data * * @throws UserUpdateException */ - public function setUserRoles(User $user, array $roles) + public function update(User $user, array $data, bool $manageUsersAllowed): User { - if ($this->demotingLastAdmin($user, $roles)) { - throw new UserUpdateException(trans('errors.role_cannot_remove_only_admin'), $user->getEditUrl()); + if (!empty($data['name'])) { + $user->name = $data['name']; + $user->refreshSlug(); } - $user->roles()->sync($roles); - } + if (!empty($data['email']) && $manageUsersAllowed) { + $user->email = $data['email']; + } - /** - * Check if the given user is the last admin and their new roles no longer - * contains the admin role. - */ - protected function demotingLastAdmin(User $user, array $newRoles): bool - { - if ($this->isOnlyAdmin($user)) { - $adminRole = Role::getSystemRole('admin'); - if (!in_array(strval($adminRole->id), $newRoles)) { - return true; - } + if (!empty($data['external_auth_id']) && $manageUsersAllowed) { + $user->external_auth_id = $data['external_auth_id']; } - return false; - } + if (isset($data['roles']) && $manageUsersAllowed) { + $this->setUserRoles($user, $data['roles']); + } - /** - * Create a new basic instance of user. - */ - public function create(array $data, bool $emailConfirmed = false): User - { - $details = [ - 'name' => $data['name'], - 'email' => $data['email'], - 'password' => bcrypt($data['password']), - 'email_confirmed' => $emailConfirmed, - 'external_auth_id' => $data['external_auth_id'] ?? '', - ]; + if (!empty($data['password'])) { + $user->password = bcrypt($data['password']); + } + + if (!empty($data['language'])) { + setting()->putUser($user, 'language', $data['language']); + } - $user = new User(); - $user->forceFill($details); - $user->refreshSlug(); $user->save(); + Activity::add(ActivityType::USER_UPDATE, $user); return $user; } @@ -186,6 +146,8 @@ class UserRepo */ public function destroy(User $user, ?int $newOwnerId = null) { + $this->ensureDeletable($user); + $user->socialAccounts()->delete(); $user->apiTokens()->delete(); $user->favourites()->delete(); @@ -201,6 +163,22 @@ class UserRepo $this->migrateOwnership($user, $newOwner); } } + + Activity::add(ActivityType::USER_DELETE, $user); + } + + /** + * @throws NotifyException + */ + protected function ensureDeletable(User $user): void + { + if ($this->isOnlyAdmin($user)) { + throw new NotifyException(trans('errors.users_cannot_delete_only_admin'), $user->getEditUrl()); + } + + if ($user->system_name === 'public') { + throw new NotifyException(trans('errors.users_cannot_delete_guest'), $user->getEditUrl()); + } } /** @@ -216,66 +194,62 @@ class UserRepo } /** - * Get the latest activity for a user. + * Get an avatar image for a user and set it as their avatar. + * Returns early if avatars disabled or not set in config. */ - public function getActivity(User $user, int $count = 20, int $page = 0): array + protected function downloadAndAssignUserAvatar(User $user): void { - return Activity::userActivity($user, $count, $page); + try { + $this->userAvatar->fetchAndAssignToUser($user); + } catch (Exception $e) { + Log::error('Failed to save user avatar image'); + } } /** - * Get the recently created content for this given user. + * Checks if the give user is the only admin. */ - public function getRecentlyCreated(User $user, int $count = 20): array + protected function isOnlyAdmin(User $user): bool { - $query = function (Builder $query) use ($user, $count) { - return $query->orderBy('created_at', 'desc') - ->where('created_by', '=', $user->id) - ->take($count) - ->get(); - }; - - return [ - 'pages' => $query(Page::visible()->where('draft', '=', false)), - 'chapters' => $query(Chapter::visible()), - 'books' => $query(Book::visible()), - 'shelves' => $query(Bookshelf::visible()), - ]; - } + if (!$user->hasSystemRole('admin')) { + return false; + } - /** - * Get asset created counts for the give user. - */ - public function getAssetCounts(User $user): array - { - $createdBy = ['created_by' => $user->id]; - - return [ - 'pages' => Page::visible()->where($createdBy)->count(), - 'chapters' => Chapter::visible()->where($createdBy)->count(), - 'books' => Book::visible()->where($createdBy)->count(), - 'shelves' => Bookshelf::visible()->where($createdBy)->count(), - ]; + $adminRole = Role::getSystemRole('admin'); + if ($adminRole->users()->count() > 1) { + return false; + } + + return true; } /** - * Get the roles in the system that are assignable to a user. + * Set the assigned user roles via an array of role IDs. + * + * @throws UserUpdateException */ - public function getAllRoles(): Collection + protected function setUserRoles(User $user, array $roles) { - return Role::query()->orderBy('display_name', 'asc')->get(); + if ($this->demotingLastAdmin($user, $roles)) { + throw new UserUpdateException(trans('errors.role_cannot_remove_only_admin'), $user->getEditUrl()); + } + + $user->roles()->sync($roles); } /** - * Get an avatar image for a user and set it as their avatar. - * Returns early if avatars disabled or not set in config. + * Check if the given user is the last admin and their new roles no longer + * contains the admin role. */ - public function downloadAndAssignUserAvatar(User $user): void + protected function demotingLastAdmin(User $user, array $newRoles): bool { - try { - $this->userAvatar->fetchAndAssignToUser($user); - } catch (Exception $e) { - Log::error('Failed to save user avatar image'); + if ($this->isOnlyAdmin($user)) { + $adminRole = Role::getSystemRole('admin'); + if (!in_array(strval($adminRole->id), $newRoles)) { + return true; + } } + + return false; } }