2016-02-28 14:03:04 -05:00
|
|
|
<?php namespace BookStack\Services;
|
|
|
|
|
2016-04-20 16:37:57 -04:00
|
|
|
use BookStack\Book;
|
|
|
|
use BookStack\Chapter;
|
2016-02-29 15:31:21 -05:00
|
|
|
use BookStack\Entity;
|
2016-04-20 16:37:57 -04:00
|
|
|
use BookStack\EntityPermission;
|
|
|
|
use BookStack\Page;
|
|
|
|
use BookStack\Role;
|
|
|
|
use Illuminate\Database\Eloquent\Collection;
|
2016-02-29 15:31:21 -05:00
|
|
|
|
2016-02-28 14:03:04 -05:00
|
|
|
class RestrictionService
|
|
|
|
{
|
|
|
|
|
|
|
|
protected $userRoles;
|
|
|
|
protected $isAdmin;
|
|
|
|
protected $currentAction;
|
2016-03-13 08:04:08 -04:00
|
|
|
protected $currentUser;
|
2016-02-28 14:03:04 -05:00
|
|
|
|
2016-04-20 16:37:57 -04:00
|
|
|
public $book;
|
|
|
|
public $chapter;
|
|
|
|
public $page;
|
|
|
|
|
|
|
|
protected $entityPermission;
|
|
|
|
protected $role;
|
2016-04-23 13:14:26 -04:00
|
|
|
|
|
|
|
protected $actions = ['view', 'create', 'update', 'delete'];
|
2016-04-20 16:37:57 -04:00
|
|
|
|
2016-02-28 14:03:04 -05:00
|
|
|
/**
|
|
|
|
* RestrictionService constructor.
|
2016-04-23 13:14:26 -04:00
|
|
|
* TODO - Handle events when roles or entities change.
|
2016-04-20 16:37:57 -04:00
|
|
|
* @param EntityPermission $entityPermission
|
|
|
|
* @param Book $book
|
|
|
|
* @param Chapter $chapter
|
|
|
|
* @param Page $page
|
|
|
|
* @param Role $role
|
2016-02-28 14:03:04 -05:00
|
|
|
*/
|
2016-04-23 13:14:26 -04:00
|
|
|
public function __construct(EntityPermission $entityPermission, Book $book, Chapter $chapter, Page $page, Role $role)
|
2016-02-28 14:03:04 -05:00
|
|
|
{
|
2016-03-13 08:04:08 -04:00
|
|
|
$this->currentUser = auth()->user();
|
|
|
|
$this->userRoles = $this->currentUser ? $this->currentUser->roles->pluck('id') : [];
|
|
|
|
$this->isAdmin = $this->currentUser ? $this->currentUser->hasRole('admin') : false;
|
2016-04-20 16:37:57 -04:00
|
|
|
|
|
|
|
$this->entityPermission = $entityPermission;
|
|
|
|
$this->role = $role;
|
|
|
|
$this->book = $book;
|
|
|
|
$this->chapter = $chapter;
|
|
|
|
$this->page = $page;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Re-generate all entity permission from scratch.
|
|
|
|
*/
|
|
|
|
public function buildEntityPermissions()
|
|
|
|
{
|
|
|
|
$this->entityPermission->truncate();
|
|
|
|
|
|
|
|
// Get all roles (Should be the most limited dimension)
|
|
|
|
$roles = $this->role->load('permissions')->all();
|
|
|
|
|
|
|
|
// Chunk through all books
|
|
|
|
$this->book->chunk(500, function ($books) use ($roles) {
|
|
|
|
$this->createManyEntityPermissions($books, $roles);
|
|
|
|
});
|
|
|
|
|
|
|
|
// Chunk through all chapters
|
2016-04-23 13:14:26 -04:00
|
|
|
$this->chapter->with('book')->chunk(500, function ($books) use ($roles) {
|
2016-04-20 16:37:57 -04:00
|
|
|
$this->createManyEntityPermissions($books, $roles);
|
|
|
|
});
|
|
|
|
|
|
|
|
// Chunk through all pages
|
2016-04-23 13:14:26 -04:00
|
|
|
$this->page->with('book', 'chapter')->chunk(500, function ($books) use ($roles) {
|
2016-04-20 16:37:57 -04:00
|
|
|
$this->createManyEntityPermissions($books, $roles);
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create & Save entity permissions for many entities and permissions.
|
|
|
|
* @param Collection $entities
|
|
|
|
* @param Collection $roles
|
|
|
|
*/
|
|
|
|
protected function createManyEntityPermissions($entities, $roles)
|
|
|
|
{
|
|
|
|
$entityPermissions = [];
|
|
|
|
foreach ($entities as $entity) {
|
|
|
|
foreach ($roles as $role) {
|
2016-04-23 13:14:26 -04:00
|
|
|
foreach ($this->actions as $action) {
|
|
|
|
$entityPermissions[] = $this->createEntityPermissionData($entity, $role, $action);
|
|
|
|
}
|
2016-04-20 16:37:57 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
$this->entityPermission->insert($entityPermissions);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2016-04-23 13:14:26 -04:00
|
|
|
protected function createEntityPermissionData(Entity $entity, Role $role, $action)
|
2016-04-20 16:37:57 -04:00
|
|
|
{
|
2016-04-23 13:14:26 -04:00
|
|
|
$permissionPrefix = $entity->getType() . '-' . $action;
|
|
|
|
$roleHasPermission = $role->hasPermission($permissionPrefix . '-all');
|
|
|
|
$roleHasPermissionOwn = $role->hasPermission($permissionPrefix . '-own');
|
|
|
|
|
|
|
|
if ($entity->isA('book')) {
|
|
|
|
|
|
|
|
if (!$entity->restricted) {
|
|
|
|
return $this->createEntityPermissionDataArray($entity, $role, $action, $roleHasPermission, $roleHasPermissionOwn);
|
|
|
|
} else {
|
|
|
|
$hasAccess = $entity->hasRestriction($role->id, $action);
|
|
|
|
return $this->createEntityPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
|
|
|
|
}
|
|
|
|
|
|
|
|
} elseif ($entity->isA('chapter')) {
|
|
|
|
|
|
|
|
if (!$entity->restricted) {
|
|
|
|
$hasAccessToBook = $entity->book->hasRestriction($role->id, $action);
|
|
|
|
return $this->createEntityPermissionDataArray($entity, $role, $action,
|
|
|
|
($roleHasPermission && $hasAccessToBook), ($roleHasPermissionOwn && $hasAccessToBook));
|
|
|
|
} else {
|
|
|
|
$hasAccess = $entity->hasRestriction($role->id, $action);
|
|
|
|
return $this->createEntityPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
|
|
|
|
}
|
|
|
|
|
|
|
|
} elseif ($entity->isA('page')) {
|
|
|
|
|
|
|
|
if (!$entity->restricted) {
|
|
|
|
$hasAccessToBook = $entity->book->hasRestriction($role->id, $action);
|
|
|
|
$hasAccessToChapter = $entity->chapter ? ($entity->chapter->hasRestriction($role->id, $action)) : true;
|
|
|
|
return $this->createEntityPermissionDataArray($entity, $role, $action,
|
|
|
|
($roleHasPermission && $hasAccessToBook && $hasAccessToChapter),
|
|
|
|
($roleHasPermissionOwn && $hasAccessToBook && $hasAccessToChapter));
|
|
|
|
} else {
|
|
|
|
$hasAccess = $entity->hasRestriction($role->id, $action);
|
|
|
|
return $this->createEntityPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function createEntityPermissionDataArray(Entity $entity, Role $role, $action, $permissionAll, $permissionOwn)
|
|
|
|
{
|
|
|
|
$entityClass = get_class($entity);
|
|
|
|
return [
|
|
|
|
'role_id' => $role->id,
|
|
|
|
'entity_id' => $entity->id,
|
|
|
|
'entity_type' => $entityClass,
|
|
|
|
'action' => $action,
|
|
|
|
'has_permission' => $permissionAll,
|
|
|
|
'has_permission_own' => $permissionOwn,
|
|
|
|
'created_by' => $entity->created_by
|
|
|
|
];
|
2016-02-29 15:31:21 -05:00
|
|
|
}
|
|
|
|
|
2016-03-05 13:09:21 -05:00
|
|
|
/**
|
|
|
|
* Checks if an entity has a restriction set upon it.
|
|
|
|
* @param Entity $entity
|
|
|
|
* @param $action
|
|
|
|
* @return bool
|
|
|
|
*/
|
2016-02-29 15:31:21 -05:00
|
|
|
public function checkIfEntityRestricted(Entity $entity, $action)
|
|
|
|
{
|
|
|
|
if ($this->isAdmin) return true;
|
|
|
|
$this->currentAction = $action;
|
|
|
|
$baseQuery = $entity->where('id', '=', $entity->id);
|
|
|
|
if ($entity->isA('page')) {
|
|
|
|
return $this->pageRestrictionQuery($baseQuery)->count() > 0;
|
|
|
|
} elseif ($entity->isA('chapter')) {
|
|
|
|
return $this->chapterRestrictionQuery($baseQuery)->count() > 0;
|
|
|
|
} elseif ($entity->isA('book')) {
|
|
|
|
return $this->bookRestrictionQuery($baseQuery)->count() > 0;
|
|
|
|
}
|
|
|
|
return false;
|
2016-02-28 14:03:04 -05:00
|
|
|
}
|
|
|
|
|
2016-03-30 15:15:44 -04:00
|
|
|
/**
|
|
|
|
* Check if an entity has restrictions set on itself or its
|
|
|
|
* parent tree.
|
|
|
|
* @param Entity $entity
|
|
|
|
* @param $action
|
|
|
|
* @return bool|mixed
|
|
|
|
*/
|
|
|
|
public function checkIfRestrictionsSet(Entity $entity, $action)
|
|
|
|
{
|
|
|
|
$this->currentAction = $action;
|
|
|
|
if ($entity->isA('page')) {
|
|
|
|
return $entity->restricted || ($entity->chapter && $entity->chapter->restricted) || $entity->book->restricted;
|
|
|
|
} elseif ($entity->isA('chapter')) {
|
|
|
|
return $entity->restricted || $entity->book->restricted;
|
|
|
|
} elseif ($entity->isA('book')) {
|
|
|
|
return $entity->restricted;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-28 14:03:04 -05:00
|
|
|
/**
|
|
|
|
* Add restrictions for a page query
|
|
|
|
* @param $query
|
|
|
|
* @param string $action
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function enforcePageRestrictions($query, $action = 'view')
|
|
|
|
{
|
2016-03-13 08:04:08 -04:00
|
|
|
// Prevent drafts being visible to others.
|
2016-03-13 09:30:47 -04:00
|
|
|
$query = $query->where(function ($query) {
|
2016-03-13 08:04:08 -04:00
|
|
|
$query->where('draft', '=', false);
|
|
|
|
if ($this->currentUser) {
|
2016-03-13 09:30:47 -04:00
|
|
|
$query->orWhere(function ($query) {
|
2016-03-13 08:04:08 -04:00
|
|
|
$query->where('draft', '=', true)->where('created_by', '=', $this->currentUser->id);
|
|
|
|
});
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
2016-02-28 14:03:04 -05:00
|
|
|
if ($this->isAdmin) return $query;
|
|
|
|
$this->currentAction = $action;
|
2016-04-23 13:14:26 -04:00
|
|
|
return $this->entityRestrictionQuery($query);
|
2016-02-28 14:03:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-04-23 13:14:26 -04:00
|
|
|
* The general query filter to remove all entities
|
|
|
|
* that the current user does not have access to.
|
2016-02-28 14:03:04 -05:00
|
|
|
* @param $query
|
|
|
|
* @return mixed
|
|
|
|
*/
|
2016-04-23 13:14:26 -04:00
|
|
|
protected function entityRestrictionQuery($query)
|
2016-02-28 14:03:04 -05:00
|
|
|
{
|
2016-04-23 13:14:26 -04:00
|
|
|
return $query->where(function ($parentQuery) {
|
|
|
|
$parentQuery->whereHas('permissions', function ($permissionQuery) {
|
|
|
|
$permissionQuery->whereIn('role_id', $this->userRoles)
|
|
|
|
->where('action', '=', $this->currentAction)
|
|
|
|
->where(function ($query) {
|
|
|
|
$query->where('has_permission', '=', true)
|
|
|
|
->orWhere(function ($query) {
|
|
|
|
$query->where('has_permission_own', '=', true)
|
|
|
|
->where('created_by', '=', $this->currentUser->id);
|
2016-02-28 14:03:04 -05:00
|
|
|
});
|
|
|
|
});
|
2016-04-23 13:14:26 -04:00
|
|
|
});
|
2016-02-28 14:03:04 -05:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add on permission restrictions to a chapter query.
|
|
|
|
* @param $query
|
|
|
|
* @param string $action
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function enforceChapterRestrictions($query, $action = 'view')
|
|
|
|
{
|
|
|
|
if ($this->isAdmin) return $query;
|
|
|
|
$this->currentAction = $action;
|
2016-04-23 13:14:26 -04:00
|
|
|
return $this->entityRestrictionQuery($query);
|
2016-02-28 14:03:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add restrictions to a book query.
|
|
|
|
* @param $query
|
|
|
|
* @param string $action
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function enforceBookRestrictions($query, $action = 'view')
|
|
|
|
{
|
|
|
|
if ($this->isAdmin) return $query;
|
|
|
|
$this->currentAction = $action;
|
2016-04-23 13:14:26 -04:00
|
|
|
return $this->entityRestrictionQuery($query);
|
2016-02-28 14:03:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter items that have entities set a a polymorphic relation.
|
|
|
|
* @param $query
|
|
|
|
* @param string $tableName
|
|
|
|
* @param string $entityIdColumn
|
|
|
|
* @param string $entityTypeColumn
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function filterRestrictedEntityRelations($query, $tableName, $entityIdColumn, $entityTypeColumn)
|
|
|
|
{
|
|
|
|
if ($this->isAdmin) return $query;
|
|
|
|
$this->currentAction = 'view';
|
|
|
|
$tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn, 'entityTypeColumn' => $entityTypeColumn];
|
2016-04-23 13:14:26 -04:00
|
|
|
|
2016-02-29 15:31:21 -05:00
|
|
|
return $query->where(function ($query) use ($tableDetails) {
|
2016-04-23 13:14:26 -04:00
|
|
|
$query->whereExists(function ($permissionQuery) use (&$tableDetails) {
|
|
|
|
$permissionQuery->select('id')->from('entity_permissions')
|
|
|
|
->whereRaw('entity_permissions.entity_id=' . $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
|
|
|
|
->whereRaw('entity_permissions.entity_type=' . $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'])
|
|
|
|
->where('action', '=', $this->currentAction)
|
|
|
|
->whereIn('role_id', $this->userRoles)
|
|
|
|
->where(function ($query) {
|
|
|
|
$query->where('has_permission', '=', true)->orWhere(function ($query) {
|
|
|
|
$query->where('has_permission_own', '=', true)
|
|
|
|
->where('created_by', '=', $this->currentUser->id);
|
2016-02-28 14:03:04 -05:00
|
|
|
});
|
2016-04-23 13:14:26 -04:00
|
|
|
});
|
2016-02-28 14:03:04 -05:00
|
|
|
});
|
|
|
|
});
|
2016-04-23 13:14:26 -04:00
|
|
|
|
2016-02-28 14:03:04 -05:00
|
|
|
}
|
|
|
|
|
2016-03-13 09:30:47 -04:00
|
|
|
/**
|
|
|
|
* Filters pages that are a direct relation to another item.
|
|
|
|
* @param $query
|
|
|
|
* @param $tableName
|
|
|
|
* @param $entityIdColumn
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function filterRelatedPages($query, $tableName, $entityIdColumn)
|
|
|
|
{
|
|
|
|
if ($this->isAdmin) return $query;
|
|
|
|
$this->currentAction = 'view';
|
|
|
|
$tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn];
|
2016-04-23 13:14:26 -04:00
|
|
|
|
|
|
|
return $query->where(function ($query) use ($tableDetails) {
|
2016-03-13 09:30:47 -04:00
|
|
|
$query->where(function ($query) use (&$tableDetails) {
|
2016-04-23 13:14:26 -04:00
|
|
|
$query->whereExists(function ($permissionQuery) use (&$tableDetails) {
|
|
|
|
$permissionQuery->select('id')->from('entity_permissions')
|
|
|
|
->whereRaw('entity_permissions.entity_id=' . $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
|
|
|
|
->where('entity_type', '=', 'Bookstack\\Page')
|
|
|
|
->where('action', '=', $this->currentAction)
|
|
|
|
->whereIn('role_id', $this->userRoles)
|
2016-03-13 09:30:47 -04:00
|
|
|
->where(function ($query) {
|
2016-04-23 13:14:26 -04:00
|
|
|
$query->where('has_permission', '=', true)->orWhere(function ($query) {
|
|
|
|
$query->where('has_permission_own', '=', true)
|
|
|
|
->where('created_by', '=', $this->currentUser->id);
|
|
|
|
});
|
2016-03-13 09:30:47 -04:00
|
|
|
});
|
2016-04-23 13:14:26 -04:00
|
|
|
});
|
|
|
|
})->orWhere($tableDetails['entityIdColumn'], '=', 0);
|
2016-03-13 09:30:47 -04:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2016-02-28 14:03:04 -05:00
|
|
|
}
|