Added login throttling test, updated reset-pw test method names

[bookstack] / app / Http / Controllers / UserController.php

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index 511b4d33ce3fba1b256fdc67d3e79d332b4c97ff..895481d02405305c80198541883613941a69a13a 100644 (file)
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -2,9 +2,9 @@
 
 namespace BookStack\Http\Controllers;
 
 
 namespace BookStack\Http\Controllers;
 

-use BookStack\Actions\ActivityType;

 use BookStack\Auth\Access\SocialAuthService;
 use BookStack\Auth\Access\SocialAuthService;

-use BookStack\Auth\Access\UserInviteService;
+use BookStack\Auth\Queries\AllUsersPaginatedAndSorted;
+use BookStack\Auth\Role;

 use BookStack\Auth\User;
 use BookStack\Auth\UserRepo;
 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Auth\User;
 use BookStack\Auth\UserRepo;
 use BookStack\Exceptions\ImageUploadException;


@@ -13,25 +13,20 @@ use BookStack\Uploads\ImageRepo;
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;

-use Illuminate\Support\Str;

 use Illuminate\Validation\Rules\Password;
 use Illuminate\Validation\ValidationException;
 
 class UserController extends Controller
 {
 use Illuminate\Validation\Rules\Password;
 use Illuminate\Validation\ValidationException;
 
 class UserController extends Controller
 {

-    protected $user;
-    protected $userRepo;
-    protected $inviteService;
-    protected $imageRepo;
+    protected UserRepo $userRepo;
+    protected ImageRepo $imageRepo;

 
     /**
      * UserController constructor.
      */
 
     /**
      * UserController constructor.
      */

-    public function __construct(User $user, UserRepo $userRepo, UserInviteService $inviteService, ImageRepo $imageRepo)
+    public function __construct(UserRepo $userRepo, ImageRepo $imageRepo)

     {
     {

-        $this->user = $user;

         $this->userRepo = $userRepo;
         $this->userRepo = $userRepo;

-        $this->inviteService = $inviteService;

         $this->imageRepo = $imageRepo;
     }
 
         $this->imageRepo = $imageRepo;
     }
 


@@ -46,12 +41,16 @@ class UserController extends Controller
             'search' => $request->get('search', ''),
             'sort'   => $request->get('sort', 'name'),
         ];
             'search' => $request->get('search', ''),
             'sort'   => $request->get('sort', 'name'),
         ];

-        $users = $this->userRepo->getAllUsersPaginatedAndSorted(20, $listDetails);
+
+        $users = (new AllUsersPaginatedAndSorted())->run(20, $listDetails);

 
         $this->setPageTitle(trans('settings.users'));
         $users->appends($listDetails);
 
 
         $this->setPageTitle(trans('settings.users'));
         $users->appends($listDetails);
 

-        return view('users.index', ['users' => $users, 'listDetails' => $listDetails]);
+        return view('users.index', [
+            'users'       => $users,
+            'listDetails' => $listDetails,
+        ]);

     }
 
     /**
     }
 
     /**


@@ -61,70 +60,41 @@ class UserController extends Controller
     {
         $this->checkPermission('users-manage');
         $authMethod = config('auth.method');
     {
         $this->checkPermission('users-manage');
         $authMethod = config('auth.method');

-        $roles = $this->userRepo->getAllRoles();
+        $roles = Role::query()->orderBy('display_name', 'asc')->get();

         $this->setPageTitle(trans('settings.users_add_new'));
 
         return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);
     }
 
     /**
         $this->setPageTitle(trans('settings.users_add_new'));
 
         return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);
     }
 
     /**

-     * Store a newly created user in storage.
+     * Store a new user in storage.

      *
      *

-     * @throws UserUpdateException

      * @throws ValidationException
      */
     public function store(Request $request)
     {
         $this->checkPermission('users-manage');
      * @throws ValidationException
      */
     public function store(Request $request)
     {
         $this->checkPermission('users-manage');

-        $validationRules = [
-            'name'    => ['required'],
-            'email'   => ['required', 'email', 'unique:users,email'],
-            'setting' => ['array'],
-        ];

 
         $authMethod = config('auth.method');
         $sendInvite = ($request->get('send_invite', 'false') === 'true');
 
         $authMethod = config('auth.method');
         $sendInvite = ($request->get('send_invite', 'false') === 'true');

+        $externalAuth = $authMethod === 'ldap' || $authMethod === 'saml2' || $authMethod === 'oidc';
+        $passwordRequired = ($authMethod === 'standard' && !$sendInvite);

 
 

-        if ($authMethod === 'standard' && !$sendInvite) {
-            $validationRules['password'] = ['required', Password::default()];
-            $validationRules['password-confirm'] = ['required', 'same:password'];
-        } elseif ($authMethod === 'ldap' || $authMethod === 'saml2' || $authMethod === 'openid') {
-            $validationRules['external_auth_id'] = ['required'];
-        }
-        $this->validate($request, $validationRules);
-
-        $user = $this->user->fill($request->all());
-
-        if ($authMethod === 'standard') {
-            $user->password = bcrypt($request->get('password', Str::random(32)));
-        } elseif ($authMethod === 'ldap' || $authMethod === 'saml2' || $authMethod === 'openid') {
-            $user->external_auth_id = $request->get('external_auth_id');
-        }
-
-        $user->refreshSlug();
-
-        DB::transaction(function () use ($user, $sendInvite, $request) {
-            $user->save();
-
-            // Save user-specific settings
-            if ($request->filled('setting')) {
-                foreach ($request->get('setting') as $key => $value) {
-                    setting()->putUser($user, $key, $value);
-                }
-            }
-
-            if ($sendInvite) {
-                $this->inviteService->sendInvitation($user);
-            }
-
-            if ($request->filled('roles')) {
-                $roles = $request->get('roles');
-                $this->userRepo->setUserRoles($user, $roles);
-            }
+        $validationRules = [
+            'name'             => ['required', 'max:100'],
+            'email'            => ['required', 'email', 'unique:users,email'],
+            'language'         => ['string', 'max:15', 'alpha_dash'],
+            'roles'            => ['array'],
+            'roles.*'          => ['integer'],
+            'password'         => $passwordRequired ? ['required', Password::default()] : null,
+            'password-confirm' => $passwordRequired ? ['required', 'same:password'] : null,
+            'external_auth_id' => $externalAuth ? ['required'] : null,
+        ];

 
 

-            $this->userRepo->downloadAndAssignUserAvatar($user);
+        $validated = $this->validate($request, array_filter($validationRules));

 
 

-            $this->logActivity(ActivityType::USER_CREATE, $user);
+        DB::transaction(function () use ($validated, $sendInvite) {
+            $this->userRepo->create($validated, $sendInvite);

         });
 
         return redirect('/settings/users');
         });
 
         return redirect('/settings/users');


@@ -138,14 +108,14 @@ class UserController extends Controller
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         /** @var User $user */
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         /** @var User $user */

-        $user = $this->user->newQuery()->with(['apiTokens', 'mfaValues'])->findOrFail($id);
+        $user = User::query()->with(['apiTokens', 'mfaValues'])->findOrFail($id);

 
         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 
         $activeSocialDrivers = $socialAuthService->getActiveDrivers();
         $mfaMethods = $user->mfaValues->groupBy('method');
         $this->setPageTitle(trans('settings.user_profile'));
 
         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 
         $activeSocialDrivers = $socialAuthService->getActiveDrivers();
         $mfaMethods = $user->mfaValues->groupBy('method');
         $this->setPageTitle(trans('settings.user_profile'));

-        $roles = $this->userRepo->getAllRoles();
+        $roles = Role::query()->orderBy('display_name', 'asc')->get();

 
         return view('users.edit', [
             'user'                => $user,
 
         return view('users.edit', [
             'user'                => $user,


@@ -168,51 +138,20 @@ class UserController extends Controller
         $this->preventAccessInDemoMode();
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         $this->preventAccessInDemoMode();
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 

-        $this->validate($request, [
-            'name'             => ['min:2'],
+        $validated = $this->validate($request, [
+            'name'             => ['min:2', 'max:100'],

             'email'            => ['min:2', 'email', 'unique:users,email,' . $id],
             'password'         => ['required_with:password_confirm', Password::default()],
             'password-confirm' => ['same:password', 'required_with:password'],
             'email'            => ['min:2', 'email', 'unique:users,email,' . $id],
             'password'         => ['required_with:password_confirm', Password::default()],
             'password-confirm' => ['same:password', 'required_with:password'],

-            'setting'          => ['array'],
+            'language'         => ['string', 'max:15', 'alpha_dash'],
+            'roles'            => ['array'],
+            'roles.*'          => ['integer'],
+            'external_auth_id' => ['string'],

             'profile_image'    => array_merge(['nullable'], $this->getImageValidationRules()),
         ]);
 
         $user = $this->userRepo->getById($id);
             'profile_image'    => array_merge(['nullable'], $this->getImageValidationRules()),
         ]);
 
         $user = $this->userRepo->getById($id);

-        $user->fill($request->except(['email']));
-
-        // Email updates
-        if (userCan('users-manage') && $request->filled('email')) {
-            $user->email = $request->get('email');
-        }
-
-        // Refresh the slug if the user's name has changed
-        if ($user->isDirty('name')) {
-            $user->refreshSlug();
-        }
-
-        // Role updates
-        if (userCan('users-manage') && $request->filled('roles')) {
-            $roles = $request->get('roles');
-            $this->userRepo->setUserRoles($user, $roles);
-        }
-
-        // Password updates
-        if ($request->filled('password')) {
-            $password = $request->get('password');
-            $user->password = bcrypt($password);
-        }
-
-        // External auth id updates
-        if (user()->can('users-manage') && $request->filled('external_auth_id')) {
-            $user->external_auth_id = $request->get('external_auth_id');
-        }
-
-        // Save user-specific settings
-        if ($request->filled('setting')) {
-            foreach ($request->get('setting') as $key => $value) {
-                setting()->putUser($user, $key, $value);
-            }
-        }
+        $this->userRepo->update($user, $validated, userCan('users-manage'));

 
         // Save profile image if in request
         if ($request->hasFile('profile_image')) {
 
         // Save profile image if in request
         if ($request->hasFile('profile_image')) {


@@ -220,6 +159,7 @@ class UserController extends Controller
             $this->imageRepo->destroyImage($user->avatar);
             $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
             $user->image_id = $image->id;
             $this->imageRepo->destroyImage($user->avatar);
             $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
             $user->image_id = $image->id;

+            $user->save();

         }
 
         // Delete the profile image if reset option is in request
         }
 
         // Delete the profile image if reset option is in request


@@ -227,11 +167,7 @@ class UserController extends Controller
             $this->imageRepo->destroyImage($user->avatar);
         }
 
             $this->imageRepo->destroyImage($user->avatar);
         }
 

-        $user->save();
-        $this->showSuccessNotification(trans('settings.users_edit_success'));
-        $this->logActivity(ActivityType::USER_UPDATE, $user);
-
-        $redirectUrl = userCan('users-manage') ? '/settings/users' : ('/settings/users/' . $user->id);
+        $redirectUrl = userCan('users-manage') ? '/settings/users' : "/settings/users/{$user->id}";

 
         return redirect($redirectUrl);
     }
 
         return redirect($redirectUrl);
     }


@@ -347,12 +283,33 @@ class UserController extends Controller
 
         $newState = $request->get('expand', 'false');
 
 
         $newState = $request->get('expand', 'false');
 

-        $user = $this->user->findOrFail($id);
+        $user = $this->userRepo->getById($id);

         setting()->putUser($user, 'section_expansion#' . $key, $newState);
 
         return response('', 204);
     }
 
         setting()->putUser($user, 'section_expansion#' . $key, $newState);
 
         return response('', 204);
     }
 

+    public function updateCodeLanguageFavourite(Request $request)
+    {
+        $validated = $this->validate($request, [
+            'language' => ['required', 'string', 'max:20'],
+            'active'   => ['required', 'bool'],
+        ]);
+
+        $currentFavoritesStr = setting()->getForCurrentUser('code-language-favourites', '');
+        $currentFavorites = array_filter(explode(',', $currentFavoritesStr));
+
+        $isFav = in_array($validated['language'], $currentFavorites);
+        if (!$isFav && $validated['active']) {
+            $currentFavorites[] = $validated['language'];
+        } elseif ($isFav && !$validated['active']) {
+            $index = array_search($validated['language'], $currentFavorites);
+            array_splice($currentFavorites, $index, 1);
+        }
+
+        setting()->putUser(user(), 'code-language-favourites', implode(',', $currentFavorites));
+    }
+

     /**
      * Changed the stored preference for a list sort order.
      */
     /**
      * Changed the stored preference for a list sort order.
      */


@@ -370,7 +327,7 @@ class UserController extends Controller
             $order = 'asc';
         }
 
             $order = 'asc';
         }
 

-        $user = $this->user->findOrFail($userId);
+        $user = $this->userRepo->getById($userId);

         $sortKey = $listName . '_sort';
         $orderKey = $listName . '_sort_order';
         setting()->putUser($user, $sortKey, $sort);
         $sortKey = $listName . '_sort';
         $orderKey = $listName . '_sort_order';
         setting()->putUser($user, $sortKey, $sort);