3 namespace BookStack\Http\Controllers;
5 use BookStack\Auth\Permissions\PermissionsRepo;
6 use BookStack\Exceptions\PermissionsException;
8 use Illuminate\Http\Request;
9 use Illuminate\Validation\ValidationException;
11 class RoleController extends Controller
13 protected $permissionsRepo;
16 * PermissionController constructor.
18 public function __construct(PermissionsRepo $permissionsRepo)
20 $this->permissionsRepo = $permissionsRepo;
24 * Show a listing of the roles in the system.
26 public function list()
28 $this->checkPermission('user-roles-manage');
29 $roles = $this->permissionsRepo->getAllRoles();
31 return view('settings.roles.index', ['roles' => $roles]);
35 * Show the form to create a new role.
37 public function create()
39 $this->checkPermission('user-roles-manage');
41 return view('settings.roles.create');
45 * Store a new role in the system.
47 public function store(Request $request)
49 $this->checkPermission('user-roles-manage');
50 $this->validate($request, [
51 'display_name' => 'required|min:3|max:180',
52 'description' => 'max:180',
55 $this->permissionsRepo->saveNewRole($request->all());
56 $this->showSuccessNotification(trans('settings.role_create_success'));
58 return redirect('/settings/roles');
62 * Show the form for editing a user role.
64 * @throws PermissionsException
66 public function edit(string $id)
68 $this->checkPermission('user-roles-manage');
69 $role = $this->permissionsRepo->getRoleById($id);
71 throw new PermissionsException(trans('errors.role_cannot_be_edited'));
74 return view('settings.roles.edit', ['role' => $role]);
78 * Updates a user role.
80 * @throws ValidationException
82 public function update(Request $request, string $id)
84 $this->checkPermission('user-roles-manage');
85 $this->validate($request, [
86 'display_name' => 'required|min:3|max:180',
87 'description' => 'max:180',
90 $this->permissionsRepo->updateRole($id, $request->all());
91 $this->showSuccessNotification(trans('settings.role_update_success'));
93 return redirect('/settings/roles');
97 * Show the view to delete a role.
98 * Offers the chance to migrate users.
100 public function showDelete(string $id)
102 $this->checkPermission('user-roles-manage');
103 $role = $this->permissionsRepo->getRoleById($id);
104 $roles = $this->permissionsRepo->getAllRolesExcept($role);
105 $blankRole = $role->newInstance(['display_name' => trans('settings.role_delete_no_migration')]);
106 $roles->prepend($blankRole);
108 return view('settings.roles.delete', ['role' => $role, 'roles' => $roles]);
112 * Delete a role from the system,
113 * Migrate from a previous role if set.
117 public function delete(Request $request, string $id)
119 $this->checkPermission('user-roles-manage');
122 $this->permissionsRepo->deleteRole($id, $request->get('migrate_role_id'));
123 } catch (PermissionsException $e) {
124 $this->showErrorNotification($e->getMessage());
126 return redirect()->back();
129 $this->showSuccessNotification(trans('settings.role_delete_success'));
131 return redirect('/settings/roles');