X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/1ee3e779e4b9b0a92f701a72f21a72c83cb1ce68..refs/pull/2515/head:/app/Auth/Permissions/PermissionsRepo.php diff --git a/app/Auth/Permissions/PermissionsRepo.php b/app/Auth/Permissions/PermissionsRepo.php index e7840ff76..f54612a43 100644 --- a/app/Auth/Permissions/PermissionsRepo.php +++ b/app/Auth/Permissions/PermissionsRepo.php @@ -1,9 +1,11 @@ permission = $permission; $this->role = $role; @@ -29,64 +28,51 @@ class PermissionsRepo /** * Get all the user roles from the system. - * @return \Illuminate\Database\Eloquent\Collection|static[] */ - public function getAllRoles() + public function getAllRoles(): Collection { return $this->role->all(); } /** * Get all the roles except for the provided one. - * @param Role $role - * @return mixed */ - public function getAllRolesExcept(Role $role) + public function getAllRolesExcept(Role $role): Collection { return $this->role->where('id', '!=', $role->id)->get(); } /** * Get a role via its ID. - * @param $id - * @return mixed */ - public function getRoleById($id) + public function getRoleById($id): Role { - return $this->role->findOrFail($id); + return $this->role->newQuery()->findOrFail($id); } /** * Save a new role into the system. - * @param array $roleData - * @return Role */ - public function saveNewRole($roleData) + public function saveNewRole(array $roleData): Role { $role = $this->role->newInstance($roleData); - $role->name = str_replace(' ', '-', strtolower($roleData['display_name'])); - // Prevent duplicate names - while ($this->role->where('name', '=', $role->name)->count() > 0) { - $role->name .= strtolower(Str::random(2)); - } $role->save(); $permissions = isset($roleData['permissions']) ? array_keys($roleData['permissions']) : []; $this->assignRolePermissions($role, $permissions); $this->permissionService->buildJointPermissionForRole($role); + Activity::add(ActivityType::ROLE_CREATE, $role); return $role; } /** * Updates an existing role. * Ensure Admin role always have core permissions. - * @param $roleId - * @param $roleData - * @throws PermissionsException */ - public function updateRole($roleId, $roleData) + public function updateRole($roleId, array $roleData) { - $role = $this->role->findOrFail($roleId); + /** @var Role $role */ + $role = $this->role->newQuery()->findOrFail($roleId); $permissions = isset($roleData['permissions']) ? array_keys($roleData['permissions']) : []; if ($role->system_name === 'admin') { @@ -104,20 +90,24 @@ class PermissionsRepo $role->fill($roleData); $role->save(); $this->permissionService->buildJointPermissionForRole($role); + Activity::add(ActivityType::ROLE_UPDATE, $role); } /** * Assign an list of permission names to an role. - * @param Role $role - * @param array $permissionNameArray */ - public function assignRolePermissions(Role $role, $permissionNameArray = []) + protected function assignRolePermissions(Role $role, array $permissionNameArray = []) { $permissions = []; $permissionNameArray = array_values($permissionNameArray); - if ($permissionNameArray && count($permissionNameArray) > 0) { - $permissions = $this->permission->whereIn('name', $permissionNameArray)->pluck('id')->toArray(); + + if ($permissionNameArray) { + $permissions = $this->permission->newQuery() + ->whereIn('name', $permissionNameArray) + ->pluck('id') + ->toArray(); } + $role->permissions()->sync($permissions); } @@ -126,30 +116,31 @@ class PermissionsRepo * Check it's not an admin role or set as default before deleting. * If an migration Role ID is specified the users assign to the current role * will be added to the role of the specified id. - * @param $roleId - * @param $migrateRoleId * @throws PermissionsException + * @throws Exception */ public function deleteRole($roleId, $migrateRoleId) { - $role = $this->role->findOrFail($roleId); + /** @var Role $role */ + $role = $this->role->newQuery()->findOrFail($roleId); // Prevent deleting admin role or default registration role. if ($role->system_name && in_array($role->system_name, $this->systemRoles)) { throw new PermissionsException(trans('errors.role_system_cannot_be_deleted')); - } else if ($role->id == setting('registration-role')) { + } else if ($role->id === intval(setting('registration-role'))) { throw new PermissionsException(trans('errors.role_registration_default_cannot_delete')); } if ($migrateRoleId) { - $newRole = $this->role->find($migrateRoleId); + $newRole = $this->role->newQuery()->find($migrateRoleId); if ($newRole) { - $users = $role->users->pluck('id')->toArray(); + $users = $role->users()->pluck('id')->toArray(); $newRole->users()->sync($users); } } $this->permissionService->deleteJointPermissionsForRole($role); + Activity::add(ActivityType::ROLE_DELETE, $role); $role->delete(); } }