-<?php namespace BookStack\Auth;
+<?php
-use Activity;
-use BookStack\Entities\Repos\EntityRepo;
-use BookStack\Exceptions\NotFoundException;
+namespace BookStack\Auth;
+
+use BookStack\Actions\ActivityType;
+use BookStack\Auth\Access\UserInviteService;
+use BookStack\Entities\EntityProvider;
+use BookStack\Exceptions\NotifyException;
use BookStack\Exceptions\UserUpdateException;
-use BookStack\Uploads\Image;
+use BookStack\Facades\Activity;
+use BookStack\Uploads\UserAvatars;
use Exception;
-use Illuminate\Database\Eloquent\Builder;
-use Images;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Str;
class UserRepo
{
-
- protected $user;
- protected $role;
- protected $entityRepo;
+ protected UserAvatars $userAvatar;
+ protected UserInviteService $inviteService;
/**
* UserRepo constructor.
- * @param User $user
- * @param Role $role
- * @param EntityRepo $entityRepo
*/
- public function __construct(User $user, Role $role, EntityRepo $entityRepo)
+ public function __construct(UserAvatars $userAvatar, UserInviteService $inviteService)
{
- $this->user = $user;
- $this->role = $role;
- $this->entityRepo = $entityRepo;
+ $this->userAvatar = $userAvatar;
+ $this->inviteService = $inviteService;
}
/**
- * @param string $email
- * @return User|null
+ * Get a user by their email address.
*/
- public function getByEmail($email)
+ 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
+ * Get a user by their slug.
*/
- public function getAllUsers()
+ public function getBySlug(string $slug): User
{
- return $this->user->with('roles', 'avatar')->orderBy('name', 'asc')->get();
+ return User::query()->where('slug', '=', $slug)->firstOrFail();
}
/**
- * Get all the users with their permissions in a paginated format.
- * @param int $count
- * @param $sortData
- * @return Builder|static
+ * 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 getAllUsersPaginatedAndSorted($count, $sortData)
+ public function createWithoutActivity(array $data, bool $emailConfirmed = false): User
{
- $query = $this->user->with('roles', 'avatar')->orderBy($sortData['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 = 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'] ?? '';
+
+ $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.
- * @param array $data
- * @param boolean $verifyEmail
- * @return \BookStack\Auth\User
- */
- public function registerNew(array $data, $verifyEmail = false)
- {
- $user = $this->create($data, $verifyEmail);
- $this->attachDefaultRole($user);
$this->downloadAndAssignUserAvatar($user);
return $user;
}
/**
- * Give a user the default role. Used when creating a new user.
- * @param User $user
+ * As per "createWithoutActivity" but records a "create" activity.
+ *
+ * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data
*/
- public function attachDefaultRole(User $user)
+ public function create(array $data, bool $sendInvite = false): User
{
- $roleId = setting('registration-role');
- if ($roleId !== false && $user->roles()->where('id', '=', $roleId)->count() === 0) {
- $user->attachRoleId($roleId);
+ $user = $this->createWithoutActivity($data, true);
+
+ if ($sendInvite) {
+ $this->inviteService->sendInvitation($user);
}
+
+ Activity::add(ActivityType::USER_CREATE, $user);
+
+ return $user;
}
/**
- * Assign a user to a system-level role.
- * @param User $user
- * @param $systemRoleName
- * @throws NotFoundException
+ * Update the given user with the given data.
+ *
+ * @param array{name: ?string, email: ?string, external_auth_id: ?string, password: ?string, roles: ?array<int>, language: ?string} $data
+ *
+ * @throws UserUpdateException
*/
- public function attachSystemRole(User $user, $systemRoleName)
+ public function update(User $user, array $data, bool $manageUsersAllowed): User
{
- $role = $this->role->newQuery()->where('system_name', '=', $systemRoleName)->first();
- if ($role === null) {
- throw new NotFoundException("Role '{$systemRoleName}' not found");
+ if (!empty($data['name'])) {
+ $user->name = $data['name'];
+ $user->refreshSlug();
}
- $user->attachRole($role);
- }
- /**
- * Checks if the give user is the only admin.
- * @param \BookStack\Auth\User $user
- * @return bool
- */
- public function isOnlyAdmin(User $user)
- {
- if (!$user->hasSystemRole('admin')) {
- return false;
+ if (!empty($data['email']) && $manageUsersAllowed) {
+ $user->email = $data['email'];
}
- $adminRole = $this->role->getSystemRole('admin');
- if ($adminRole->users->count() > 1) {
- return false;
+ if (!empty($data['external_auth_id']) && $manageUsersAllowed) {
+ $user->external_auth_id = $data['external_auth_id'];
}
- 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)
- {
- if ($this->demotingLastAdmin($user, $roles)) {
- throw new UserUpdateException(trans('errors.role_cannot_remove_only_admin'), $user->getEditUrl());
+ if (isset($data['roles']) && $manageUsersAllowed) {
+ $this->setUserRoles($user, $data['roles']);
}
- $user->roles()->sync($roles);
- }
+ if (!empty($data['password'])) {
+ $user->password = bcrypt($data['password']);
+ }
- /**
- * 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');
- if (!in_array(strval($adminRole->id), $newRoles)) {
- return true;
- }
+ if (!empty($data['language'])) {
+ setting()->putUser($user, 'language', $data['language']);
}
- return false;
- }
+ $user->save();
+ Activity::add(ActivityType::USER_UPDATE, $user);
- /**
- * Create a new basic instance of user.
- * @param array $data
- * @param boolean $verifyEmail
- * @return \BookStack\Auth\User
- */
- public function create(array $data, $verifyEmail = false)
- {
- return $this->user->forceCreate([
- 'name' => $data['name'],
- 'email' => $data['email'],
- 'password' => bcrypt($data['password']),
- 'email_confirmed' => $verifyEmail
- ]);
+ return $user;
}
/**
* Remove the given user from storage, Delete all related content.
- * @param \BookStack\Auth\User $user
+ *
* @throws Exception
*/
- public function destroy(User $user)
+ public function destroy(User $user, ?int $newOwnerId = null)
{
+ $this->ensureDeletable($user);
+
$user->socialAccounts()->delete();
+ $user->apiTokens()->delete();
+ $user->favourites()->delete();
+ $user->mfaValues()->delete();
$user->delete();
-
+
// Delete user profile images
- $profileImages = Image::where('type', '=', 'user')->where('uploaded_to', '=', $user->id)->get();
- foreach ($profileImages as $image) {
- Images::destroy($image);
+ $this->userAvatar->destroyAllForUser($user);
+
+ if (!empty($newOwnerId)) {
+ $newOwner = User::query()->find($newOwnerId);
+ if (!is_null($newOwner)) {
+ $this->migrateOwnership($user, $newOwner);
+ }
}
+
+ Activity::add(ActivityType::USER_DELETE, $user);
}
/**
- * Get the latest activity for a user.
- * @param \BookStack\Auth\User $user
- * @param int $count
- * @param int $page
- * @return array
+ * @throws NotifyException
*/
- public function getActivity(User $user, $count = 20, $page = 0)
+ protected function ensureDeletable(User $user): void
{
- return Activity::userActivity($user, $count, $page);
+ 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());
+ }
}
/**
- * Get the recently created content for this given user.
- * @param \BookStack\Auth\User $user
- * @param int $count
- * @return mixed
+ * Migrate ownership of items in the system from one user to another.
*/
- public function getRecentlyCreated(User $user, $count = 20)
+ protected function migrateOwnership(User $fromUser, User $toUser)
{
- $createdByUserQuery = function (Builder $query) use ($user) {
- $query->where('created_by', '=', $user->id);
- };
-
- return [
- 'pages' => $this->entityRepo->getRecentlyCreated('page', $count, 0, $createdByUserQuery),
- 'chapters' => $this->entityRepo->getRecentlyCreated('chapter', $count, 0, $createdByUserQuery),
- 'books' => $this->entityRepo->getRecentlyCreated('book', $count, 0, $createdByUserQuery),
- 'shelves' => $this->entityRepo->getRecentlyCreated('bookshelf', $count, 0, $createdByUserQuery)
- ];
+ $entities = (new EntityProvider())->all();
+ foreach ($entities as $instance) {
+ $instance->newQuery()->where('owned_by', '=', $fromUser->id)
+ ->update(['owned_by' => $toUser->id]);
+ }
}
/**
- * Get asset created counts for the give user.
- * @param \BookStack\Auth\User $user
- * @return array
+ * 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 getAssetCounts(User $user)
+ protected function downloadAndAssignUserAvatar(User $user): void
{
- return [
- 'pages' => $this->entityRepo->getUserTotalCreated('page', $user),
- 'chapters' => $this->entityRepo->getUserTotalCreated('chapter', $user),
- 'books' => $this->entityRepo->getUserTotalCreated('book', $user),
- 'shelves' => $this->entityRepo->getUserTotalCreated('bookshelf', $user),
- ];
+ try {
+ $this->userAvatar->fetchAndAssignToUser($user);
+ } catch (Exception $e) {
+ Log::error('Failed to save user avatar image');
+ }
}
/**
- * Get the roles in the system that are assignable to a user.
- * @return mixed
+ * Checks if the give user is the only admin.
*/
- public function getAllRoles()
+ protected function isOnlyAdmin(User $user): bool
{
- return $this->role->newQuery()->orderBy('name', 'asc')->get();
+ if (!$user->hasSystemRole('admin')) {
+ return false;
+ }
+
+ $adminRole = Role::getSystemRole('admin');
+ if ($adminRole->users()->count() > 1) {
+ return false;
+ }
+
+ return true;
}
/**
- * Get all the roles which can be given restricted access to
- * other entities in the system.
- * @return mixed
+ * Set the assigned user roles via an array of role IDs.
+ *
+ * @throws UserUpdateException
*/
- public function getRestrictableRoles()
+ protected function setUserRoles(User $user, array $roles)
{
- return $this->role->where('system_name', '!=', 'admin')->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.
- * @param User $user
- * @return bool
+ * Check if the given user is the last admin and their new roles no longer
+ * contains the admin role.
*/
- public function downloadAndAssignUserAvatar(User $user)
+ protected function demotingLastAdmin(User $user, array $newRoles): bool
{
- if (!Images::avatarFetchEnabled()) {
- return false;
+ if ($this->isOnlyAdmin($user)) {
+ $adminRole = Role::getSystemRole('admin');
+ if (!in_array(strval($adminRole->id), $newRoles)) {
+ return true;
+ }
}
- try {
- $avatar = Images::saveUserAvatar($user);
- $user->avatar()->associate($avatar);
- $user->save();
- return true;
- } catch (Exception $e) {
- \Log::error('Failed to save user avatar image');
- return false;
- }
+ return false;
}
}
projects / bookstack / blobdiff