BookStack Code Mirror - bookstack/blob - app/Auth/UserRepo.php

   1 <?php
   2
   3 namespace BookStack\Auth;
   4
   5 use Activity;
   6 use BookStack\Entities\EntityProvider;
   7 use BookStack\Entities\Models\Book;
   8 use BookStack\Entities\Models\Bookshelf;
   9 use BookStack\Entities\Models\Chapter;
  10 use BookStack\Entities\Models\Page;
  11 use BookStack\Exceptions\NotFoundException;
  12 use BookStack\Exceptions\UserUpdateException;
  13 use BookStack\Uploads\UserAvatars;
  14 use Exception;
  15 use Illuminate\Database\Eloquent\Builder;
  16 use Illuminate\Database\Eloquent\Collection;
  17 use Illuminate\Pagination\LengthAwarePaginator;
  18 use Log;
  19
  20 class UserRepo
  21 {
  22     protected $userAvatar;
  23
  24     /**
  25      * UserRepo constructor.
  26      */
  27     public function __construct(UserAvatars $userAvatar)
  28     {
  29         $this->userAvatar = $userAvatar;
  30     }
  31
  32     /**
  33      * Get a user by their email address.
  34      */
  35     public function getByEmail(string $email): ?User
  36     {
  37         return User::query()->where('email', '=', $email)->first();
  38     }
  39
  40     /**
  41      * Get a user by their ID.
  42      */
  43     public function getById(int $id): User
  44     {
  45         return User::query()->findOrFail($id);
  46     }
  47
  48     /**
  49      * Get a user by their slug.
  50      */
  51     public function getBySlug(string $slug): User
  52     {
  53         return User::query()->where('slug', '=', $slug)->firstOrFail();
  54     }
  55
  56     /**
  57      * Get all the users with their permissions.
  58      */
  59     public function getAllUsers(): Collection
  60     {
  61         return User::query()->with('roles', 'avatar')->orderBy('name', 'asc')->get();
  62     }
  63
  64     /**
  65      * Get all the users with their permissions in a paginated format.
  66      */
  67     public function getAllUsersPaginatedAndSorted(int $count, array $sortData): LengthAwarePaginator
  68     {
  69         $sort = $sortData['sort'];
  70
  71         $query = User::query()->select(['*'])
  72             ->withLastActivityAt()
  73             ->with(['roles', 'avatar'])
  74             ->withCount('mfaValues')
  75             ->orderBy($sort, $sortData['order']);
  76
  77         if ($sortData['search']) {
  78             $term = '%' . $sortData['search'] . '%';
  79             $query->where(function ($query) use ($term) {
  80                 $query->where('name', 'like', $term)
  81                     ->orWhere('email', 'like', $term);
  82             });
  83         }
  84
  85         return $query->paginate($count);
  86     }
  87
  88     /**
  89      * Creates a new user and attaches a role to them.
  90      */
  91     public function registerNew(array $data, bool $emailConfirmed = false): User
  92     {
  93         $user = $this->create($data, $emailConfirmed);
  94         $user->attachDefaultRole();
  95         $this->downloadAndAssignUserAvatar($user);
  96
  97         return $user;
  98     }
  99
 100     /**
 101      * Assign a user to a system-level role.
 102      *
 103      * @throws NotFoundException
 104      */
 105     public function attachSystemRole(User $user, string $systemRoleName)
 106     {
 107         $role = Role::getSystemRole($systemRoleName);
 108         if (is_null($role)) {
 109             throw new NotFoundException("Role '{$systemRoleName}' not found");
 110         }
 111         $user->attachRole($role);
 112     }
 113
 114     /**
 115      * Checks if the give user is the only admin.
 116      */
 117     public function isOnlyAdmin(User $user): bool
 118     {
 119         if (!$user->hasSystemRole('admin')) {
 120             return false;
 121         }
 122
 123         $adminRole = Role::getSystemRole('admin');
 124         if ($adminRole->users()->count() > 1) {
 125             return false;
 126         }
 127
 128         return true;
 129     }
 130
 131     /**
 132      * Set the assigned user roles via an array of role IDs.
 133      *
 134      * @throws UserUpdateException
 135      */
 136     public function setUserRoles(User $user, array $roles)
 137     {
 138         if ($this->demotingLastAdmin($user, $roles)) {
 139             throw new UserUpdateException(trans('errors.role_cannot_remove_only_admin'), $user->getEditUrl());
 140         }
 141
 142         $user->roles()->sync($roles);
 143     }
 144
 145     /**
 146      * Check if the given user is the last admin and their new roles no longer
 147      * contains the admin role.
 148      */
 149     protected function demotingLastAdmin(User $user, array $newRoles): bool
 150     {
 151         if ($this->isOnlyAdmin($user)) {
 152             $adminRole = Role::getSystemRole('admin');
 153             if (!in_array(strval($adminRole->id), $newRoles)) {
 154                 return true;
 155             }
 156         }
 157
 158         return false;
 159     }
 160
 161     /**
 162      * Create a new basic instance of user.
 163      */
 164     public function create(array $data, bool $emailConfirmed = false): User
 165     {
 166         $details = [
 167             'name'             => $data['name'],
 168             'email'            => $data['email'],
 169             'password'         => bcrypt($data['password']),
 170             'email_confirmed'  => $emailConfirmed,
 171             'external_auth_id' => $data['external_auth_id'] ?? '',
 172         ];
 173
 174         $user = new User();
 175         $user->forceFill($details);
 176         $user->refreshSlug();
 177         $user->save();
 178
 179         return $user;
 180     }
 181
 182     /**
 183      * Remove the given user from storage, Delete all related content.
 184      *
 185      * @throws Exception
 186      */
 187     public function destroy(User $user, ?int $newOwnerId = null)
 188     {
 189         $user->socialAccounts()->delete();
 190         $user->apiTokens()->delete();
 191         $user->favourites()->delete();
 192         $user->mfaValues()->delete();
 193         $user->delete();
 194
 195         // Delete user profile images
 196         $this->userAvatar->destroyAllForUser($user);
 197
 198         if (!empty($newOwnerId)) {
 199             $newOwner = User::query()->find($newOwnerId);
 200             if (!is_null($newOwner)) {
 201                 $this->migrateOwnership($user, $newOwner);
 202             }
 203         }
 204     }
 205
 206     /**
 207      * Migrate ownership of items in the system from one user to another.
 208      */
 209     protected function migrateOwnership(User $fromUser, User $toUser)
 210     {
 211         $entities = (new EntityProvider())->all();
 212         foreach ($entities as $instance) {
 213             $instance->newQuery()->where('owned_by', '=', $fromUser->id)
 214                 ->update(['owned_by' => $toUser->id]);
 215         }
 216     }
 217
 218     /**
 219      * Get the latest activity for a user.
 220      */
 221     public function getActivity(User $user, int $count = 20, int $page = 0): array
 222     {
 223         return Activity::userActivity($user, $count, $page);
 224     }
 225
 226     /**
 227      * Get the recently created content for this given user.
 228      */
 229     public function getRecentlyCreated(User $user, int $count = 20): array
 230     {
 231         $query = function (Builder $query) use ($user, $count) {
 232             return $query->orderBy('created_at', 'desc')
 233                 ->where('created_by', '=', $user->id)
 234                 ->take($count)
 235                 ->get();
 236         };
 237
 238         return [
 239             'pages'    => $query(Page::visible()->where('draft', '=', false)),
 240             'chapters' => $query(Chapter::visible()),
 241             'books'    => $query(Book::visible()),
 242             'shelves'  => $query(Bookshelf::visible()),
 243         ];
 244     }
 245
 246     /**
 247      * Get asset created counts for the give user.
 248      */
 249     public function getAssetCounts(User $user): array
 250     {
 251         $createdBy = ['created_by' => $user->id];
 252
 253         return [
 254             'pages'       => Page::visible()->where($createdBy)->count(),
 255             'chapters'    => Chapter::visible()->where($createdBy)->count(),
 256             'books'       => Book::visible()->where($createdBy)->count(),
 257             'shelves'     => Bookshelf::visible()->where($createdBy)->count(),
 258         ];
 259     }
 260
 261     /**
 262      * Get the roles in the system that are assignable to a user.
 263      */
 264     public function getAllRoles(): Collection
 265     {
 266         return Role::query()->orderBy('display_name', 'asc')->get();
 267     }
 268
 269     /**
 270      * Get an avatar image for a user and set it as their avatar.
 271      * Returns early if avatars disabled or not set in config.
 272      */
 273     public function downloadAndAssignUserAvatar(User $user): void
 274     {
 275         try {
 276             $this->userAvatar->fetchAndAssignToUser($user);
 277         } catch (Exception $e) {
 278             Log::error('Failed to save user avatar image');
 279         }
 280     }
 281 }