BookStack Code Mirror - bookstack/blob - app/Users/Controllers/UserController.php

   1 <?php
   2
   3 namespace BookStack\Users\Controllers;
   4
   5 use BookStack\Access\SocialAuthService;
   6 use BookStack\Exceptions\ImageUploadException;
   7 use BookStack\Exceptions\UserUpdateException;
   8 use BookStack\Http\Controller;
   9 use BookStack\Uploads\ImageRepo;
  10 use BookStack\Users\Models\Role;
  11 use BookStack\Users\Queries\UsersAllPaginatedAndSorted;
  12 use BookStack\Users\UserRepo;
  13 use BookStack\Util\SimpleListOptions;
  14 use Exception;
  15 use Illuminate\Http\Request;
  16 use Illuminate\Support\Facades\DB;
  17 use Illuminate\Validation\Rules\Password;
  18 use Illuminate\Validation\ValidationException;
  19
  20 class UserController extends Controller
  21 {
  22     public function __construct(
  23         protected UserRepo $userRepo,
  24         protected ImageRepo $imageRepo
  25     ) {
  26     }
  27
  28     /**
  29      * Display a listing of the users.
  30      */
  31     public function index(Request $request)
  32     {
  33         $this->checkPermission('users-manage');
  34
  35         $listOptions = SimpleListOptions::fromRequest($request, 'users')->withSortOptions([
  36             'name' => trans('common.sort_name'),
  37             'email' => trans('auth.email'),
  38             'created_at' => trans('common.sort_created_at'),
  39             'updated_at' => trans('common.sort_updated_at'),
  40             'last_activity_at' => trans('settings.users_latest_activity'),
  41         ]);
  42
  43         $users = (new UsersAllPaginatedAndSorted())->run(20, $listOptions);
  44
  45         $this->setPageTitle(trans('settings.users'));
  46         $users->appends($listOptions->getPaginationAppends());
  47
  48         return view('users.index', [
  49             'users'       => $users,
  50             'listOptions' => $listOptions,
  51         ]);
  52     }
  53
  54     /**
  55      * Show the form for creating a new user.
  56      */
  57     public function create()
  58     {
  59         $this->checkPermission('users-manage');
  60         $authMethod = config('auth.method');
  61         $roles = Role::query()->orderBy('display_name', 'asc')->get();
  62         $this->setPageTitle(trans('settings.users_add_new'));
  63
  64         return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);
  65     }
  66
  67     /**
  68      * Store a new user in storage.
  69      *
  70      * @throws ValidationException
  71      */
  72     public function store(Request $request)
  73     {
  74         $this->checkPermission('users-manage');
  75
  76         $authMethod = config('auth.method');
  77         $sendInvite = ($request->get('send_invite', 'false') === 'true');
  78         $externalAuth = $authMethod === 'ldap' || $authMethod === 'saml2' || $authMethod === 'oidc';
  79         $passwordRequired = ($authMethod === 'standard' && !$sendInvite);
  80
  81         $validationRules = [
  82             'name'             => ['required', 'max:100'],
  83             'email'            => ['required', 'email', 'unique:users,email'],
  84             'language'         => ['string', 'max:15', 'alpha_dash'],
  85             'roles'            => ['array'],
  86             'roles.*'          => ['integer'],
  87             'password'         => $passwordRequired ? ['required', Password::default()] : null,
  88             'password-confirm' => $passwordRequired ? ['required', 'same:password'] : null,
  89             'external_auth_id' => $externalAuth ? ['required'] : null,
  90         ];
  91
  92         $validated = $this->validate($request, array_filter($validationRules));
  93
  94         DB::transaction(function () use ($validated, $sendInvite) {
  95             $this->userRepo->create($validated, $sendInvite);
  96         });
  97
  98         return redirect('/settings/users');
  99     }
 100
 101     /**
 102      * Show the form for editing the specified user.
 103      */
 104     public function edit(int $id, SocialAuthService $socialAuthService)
 105     {
 106         $this->preventGuestAccess();
 107         $this->checkPermissionOrCurrentUser('users-manage', $id);
 108
 109         $user = $this->userRepo->getById($id);
 110         $user->load(['apiTokens', 'mfaValues']);
 111         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 112
 113         $activeSocialDrivers = $socialAuthService->getActiveDrivers();
 114         $mfaMethods = $user->mfaValues->groupBy('method');
 115         $this->setPageTitle(trans('settings.user_profile'));
 116         $roles = Role::query()->orderBy('display_name', 'asc')->get();
 117
 118         return view('users.edit', [
 119             'user'                => $user,
 120             'activeSocialDrivers' => $activeSocialDrivers,
 121             'mfaMethods'          => $mfaMethods,
 122             'authMethod'          => $authMethod,
 123             'roles'               => $roles,
 124         ]);
 125     }
 126
 127     /**
 128      * Update the specified user in storage.
 129      *
 130      * @throws UserUpdateException
 131      * @throws ImageUploadException
 132      * @throws ValidationException
 133      */
 134     public function update(Request $request, int $id)
 135     {
 136         $this->preventAccessInDemoMode();
 137         $this->preventGuestAccess();
 138         $this->checkPermissionOrCurrentUser('users-manage', $id);
 139
 140         $validated = $this->validate($request, [
 141             'name'             => ['min:2', 'max:100'],
 142             'email'            => ['min:2', 'email', 'unique:users,email,' . $id],
 143             'password'         => ['required_with:password_confirm', Password::default()],
 144             'password-confirm' => ['same:password', 'required_with:password'],
 145             'language'         => ['string', 'max:15', 'alpha_dash'],
 146             'roles'            => ['array'],
 147             'roles.*'          => ['integer'],
 148             'external_auth_id' => ['string'],
 149             'profile_image'    => array_merge(['nullable'], $this->getImageValidationRules()),
 150         ]);
 151
 152         $user = $this->userRepo->getById($id);
 153         $this->userRepo->update($user, $validated, userCan('users-manage'));
 154
 155         // Save profile image if in request
 156         if ($request->hasFile('profile_image')) {
 157             $imageUpload = $request->file('profile_image');
 158             $this->imageRepo->destroyImage($user->avatar);
 159             $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
 160             $user->image_id = $image->id;
 161             $user->save();
 162         }
 163
 164         // Delete the profile image if reset option is in request
 165         if ($request->has('profile_image_reset')) {
 166             $this->imageRepo->destroyImage($user->avatar);
 167             $user->image_id = 0;
 168             $user->save();
 169         }
 170
 171         $redirectUrl = userCan('users-manage') ? '/settings/users' : "/settings/users/{$user->id}";
 172
 173         return redirect($redirectUrl);
 174     }
 175
 176     /**
 177      * Show the user delete page.
 178      */
 179     public function delete(int $id)
 180     {
 181         $this->preventGuestAccess();
 182         $this->checkPermissionOrCurrentUser('users-manage', $id);
 183
 184         $user = $this->userRepo->getById($id);
 185         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));
 186
 187         return view('users.delete', ['user' => $user]);
 188     }
 189
 190     /**
 191      * Remove the specified user from storage.
 192      *
 193      * @throws Exception
 194      */
 195     public function destroy(Request $request, int $id)
 196     {
 197         $this->preventAccessInDemoMode();
 198         $this->preventGuestAccess();
 199         $this->checkPermissionOrCurrentUser('users-manage', $id);
 200
 201         $user = $this->userRepo->getById($id);
 202         $newOwnerId = intval($request->get('new_owner_id')) ?: null;
 203
 204         $this->userRepo->destroy($user, $newOwnerId);
 205
 206         return redirect('/settings/users');
 207     }
 208 }