Refactored common list handling operations to new class

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

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index c91b7678c58a075671ad89942685a0b7bafaa470..9b3cc3977dd18971795eddcb0f075985931531ae 100644 (file)
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -1,115 +1,105 @@
-<?php namespace BookStack\Http\Controllers;
+<?php
+
+namespace BookStack\Http\Controllers;

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

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

 use BookStack\Auth\User;
 use BookStack\Auth\UserRepo;
 use BookStack\Auth\User;
 use BookStack\Auth\UserRepo;

+use BookStack\Exceptions\ImageUploadException;

 use BookStack\Exceptions\UserUpdateException;
 use BookStack\Uploads\ImageRepo;
 use BookStack\Exceptions\UserUpdateException;
 use BookStack\Uploads\ImageRepo;

+use BookStack\Util\SimpleListOptions;
+use Exception;

 use Illuminate\Http\Request;
 use Illuminate\Http\Request;

-use Illuminate\Http\Response;
-use Illuminate\Support\Str;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Validation\Rules\Password;
+use Illuminate\Validation\ValidationException;

 
 class UserController extends Controller
 {
 
 class UserController extends Controller
 {

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

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

-     * @param User $user
-     * @param UserRepo $userRepo
-     * @param UserInviteService $inviteService
-     * @param ImageRepo $imageRepo

      */
      */

-    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;

-        parent::__construct();

     }
 
     /**
      * Display a listing of the users.
     }
 
     /**
      * Display a listing of the users.

-     * @param Request $request
-     * @return Response

      */
     public function index(Request $request)
     {
         $this->checkPermission('users-manage');
      */
     public function index(Request $request)
     {
         $this->checkPermission('users-manage');

-        $listDetails = [
-            'order' => $request->get('order', 'asc'),
-            'search' => $request->get('search', ''),
-            'sort' => $request->get('sort', 'name'),
-        ];
-        $users = $this->userRepo->getAllUsersPaginatedAndSorted(20, $listDetails);
+
+        $listOptions = SimpleListOptions::fromRequest($request, 'users')->withSortOptions([
+            'name' => trans('common.sort_name'),
+            'email' => trans('auth.email'),
+            'created_at' => trans('common.sort_created_at'),
+            'updated_at' => trans('common.sort_updated_at'),
+            'last_activity_at' => trans('settings.users_latest_activity'),
+        ]);
+
+        $users = (new UsersAllPaginatedAndSorted())->run(20, $listOptions);
+

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

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

     }
 
     /**
      * Show the form for creating a new user.
     }
 
     /**
      * Show the form for creating a new user.

-     * @return Response

      */
     public function create()
     {
         $this->checkPermission('users-manage');
         $authMethod = config('auth.method');
      */
     public function create()
     {
         $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]);
     }
 
     /**
         return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);
     }
 
     /**

-     * Store a newly created user in storage.
-     * @param  Request $request
-     * @return Response
-     * @throws UserUpdateException
+     * Store a new user in storage.
+     *
+     * @throws ValidationException

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

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

 
         $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|min:6';
-            $validationRules['password-confirm'] = 'required|same:password';
-        } elseif ($authMethod === 'ldap') {
-            $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') {
-            $user->external_auth_id = $request->get('external_auth_id');
-        }
-
-        $user->save();
-
-        if ($sendInvite) {
-            $this->inviteService->sendInvitation($user);
-        }
+        $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,
+        ];

 
 

-        if ($request->filled('roles')) {
-            $roles = $request->get('roles');
-            $this->userRepo->setUserRoles($user, $roles);
-        }
+        $validated = $this->validate($request, array_filter($validationRules));

 
 

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

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


@@ -121,74 +111,51 @@ class UserController extends Controller
     {
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
     {
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 

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

 
         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 
         $activeSocialDrivers = $socialAuthService->getActiveDrivers();
 
         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 
         $activeSocialDrivers = $socialAuthService->getActiveDrivers();

+        $mfaMethods = $user->mfaValues->groupBy('method');

         $this->setPageTitle(trans('settings.user_profile'));
         $this->setPageTitle(trans('settings.user_profile'));

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

         return view('users.edit', [
         return view('users.edit', [

-            'user' => $user,
+            'user'                => $user,

             'activeSocialDrivers' => $activeSocialDrivers,
             'activeSocialDrivers' => $activeSocialDrivers,

-            'authMethod' => $authMethod,
-            'roles' => $roles
+            'mfaMethods'          => $mfaMethods,
+            'authMethod'          => $authMethod,
+            'roles'               => $roles,

         ]);
     }
 
     /**
      * Update the specified user in storage.
         ]);
     }
 
     /**
      * Update the specified user in storage.

-     * @param Request $request
-     * @param int $id
-     * @return Response
+     *

      * @throws UserUpdateException
      * @throws UserUpdateException

-     * @throws \BookStack\Exceptions\ImageUploadException
+     * @throws ImageUploadException
+     * @throws ValidationException

      */
      */

-    public function update(Request $request, $id)
+    public function update(Request $request, int $id)

     {
         $this->preventAccessInDemoMode();
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
     {
         $this->preventAccessInDemoMode();
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 

-        $this->validate($request, [
-            'name'             => 'min:2',
-            'email'            => 'min:2|email|unique:users,email,' . $id,
-            'password'         => 'min:6|required_with:password_confirm',
-            'password-confirm' => 'same:password|required_with:password',
-            'setting'          => 'array',
-            'profile_image'    => $this->imageRepo->getImageValidationRules(),
+        $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'],
+            '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);
         ]);
 
         $user = $this->userRepo->getById($id);

-        $user->fill($request->except(['email']));
-
-        // Email updates
-        if (userCan('users-manage') && $request->filled('email')) {
-            $user->email = $request->get('email');
-        }
-
-        // 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 an 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')) {


@@ -196,114 +163,78 @@ 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 set to
+        // Delete the profile image if reset option is in request

         if ($request->has('profile_image_reset')) {
             $this->imageRepo->destroyImage($user->avatar);
         }
 
         if ($request->has('profile_image_reset')) {
             $this->imageRepo->destroyImage($user->avatar);
         }
 

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

 
 

-        $redirectUrl = userCan('users-manage') ? '/settings/users' : ('/settings/users/' . $user->id);

         return redirect($redirectUrl);
     }
 
     /**
      * Show the user delete page.
         return redirect($redirectUrl);
     }
 
     /**
      * Show the user delete page.

-     * @param int $id
-     * @return \Illuminate\View\View

      */
      */

-    public function delete($id)
+    public function delete(int $id)

     {
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         $user = $this->userRepo->getById($id);
         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));
     {
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         $user = $this->userRepo->getById($id);
         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));

+

         return view('users.delete', ['user' => $user]);
     }
 
     /**
      * Remove the specified user from storage.
         return view('users.delete', ['user' => $user]);
     }
 
     /**
      * Remove the specified user from storage.

-     * @param  int $id
-     * @return Response
-     * @throws \Exception
+     *
+     * @throws Exception

      */
      */

-    public function destroy($id)
+    public function destroy(Request $request, int $id)

     {
         $this->preventAccessInDemoMode();
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         $user = $this->userRepo->getById($id);
     {
         $this->preventAccessInDemoMode();
         $this->checkPermissionOrCurrentUser('users-manage', $id);
 
         $user = $this->userRepo->getById($id);

+        $newOwnerId = $request->get('new_owner_id', null);

 
 

-        if ($this->userRepo->isOnlyAdmin($user)) {
-            $this->showErrorNotification(trans('errors.users_cannot_delete_only_admin'));
-            return redirect($user->getEditUrl());
-        }
-
-        if ($user->system_name === 'public') {
-            $this->showErrorNotification(trans('errors.users_cannot_delete_guest'));
-            return redirect($user->getEditUrl());
-        }
-
-        $this->userRepo->destroy($user);
-        $this->showSuccessNotification(trans('settings.users_delete_success'));
+        $this->userRepo->destroy($user, $newOwnerId);

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

-     * Show the user profile page
-     * @param $id
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     * Update the user's preferred book-list display setting.

      */
      */

-    public function showProfilePage($id)
+    public function switchBooksView(Request $request, int $id)

     {
     {

-        $user = $this->userRepo->getById($id);
-
-        $userActivity = $this->userRepo->getActivity($user);
-        $recentlyCreated = $this->userRepo->getRecentlyCreated($user, 5);
-        $assetCounts = $this->userRepo->getAssetCounts($user);
-
-        return view('users.profile', [
-            'user' => $user,
-            'activity' => $userActivity,
-            'recentlyCreated' => $recentlyCreated,
-            'assetCounts' => $assetCounts
-        ]);
+        return $this->switchViewType($id, $request, 'books');

     }
 
     /**
     }
 
     /**

-     * Update the user's preferred book-list display setting.
-     * @param Request $request
-     * @param $id
-     * @return \Illuminate\Http\RedirectResponse
+     * Update the user's preferred shelf-list display setting.

      */
      */

-    public function switchBookView(Request $request, $id)
+    public function switchShelvesView(Request $request, int $id)

     {
     {

-        return $this->switchViewType($id, $request, 'books');
+        return $this->switchViewType($id, $request, 'bookshelves');

     }
 
     /**
     }
 
     /**

-     * Update the user's preferred shelf-list display setting.
-     * @param Request $request
-     * @param $id
-     * @return \Illuminate\Http\RedirectResponse
+     * Update the user's preferred shelf-view book list display setting.

      */
      */

-    public function switchShelfView(Request $request, $id)
+    public function switchShelfView(Request $request, int $id)

     {
     {

-        return $this->switchViewType($id, $request, 'bookshelves');
+        return $this->switchViewType($id, $request, 'bookshelf');

     }
 
     /**
      * For a type of list, switch with stored view type for a user.
     }
 
     /**
      * For a type of list, switch with stored view type for a user.

-     * @param integer $userId
-     * @param Request $request
-     * @param string $listName
-     * @return \Illuminate\Http\RedirectResponse

      */
      */

-    protected function switchViewType($userId, Request $request, string $listName)
+    protected function switchViewType(int $userId, Request $request, string $listName)

     {
         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 
     {
         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 


@@ -321,69 +252,76 @@ class UserController extends Controller
 
     /**
      * Change the stored sort type for a particular view.
 
     /**
      * Change the stored sort type for a particular view.

-     * @param Request $request
-     * @param string $id
-     * @param string $type
-     * @return \Illuminate\Http\RedirectResponse

      */
     public function changeSort(Request $request, string $id, string $type)
     {
      */
     public function changeSort(Request $request, string $id, string $type)
     {

-        $validSortTypes = ['books', 'bookshelves'];
+        $validSortTypes = ['books', 'bookshelves', 'shelf_books', 'users', 'roles', 'webhooks'];

         if (!in_array($type, $validSortTypes)) {
             return redirect()->back(500);
         }
         if (!in_array($type, $validSortTypes)) {
             return redirect()->back(500);
         }

-        return $this->changeListSort($id, $request, $type);
+
+        $this->checkPermissionOrCurrentUser('users-manage', $id);
+
+        $sort = substr($request->get('sort') ?: 'name', 0, 50);
+        $order = $request->get('order') === 'desc' ? 'desc' : 'asc';
+
+        $user = $this->userRepo->getById($id);
+        $sortKey = $type . '_sort';
+        $orderKey = $type . '_sort_order';
+        setting()->putUser($user, $sortKey, $sort);
+        setting()->putUser($user, $orderKey, $order);
+
+        return redirect()->back(302, [], "/settings/users/{$id}");
+    }
+
+    /**
+     * Toggle dark mode for the current user.
+     */
+    public function toggleDarkMode()
+    {
+        $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
+        setting()->putUser(user(), 'dark-mode-enabled', $enabled ? 'false' : 'true');
+
+        return redirect()->back();

     }
 
     /**
      * Update the stored section expansion preference for the given user.
     }
 
     /**
      * Update the stored section expansion preference for the given user.

-     * @param Request $request
-     * @param string $id
-     * @param string $key
-     * @return \Illuminate\Contracts\Routing\ResponseFactory|\Symfony\Component\HttpFoundation\Response

      */
     public function updateExpansionPreference(Request $request, string $id, string $key)
     {
         $this->checkPermissionOrCurrentUser('users-manage', $id);
         $keyWhitelist = ['home-details'];
         if (!in_array($key, $keyWhitelist)) {
      */
     public function updateExpansionPreference(Request $request, string $id, string $key)
     {
         $this->checkPermissionOrCurrentUser('users-manage', $id);
         $keyWhitelist = ['home-details'];
         if (!in_array($key, $keyWhitelist)) {

-            return response("Invalid key", 500);
+            return response('Invalid key', 500);

         }
 
         $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);
         setting()->putUser($user, 'section_expansion#' . $key, $newState);

-        return response("", 204);
+
+        return response('', 204);

     }
 
     }
 

-    /**
-     * Changed the stored preference for a list sort order.
-     * @param int $userId
-     * @param Request $request
-     * @param string $listName
-     * @return \Illuminate\Http\RedirectResponse
-     */
-    protected function changeListSort(int $userId, Request $request, string $listName)
+    public function updateCodeLanguageFavourite(Request $request)

     {
     {

-        $this->checkPermissionOrCurrentUser('users-manage', $userId);
+        $validated = $this->validate($request, [
+            'language' => ['required', 'string', 'max:20'],
+            'active'   => ['required', 'bool'],
+        ]);

 
 

-        $sort = $request->get('sort');
-        if (!in_array($sort, ['name', 'created_at', 'updated_at'])) {
-            $sort = 'name';
-        }
+        $currentFavoritesStr = setting()->getForCurrentUser('code-language-favourites', '');
+        $currentFavorites = array_filter(explode(',', $currentFavoritesStr));

 
 

-        $order = $request->get('order');
-        if (!in_array($order, ['asc', 'desc'])) {
-            $order = 'asc';
+        $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);

         }
 
         }
 

-        $user = $this->user->findOrFail($userId);
-        $sortKey = $listName . '_sort';
-        $orderKey = $listName . '_sort_order';
-        setting()->putUser($user, $sortKey, $sort);
-        setting()->putUser($user, $orderKey, $order);
-
-        return redirect()->back(302, [], "/settings/users/$userId");
+        setting()->putUser(user(), 'code-language-favourites', implode(',', $currentFavorites));

     }
 }
     }
 }