Fixed failing webhook test cases

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

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index 55a4610bcbdd3052acdeab15d28e707df0677e48..a78f921f21e2ea187b906be6e3b4783d77d70e23 100644 (file)
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -1,18 +1,23 @@
-<?php namespace BookStack\Http\Controllers;
+<?php

 
 

+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\ActivityType;

 use BookStack\Auth\Access\SocialAuthService;
 use BookStack\Auth\Access\UserInviteService;
 use BookStack\Auth\User;
 use BookStack\Auth\UserRepo;
 use BookStack\Auth\Access\SocialAuthService;
 use BookStack\Auth\Access\UserInviteService;
 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 Exception;

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

-use Illuminate\Http\Response;

 use Illuminate\Support\Str;
 use Illuminate\Support\Str;

+use Illuminate\Validation\Rules\Password;
+use Illuminate\Validation\ValidationException;

 
 class UserController extends Controller
 {
 
 class UserController extends Controller
 {

-

     protected $user;
     protected $userRepo;
     protected $inviteService;
     protected $user;
     protected $userRepo;
     protected $inviteService;


@@ -20,10 +25,6 @@ class UserController extends Controller
 
     /**
      * 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(User $user, UserRepo $userRepo, UserInviteService $inviteService, ImageRepo $imageRepo)
     {


@@ -31,62 +32,61 @@ class UserController extends Controller
         $this->userRepo = $userRepo;
         $this->inviteService = $inviteService;
         $this->imageRepo = $imageRepo;
         $this->userRepo = $userRepo;
         $this->inviteService = $inviteService;
         $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');
         $listDetails = [
      */
     public function index(Request $request)
     {
         $this->checkPermission('users-manage');
         $listDetails = [

-            'order' => $request->get('order', 'asc'),
+            'order'  => $request->get('order', 'asc'),

             'search' => $request->get('search', ''),
             'search' => $request->get('search', ''),

-            'sort' => $request->get('sort', 'name'),
+            'sort'   => $request->get('sort', 'name'),

         ];
         $users = $this->userRepo->getAllUsersPaginatedAndSorted(20, $listDetails);
         ];
         $users = $this->userRepo->getAllUsersPaginatedAndSorted(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]);
     }
 
     /**
      * Show the form for creating a new user.
         return view('users.index', ['users' => $users, 'listDetails' => $listDetails]);
     }
 
     /**
      * 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]);
     }
 
     /**
      * Store a newly created user in storage.
         return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);
     }
 
     /**
      * Store a newly created user in storage.

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

      * @throws UserUpdateException
      * @throws UserUpdateException

+     * @throws 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');
         $sendInvite = ($request->get('send_invite', 'false') === 'true');
 
         if ($authMethod === 'standard' && !$sendInvite) {
         ];
 
         $authMethod = config('auth.method');
         $sendInvite = ($request->get('send_invite', 'false') === 'true');
 
         if ($authMethod === 'standard' && !$sendInvite) {

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


@@ -94,10 +94,11 @@ class UserController extends Controller
 
         if ($authMethod === 'standard') {
             $user->password = bcrypt($request->get('password', Str::random(32)));
 
         if ($authMethod === 'standard') {
             $user->password = bcrypt($request->get('password', Str::random(32)));

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

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

+        $user->refreshSlug();

         $user->save();
 
         if ($sendInvite) {
         $user->save();
 
         if ($sendInvite) {


@@ -111,6 +112,8 @@ class UserController extends Controller
 
         $this->userRepo->downloadAndAssignUserAvatar($user);
 
 
         $this->userRepo->downloadAndAssignUserAvatar($user);
 

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

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


@@ -121,41 +124,44 @@ 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 = $this->user->newQuery()->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'));
         $roles = $this->userRepo->getAllRoles();
         $this->setPageTitle(trans('settings.user_profile'));
         $roles = $this->userRepo->getAllRoles();

+

         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->validate($request, [
     {
         $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'    => 'nullable|' . $this->getImageValidationRules(),
+            'name'             => ['min:2'],
+            'email'            => ['min:2', 'email', 'unique:users,email,' . $id],
+            'password'         => ['required_with:password_confirm', Password::default()],
+            'password-confirm' => ['same:password', 'required_with:password'],
+            'setting'          => ['array'],
+            'profile_image'    => array_merge(['nullable'], $this->getImageValidationRules()),

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


@@ -166,6 +172,11 @@ class UserController extends Controller
             $user->email = $request->get('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');
         // Role updates
         if (userCan('users-manage') && $request->filled('roles')) {
             $roles = $request->get('roles');


@@ -198,112 +209,93 @@ class UserController extends Controller
             $user->image_id = $image->id;
         }
 
             $user->image_id = $image->id;
         }
 

-        // 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);
         }
 
         $user->save();
         $this->showSuccessNotification(trans('settings.users_edit_success'));
         if ($request->has('profile_image_reset')) {
             $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);
     }
 
     /**
      * 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'));
 
         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());
         }
 
         if ($user->system_name === 'public') {
             $this->showErrorNotification(trans('errors.users_cannot_delete_guest'));

+

             return redirect($user->getEditUrl());
         }
 
             return redirect($user->getEditUrl());
         }
 

-        $this->userRepo->destroy($user);
+        $this->userRepo->destroy($user, $newOwnerId);

         $this->showSuccessNotification(trans('settings.users_delete_success'));
         $this->showSuccessNotification(trans('settings.users_delete_success'));

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

 
         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,55 +313,56 @@ 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'];

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

+

         return $this->changeListSort($id, $request, $type);
     }
 
         return $this->changeListSort($id, $request, $type);
     }
 

+    /**
+     * 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');
 
         $user = $this->user->findOrFail($id);
         setting()->putUser($user, 'section_expansion#' . $key, $newState);
         }
 
         $newState = $request->get('expand', 'false');
 
         $user = $this->user->findOrFail($id);
         setting()->putUser($user, 'section_expansion#' . $key, $newState);

-        return response("", 204);
+
+        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)
     {
         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 
         $sort = $request->get('sort');
      */
     protected function changeListSort(int $userId, Request $request, string $listName)
     {
         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 
         $sort = $request->get('sort');

-        if (!in_array($sort, ['name', 'created_at', 'updated_at'])) {
+        if (!in_array($sort, ['name', 'created_at', 'updated_at', 'default'])) {

             $sort = 'name';
         }
 
             $sort = 'name';
         }