Code cleanup, bug squashing

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

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index 92dc3cdaaa9d00f478c46e72a06b70c9f03d3579..1713565fcdf8685770725bd23bfec3f199f4bd75 100644 (file)
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -1,33 +1,36 @@
 <?php namespace BookStack\Http\Controllers;
 
 <?php 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\User;
 use BookStack\Auth\UserRepo;
 use BookStack\Auth\User;
 use BookStack\Auth\UserRepo;

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

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

-use Illuminate\Http\Response;
+use Illuminate\Support\Str;

 
 class UserController extends Controller
 {
 
     protected $user;
     protected $userRepo;
 
 class UserController extends Controller
 {
 
     protected $user;
     protected $userRepo;

+    protected $inviteService;
+    protected $imageRepo;

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

-     * @param User     $user
-     * @param \BookStack\Auth\UserRepo $userRepo

      */
      */

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

     {
         $this->user = $user;
         $this->userRepo = $userRepo;
     {
         $this->user = $user;
         $this->userRepo = $userRepo;

-        parent::__construct();
+        $this->inviteService = $inviteService;
+        $this->imageRepo = $imageRepo;

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

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

      */
     public function index(Request $request)
     {
      */
     public function index(Request $request)
     {


@@ -40,39 +43,40 @@ class UserController extends Controller
         $users = $this->userRepo->getAllUsersPaginatedAndSorted(20, $listDetails);
         $this->setPageTitle(trans('settings.users'));
         $users->appends($listDetails);
         $users = $this->userRepo->getAllUsersPaginatedAndSorted(20, $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]);

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

-        return view('users/create', ['authMethod' => $authMethod, 'roles' => $roles]);
+        return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);

     }
 
     /**
      * Store a newly created user in storage.
     }
 
     /**
      * Store a newly created user in storage.

-     * @param  Request $request
-     * @return Response
+     * @throws UserUpdateException
+     * @throws \Illuminate\Validation\ValidationException

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

-            'name'             => 'required',
-            'email'            => 'required|email|unique:users,email'
+            'name'  => 'required',
+            'email' => 'required|email|unique:users,email'

         ];
 
         $authMethod = config('auth.method');
         ];
 
         $authMethod = config('auth.method');

-        if ($authMethod === 'standard') {
-            $validationRules['password'] = 'required|min:5';
+        $sendInvite = ($request->get('send_invite', 'false') === 'true');
+
+        if ($authMethod === 'standard' && !$sendInvite) {
+            $validationRules['password'] = 'required|min:6';

             $validationRules['password-confirm'] = 'required|same:password';
             $validationRules['password-confirm'] = 'required|same:password';

-        } elseif ($authMethod === 'ldap') {
+        } elseif ($authMethod === 'ldap' || $authMethod === 'saml2') {

             $validationRules['external_auth_id'] = 'required';
         }
         $this->validate($request, $validationRules);
             $validationRules['external_auth_id'] = 'required';
         }
         $this->validate($request, $validationRules);


@@ -80,73 +84,82 @@ class UserController extends Controller
         $user = $this->user->fill($request->all());
 
         if ($authMethod === 'standard') {
         $user = $this->user->fill($request->all());
 
         if ($authMethod === 'standard') {

-            $user->password = bcrypt($request->get('password'));
-        } elseif ($authMethod === 'ldap') {
+            $user->password = bcrypt($request->get('password', Str::random(32)));
+        } elseif ($authMethod === 'ldap' || $authMethod === 'saml2') {

             $user->external_auth_id = $request->get('external_auth_id');
         }
 
         $user->save();
 
             $user->external_auth_id = $request->get('external_auth_id');
         }
 
         $user->save();
 

+        if ($sendInvite) {
+            $this->inviteService->sendInvitation($user);
+        }
+

         if ($request->filled('roles')) {
             $roles = $request->get('roles');
         if ($request->filled('roles')) {
             $roles = $request->get('roles');

-            $user->roles()->sync($roles);
+            $this->userRepo->setUserRoles($user, $roles);

         }
 
         }
 

-        $this->userRepo->downloadGravatarToUserAvatar($user);
+        $this->userRepo->downloadAndAssignUserAvatar($user);

 
 

+        $this->logActivity(ActivityType::USER_CREATE, $user);

         return redirect('/settings/users');
     }
 
     /**
      * Show the form for editing the specified user.
         return redirect('/settings/users');
     }
 
     /**
      * Show the form for editing the specified user.

-     * @param  int              $id
-     * @param \BookStack\Auth\Access\SocialAuthService $socialAuthService
-     * @return Response

      */
      */

-    public function edit($id, SocialAuthService $socialAuthService)
+    public function edit(int $id, SocialAuthService $socialAuthService)

     {
     {

-        $this->checkPermissionOr('users-manage', function () use ($id) {
-            return $this->currentUser->id == $id;
-        });
+        $this->checkPermissionOrCurrentUser('users-manage', $id);

 
 

-        $user = $this->user->findOrFail($id);
+        $user = $this->user->newQuery()->with(['apiTokens'])->findOrFail($id);

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

-        return view('users/edit', ['user' => $user, 'activeSocialDrivers' => $activeSocialDrivers, 'authMethod' => $authMethod, 'roles' => $roles]);
+        return view('users.edit', [
+            'user' => $user,
+            'activeSocialDrivers' => $activeSocialDrivers,
+            '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 \BookStack\Exceptions\ImageUploadException
+     * @throws \Illuminate\Validation\ValidationException

      */
      */

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

     {
     {

-        $this->preventAccessForDemoUsers();
-        $this->checkPermissionOr('users-manage', function () use ($id) {
-            return $this->currentUser->id == $id;
-        });
+        $this->preventAccessInDemoMode();
+        $this->checkPermissionOrCurrentUser('users-manage', $id);

 
         $this->validate($request, [
             'name'             => 'min:2',
             'email'            => 'min:2|email|unique:users,email,' . $id,
 
         $this->validate($request, [
             'name'             => 'min:2',
             'email'            => 'min:2|email|unique:users,email,' . $id,

-            'password'         => 'min:5|required_with:password_confirm',
+            'password'         => 'min:6|required_with:password_confirm',

             'password-confirm' => 'same:password|required_with:password',
             'password-confirm' => 'same:password|required_with:password',

-            'setting'          => 'array'
+            'setting'          => 'array',
+            'profile_image'    => 'nullable|' . $this->getImageValidationRules(),

         ]);
 
         ]);
 

-        $user = $this->user->findOrFail($id);
-        $user->fill($request->all());
+        $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');
 
         // Role updates
         if (userCan('users-manage') && $request->filled('roles')) {
             $roles = $request->get('roles');

-            $user->roles()->sync($roles);
+            $this->userRepo->setUserRoles($user, $roles);

         }
 
         // Password updates
         }
 
         // Password updates


@@ -156,7 +169,7 @@ class UserController extends Controller
         }
 
         // External auth id updates
         }
 
         // External auth id updates

-        if ($this->currentUser->can('users-manage') && $request->filled('external_auth_id')) {
+        if (user()->can('users-manage') && $request->filled('external_auth_id')) {

             $user->external_auth_id = $request->get('external_auth_id');
         }
 
             $user->external_auth_id = $request->get('external_auth_id');
         }
 


@@ -167,71 +180,79 @@ class UserController extends Controller
             }
         }
 
             }
         }
 

+        // Save profile image if in request
+        if ($request->hasFile('profile_image')) {
+            $imageUpload = $request->file('profile_image');
+            $this->imageRepo->destroyImage($user->avatar);
+            $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
+            $user->image_id = $image->id;
+        }
+
+        // Delete the profile image if set to
+        if ($request->has('profile_image_reset')) {
+            $this->imageRepo->destroyImage($user->avatar);
+        }
+

         $user->save();
         $user->save();

-        session()->flash('success', trans('settings.users_edit_success'));
+        $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);
     }
 
     /**
      * 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->checkPermissionOr('users-manage', function () use ($id) {
-            return $this->currentUser->id == $id;
-        });
+        $this->checkPermissionOrCurrentUser('users-manage', $id);

 
 

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

         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));
         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));

-        return view('users/delete', ['user' => $user]);
+        return view('users.delete', ['user' => $user]);

     }
 
     /**
      * Remove the specified user from storage.
     }
 
     /**
      * Remove the specified user from storage.

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

      */
      */

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

     {
     {

-        $this->preventAccessForDemoUsers();
-        $this->checkPermissionOr('users-manage', function () use ($id) {
-            return $this->currentUser->id == $id;
-        });
+        $this->preventAccessInDemoMode();
+        $this->checkPermissionOrCurrentUser('users-manage', $id);

 
         $user = $this->userRepo->getById($id);
 
         if ($this->userRepo->isOnlyAdmin($user)) {
 
         $user = $this->userRepo->getById($id);
 
         if ($this->userRepo->isOnlyAdmin($user)) {

-            session()->flash('error', trans('errors.users_cannot_delete_only_admin'));
+            $this->showErrorNotification(trans('errors.users_cannot_delete_only_admin'));

             return redirect($user->getEditUrl());
         }
 
         if ($user->system_name === 'public') {
             return redirect($user->getEditUrl());
         }
 
         if ($user->system_name === 'public') {

-            session()->flash('error', trans('errors.users_cannot_delete_guest'));
+            $this->showErrorNotification(trans('errors.users_cannot_delete_guest'));

             return redirect($user->getEditUrl());
         }
 
         $this->userRepo->destroy($user);
             return redirect($user->getEditUrl());
         }
 
         $this->userRepo->destroy($user);

-        session()->flash('success', trans('settings.users_delete_success'));
+        $this->showSuccessNotification(trans('settings.users_delete_success'));
+        $this->logActivity(ActivityType::USER_DELETE, $user);

 
         return redirect('/settings/users');
     }
 
     /**
      * Show the user profile page
 
         return redirect('/settings/users');
     }
 
     /**
      * Show the user profile page

-     * @param $id
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View

      */
     public function showProfilePage($id)
     {
         $user = $this->userRepo->getById($id);
      */
     public function showProfilePage($id)
     {
         $user = $this->userRepo->getById($id);

+

         $userActivity = $this->userRepo->getActivity($user);
         $userActivity = $this->userRepo->getActivity($user);

-        $recentlyCreated = $this->userRepo->getRecentlyCreated($user, 5, 0);
+        $recentlyCreated = $this->userRepo->getRecentlyCreated($user, 5);

         $assetCounts = $this->userRepo->getAssetCounts($user);
         $assetCounts = $this->userRepo->getAssetCounts($user);

-        return view('users/profile', [
+
+        return view('users.profile', [

             'user' => $user,
             'activity' => $userActivity,
             'recentlyCreated' => $recentlyCreated,
             'user' => $user,
             'activity' => $userActivity,
             'recentlyCreated' => $recentlyCreated,


@@ -241,34 +262,32 @@ class UserController extends Controller
 
     /**
      * Update the user's preferred book-list display setting.
 
     /**
      * Update the user's preferred book-list display setting.

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

      */
      */

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

     {
         return $this->switchViewType($id, $request, 'books');
     }
 
     /**
      * Update the user's preferred shelf-list display setting.
     {
         return $this->switchViewType($id, $request, 'books');
     }
 
     /**
      * Update the user's preferred shelf-list display setting.

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

      */
      */

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

     {
         return $this->switchViewType($id, $request, 'bookshelves');
     }
 
     {
         return $this->switchViewType($id, $request, 'bookshelves');
     }
 

+    /**
+     * Update the user's preferred shelf-view book list display setting.
+     */
+    public function switchShelfView(Request $request, int $id)
+    {
+        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);
 


@@ -277,7 +296,7 @@ class UserController extends Controller
             $viewType = 'list';
         }
 
             $viewType = 'list';
         }
 

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

         $key = $listName . '_view_type';
         setting()->putUser($user, $key, $viewType);
 
         $key = $listName . '_view_type';
         setting()->putUser($user, $key, $viewType);
 


@@ -285,23 +304,47 @@ class UserController extends Controller
     }
 
     /**
     }
 
     /**

-     * Change the stored sort type for the books view.
-     * @param $id
-     * @param Request $request
-     * @return \Illuminate\Http\RedirectResponse
+     * Change the stored sort type for a particular view.
+     */
+    public function changeSort(Request $request, string $id, string $type)
+    {
+        $validSortTypes = ['books', 'bookshelves'];
+        if (!in_array($type, $validSortTypes)) {
+            return redirect()->back(500);
+        }
+        return $this->changeListSort($id, $request, $type);
+    }
+
+    /**
+     * Toggle dark mode for the current user.

      */
      */

-    public function changeBooksSort($id, Request $request)
+    public function toggleDarkMode()

     {
     {

-        // TODO - Test this endpoint
-        return $this->changeListSort($id, $request, 'books');
+        $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.
+     */
+    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);
+        }
+
+        $newState = $request->get('expand', 'false');
+
+        $user = $this->user->findOrFail($id);
+        setting()->putUser($user, 'section_expansion#' . $key, $newState);
+        return response("", 204);

     }
 
     /**
      * Changed the stored preference for a list sort order.
     }
 
     /**
      * 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)
     {
      */
     protected function changeListSort(int $userId, Request $request, string $listName)
     {


@@ -325,5 +368,4 @@ class UserController extends Controller
 
         return redirect()->back(302, [], "/settings/users/$userId");
     }
 
         return redirect()->back(302, [], "/settings/users/$userId");
     }

-

 }
 }