currentUser(); $userRoleIds = $this->getCurrentUserRoleIds(); $allRolePermission = $user->can($permission . '-all'); $ownRolePermission = $user->can($permission . '-own'); $nonJointPermissions = ['restrictions', 'image', 'attachment', 'comment']; $ownerField = ($ownable instanceof Entity) ? 'owned_by' : 'created_by'; $isOwner = $user->id === $ownable->getAttribute($ownerField); $hasRolePermission = $allRolePermission || ($isOwner && $ownRolePermission); // Handle non entity specific jointPermissions if (in_array($explodedPermission[0], $nonJointPermissions)) { return $hasRolePermission; } $entityPermissions = $this->getApplicableEntityPermissions($ownable, $userRoleIds, $action); if (is_null($entityPermissions)) { return $hasRolePermission; } return count($entityPermissions) > 0; } /** * Get the permissions that are applicable for the given entity item. * Returns null when no entity permissions apply otherwise entity permissions * are active, even if the returned array is empty. * * @returns EntityPermission[] */ protected function getApplicableEntityPermissions(Entity $entity, array $userRoleIds, string $action): ?array { $chain = [$entity]; if ($entity instanceof Page && $entity->chapter_id) { $chain[] = $entity->chapter; } if ($entity instanceof Page || $entity instanceof Chapter) { $chain[] = $entity->book; } foreach ($chain as $currentEntity) { if ($currentEntity->restricted) { return $currentEntity->permissions() ->whereIn('role_id', $userRoleIds) ->where('action', '=', $action) ->get() ->all(); } } return null; } /** * Checks if a user has the given permission for any items in the system. * Can be passed an entity instance to filter on a specific type. */ public function checkUserHasEntityPermissionOnAny(string $action, string $entityClass = ''): bool { if (strpos($action, '-') !== false) { throw new InvalidArgumentException("Action should be a simple entity permission action, not a role permission"); } $permissionQuery = EntityPermission::query() ->where('action', '=', $action) ->whereIn('role_id', $this->getCurrentUserRoleIds()); if (!empty($entityClass)) { /** @var Entity $entityInstance */ $entityInstance = app()->make($entityClass); $permissionQuery = $permissionQuery->where('restrictable_type', '=', $entityInstance->getMorphClass()); } $hasPermission = $permissionQuery->count() > 0; return $hasPermission; } /** * Limited the given entity query so that the query will only * return items that the user has view permission for. */ public function restrictEntityQuery(Builder $query): Builder { return $query->where(function (Builder $parentQuery) { $parentQuery->whereHas('jointPermissions', function (Builder $permissionQuery) { $permissionQuery->whereIn('role_id', $this->getCurrentUserRoleIds()) // TODO - Delete line once only views ->where('action', '=', 'view') ->where(function (Builder $query) { $this->addJointHasPermissionCheck($query, $this->currentUser()->id); }); }); }); } /** * Extend the given page query to ensure draft items are not visible * unless created by the given user. */ public function enforceDraftVisibilityOnQuery(Builder $query): Builder { return $query->where(function (Builder $query) { $query->where('draft', '=', false) ->orWhere(function (Builder $query) { $query->where('draft', '=', true) ->where('owned_by', '=', $this->currentUser()->id); }); }); } /** * Add restrictions for a generic entity. */ public function enforceEntityRestrictions(Entity $entity, Builder $query): Builder { if ($entity instanceof Page) { // Prevent drafts being visible to others. $this->enforceDraftVisibilityOnQuery($query); } return $this->entityRestrictionQuery($query); } /** * The general query filter to remove all entities * that the current user does not have access to. */ protected function entityRestrictionQuery(Builder $query): Builder { $q = $query->where(function ($parentQuery) { $parentQuery->whereHas('jointPermissions', function ($permissionQuery) { $permissionQuery->whereIn('role_id', $this->getCurrentUserRoleIds()) // TODO - Delete line once only views ->where('action', '=', 'view') ->where(function (Builder $query) { $this->addJointHasPermissionCheck($query, $this->currentUser()->id); }); }); }); return $q; } /** * Filter items that have entities set as a polymorphic relation. * For simplicity, this will not return results attached to draft pages. * Draft pages should never really have related items though. * * @param Builder|QueryBuilder $query */ public function filterRestrictedEntityRelations($query, string $tableName, string $entityIdColumn, string $entityTypeColumn) { $tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn, 'entityTypeColumn' => $entityTypeColumn]; $pageMorphClass = (new Page())->getMorphClass(); $q = $query->whereExists(function ($permissionQuery) use (&$tableDetails) { /** @var Builder $permissionQuery */ $permissionQuery->select(['role_id'])->from('joint_permissions') ->whereColumn('joint_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn']) ->whereColumn('joint_permissions.entity_type', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn']) ->where('joint_permissions.action', '=', 'view') ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoleIds()) ->where(function (QueryBuilder $query) { $this->addJointHasPermissionCheck($query, $this->currentUser()->id); }); })->where(function ($query) use ($tableDetails, $pageMorphClass) { /** @var Builder $query */ $query->where($tableDetails['entityTypeColumn'], '!=', $pageMorphClass) ->orWhereExists(function (QueryBuilder $query) use ($tableDetails, $pageMorphClass) { $query->select('id')->from('pages') ->whereColumn('pages.id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn']) ->where($tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'], '=', $pageMorphClass) ->where('pages.draft', '=', false); }); }); return $q; } /** * Add conditions to a query to filter the selection to related entities * where view permissions are granted. */ public function filterRelatedEntity(string $entityClass, Builder $query, string $tableName, string $entityIdColumn): Builder { $fullEntityIdColumn = $tableName . '.' . $entityIdColumn; $instance = new $entityClass(); $morphClass = $instance->getMorphClass(); $existsQuery = function ($permissionQuery) use ($fullEntityIdColumn, $morphClass) { /** @var Builder $permissionQuery */ $permissionQuery->select('joint_permissions.role_id')->from('joint_permissions') ->whereColumn('joint_permissions.entity_id', '=', $fullEntityIdColumn) ->where('joint_permissions.entity_type', '=', $morphClass) ->where('joint_permissions.action', '=', 'view') ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoleIds()) ->where(function (QueryBuilder $query) { $this->addJointHasPermissionCheck($query, $this->currentUser()->id); }); }; $q = $query->where(function ($query) use ($existsQuery, $fullEntityIdColumn) { $query->whereExists($existsQuery) ->orWhere($fullEntityIdColumn, '=', 0); }); if ($instance instanceof Page) { // Prevent visibility of non-owned draft pages $q->whereExists(function (QueryBuilder $query) use ($fullEntityIdColumn) { $query->select('id')->from('pages') ->whereColumn('pages.id', '=', $fullEntityIdColumn) ->where(function (QueryBuilder $query) { $query->where('pages.draft', '=', false) ->orWhere('pages.owned_by', '=', $this->currentUser()->id); }); }); } return $q; } /** * Add the query for checking the given user id has permission * within the join_permissions table. * * @param QueryBuilder|Builder $query */ protected function addJointHasPermissionCheck($query, int $userIdToCheck) { $query->where('joint_permissions.has_permission', '=', true)->orWhere(function ($query) use ($userIdToCheck) { $query->where('joint_permissions.has_permission_own', '=', true) ->where('joint_permissions.owned_by', '=', $userIdToCheck); }); } /** * Get the current user. */ protected function currentUser(): User { return user(); } /** * Get the roles for the current logged-in user. * * @return int[] */ protected function getCurrentUserRoleIds(): array { if (auth()->guest()) { return [Role::getSystemRole('public')->id]; } return $this->currentUser()->roles->pluck('id')->values()->all(); } }