1 <?php namespace BookStack\Http\Controllers;
3 use BookStack\Auth\Permissions\PermissionsRepo;
4 use BookStack\Exceptions\PermissionsException;
6 use Illuminate\Http\Request;
7 use Illuminate\Validation\ValidationException;
9 class RoleController extends Controller
12 protected $permissionsRepo;
15 * PermissionController constructor.
17 public function __construct(PermissionsRepo $permissionsRepo)
19 $this->permissionsRepo = $permissionsRepo;
23 * Show a listing of the roles in the system.
25 public function list()
27 $this->checkPermission('user-roles-manage');
28 $roles = $this->permissionsRepo->getAllRoles();
29 return view('settings.roles.index', ['roles' => $roles]);
33 * Show the form to create a new role
35 public function create()
37 $this->checkPermission('user-roles-manage');
38 return view('settings.roles.create');
42 * Store a new role in the system.
44 public function store(Request $request)
46 $this->checkPermission('user-roles-manage');
47 $this->validate($request, [
48 'display_name' => 'required|min:3|max:180',
49 'description' => 'max:180'
52 $this->permissionsRepo->saveNewRole($request->all());
53 $this->showSuccessNotification(trans('settings.role_create_success'));
54 return redirect('/settings/roles');
58 * Show the form for editing a user role.
59 * @throws PermissionsException
61 public function edit(string $id)
63 $this->checkPermission('user-roles-manage');
64 $role = $this->permissionsRepo->getRoleById($id);
66 throw new PermissionsException(trans('errors.role_cannot_be_edited'));
68 return view('settings.roles.edit', ['role' => $role]);
72 * Updates a user role.
73 * @throws ValidationException
75 public function update(Request $request, string $id)
77 $this->checkPermission('user-roles-manage');
78 $this->validate($request, [
79 'display_name' => 'required|min:3|max:180',
80 'description' => 'max:180'
83 $this->permissionsRepo->updateRole($id, $request->all());
84 $this->showSuccessNotification(trans('settings.role_update_success'));
85 return redirect('/settings/roles');
89 * Show the view to delete a role.
90 * Offers the chance to migrate users.
92 public function showDelete(string $id)
94 $this->checkPermission('user-roles-manage');
95 $role = $this->permissionsRepo->getRoleById($id);
96 $roles = $this->permissionsRepo->getAllRolesExcept($role);
97 $blankRole = $role->newInstance(['display_name' => trans('settings.role_delete_no_migration')]);
98 $roles->prepend($blankRole);
99 return view('settings.roles.delete', ['role' => $role, 'roles' => $roles]);
103 * Delete a role from the system,
104 * Migrate from a previous role if set.
107 public function delete(Request $request, string $id)
109 $this->checkPermission('user-roles-manage');
112 $this->permissionsRepo->deleteRole($id, $request->get('migrate_role_id'));
113 } catch (PermissionsException $e) {
114 $this->showErrorNotification($e->getMessage());
115 return redirect()->back();
118 $this->showSuccessNotification(trans('settings.role_delete_success'));
119 return redirect('/settings/roles');