142 lines
No EOL
4 KiB
PHP
142 lines
No EOL
4 KiB
PHP
<?php namespace BookStack\Repos;
|
|
|
|
|
|
use BookStack\Exceptions\PermissionsException;
|
|
use BookStack\Permission;
|
|
use BookStack\Role;
|
|
use Setting;
|
|
|
|
class PermissionsRepo
|
|
{
|
|
|
|
protected $permission;
|
|
protected $role;
|
|
|
|
/**
|
|
* PermissionsRepo constructor.
|
|
* @param $permission
|
|
* @param $role
|
|
*/
|
|
public function __construct(Permission $permission, Role $role)
|
|
{
|
|
$this->permission = $permission;
|
|
$this->role = $role;
|
|
}
|
|
|
|
/**
|
|
* Get all the user roles from the system.
|
|
* @return \Illuminate\Database\Eloquent\Collection|static[]
|
|
*/
|
|
public function getAllRoles()
|
|
{
|
|
return $this->role->all();
|
|
}
|
|
|
|
/**
|
|
* Get all the roles except for the provided one.
|
|
* @param Role $role
|
|
* @return mixed
|
|
*/
|
|
public function getAllRolesExcept(Role $role)
|
|
{
|
|
return $this->role->where('id', '!=', $role->id)->get();
|
|
}
|
|
|
|
/**
|
|
* Get a role via its ID.
|
|
* @param $id
|
|
* @return mixed
|
|
*/
|
|
public function getRoleById($id)
|
|
{
|
|
return $this->role->findOrFail($id);
|
|
}
|
|
|
|
/**
|
|
* Save a new role into the system.
|
|
* @param array $roleData
|
|
* @return Role
|
|
*/
|
|
public function saveNewRole($roleData)
|
|
{
|
|
$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);
|
|
return $role;
|
|
}
|
|
|
|
/**
|
|
* Updates an existing role.
|
|
* Ensure Admin role always has all permissions.
|
|
* @param $roleId
|
|
* @param $roleData
|
|
*/
|
|
public function updateRole($roleId, $roleData)
|
|
{
|
|
$role = $this->role->findOrFail($roleId);
|
|
$permissions = isset($roleData['permissions']) ? array_keys($roleData['permissions']) : [];
|
|
$this->assignRolePermissions($role, $permissions);
|
|
|
|
if ($role->name === 'admin') {
|
|
$permissions = $this->permission->all()->pluck('id')->toArray();
|
|
$role->permissions()->sync($permissions);
|
|
}
|
|
|
|
$role->fill($roleData);
|
|
$role->save();
|
|
}
|
|
|
|
/**
|
|
* Assign an list of permission names to an role.
|
|
* @param Role $role
|
|
* @param array $permissionNameArray
|
|
*/
|
|
public function assignRolePermissions(Role $role, $permissionNameArray = [])
|
|
{
|
|
$permissions = [];
|
|
$permissionNameArray = array_values($permissionNameArray);
|
|
if ($permissionNameArray && count($permissionNameArray) > 0) {
|
|
$permissions = $this->permission->whereIn('name', $permissionNameArray)->pluck('id')->toArray();
|
|
}
|
|
$role->permissions()->sync($permissions);
|
|
}
|
|
|
|
/**
|
|
* Delete a role from the system.
|
|
* 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
|
|
*/
|
|
public function deleteRole($roleId, $migrateRoleId)
|
|
{
|
|
$role = $this->role->findOrFail($roleId);
|
|
|
|
// Prevent deleting admin role or default registration role.
|
|
if ($role->name === 'admin') {
|
|
throw new PermissionsException('The admin role cannot be deleted');
|
|
} else if ($role->id == setting('registration-role')) {
|
|
throw new PermissionsException('This role cannot be deleted while set as the default registration role.');
|
|
}
|
|
|
|
if ($migrateRoleId) {
|
|
$newRole = $this->role->find($migrateRoleId);
|
|
if ($newRole) {
|
|
$users = $role->users->pluck('id')->toArray();
|
|
$newRole->users()->sync($users);
|
|
}
|
|
}
|
|
|
|
$role->delete();
|
|
}
|
|
|
|
} |