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