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