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

   1 <?php
   2
   3 namespace BookStack\Users\Controllers;
   4
   5 use BookStack\Access\SocialDriverManager;
   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, SocialDriverManager $socialDriverManager)
 105     {
 106         $this->checkPermission('users-manage');
 107
 108         $user = $this->userRepo->getById($id);
 109         $user->load(['apiTokens', 'mfaValues']);
 110         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 111
 112         $activeSocialDrivers = $socialDriverManager->getActive();
 113         $mfaMethods = $user->mfaValues->groupBy('method');
 114         $this->setPageTitle(trans('settings.user_profile'));
 115         $roles = Role::query()->orderBy('display_name', 'asc')->get();
 116
 117         return view('users.edit', [
 118             'user'                => $user,
 119             'activeSocialDrivers' => $activeSocialDrivers,
 120             'mfaMethods'          => $mfaMethods,
 121             'authMethod'          => $authMethod,
 122             'roles'               => $roles,
 123         ]);
 124     }
 125
 126     /**
 127      * Update the specified user in storage.
 128      *
 129      * @throws UserUpdateException
 130      * @throws ImageUploadException
 131      * @throws ValidationException
 132      */
 133     public function update(Request $request, int $id)
 134     {
 135         $this->preventAccessInDemoMode();
 136         $this->checkPermission('users-manage');
 137
 138         $validated = $this->validate($request, [
 139             'name'             => ['min:2', 'max:100'],
 140             'email'            => ['min:2', 'email', 'unique:users,email,' . $id],
 141             'password'         => ['required_with:password_confirm', Password::default()],
 142             'password-confirm' => ['same:password', 'required_with:password'],
 143             'language'         => ['string', 'max:15', 'alpha_dash'],
 144             'roles'            => ['array'],
 145             'roles.*'          => ['integer'],
 146             'external_auth_id' => ['string'],
 147             'profile_image'    => array_merge(['nullable'], $this->getImageValidationRules()),
 148         ]);
 149
 150         $user = $this->userRepo->getById($id);
 151         $this->userRepo->update($user, $validated, true);
 152
 153         // Save profile image if in request
 154         if ($request->hasFile('profile_image')) {
 155             $imageUpload = $request->file('profile_image');
 156             $this->imageRepo->destroyImage($user->avatar);
 157             $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
 158             $user->image_id = $image->id;
 159             $user->save();
 160         }
 161
 162         // Delete the profile image if reset option is in request
 163         if ($request->has('profile_image_reset')) {
 164             $this->imageRepo->destroyImage($user->avatar);
 165             $user->image_id = 0;
 166             $user->save();
 167         }
 168
 169         return redirect('/settings/users');
 170     }
 171
 172     /**
 173      * Show the user delete page.
 174      */
 175     public function delete(int $id)
 176     {
 177         $this->checkPermission('users-manage');
 178
 179         $user = $this->userRepo->getById($id);
 180         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));
 181
 182         return view('users.delete', ['user' => $user]);
 183     }
 184
 185     /**
 186      * Remove the specified user from storage.
 187      *
 188      * @throws Exception
 189      */
 190     public function destroy(Request $request, int $id)
 191     {
 192         $this->preventAccessInDemoMode();
 193         $this->checkPermission('users-manage');
 194
 195         $user = $this->userRepo->getById($id);
 196         $newOwnerId = intval($request->get('new_owner_id')) ?: null;
 197
 198         $this->userRepo->destroy($user, $newOwnerId);
 199
 200         return redirect('/settings/users');
 201     }
 202 }