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\Chapter;
   8 use BookStack\Entities\Models\Entity;
   9 use BookStack\Entities\Models\Page;
  10 use BookStack\Model;
  11 use BookStack\Traits\HasCreatorAndUpdater;
  12 use BookStack\Traits\HasOwner;
  13 use Illuminate\Database\Eloquent\Builder;
  14 use Illuminate\Database\Query\Builder as QueryBuilder;
  15 use InvalidArgumentException;
  16
  17 class PermissionApplicator
  18 {
  19     /**
  20      * Checks if an entity has a restriction set upon it.
  21      *
  22      * @param HasCreatorAndUpdater|HasOwner $ownable
  23      */
  24     public function checkOwnableUserAccess(Model $ownable, string $permission): bool
  25     {
  26         $explodedPermission = explode('-', $permission);
  27         $action = $explodedPermission[1] ?? $explodedPermission[0];
  28         $fullPermission = count($explodedPermission) > 1 ? $permission : $ownable->getMorphClass() . '-' . $permission;
  29
  30         $user = $this->currentUser();
  31         $userRoleIds = $this->getCurrentUserRoleIds();
  32
  33         $allRolePermission = $user->can($fullPermission . '-all');
  34         $ownRolePermission = $user->can($fullPermission . '-own');
  35         $nonJointPermissions = ['restrictions', 'image', 'attachment', 'comment'];
  36         $ownerField = ($ownable instanceof Entity) ? 'owned_by' : 'created_by';
  37         $ownableFieldVal = $ownable->getAttribute($ownerField);
  38
  39         if (is_null($ownableFieldVal)) {
  40             throw new InvalidArgumentException("{$ownerField} field used but has not been loaded");
  41         }
  42
  43         $isOwner = $user->id === $ownableFieldVal;
  44         $hasRolePermission = $allRolePermission || ($isOwner && $ownRolePermission);
  45
  46         // Handle non entity specific jointPermissions
  47         if (in_array($explodedPermission[0], $nonJointPermissions)) {
  48             return $hasRolePermission;
  49         }
  50
  51         $hasApplicableEntityPermissions = $this->hasEntityPermission($ownable, $userRoleIds, $user->id, $action);
  52
  53         return is_null($hasApplicableEntityPermissions) ? $hasRolePermission : $hasApplicableEntityPermissions;
  54     }
  55
  56     /**
  57      * Check if there are permissions that are applicable for the given entity item, action and roles.
  58      * Returns null when no entity permissions are in force.
  59      */
  60     protected function hasEntityPermission(Entity $entity, array $userRoleIds, int $userId, string $action): ?bool
  61     {
  62         $this->ensureValidEntityAction($action);
  63
  64         $adminRoleId = Role::getSystemRole('admin')->id;
  65         if (in_array($adminRoleId, $userRoleIds)) {
  66             return true;
  67         }
  68
  69         // The array order here is very important due to the fact we walk up the chain
  70         // in the flattening loop below. Earlier items in the chain have higher priority.
  71         $typeIdList = [$entity->getMorphClass() . ':' . $entity->id];
  72         if ($entity instanceof Page && $entity->chapter_id) {
  73             $typeIdList[] = 'chapter:' . $entity->chapter_id;
  74         }
  75
  76         if ($entity instanceof Page || $entity instanceof Chapter) {
  77             $typeIdList[] = 'book:' . $entity->book_id;
  78         }
  79
  80         $relevantPermissions = EntityPermission::query()
  81             ->where(function (Builder $query) use ($typeIdList) {
  82                 foreach ($typeIdList as $typeId) {
  83                     $query->orWhere(function (Builder $query) use ($typeId) {
  84                         [$type, $id] = explode(':', $typeId);
  85                         $query->where('entity_type', '=', $type)
  86                             ->where('entity_id', '=', $id);
  87                     });
  88                 }
  89             })->where(function (Builder $query) use ($userRoleIds, $userId) {
  90                 $query->whereIn('role_id', $userRoleIds)
  91                     ->orWhere('user_id', '=', $userId)
  92                     ->orWhere(function (Builder $query) {
  93                         $query->whereNull(['role_id', 'user_id']);
  94                     });
  95             })->get(['entity_id', 'entity_type', 'role_id', 'user_id', $action])
  96             ->all();
  97
  98         $permissionMap = new EntityPermissionMap($relevantPermissions);
  99         $permitsByType = ['user' => [], 'fallback' => [], 'role' => []];
 100
 101         // Collapse and simplify permission structure
 102         foreach ($typeIdList as $typeId) {
 103             $permissions = $permissionMap->getForEntity($typeId);
 104             foreach ($permissions as $permission) {
 105                 $related = $permission->getAssignedType();
 106                 $relatedId = $permission->getAssignedTypeId();
 107                 if (!isset($permitsByType[$related][$relatedId])) {
 108                     $permitsByType[$related][$relatedId] = $permission->$action;
 109                 }
 110             }
 111         }
 112
 113         // Return user-level permission if exists
 114         if (count($permitsByType['user']) > 0) {
 115             return boolval(array_values($permitsByType['user'])[0]);
 116         }
 117
 118         // Return grant or reject from role-level if exists
 119         if (count($permitsByType['role']) > 0) {
 120             return boolval(max($permitsByType['role']));
 121         }
 122
 123         // Return fallback permission if exists
 124         if (count($permitsByType['fallback']) > 0) {
 125             return boolval($permitsByType['fallback'][0]);
 126         }
 127
 128         return null;
 129     }
 130
 131     /**
 132      * Checks if a user has the given permission for any items in the system.
 133      * Can be passed an entity instance to filter on a specific type.
 134      */
 135     public function checkUserHasEntityPermissionOnAny(string $action, string $entityClass = ''): bool
 136     {
 137         $this->ensureValidEntityAction($action);
 138
 139         $permissionQuery = EntityPermission::query()
 140             ->where($action, '=', true)
 141             ->where(function (Builder $query) {
 142                 $query->whereIn('role_id', $this->getCurrentUserRoleIds())
 143                 ->orWhere('user_id', '=', $this->currentUser()->id);
 144             });
 145
 146         if (!empty($entityClass)) {
 147             /** @var Entity $entityInstance */
 148             $entityInstance = app()->make($entityClass);
 149             $permissionQuery = $permissionQuery->where('entity_type', '=', $entityInstance->getMorphClass());
 150         }
 151
 152         $hasPermission = $permissionQuery->count() > 0;
 153
 154         return $hasPermission;
 155     }
 156
 157     /**
 158      * Limit the given entity query so that the query will only
 159      * return items that the user has view permission for.
 160      */
 161     public function restrictEntityQuery(Builder $query, string $morphClass): Builder
 162     {
 163         $this->getCurrentUserRoleIds();
 164         $this->currentUser()->id;
 165
 166         $userViewAll = userCan($morphClass . '-view-all');
 167         $userViewOwn = userCan($morphClass . '-view-own');
 168
 169         // TODO - Leave this as the new admin workaround?
 170         //   Or auto generate collapsed role permissions for admins?
 171         if (\user()->hasSystemRole('admin')) {
 172             return $query;
 173         }
 174
 175         // Fallback permission join
 176         $query->joinSub(function (QueryBuilder $joinQuery) use ($morphClass) {
 177             $joinQuery->select(['entity_id'])->selectRaw('max(view) as perms_fallback')
 178                 ->from('entity_permissions_collapsed')
 179                 ->where('entity_type', '=', $morphClass)
 180                 ->whereNull(['role_id', 'user_id'])
 181                 ->groupBy('entity_id');
 182         }, 'p_f', 'id', '=', 'p_f.entity_id', 'left');
 183
 184         // Role permission join
 185         $query->joinSub(function (QueryBuilder $joinQuery) use ($morphClass) {
 186             $joinQuery->select(['entity_id'])->selectRaw('max(view) as perms_role')
 187                 ->from('entity_permissions_collapsed')
 188                 ->where('entity_type', '=', $morphClass)
 189                 ->whereIn('role_id', $this->getCurrentUserRoleIds())
 190                 ->groupBy('entity_id');
 191         }, 'p_r', 'id', '=', 'p_r.entity_id', 'left');
 192
 193         // User permission join
 194         $query->joinSub(function (QueryBuilder $joinQuery) use ($morphClass) {
 195             $joinQuery->select(['entity_id'])->selectRaw('max(view) as perms_user')
 196                 ->from('entity_permissions_collapsed')
 197                 ->where('entity_type', '=', $morphClass)
 198                 ->where('user_id', '=', $this->currentUser()->id)
 199                 ->groupBy('entity_id');
 200         }, 'p_u', 'id', '=', 'p_u.entity_id', 'left');
 201
 202         // Where permissions apply
 203         $query->where(function (Builder $query) use ($userViewOwn, $userViewAll) {
 204             $query->where('perms_user', '=', 1)
 205                 ->orWhere(function (Builder $query) {
 206                     $query->whereNull('perms_user')->where('perms_role', '=', 1);
 207                 })->orWhere(function (Builder $query) {
 208                     $query->whereNull(['perms_user', 'perms_role'])
 209                         ->where('perms_fallback', '=', 1);
 210                 });
 211
 212             if ($userViewAll) {
 213                 $query->orWhere(function (Builder $query) {
 214                     $query->whereNull(['perms_user', 'perms_role', 'perms_fallback']);
 215                 });
 216             } else if ($userViewOwn) {
 217                 $query->orWhere(function (Builder $query) {
 218                     $query->whereNull(['perms_user', 'perms_role', 'perms_fallback'])
 219                         ->where('owned_by', '=', $this->currentUser()->id);
 220                 });
 221             }
 222         });
 223
 224         return $query;
 225     }
 226
 227     /**
 228      * Extend the given page query to ensure draft items are not visible
 229      * unless created by the given user.
 230      */
 231     public function restrictDraftsOnPageQuery(Builder $query): Builder
 232     {
 233         return $query->where(function (Builder $query) {
 234             $query->where('draft', '=', false)
 235                 ->orWhere(function (Builder $query) {
 236                     $query->where('draft', '=', true)
 237                         ->where('owned_by', '=', $this->currentUser()->id);
 238                 });
 239         });
 240     }
 241
 242     /**
 243      * Filter items that have entities set as a polymorphic relation.
 244      * For simplicity, this will not return results attached to draft pages.
 245      * Draft pages should never really have related items though.
 246      *
 247      * @param Builder|QueryBuilder $query
 248      */
 249     public function restrictEntityRelationQuery($query, string $tableName, string $entityIdColumn, string $entityTypeColumn)
 250     {
 251         $tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn, 'entityTypeColumn' => $entityTypeColumn];
 252         $pageMorphClass = (new Page())->getMorphClass();
 253
 254         // TODO;
 255         return $query;
 256
 257         $q = $query->where(function ($query) use ($tableDetails) {
 258             $query->whereExists(function ($permissionQuery) use ($tableDetails) {
 259                 /** @var Builder $permissionQuery */
 260                 $permissionQuery->select(['role_id'])->from('joint_permissions')
 261                     ->whereColumn('joint_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
 262                     ->whereColumn('joint_permissions.entity_type', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'])
 263                     ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoleIds())
 264                     ->where(function (QueryBuilder $query) {
 265                         $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
 266                     });
 267             })->orWhereExists(function ($permissionQuery) use ($tableDetails) {
 268                 /** @var Builder $permissionQuery */
 269                 $permissionQuery->select(['user_id'])->from('joint_user_permissions')
 270                     ->whereColumn('joint_user_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
 271                     ->whereColumn('joint_user_permissions.entity_type', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'])
 272                     ->where('joint_user_permissions.user_id', '=', $this->currentUser()->id)
 273                     ->where('joint_user_permissions.has_permission', '=', true);
 274             });
 275         })->whereNotExists(function ($query) use ($tableDetails) {
 276             $query->select(['user_id'])->from('joint_user_permissions')
 277                 ->whereColumn('joint_user_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
 278                 ->whereColumn('joint_user_permissions.entity_type', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'])
 279                 ->where('joint_user_permissions.user_id', '=', $this->currentUser()->id)
 280                 ->where('joint_user_permissions.has_permission', '=', false);
 281         })->where(function ($query) use ($tableDetails, $pageMorphClass) {
 282             /** @var Builder $query */
 283             $query->where($tableDetails['entityTypeColumn'], '!=', $pageMorphClass)
 284                 ->orWhereExists(function (QueryBuilder $query) use ($tableDetails, $pageMorphClass) {
 285                     $query->select('id')->from('pages')
 286                         ->whereColumn('pages.id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
 287                         ->where($tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'], '=', $pageMorphClass)
 288                         ->where('pages.draft', '=', false);
 289                 });
 290         });
 291
 292         return $q;
 293     }
 294
 295     /**
 296      * Add conditions to a query for a model that's a relation of a page, so only the model results
 297      * on visible pages are returned by the query.
 298      * Is effectively the same as "restrictEntityRelationQuery" but takes into account page drafts
 299      * while not expecting a polymorphic relation, Just a simpler one-page-to-many-relations set-up.
 300      */
 301     public function restrictPageRelationQuery(Builder $query, string $tableName, string $pageIdColumn): Builder
 302     {
 303         $fullPageIdColumn = $tableName . '.' . $pageIdColumn;
 304         $morphClass = (new Page())->getMorphClass();
 305
 306         // TODO
 307         return $query;
 308
 309         $existsQuery = function ($permissionQuery) use ($fullPageIdColumn, $morphClass) {
 310             /** @var Builder $permissionQuery */
 311             $permissionQuery->select('joint_permissions.role_id')->from('joint_permissions')
 312                 ->whereColumn('joint_permissions.entity_id', '=', $fullPageIdColumn)
 313                 ->where('joint_permissions.entity_type', '=', $morphClass)
 314                 ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoleIds())
 315                 ->where(function (QueryBuilder $query) {
 316                     $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
 317                 });
 318         };
 319
 320         $userExistsQuery = function ($hasPermission) use ($fullPageIdColumn, $morphClass) {
 321             return function ($permissionQuery) use ($fullPageIdColumn, $morphClass) {
 322                 /** @var Builder $permissionQuery */
 323                 $permissionQuery->select('joint_user_permissions.user_id')->from('joint_user_permissions')
 324                     ->whereColumn('joint_user_permissions.entity_id', '=', $fullPageIdColumn)
 325                     ->where('joint_user_permissions.entity_type', '=', $morphClass)
 326                     ->where('joint_user_permissions.user_id', $this->currentUser()->id)
 327                     ->where('has_permission', '=', true);
 328             };
 329         };
 330
 331         $q = $query->where(function ($query) use ($existsQuery, $userExistsQuery, $fullPageIdColumn) {
 332             $query->whereExists($existsQuery)
 333                 ->orWhereExists($userExistsQuery(true))
 334                 ->orWhere($fullPageIdColumn, '=', 0);
 335         })->whereNotExists($userExistsQuery(false));
 336
 337         // Prevent visibility of non-owned draft pages
 338         $q->whereExists(function (QueryBuilder $query) use ($fullPageIdColumn) {
 339             $query->select('id')->from('pages')
 340                 ->whereColumn('pages.id', '=', $fullPageIdColumn)
 341                 ->where(function (QueryBuilder $query) {
 342                     $query->where('pages.draft', '=', false)
 343                         ->orWhere('pages.owned_by', '=', $this->currentUser()->id);
 344                 });
 345         });
 346
 347         return $q;
 348     }
 349
 350     /**
 351      * Add the query for checking the given user id has permission
 352      * within the join_permissions table.
 353      *
 354      * @param QueryBuilder|Builder $query
 355      */
 356     protected function addJointHasPermissionCheck($query, int $userIdToCheck)
 357     {
 358         $query->where('joint_permissions.has_permission', '=', true)->orWhere(function ($query) use ($userIdToCheck) {
 359             $query->where('joint_permissions.has_permission_own', '=', true)
 360                 ->where('joint_permissions.owned_by', '=', $userIdToCheck);
 361         });
 362     }
 363
 364     /**
 365      * Get the current user.
 366      */
 367     protected function currentUser(): User
 368     {
 369         return user();
 370     }
 371
 372     /**
 373      * Get the roles for the current logged-in user.
 374      *
 375      * @return int[]
 376      */
 377     protected function getCurrentUserRoleIds(): array
 378     {
 379         if (auth()->guest()) {
 380             return [Role::getSystemRole('public')->id];
 381         }
 382
 383         return $this->currentUser()->roles->pluck('id')->values()->all();
 384     }
 385
 386     /**
 387      * Ensure the given action is a valid and expected entity action.
 388      * Throws an exception if invalid otherwise does nothing.
 389      * @throws InvalidArgumentException
 390      */
 391     protected function ensureValidEntityAction(string $action): void
 392     {
 393         if (!in_array($action, EntityPermission::PERMISSIONS)) {
 394             throw new InvalidArgumentException('Action should be a simple entity permission action, not a role permission');
 395         }
 396     }
 397 }