X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/cd6572b61af2165133468d2562d04dffdca8fca8..refs/pull/711/head:/app/Services/PermissionService.php

diff --git a/app/Services/PermissionService.php b/app/Services/PermissionService.php
index 467bf95da..331ed06c8 100644
--- a/app/Services/PermissionService.php
+++ b/app/Services/PermissionService.php
@@ -3,6 +3,7 @@
 use BookStack\Book;
 use BookStack\Chapter;
 use BookStack\Entity;
+use BookStack\EntityPermission;
 use BookStack\JointPermission;
 use BookStack\Ownable;
 use BookStack\Page;
@@ -10,6 +11,7 @@ use BookStack\Role;
 use BookStack\User;
 use Illuminate\Database\Connection;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Support\Collection;
 
 class PermissionService
@@ -28,22 +30,25 @@ class PermissionService
 
     protected $jointPermission;
     protected $role;
+    protected $entityPermission;
 
     protected $entityCache;
 
     /**
      * PermissionService constructor.
      * @param JointPermission $jointPermission
+     * @param EntityPermission $entityPermission
      * @param Connection $db
      * @param Book $book
      * @param Chapter $chapter
      * @param Page $page
      * @param Role $role
      */
-    public function __construct(JointPermission $jointPermission, Connection $db, Book $book, Chapter $chapter, Page $page, Role $role)
+    public function __construct(JointPermission $jointPermission, EntityPermission $entityPermission, Connection $db, Book $book, Chapter $chapter, Page $page, Role $role)
     {
         $this->db = $db;
         $this->jointPermission = $jointPermission;
+        $this->entityPermission = $entityPermission;
         $this->role = $role;
         $this->book = $book;
         $this->chapter = $chapter;
@@ -51,6 +56,15 @@ class PermissionService
         // TODO - Update so admin still goes through filters
     }
 
+    /**
+     * Set the database connection
+     * @param Connection $connection
+     */
+    public function setConnection(Connection $connection)
+    {
+        $this->db = $connection;
+    }
+
     /**
      * Prepare the local entity cache and ensure it's empty
      */
@@ -74,7 +88,9 @@ class PermissionService
         }
 
         $book = $this->book->find($bookId);
-        if ($book === null) $book = false;
+        if ($book === null) {
+            $book = false;
+        }
         if (isset($this->entityCache['books'])) {
             $this->entityCache['books']->put($bookId, $book);
         }
@@ -94,7 +110,9 @@ class PermissionService
         }
 
         $chapter = $this->chapter->find($chapterId);
-        if ($chapter === null) $chapter = false;
+        if ($chapter === null) {
+            $chapter = false;
+        }
         if (isset($this->entityCache['chapters'])) {
             $this->entityCache['chapters']->put($chapterId, $chapter);
         }
@@ -108,7 +126,9 @@ class PermissionService
      */
     protected function getRoles()
     {
-        if ($this->userRoles !== false) return $this->userRoles;
+        if ($this->userRoles !== false) {
+            return $this->userRoles;
+        }
 
         $roles = [];
 
@@ -133,22 +153,51 @@ class PermissionService
         $this->readyEntityCache();
 
         // Get all roles (Should be the most limited dimension)
-        $roles = $this->role->with('permissions')->get();
+        $roles = $this->role->with('permissions')->get()->all();
 
         // Chunk through all books
-        $this->book->with('permissions')->chunk(500, function ($books) use ($roles) {
-            $this->createManyJointPermissions($books, $roles);
+        $this->bookFetchQuery()->chunk(5, function ($books) use ($roles) {
+            $this->buildJointPermissionsForBooks($books, $roles);
         });
+    }
 
-        // Chunk through all chapters
-        $this->chapter->with('book', 'permissions')->chunk(500, function ($chapters) use ($roles) {
-            $this->createManyJointPermissions($chapters, $roles);
-        });
+    /**
+     * Get a query for fetching a book with it's children.
+     * @return QueryBuilder
+     */
+    protected function bookFetchQuery()
+    {
+        return $this->book->newQuery()->select(['id', 'restricted', 'created_by'])->with(['chapters' => function ($query) {
+            $query->select(['id', 'restricted', 'created_by', 'book_id']);
+        }, 'pages'  => function ($query) {
+            $query->select(['id', 'restricted', 'created_by', 'book_id', 'chapter_id']);
+        }]);
+    }
 
-        // Chunk through all pages
-        $this->page->with('book', 'chapter', 'permissions')->chunk(500, function ($pages) use ($roles) {
-            $this->createManyJointPermissions($pages, $roles);
-        });
+    /**
+     * Build joint permissions for an array of books
+     * @param Collection $books
+     * @param array $roles
+     * @param bool $deleteOld
+     */
+    protected function buildJointPermissionsForBooks($books, $roles, $deleteOld = false)
+    {
+        $entities = clone $books;
+
+        /** @var Book $book */
+        foreach ($books->all() as $book) {
+            foreach ($book->getRelation('chapters') as $chapter) {
+                $entities->push($chapter);
+            }
+            foreach ($book->getRelation('pages') as $page) {
+                $entities->push($page);
+            }
+        }
+
+        if ($deleteOld) {
+            $this->deleteManyJointPermissionsForEntities($entities->all());
+        }
+        $this->createManyJointPermissions($entities, $roles);
     }
 
     /**
@@ -157,18 +206,27 @@ class PermissionService
      */
     public function buildJointPermissionsForEntity(Entity $entity)
     {
-        $roles = $this->role->with('jointPermissions')->get();
-        $entities = collect([$entity]);
-
+        $entities = [$entity];
         if ($entity->isA('book')) {
-            $entities = $entities->merge($entity->chapters);
-            $entities = $entities->merge($entity->pages);
-        } elseif ($entity->isA('chapter')) {
-            $entities = $entities->merge($entity->pages);
+            $books = $this->bookFetchQuery()->where('id', '=', $entity->id)->get();
+            $this->buildJointPermissionsForBooks($books, $this->role->newQuery()->get(), true);
+            return;
+        }
+
+        $entities[] = $entity->book;
+
+        if ($entity->isA('page') && $entity->chapter_id) {
+            $entities[] = $entity->chapter;
+        }
+
+        if ($entity->isA('chapter')) {
+            foreach ($entity->pages as $page) {
+                $entities[] = $page;
+            }
         }
 
         $this->deleteManyJointPermissionsForEntities($entities);
-        $this->createManyJointPermissions($entities, $roles);
+        $this->buildJointPermissionsForEntities(collect($entities));
     }
 
     /**
@@ -177,8 +235,8 @@ class PermissionService
      */
     public function buildJointPermissionsForEntities(Collection $entities)
     {
-        $roles = $this->role->with('jointPermissions')->get();
-        $this->deleteManyJointPermissionsForEntities($entities);
+        $roles = $this->role->newQuery()->get();
+        $this->deleteManyJointPermissionsForEntities($entities->all());
         $this->createManyJointPermissions($entities, $roles);
     }
 
@@ -188,23 +246,12 @@ class PermissionService
      */
     public function buildJointPermissionForRole(Role $role)
     {
-        $roles = collect([$role]);
-
+        $roles = [$role];
         $this->deleteManyJointPermissionsForRoles($roles);
 
         // Chunk through all books
-        $this->book->with('permissions')->chunk(500, function ($books) use ($roles) {
-            $this->createManyJointPermissions($books, $roles);
-        });
-
-        // Chunk through all chapters
-        $this->chapter->with('book', 'permissions')->chunk(500, function ($books) use ($roles) {
-            $this->createManyJointPermissions($books, $roles);
-        });
-
-        // Chunk through all pages
-        $this->page->with('book', 'chapter', 'permissions')->chunk(500, function ($books) use ($roles) {
-            $this->createManyJointPermissions($books, $roles);
+        $this->bookFetchQuery()->chunk(5, function ($books) use ($roles) {
+            $this->buildJointPermissionsForBooks($books, $roles);
         });
     }
 
@@ -223,9 +270,10 @@ class PermissionService
      */
     protected function deleteManyJointPermissionsForRoles($roles)
     {
-        foreach ($roles as $role) {
-            $role->jointPermissions()->delete();
-        }
+        $roleIds = array_map(function ($role) {
+            return $role->id;
+        }, $roles);
+        $this->jointPermission->newQuery()->whereIn('role_id', $roleIds)->delete();
     }
 
     /**
@@ -243,53 +291,94 @@ class PermissionService
      */
     protected function deleteManyJointPermissionsForEntities($entities)
     {
-        $query = $this->jointPermission->newQuery();
-        foreach ($entities as $entity) {
-            $query->orWhere(function($query) use ($entity) {
-                $query->where('entity_id', '=', $entity->id)
-                    ->where('entity_type', '=', $entity->getMorphClass());
-            });
+        if (count($entities) === 0) {
+            return;
         }
-        $query->delete();
+
+        $this->db->transaction(function () use ($entities) {
+
+            foreach (array_chunk($entities, 1000) as $entityChunk) {
+                $query = $this->db->table('joint_permissions');
+                foreach ($entityChunk as $entity) {
+                    $query->orWhere(function (QueryBuilder $query) use ($entity) {
+                        $query->where('entity_id', '=', $entity->id)
+                            ->where('entity_type', '=', $entity->getMorphClass());
+                    });
+                }
+                $query->delete();
+            }
+        });
     }
 
     /**
      * Create & Save entity jointPermissions for many entities and jointPermissions.
      * @param Collection $entities
-     * @param Collection $roles
+     * @param array $roles
      */
     protected function createManyJointPermissions($entities, $roles)
     {
         $this->readyEntityCache();
         $jointPermissions = [];
+
+        // Fetch Entity Permissions and create a mapping of entity restricted statuses
+        $entityRestrictedMap = [];
+        $permissionFetch = $this->entityPermission->newQuery();
+        foreach ($entities as $entity) {
+            $entityRestrictedMap[$entity->getMorphClass() . ':' . $entity->id] = boolval($entity->getRawAttribute('restricted'));
+            $permissionFetch->orWhere(function ($query) use ($entity) {
+                $query->where('restrictable_id', '=', $entity->id)->where('restrictable_type', '=', $entity->getMorphClass());
+            });
+        }
+        $permissions = $permissionFetch->get();
+
+        // Create a mapping of explicit entity permissions
+        $permissionMap = [];
+        foreach ($permissions as $permission) {
+            $key = $permission->restrictable_type . ':' . $permission->restrictable_id . ':' . $permission->role_id . ':' . $permission->action;
+            $isRestricted = $entityRestrictedMap[$permission->restrictable_type . ':' . $permission->restrictable_id];
+            $permissionMap[$key] = $isRestricted;
+        }
+
+        // Create a mapping of role permissions
+        $rolePermissionMap = [];
+        foreach ($roles as $role) {
+            foreach ($role->getRelationValue('permissions') as $permission) {
+                $rolePermissionMap[$role->getRawAttribute('id') . ':' . $permission->getRawAttribute('name')] = true;
+            }
+        }
+
+        // Create Joint Permission Data
         foreach ($entities as $entity) {
             foreach ($roles as $role) {
                 foreach ($this->getActions($entity) as $action) {
-                    $jointPermissions[] = $this->createJointPermissionData($entity, $role, $action);
+                    $jointPermissions[] = $this->createJointPermissionData($entity, $role, $action, $permissionMap, $rolePermissionMap);
                 }
             }
         }
-        $this->jointPermission->insert($jointPermissions);
+
+        $this->db->transaction(function () use ($jointPermissions) {
+            foreach (array_chunk($jointPermissions, 1000) as $jointPermissionChunk) {
+                $this->db->table('joint_permissions')->insert($jointPermissionChunk);
+            }
+        });
     }
 
 
     /**
      * Get the actions related to an entity.
-     * @param $entity
+     * @param Entity $entity
      * @return array
      */
-    protected function getActions($entity)
+    protected function getActions(Entity $entity)
     {
         $baseActions = ['view', 'update', 'delete'];
-
-        if ($entity->isA('chapter')) {
-            $baseActions[] = 'page-create';
-        } else if ($entity->isA('book')) {
+        if ($entity->isA('chapter') || $entity->isA('book')) {
             $baseActions[] = 'page-create';
+        }
+        if ($entity->isA('book')) {
             $baseActions[] = 'chapter-create';
         }
-
-         return $baseActions;
+        return $baseActions;
     }
 
     /**
@@ -297,14 +386,16 @@ class PermissionService
      * for a particular action.
      * @param Entity $entity
      * @param Role $role
-     * @param $action
+     * @param string $action
+     * @param array $permissionMap
+     * @param array $rolePermissionMap
      * @return array
      */
-    protected function createJointPermissionData(Entity $entity, Role $role, $action)
+    protected function createJointPermissionData(Entity $entity, Role $role, $action, $permissionMap, $rolePermissionMap)
     {
         $permissionPrefix = (strpos($action, '-') === false ? ($entity->getType() . '-') : '') . $action;
-        $roleHasPermission = $role->hasPermission($permissionPrefix . '-all');
-        $roleHasPermissionOwn = $role->hasPermission($permissionPrefix . '-own');
+        $roleHasPermission = isset($rolePermissionMap[$role->getRawAttribute('id') . ':' . $permissionPrefix . '-all']);
+        $roleHasPermissionOwn = isset($rolePermissionMap[$role->getRawAttribute('id') . ':' . $permissionPrefix . '-own']);
         $explodedAction = explode('-', $action);
         $restrictionAction = end($explodedAction);
 
@@ -312,54 +403,50 @@ class PermissionService
             return $this->createJointPermissionDataArray($entity, $role, $action, true, true);
         }
 
-        if ($entity->isA('book')) {
-
-            if (!$entity->restricted) {
-                return $this->createJointPermissionDataArray($entity, $role, $action, $roleHasPermission, $roleHasPermissionOwn);
-            } else {
-                $hasAccess = $entity->hasActiveRestriction($role->id, $restrictionAction);
-                return $this->createJointPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
-            }
+        if ($entity->restricted) {
+            $hasAccess = $this->mapHasActiveRestriction($permissionMap, $entity, $role, $restrictionAction);
+            return $this->createJointPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
+        }
 
-        } elseif ($entity->isA('chapter')) {
+        if ($entity->isA('book')) {
+            return $this->createJointPermissionDataArray($entity, $role, $action, $roleHasPermission, $roleHasPermissionOwn);
+        }
 
-            if (!$entity->restricted) {
-                $book = $this->getBook($entity->book_id);
-                $hasExplicitAccessToBook = $book->hasActiveRestriction($role->id, $restrictionAction);
-                $hasPermissiveAccessToBook = !$book->restricted;
-                return $this->createJointPermissionDataArray($entity, $role, $action,
-                    ($hasExplicitAccessToBook || ($roleHasPermission && $hasPermissiveAccessToBook)),
-                    ($hasExplicitAccessToBook || ($roleHasPermissionOwn && $hasPermissiveAccessToBook)));
-            } else {
-                $hasAccess = $entity->hasActiveRestriction($role->id, $restrictionAction);
-                return $this->createJointPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
+        // For chapters and pages, Check if explicit permissions are set on the Book.
+        $book = $this->getBook($entity->book_id);
+        $hasExplicitAccessToParents = $this->mapHasActiveRestriction($permissionMap, $book, $role, $restrictionAction);
+        $hasPermissiveAccessToParents = !$book->restricted;
+
+        // For pages with a chapter, Check if explicit permissions are set on the Chapter
+        if ($entity->isA('page') && $entity->chapter_id !== 0 && $entity->chapter_id !== '0') {
+            $chapter = $this->getChapter($entity->chapter_id);
+            $hasPermissiveAccessToParents = $hasPermissiveAccessToParents && !$chapter->restricted;
+            if ($chapter->restricted) {
+                $hasExplicitAccessToParents = $this->mapHasActiveRestriction($permissionMap, $chapter, $role, $restrictionAction);
             }
+        }
 
-        } elseif ($entity->isA('page')) {
-
-            if (!$entity->restricted) {
-                $book = $this->getBook($entity->book_id);
-                $hasExplicitAccessToBook = $book->hasActiveRestriction($role->id, $restrictionAction);
-                $hasPermissiveAccessToBook = !$book->restricted;
-
-                $chapter = $this->getChapter($entity->chapter_id);
-                $hasExplicitAccessToChapter = $chapter && $chapter->hasActiveRestriction($role->id, $restrictionAction);
-                $hasPermissiveAccessToChapter = $chapter && !$chapter->restricted;
-                $acknowledgeChapter = ($chapter && $chapter->restricted);
-
-                $hasExplicitAccessToParents = $acknowledgeChapter ? $hasExplicitAccessToChapter : $hasExplicitAccessToBook;
-                $hasPermissiveAccessToParents = $acknowledgeChapter ? $hasPermissiveAccessToChapter : $hasPermissiveAccessToBook;
-
-                return $this->createJointPermissionDataArray($entity, $role, $action,
-                    ($hasExplicitAccessToParents || ($roleHasPermission && $hasPermissiveAccessToParents)),
-                    ($hasExplicitAccessToParents || ($roleHasPermissionOwn && $hasPermissiveAccessToParents))
-                );
-            } else {
-                $hasAccess = $entity->hasRestriction($role->id, $action);
-                return $this->createJointPermissionDataArray($entity, $role, $action, $hasAccess, $hasAccess);
-            }
+        return $this->createJointPermissionDataArray(
+            $entity,
+            $role,
+            $action,
+            ($hasExplicitAccessToParents || ($roleHasPermission && $hasPermissiveAccessToParents)),
+            ($hasExplicitAccessToParents || ($roleHasPermissionOwn && $hasPermissiveAccessToParents))
+        );
+    }
 
-        }
+    /**
+     * Check for an active restriction in an entity map.
+     * @param $entityMap
+     * @param Entity $entity
+     * @param Role $role
+     * @param $action
+     * @return bool
+     */
+    protected function mapHasActiveRestriction($entityMap, Entity $entity, Role $role, $action)
+    {
+        $key = $entity->getMorphClass() . ':' . $entity->getRawAttribute('id') . ':' . $role->getRawAttribute('id') . ':' . $action;
+        return isset($entityMap[$key]) ? $entityMap[$key] : false;
     }
 
     /**
@@ -374,11 +461,10 @@ class PermissionService
      */
     protected function createJointPermissionDataArray(Entity $entity, Role $role, $action, $permissionAll, $permissionOwn)
     {
-        $entityClass = get_class($entity);
         return [
             'role_id'            => $role->getRawAttribute('id'),
             'entity_id'          => $entity->getRawAttribute('id'),
-            'entity_type'        => $entityClass,
+            'entity_type'        => $entity->getMorphClass(),
             'action'             => $action,
             'has_permission'     => $permissionAll,
             'has_permission_own' => $permissionOwn,
@@ -405,7 +491,7 @@ class PermissionService
         $action = end($explodedPermission);
         $this->currentAction = $action;
 
-        $nonJointPermissions = ['restrictions'];
+        $nonJointPermissions = ['restrictions', 'image', 'attachment', 'comment'];
 
         // Handle non entity specific jointPermissions
         if (in_array($explodedPermission[0], $nonJointPermissions)) {
@@ -421,7 +507,6 @@ class PermissionService
             $this->currentAction = $permission;
         }
 
-
         $q = $this->entityRestrictionQuery($baseQuery)->count() > 0;
         $this->clean();
         return $q;
@@ -471,49 +556,42 @@ class PermissionService
         return $q;
     }
 
-    public function bookChildrenQuery($book_id, $filterDrafts = false) {
-
-        // Draft setup
-        $params = [
-            'userId' => $this->currentUser()->id,
-            'bookIdPage' => $book_id,
-            'bookIdChapter' => $book_id
-        ];
-        if (!$filterDrafts) {
-            $params['userIdDrafts'] = $this->currentUser()->id;
-        }
-        // Role setup
-        $userRoles = $this->getRoles();
-        $roleBindings = [];
-        $roleValues = [];
-        foreach ($userRoles as $index => $roleId) {
-            $roleBindings[':role'.$index] = $roleId;
-            $roleValues['role'.$index] = $roleId;
-        }
-        // TODO - Clean this up, Maybe extract into a nice class for doing these kind of manual things
-        // Something which will handle the above role crap in a nice clean way
-        $roleBindingString = implode(',', array_keys($roleBindings));
-        $query = "SELECT * from (
-(SELECT 'Bookstack\\\Page' as entity_type, id, slug, name, text, '' as description, book_id, priority, chapter_id, draft FROM {$this->page->getTable()}
-    where book_id = :bookIdPage AND ". ($filterDrafts ? '(draft = 0)' : '(draft = 0 OR (draft = 1 AND created_by = :userIdDrafts))') .")
-UNION
-(SELECT 'Bookstack\\\Chapter' as entity_type, id, slug, name, '' as text, description, book_id, priority, 0 as chapter_id, 0 as draft FROM {$this->chapter->getTable()} WHERE book_id = :bookIdChapter)
-) as U  WHERE (
-	SELECT COUNT(*) FROM {$this->jointPermission->getTable()} jp
-    WHERE
-		jp.entity_id=U.id AND
-        jp.entity_type=U.entity_type AND
-		jp.action = 'view' AND
-        jp.role_id IN ({$roleBindingString}) AND
-        (
-			jp.has_permission = 1 OR
-            (jp.has_permission_own = 1 AND jp.created_by = :userId)
-        )
-) > 0
-ORDER BY draft desc, priority asc";
+    /**
+     * Get the children of a book in an efficient single query, Filtered by the permission system.
+     * @param integer $book_id
+     * @param bool $filterDrafts
+     * @param bool $fetchPageContent
+     * @return QueryBuilder
+     */
+    public function bookChildrenQuery($book_id, $filterDrafts = false, $fetchPageContent = false)
+    {
+        $pageSelect = $this->db->table('pages')->selectRaw($this->page->entityRawQuery($fetchPageContent))->where('book_id', '=', $book_id)->where(function ($query) use ($filterDrafts) {
+            $query->where('draft', '=', 0);
+            if (!$filterDrafts) {
+                $query->orWhere(function ($query) {
+                    $query->where('draft', '=', 1)->where('created_by', '=', $this->currentUser()->id);
+                });
+            }
+        });
+        $chapterSelect = $this->db->table('chapters')->selectRaw($this->chapter->entityRawQuery())->where('book_id', '=', $book_id);
+        $query = $this->db->query()->select('*')->from($this->db->raw("({$pageSelect->toSql()} UNION {$chapterSelect->toSql()}) AS U"))
+            ->mergeBindings($pageSelect)->mergeBindings($chapterSelect);
+
+        if (!$this->isAdmin()) {
+            $whereQuery = $this->db->table('joint_permissions as jp')->selectRaw('COUNT(*)')
+                ->whereRaw('jp.entity_id=U.id')->whereRaw('jp.entity_type=U.entity_type')
+                ->where('jp.action', '=', 'view')->whereIn('jp.role_id', $this->getRoles())
+                ->where(function ($query) {
+                    $query->where('jp.has_permission', '=', 1)->orWhere(function ($query) {
+                        $query->where('jp.has_permission_own', '=', 1)->where('jp.created_by', '=', $this->currentUser()->id);
+                    });
+                });
+            $query->whereRaw("({$whereQuery->toSql()}) > 0")->mergeBindings($whereQuery);
+        }
 
+        $query->orderBy('draft', 'desc')->orderBy('priority', 'asc');
         $this->clean();
-        return $this->db->select($query, array_replace($roleValues, $params));
+        return  $query;
     }
 
     /**
@@ -521,7 +599,7 @@ ORDER BY draft desc, priority asc";
      * @param string $entityType
      * @param Builder|Entity $query
      * @param string $action
-     * @return mixed
+     * @return Builder
      */
     public function enforceEntityRestrictions($entityType, $query, $action = 'view')
     {
@@ -547,7 +625,7 @@ ORDER BY draft desc, priority asc";
     }
 
     /**
-     * Filter items that have entities set a a polymorphic relation.
+     * Filter items that have entities set as a polymorphic relation.
      * @param $query
      * @param string $tableName
      * @param string $entityIdColumn
@@ -579,6 +657,7 @@ ORDER BY draft desc, priority asc";
                     });
             });
         });
+        $this->clean();
         return $q;
     }
 
@@ -655,5 +734,4 @@ ORDER BY draft desc, priority asc";
         $this->userRoles = false;
         $this->isAdminUser = null;
     }
-
-}
\ No newline at end of file
+}