BookStack Code Mirror - bookstack/blob - app/Auth/Permissions/PermissionApplicator.php

   1 <?php
   2
   3 namespace BookStack\Auth\Permissions;
   4
   5 use BookStack\Auth\Role;
   6 use BookStack\Auth\User;
   7 use BookStack\Entities\Models\Entity;
   8 use BookStack\Entities\Models\Page;
   9 use BookStack\Model;
  10 use BookStack\Traits\HasCreatorAndUpdater;
  11 use BookStack\Traits\HasOwner;
  12 use Illuminate\Database\Eloquent\Builder;
  13 use Illuminate\Database\Query\Builder as QueryBuilder;
  14 use InvalidArgumentException;
  15
  16 class PermissionApplicator
  17 {
  18     /**
  19      * Checks if an entity has a restriction set upon it.
  20      *
  21      * @param HasCreatorAndUpdater|HasOwner $ownable
  22      */
  23     public function checkOwnableUserAccess(Model $ownable, string $permission): bool
  24     {
  25         $explodedPermission = explode('-', $permission);
  26         $action = $explodedPermission[1] ?? $explodedPermission[0];
  27         $fullPermission = count($explodedPermission) > 1 ? $permission : $ownable->getMorphClass() . '-' . $permission;
  28
  29         $user = $this->currentUser();
  30         $userRoleIds = $this->getCurrentUserRoleIds();
  31
  32         $allRolePermission = $user->can($fullPermission . '-all');
  33         $ownRolePermission = $user->can($fullPermission . '-own');
  34         $nonJointPermissions = ['restrictions', 'image', 'attachment', 'comment'];
  35         $ownerField = ($ownable instanceof Entity) ? 'owned_by' : 'created_by';
  36         $ownableFieldVal = $ownable->getAttribute($ownerField);
  37
  38         if (is_null($ownableFieldVal)) {
  39             throw new InvalidArgumentException("{$ownerField} field used but has not been loaded");
  40         }
  41
  42         $isOwner = $user->id === $ownableFieldVal;
  43         $hasRolePermission = $allRolePermission || ($isOwner && $ownRolePermission);
  44
  45         // Handle non entity specific jointPermissions
  46         if (in_array($explodedPermission[0], $nonJointPermissions)) {
  47             return $hasRolePermission;
  48         }
  49
  50         $hasApplicableEntityPermissions = $this->hasEntityPermission($ownable, $userRoleIds, $action);
  51
  52         return is_null($hasApplicableEntityPermissions) ? $hasRolePermission : $hasApplicableEntityPermissions;
  53     }
  54
  55     /**
  56      * Check if there are permissions that are applicable for the given entity item, action and roles.
  57      * Returns null when no entity permissions are in force.
  58      */
  59     protected function hasEntityPermission(Entity $entity, array $userRoleIds, string $action): ?bool
  60     {
  61         $this->ensureValidEntityAction($action);
  62
  63         return (new EntityPermissionEvaluator($action))->evaluateEntityForUser($entity, $userRoleIds);
  64     }
  65
  66     /**
  67      * Checks if a user has the given permission for any items in the system.
  68      * Can be passed an entity instance to filter on a specific type.
  69      */
  70     public function checkUserHasEntityPermissionOnAny(string $action, string $entityClass = ''): bool
  71     {
  72         $this->ensureValidEntityAction($action);
  73
  74         $permissionQuery = EntityPermission::query()
  75             ->where($action, '=', true)
  76             ->whereIn('role_id', $this->getCurrentUserRoleIds());
  77
  78         if (!empty($entityClass)) {
  79             /** @var Entity $entityInstance */
  80             $entityInstance = app()->make($entityClass);
  81             $permissionQuery = $permissionQuery->where('entity_type', '=', $entityInstance->getMorphClass());
  82         }
  83
  84         $hasPermission = $permissionQuery->count() > 0;
  85
  86         return $hasPermission;
  87     }
  88
  89     /**
  90      * Limit the given entity query so that the query will only
  91      * return items that the user has view permission for.
  92      */
  93     public function restrictEntityQuery(Builder $query): Builder
  94     {
  95         return $query->where(function (Builder $parentQuery) {
  96             $parentQuery->whereHas('jointPermissions', function (Builder $permissionQuery) {
  97                 $permissionQuery->select(['entity_id', 'entity_type'])
  98                     ->selectRaw('max(owner_id) as owner_id')
  99                     ->selectRaw('max(status) as status')
 100                     ->whereIn('role_id', $this->getCurrentUserRoleIds())
 101                     ->groupBy(['entity_type', 'entity_id'])
 102                     ->havingRaw('(status IN (1, 3) or owner_id = ?)', [$this->currentUser()->id]);
 103             });
 104         });
 105     }
 106
 107     /**
 108      * Extend the given page query to ensure draft items are not visible
 109      * unless created by the given user.
 110      */
 111     public function restrictDraftsOnPageQuery(Builder $query): Builder
 112     {
 113         return $query->where(function (Builder $query) {
 114             $query->where('draft', '=', false)
 115                 ->orWhere(function (Builder $query) {
 116                     $query->where('draft', '=', true)
 117                         ->where('owned_by', '=', $this->currentUser()->id);
 118                 });
 119         });
 120     }
 121
 122     /**
 123      * Filter items that have entities set as a polymorphic relation.
 124      * For simplicity, this will not return results attached to draft pages.
 125      * Draft pages should never really have related items though.
 126      */
 127     public function restrictEntityRelationQuery(Builder $query, string $tableName, string $entityIdColumn, string $entityTypeColumn): Builder
 128     {
 129         $tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn, 'entityTypeColumn' => $entityTypeColumn];
 130         $pageMorphClass = (new Page())->getMorphClass();
 131
 132         return $this->restrictEntityQuery($query)
 133             ->where(function ($query) use ($tableDetails, $pageMorphClass) {
 134                 /** @var Builder $query */
 135                 $query->where($tableDetails['entityTypeColumn'], '!=', $pageMorphClass)
 136                 ->orWhereExists(function (QueryBuilder $query) use ($tableDetails, $pageMorphClass) {
 137                     $query->select('id')->from('pages')
 138                         ->whereColumn('pages.id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
 139                         ->where($tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'], '=', $pageMorphClass)
 140                         ->where('pages.draft', '=', false);
 141                 });
 142             });
 143     }
 144
 145     /**
 146      * Add conditions to a query for a model that's a relation of a page, so only the model results
 147      * on visible pages are returned by the query.
 148      * Is effectively the same as "restrictEntityRelationQuery" but takes into account page drafts
 149      * while not expecting a polymorphic relation, Just a simpler one-page-to-many-relations set-up.
 150      */
 151     public function restrictPageRelationQuery(Builder $query, string $tableName, string $pageIdColumn): Builder
 152     {
 153         // TODO - Refactor
 154         $fullPageIdColumn = $tableName . '.' . $pageIdColumn;
 155         $morphClass = (new Page())->getMorphClass();
 156
 157         $existsQuery = function ($permissionQuery) use ($fullPageIdColumn, $morphClass) {
 158             /** @var Builder $permissionQuery */
 159             $permissionQuery->select('joint_permissions.role_id')->from('joint_permissions')
 160                 ->whereColumn('joint_permissions.entity_id', '=', $fullPageIdColumn)
 161                 ->where('joint_permissions.entity_type', '=', $morphClass)
 162                 ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoleIds())
 163                 ->where(function (QueryBuilder $query) {
 164                     $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
 165                 });
 166         };
 167
 168         $q = $query->where(function ($query) use ($existsQuery, $fullPageIdColumn) {
 169             $query->whereExists($existsQuery)
 170                 ->orWhere($fullPageIdColumn, '=', 0);
 171         });
 172
 173         // Prevent visibility of non-owned draft pages
 174         $q->whereExists(function (QueryBuilder $query) use ($fullPageIdColumn) {
 175             $query->select('id')->from('pages')
 176                 ->whereColumn('pages.id', '=', $fullPageIdColumn)
 177                 ->where(function (QueryBuilder $query) {
 178                     $query->where('pages.draft', '=', false)
 179                         ->orWhere('pages.owned_by', '=', $this->currentUser()->id);
 180                 });
 181         });
 182
 183         return $q;
 184     }
 185
 186     /**
 187      * Add the query for checking the given user id has permission
 188      * within the join_permissions table.
 189      *
 190      * @param QueryBuilder|Builder $query
 191      */
 192     protected function addJointHasPermissionCheck($query, int $userIdToCheck)
 193     {
 194         $query->where('joint_permissions.has_permission', '=', true)->orWhere(function ($query) use ($userIdToCheck) {
 195             $query->where('joint_permissions.has_permission_own', '=', true)
 196                 ->where('joint_permissions.owned_by', '=', $userIdToCheck);
 197         });
 198     }
 199
 200     /**
 201      * Get the current user.
 202      */
 203     protected function currentUser(): User
 204     {
 205         return user();
 206     }
 207
 208     /**
 209      * Get the roles for the current logged-in user.
 210      *
 211      * @return int[]
 212      */
 213     protected function getCurrentUserRoleIds(): array
 214     {
 215         if (auth()->guest()) {
 216             return [Role::getSystemRole('public')->id];
 217         }
 218
 219         return $this->currentUser()->roles->pluck('id')->values()->all();
 220     }
 221
 222     /**
 223      * Ensure the given action is a valid and expected entity action.
 224      * Throws an exception if invalid otherwise does nothing.
 225      * @throws InvalidArgumentException
 226      */
 227     protected function ensureValidEntityAction(string $action): void
 228     {
 229         if (!in_array($action, EntityPermission::PERMISSIONS)) {
 230             throw new InvalidArgumentException('Action should be a simple entity permission action, not a role permission');
 231         }
 232     }
 233 }