Added migration file.

[bookstack] / app / Repos / EntityRepo.php

diff --git a/app/Repos/EntityRepo.php b/app/Repos/EntityRepo.php
index 7ecfb758c9e31364414987cc1121fa1df18f377d..a682e696bae5d1c4e633d649ef260433480e8426 100644 (file)
--- a/app/Repos/EntityRepo.php
+++ b/app/Repos/EntityRepo.php
@@ -3,11 +3,17 @@
 use BookStack\Book;
 use BookStack\Chapter;
 use BookStack\Entity;
 use BookStack\Book;
 use BookStack\Chapter;
 use BookStack\Entity;

+use BookStack\Exceptions\NotFoundException;

 use BookStack\Page;
 use BookStack\Page;

+use BookStack\PageRevision;
+use BookStack\Services\AttachmentService;

 use BookStack\Services\PermissionService;
 use BookStack\Services\PermissionService;

-use BookStack\User;
+use BookStack\Services\SearchService;
+use BookStack\Services\ViewService;
+use Carbon\Carbon;
+use DOMDocument;
+use DOMXPath;

 use Illuminate\Support\Collection;
 use Illuminate\Support\Collection;

-use Illuminate\Support\Facades\Log;

 
 class EntityRepo
 {
 
 class EntityRepo
 {


@@ -27,85 +33,223 @@ class EntityRepo
      */
     public $page;
 
      */
     public $page;
 

+    /**
+     * @var PageRevision
+     */
+    protected $pageRevision;
+
+    /**
+     * Base entity instances keyed by type
+     * @var []Entity
+     */
+    protected $entities;
+

     /**
      * @var PermissionService
      */
     protected $permissionService;
 
     /**
     /**
      * @var PermissionService
      */
     protected $permissionService;
 
     /**

-     * Acceptable operators to be used in a query
-     * @var array
+     * @var ViewService

      */
      */

-    protected $queryOperators = ['<=', '>=', '=', '<', '>', 'like', '!='];
+    protected $viewService;

 
     /**
 
     /**

-     * EntityService constructor.
+     * @var TagRepo

      */
      */

-    public function __construct()
+    protected $tagRepo;
+
+    /**
+     * @var SearchService
+     */
+    protected $searchService;
+
+    /**
+     * EntityRepo constructor.
+     * @param Book $book
+     * @param Chapter $chapter
+     * @param Page $page
+     * @param PageRevision $pageRevision
+     * @param ViewService $viewService
+     * @param PermissionService $permissionService
+     * @param TagRepo $tagRepo
+     * @param SearchService $searchService
+     */
+    public function __construct(
+        Book $book, Chapter $chapter, Page $page, PageRevision $pageRevision,
+        ViewService $viewService, PermissionService $permissionService,
+        TagRepo $tagRepo, SearchService $searchService
+    )

     {
     {

-        $this->book = app(Book::class);
-        $this->chapter = app(Chapter::class);
-        $this->page = app(Page::class);
-        $this->permissionService = app(PermissionService::class);
+        $this->book = $book;
+        $this->chapter = $chapter;
+        $this->page = $page;
+        $this->pageRevision = $pageRevision;
+        $this->entities = [
+            'page' => $this->page,
+            'chapter' => $this->chapter,
+            'book' => $this->book
+        ];
+        $this->viewService = $viewService;
+        $this->permissionService = $permissionService;
+        $this->tagRepo = $tagRepo;
+        $this->searchService = $searchService;

     }
 
     /**
     }
 
     /**

-     * Get the latest books added to the system.
-     * @param int $count
-     * @param int $page
-     * @param bool $additionalQuery
-     * @return
+     * Get an entity instance via type.
+     * @param $type
+     * @return Entity

      */
      */

-    public function getRecentlyCreatedBooks($count = 20, $page = 0, $additionalQuery = false)
+    protected function getEntity($type)

     {
     {

-        $query = $this->permissionService->enforceBookRestrictions($this->book)
-            ->orderBy('created_at', 'desc');
-        if ($additionalQuery !== false && is_callable($additionalQuery)) {
-            $additionalQuery($query);
+        return $this->entities[strtolower($type)];
+    }
+
+    /**
+     * Base query for searching entities via permission system
+     * @param string $type
+     * @param bool $allowDrafts
+     * @return \Illuminate\Database\Query\Builder
+     */
+    protected function entityQuery($type, $allowDrafts = false)
+    {
+        $q = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type), 'view');
+        if (strtolower($type) === 'page' && !$allowDrafts) {
+            $q = $q->where('draft', '=', false);

         }
         }

-        return $query->skip($page * $count)->take($count)->get();
+        return $q;

     }
 
     /**
     }
 
     /**

-     * Get the most recently updated books.
-     * @param $count
-     * @param int $page
-     * @return mixed
+     * Check if an entity with the given id exists.
+     * @param $type
+     * @param $id
+     * @return bool

      */
      */

-    public function getRecentlyUpdatedBooks($count = 20, $page = 0)
+    public function exists($type, $id)

     {
     {

-        return $this->permissionService->enforceBookRestrictions($this->book)
-            ->orderBy('updated_at', 'desc')->skip($page * $count)->take($count)->get();
+        return $this->entityQuery($type)->where('id', '=', $id)->exists();

     }
 
     /**
     }
 
     /**

-     * Get the latest pages added to the system.
+     * Get an entity by ID
+     * @param string $type
+     * @param integer $id
+     * @param bool $allowDrafts
+     * @param bool $ignorePermissions
+     * @return Entity
+     */
+    public function getById($type, $id, $allowDrafts = false, $ignorePermissions = false)
+    {
+        if ($ignorePermissions) {
+            $entity = $this->getEntity($type);
+            return $entity->newQuery()->find($id);
+        }
+        return $this->entityQuery($type, $allowDrafts)->find($id);
+    }
+
+    /**
+     * Get an entity by its url slug.
+     * @param string $type
+     * @param string $slug
+     * @param string|bool $bookSlug
+     * @return Entity
+     * @throws NotFoundException
+     */
+    public function getBySlug($type, $slug, $bookSlug = false)
+    {
+        $q = $this->entityQuery($type)->where('slug', '=', $slug);
+
+        if (strtolower($type) === 'chapter' || strtolower($type) === 'page') {
+            $q = $q->where('book_id', '=', function($query) use ($bookSlug) {
+                $query->select('id')
+                    ->from($this->book->getTable())
+                    ->where('slug', '=', $bookSlug)->limit(1);
+            });
+        }
+        $entity = $q->first();
+        if ($entity === null) throw new NotFoundException(trans('errors.' . strtolower($type) . '_not_found'));
+        return $entity;
+    }
+
+
+    /**
+     * Search through page revisions and retrieve the last page in the
+     * current book that has a slug equal to the one given.
+     * @param string $pageSlug
+     * @param string $bookSlug
+     * @return null|Page
+     */
+    public function getPageByOldSlug($pageSlug, $bookSlug)
+    {
+        $revision = $this->pageRevision->where('slug', '=', $pageSlug)
+            ->whereHas('page', function ($query) {
+                $this->permissionService->enforceEntityRestrictions('page', $query);
+            })
+            ->where('type', '=', 'version')
+            ->where('book_slug', '=', $bookSlug)
+            ->orderBy('created_at', 'desc')
+            ->with('page')->first();
+        return $revision !== null ? $revision->page : null;
+    }
+
+    /**
+     * Get all entities of a type limited by count unless count if false.
+     * @param string $type
+     * @param integer|bool $count
+     * @return Collection
+     */
+    public function getAll($type, $count = 20)
+    {
+        $q = $this->entityQuery($type)->orderBy('name', 'asc');
+        if ($count !== false) $q = $q->take($count);
+        return $q->get();
+    }
+
+    /**
+     * Get all entities in a paginated format
+     * @param $type
+     * @param int $count
+     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
+    public function getAllPaginated($type, $count = 10)
+    {
+        return $this->entityQuery($type)->orderBy('name', 'asc')->paginate($count);
+    }
+
+    /**
+     * Get the most recently created entities of the given type.
+     * @param string $type

      * @param int $count
      * @param int $page
      * @param int $count
      * @param int $page

-     * @param bool $additionalQuery
-     * @return
+     * @param bool|callable $additionalQuery
+     * @return Collection

      */
      */

-    public function getRecentlyCreatedPages($count = 20, $page = 0, $additionalQuery = false)
+    public function getRecentlyCreated($type, $count = 20, $page = 0, $additionalQuery = false)

     {
     {

-        $query = $this->permissionService->enforcePageRestrictions($this->page)
-            ->orderBy('created_at', 'desc')->where('draft', '=', false);
+        $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
+            ->orderBy('created_at', 'desc');
+        if (strtolower($type) === 'page') $query = $query->where('draft', '=', false);

         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }
         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }

-        return $query->with('book')->skip($page * $count)->take($count)->get();
+        return $query->skip($page * $count)->take($count)->get();

     }
 
     /**
     }
 
     /**

-     * Get the latest chapters added to the system.
+     * Get the most recently updated entities of the given type.
+     * @param string $type

      * @param int $count
      * @param int $page
      * @param int $count
      * @param int $page

-     * @param bool $additionalQuery
-     * @return
+     * @param bool|callable $additionalQuery
+     * @return Collection

      */
      */

-    public function getRecentlyCreatedChapters($count = 20, $page = 0, $additionalQuery = false)
+    public function getRecentlyUpdated($type, $count = 20, $page = 0, $additionalQuery = false)

     {
     {

-        $query = $this->permissionService->enforceChapterRestrictions($this->chapter)
-            ->orderBy('created_at', 'desc');
+        $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
+            ->orderBy('updated_at', 'desc');
+        if (strtolower($type) === 'page') $query = $query->where('draft', '=', false);

         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }
         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }


@@ -113,16 +257,51 @@ class EntityRepo
     }
 
     /**
     }
 
     /**

-     * Get the most recently updated pages.
-     * @param $count
+     * Get the most recently viewed entities.
+     * @param string|bool $type
+     * @param int $count

      * @param int $page
      * @return mixed
      */
      * @param int $page
      * @return mixed
      */

-    public function getRecentlyUpdatedPages($count = 20, $page = 0)
+    public function getRecentlyViewed($type, $count = 10, $page = 0)

     {
     {

-        return $this->permissionService->enforcePageRestrictions($this->page)
-            ->where('draft', '=', false)
-            ->orderBy('updated_at', 'desc')->with('book')->skip($page * $count)->take($count)->get();
+        $filter = is_bool($type) ? false : $this->getEntity($type);
+        return $this->viewService->getUserRecentlyViewed($count, $page, $filter);
+    }
+
+    /**
+     * Get the latest pages added to the system with pagination.
+     * @param string $type
+     * @param int $count
+     * @return mixed
+     */
+    public function getRecentlyCreatedPaginated($type, $count = 20)
+    {
+        return $this->entityQuery($type)->orderBy('created_at', 'desc')->paginate($count);
+    }
+
+    /**
+     * Get the latest pages added to the system with pagination.
+     * @param string $type
+     * @param int $count
+     * @return mixed
+     */
+    public function getRecentlyUpdatedPaginated($type, $count = 20)
+    {
+        return $this->entityQuery($type)->orderBy('updated_at', 'desc')->paginate($count);
+    }
+
+    /**
+     * Get the most popular entities base on all views.
+     * @param string|bool $type
+     * @param int $count
+     * @param int $page
+     * @return mixed
+     */
+    public function getPopular($type, $count = 10, $page = 0)
+    {
+        $filter = is_bool($type) ? false : $this->getEntity($type);
+        return $this->viewService->getPopular($count, $page, $filter);

     }
 
     /**
     }
 
     /**


@@ -138,6 +317,123 @@ class EntityRepo
             ->skip($count * $page)->take($count)->get();
     }
 
             ->skip($count * $page)->take($count)->get();
     }
 

+    /**
+     * Get all child objects of a book.
+     * Returns a sorted collection of Pages and Chapters.
+     * Loads the book slug onto child elements to prevent access database access for getting the slug.
+     * @param Book $book
+     * @param bool $filterDrafts
+     * @param bool $renderPages
+     * @return mixed
+     */
+    public function getBookChildren(Book $book, $filterDrafts = false, $renderPages = false)
+    {
+        $q = $this->permissionService->bookChildrenQuery($book->id, $filterDrafts, $renderPages)->get();
+        $entities = [];
+        $parents = [];
+        $tree = [];
+
+        foreach ($q as $index => $rawEntity) {
+            if ($rawEntity->entity_type === 'BookStack\\Page') {
+                $entities[$index] = $this->page->newFromBuilder($rawEntity);
+                if ($renderPages) {
+                    $entities[$index]->html = $rawEntity->html;
+                    $entities[$index]->html = $this->renderPage($entities[$index]);
+                };
+            } else if ($rawEntity->entity_type === 'BookStack\\Chapter') {
+                $entities[$index] = $this->chapter->newFromBuilder($rawEntity);
+                $key = $entities[$index]->entity_type . ':' . $entities[$index]->id;
+                $parents[$key] = $entities[$index];
+                $parents[$key]->setAttribute('pages', collect());
+            }
+            if ($entities[$index]->chapter_id === 0 || $entities[$index]->chapter_id === '0') $tree[] = $entities[$index];
+            $entities[$index]->book = $book;
+        }
+
+        foreach ($entities as $entity) {
+            if ($entity->chapter_id === 0 || $entity->chapter_id === '0') continue;
+            $parentKey = 'BookStack\\Chapter:' . $entity->chapter_id;
+            if (!isset($parents[$parentKey])) {
+                $tree[] = $entity;
+                continue;
+            }
+            $chapter = $parents[$parentKey];
+            $chapter->pages->push($entity);
+        }
+
+        return collect($tree);
+    }
+
+    /**
+     * Get the child items for a chapter sorted by priority but
+     * with draft items floated to the top.
+     * @param Chapter $chapter
+     * @return \Illuminate\Database\Eloquent\Collection|static[]
+     */
+    public function getChapterChildren(Chapter $chapter)
+    {
+        return $this->permissionService->enforceEntityRestrictions('page', $chapter->pages())
+            ->orderBy('draft', 'DESC')->orderBy('priority', 'ASC')->get();
+    }
+
+
+    /**
+     * Get the next sequential priority for a new child element in the given book.
+     * @param Book $book
+     * @return int
+     */
+    public function getNewBookPriority(Book $book)
+    {
+        $lastElem = $this->getBookChildren($book)->pop();
+        return $lastElem ? $lastElem->priority + 1 : 0;
+    }
+
+    /**
+     * Get a new priority for a new page to be added to the given chapter.
+     * @param Chapter $chapter
+     * @return int
+     */
+    public function getNewChapterPriority(Chapter $chapter)
+    {
+        $lastPage = $chapter->pages('DESC')->first();
+        return $lastPage !== null ? $lastPage->priority + 1 : 0;
+    }
+
+    /**
+     * Find a suitable slug for an entity.
+     * @param string $type
+     * @param string $name
+     * @param bool|integer $currentId
+     * @param bool|integer $bookId Only pass if type is not a book
+     * @return string
+     */
+    public function findSuitableSlug($type, $name, $currentId = false, $bookId = false)
+    {
+        $slug = $this->nameToSlug($name);
+        while ($this->slugExists($type, $slug, $currentId, $bookId)) {
+            $slug .= '-' . substr(md5(rand(1, 500)), 0, 3);
+        }
+        return $slug;
+    }
+
+    /**
+     * Check if a slug already exists in the database.
+     * @param string $type
+     * @param string $slug
+     * @param bool|integer $currentId
+     * @param bool|integer $bookId
+     * @return bool
+     */
+    protected function slugExists($type, $slug, $currentId = false, $bookId = false)
+    {
+        $query = $this->getEntity($type)->where('slug', '=', $slug);
+        if (strtolower($type) === 'page' || strtolower($type) === 'chapter') {
+            $query = $query->where('book_id', '=', $bookId);
+        }
+        if ($currentId) $query = $query->where('id', '!=', $currentId);
+        return $query->count() > 0;
+    }
+

     /**
      * Updates entity restrictions from a request
      * @param $request
     /**
      * Updates entity restrictions from a request
      * @param $request


@@ -161,125 +457,641 @@ class EntityRepo
         $this->permissionService->buildJointPermissionsForEntity($entity);
     }
 
         $this->permissionService->buildJointPermissionsForEntity($entity);
     }
 

+
+

     /**
     /**

-     * Prepare a string of search terms by turning
-     * it into an array of terms.
-     * Keeps quoted terms together.
-     * @param $termString
-     * @return array
+     * Create a new entity from request input.
+     * Used for books and chapters.
+     * @param string $type
+     * @param array $input
+     * @param bool|Book $book
+     * @return Entity

      */
      */

-    public function prepareSearchTerms($termString)
+    public function createFromInput($type, $input = [], $book = false)

     {
     {

-        $termString = $this->cleanSearchTermString($termString);
-        preg_match_all('/(".*?")/', $termString, $matches);
-        $terms = [];
-        if (count($matches[1]) > 0) {
-            foreach ($matches[1] as $match) {
-                $terms[] = $match;
+        $isChapter = strtolower($type) === 'chapter';
+        $entity = $this->getEntity($type)->newInstance($input);
+        $entity->slug = $this->findSuitableSlug($type, $entity->name, false, $isChapter ? $book->id : false);
+        $entity->created_by = user()->id;
+        $entity->updated_by = user()->id;
+        $isChapter ? $book->chapters()->save($entity) : $entity->save();
+        $this->permissionService->buildJointPermissionsForEntity($entity);
+        $this->searchService->indexEntity($entity);
+        return $entity;
+    }
+
+    /**
+     * Update entity details from request input.
+     * Used for books and chapters
+     * @param string $type
+     * @param Entity $entityModel
+     * @param array $input
+     * @return Entity
+     */
+    public function updateFromInput($type, Entity $entityModel, $input = [])
+    {
+        if ($entityModel->name !== $input['name']) {
+            $entityModel->slug = $this->findSuitableSlug($type, $input['name'], $entityModel->id);
+        }
+        $entityModel->fill($input);
+        $entityModel->updated_by = user()->id;
+        $entityModel->save();
+        $this->permissionService->buildJointPermissionsForEntity($entityModel);
+        $this->searchService->indexEntity($entityModel);
+        return $entityModel;
+    }
+
+    /**
+     * Change the book that an entity belongs to.
+     * @param string $type
+     * @param integer $newBookId
+     * @param Entity $entity
+     * @param bool $rebuildPermissions
+     * @return Entity
+     */
+    public function changeBook($type, $newBookId, Entity $entity, $rebuildPermissions = false)
+    {
+        $entity->book_id = $newBookId;
+        // Update related activity
+        foreach ($entity->activity as $activity) {
+            $activity->book_id = $newBookId;
+            $activity->save();
+        }
+        $entity->slug = $this->findSuitableSlug($type, $entity->name, $entity->id, $newBookId);
+        $entity->save();
+
+        // Update all child pages if a chapter
+        if (strtolower($type) === 'chapter') {
+            foreach ($entity->pages as $page) {
+                $this->changeBook('page', $newBookId, $page, false);

             }
             }

-            $termString = trim(preg_replace('/"(.*?)"/', '', $termString));

         }
         }

-        if (!empty($termString)) $terms = array_merge($terms, explode(' ', $termString));
-        return $terms;
+
+        // Update permissions if applicable
+        if ($rebuildPermissions) {
+            $entity->load('book');
+            $this->permissionService->buildJointPermissionsForEntity($entity->book);
+        }
+
+        return $entity;

     }
 
     /**
     }
 
     /**

-     * Removes any special search notation that should not
-     * be used in a full-text search.
-     * @param $termString
-     * @return mixed
+     * Alias method to update the book jointPermissions in the PermissionService.
+     * @param Book $book

      */
      */

-    protected function cleanSearchTermString($termString)
+    public function buildJointPermissionsForBook(Book $book)

     {
     {

-        // Strip tag searches
-        $termString = preg_replace('/\[.*?\]/', '', $termString);
-        // Reduced multiple spacing into single spacing
-        $termString = preg_replace("/\s{2,}/", " ", $termString);
-        return $termString;
+        $this->permissionService->buildJointPermissionsForEntity($book);

     }
 
     /**
     }
 
     /**

-     * Get the available query operators as a regex escaped list.
-     * @return mixed
+     * Format a name as a url slug.
+     * @param $name
+     * @return string
+     */
+    protected function nameToSlug($name)
+    {
+        $slug = str_replace(' ', '-', strtolower($name));
+        $slug = preg_replace('/[\+\/\\\?\@\}\{\.\,\=\[\]\#\&\!\*\'\;\:\$\%]/', '', $slug);
+        if ($slug === "") $slug = substr(md5(rand(1, 500)), 0, 5);
+        return $slug;
+    }
+
+    /**
+     * Publish a draft page to make it a normal page.
+     * Sets the slug and updates the content.
+     * @param Page $draftPage
+     * @param array $input
+     * @return Page
+     */
+    public function publishPageDraft(Page $draftPage, array $input)
+    {
+        $draftPage->fill($input);
+
+        // Save page tags if present
+        if (isset($input['tags'])) {
+            $this->tagRepo->saveTagsToEntity($draftPage, $input['tags']);
+        }
+
+        $draftPage->slug = $this->findSuitableSlug('page', $draftPage->name, false, $draftPage->book->id);
+        $draftPage->html = $this->formatHtml($input['html']);
+        $draftPage->text = $this->pageToPlainText($draftPage);
+        $draftPage->draft = false;
+        $draftPage->revision_count = 1;
+
+        $draftPage->save();
+        $this->savePageRevision($draftPage, trans('entities.pages_initial_revision'));
+        $this->searchService->indexEntity($draftPage);
+        return $draftPage;
+    }
+
+    /**
+     * Saves a page revision into the system.
+     * @param Page $page
+     * @param null|string $summary
+     * @return PageRevision
+     */
+    public function savePageRevision(Page $page, $summary = null)
+    {
+        $revision = $this->pageRevision->newInstance($page->toArray());
+        if (setting('app-editor') !== 'markdown') $revision->markdown = '';
+        $revision->page_id = $page->id;
+        $revision->slug = $page->slug;
+        $revision->book_slug = $page->book->slug;
+        $revision->created_by = user()->id;
+        $revision->created_at = $page->updated_at;
+        $revision->type = 'version';
+        $revision->summary = $summary;
+        $revision->revision_number = $page->revision_count;
+        $revision->save();
+
+        // Clear old revisions
+        if ($this->pageRevision->where('page_id', '=', $page->id)->count() > 50) {
+            $this->pageRevision->where('page_id', '=', $page->id)
+                ->orderBy('created_at', 'desc')->skip(50)->take(5)->delete();
+        }
+
+        return $revision;
+    }
+
+    /**
+     * Formats a page's html to be tagged correctly
+     * within the system.
+     * @param string $htmlText
+     * @return string
+     */
+    protected function formatHtml($htmlText)
+    {
+        if ($htmlText == '') return $htmlText;
+        libxml_use_internal_errors(true);
+        $doc = new DOMDocument();
+        $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
+
+        $container = $doc->documentElement;
+        $body = $container->childNodes->item(0);
+        $childNodes = $body->childNodes;
+
+        // Ensure no duplicate ids are used
+        $idArray = [];
+
+        foreach ($childNodes as $index => $childNode) {
+            /** @var \DOMElement $childNode */
+            if (get_class($childNode) !== 'DOMElement') continue;
+
+            // Overwrite id if not a BookStack custom id
+            if ($childNode->hasAttribute('id')) {
+                $id = $childNode->getAttribute('id');
+                if (strpos($id, 'bkmrk') === 0 && array_search($id, $idArray) === false) {
+                    $idArray[] = $id;
+                    continue;
+                };
+            }
+
+            // Create an unique id for the element
+            // Uses the content as a basis to ensure output is the same every time
+            // the same content is passed through.
+            $contentId = 'bkmrk-' . substr(strtolower(preg_replace('/\s+/', '-', trim($childNode->nodeValue))), 0, 20);
+            $newId = urlencode($contentId);
+            $loopIndex = 0;
+            while (in_array($newId, $idArray)) {
+                $newId = urlencode($contentId . '-' . $loopIndex);
+                $loopIndex++;
+            }
+
+            $childNode->setAttribute('id', $newId);
+            $idArray[] = $newId;
+        }
+
+        // Generate inner html as a string
+        $html = '';
+        foreach ($childNodes as $childNode) {
+            $html .= $doc->saveHTML($childNode);
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * Render the page for viewing, Parsing and performing features such as page transclusion.
+     * @param Page $page
+     * @param bool $ignorePermissions
+     * @return mixed|string

      */
      */

-    protected function getRegexEscapedOperators()
+    public function renderPage(Page $page, $ignorePermissions = false)

     {
     {

-        $escapedOperators = [];
-        foreach ($this->queryOperators as $operator) {
-            $escapedOperators[] = preg_quote($operator);
+        $content = $page->html;
+        $matches = [];
+        preg_match_all("/{{@\s?([0-9].*?)}}/", $content, $matches);
+        if (count($matches[0]) === 0) return $content;
+
+        foreach ($matches[1] as $index => $includeId) {
+            $splitInclude = explode('#', $includeId, 2);
+            $pageId = intval($splitInclude[0]);
+            if (is_nan($pageId)) continue;
+
+            $page = $this->getById('page', $pageId, false, $ignorePermissions);
+            if ($page === null) {
+                $content = str_replace($matches[0][$index], '', $content);
+                continue;
+            }
+
+            if (count($splitInclude) === 1) {
+                $content = str_replace($matches[0][$index], $page->html, $content);
+                continue;
+            }
+
+            $doc = new DOMDocument();
+            $doc->loadHTML(mb_convert_encoding('<body>'.$page->html.'</body>', 'HTML-ENTITIES', 'UTF-8'));
+            $matchingElem = $doc->getElementById($splitInclude[1]);
+            if ($matchingElem === null) {
+                $content = str_replace($matches[0][$index], '', $content);
+                continue;
+            }
+            $innerContent = '';
+            foreach ($matchingElem->childNodes as $childNode) {
+                $innerContent .= $doc->saveHTML($childNode);
+            }
+            $content = str_replace($matches[0][$index], trim($innerContent), $content);

         }
         }

-        return join('|', $escapedOperators);
+
+        $page->renderedHTML = $content;
+        return $content;

     }
 
     /**
     }
 
     /**

-     * Parses advanced search notations and adds them to the db query.
-     * @param $query
-     * @param $termString
+     * Get the plain text version of a page's content.
+     * @param Page $page
+     * @return string
+     */
+    public function pageToPlainText(Page $page)
+    {
+        $html = $this->renderPage($page);
+        return strip_tags($html);
+    }
+
+    /**
+     * Get a new draft page instance.
+     * @param Book $book
+     * @param Chapter|bool $chapter
+     * @return Page
+     */
+    public function getDraftPage(Book $book, $chapter = false)
+    {
+        $page = $this->page->newInstance();
+        $page->name = trans('entities.pages_initial_name');
+        $page->created_by = user()->id;
+        $page->updated_by = user()->id;
+        $page->draft = true;
+
+        if ($chapter) $page->chapter_id = $chapter->id;
+
+        $book->pages()->save($page);
+        $page = $this->page->find($page->id);
+        $this->permissionService->buildJointPermissionsForEntity($page);
+        return $page;
+    }
+
+    /**
+     * Search for image usage within page content.
+     * @param $imageString

      * @return mixed
      */
      * @return mixed
      */

-    protected function addAdvancedSearchQueries($query, $termString)
+    public function searchForImage($imageString)

     {
     {

-        $escapedOperators = $this->getRegexEscapedOperators();
-        // Look for tag searches
-        preg_match_all("/\[(.*?)((${escapedOperators})(.*?))?\]/", $termString, $tags);
-        if (count($tags[0]) > 0) {
-            $this->applyTagSearches($query, $tags);
+        $pages = $this->entityQuery('page')->where('html', 'like', '%' . $imageString . '%')->get();
+        foreach ($pages as $page) {
+            $page->url = $page->getUrl();
+            $page->html = '';
+            $page->text = '';

         }
         }

+        return count($pages) > 0 ? $pages : false;
+    }

 
 

-        return $query;
+    /**
+     * Parse the headers on the page to get a navigation menu
+     * @param String $pageContent
+     * @return array
+     */
+    public function getPageNav($pageContent)
+    {
+        if ($pageContent == '') return [];
+        libxml_use_internal_errors(true);
+        $doc = new DOMDocument();
+        $doc->loadHTML(mb_convert_encoding($pageContent, 'HTML-ENTITIES', 'UTF-8'));
+        $xPath = new DOMXPath($doc);
+        $headers = $xPath->query("//h1|//h2|//h3|//h4|//h5|//h6");
+
+        if (is_null($headers)) return [];
+
+        $tree = collect([]);
+        foreach ($headers as $header) {
+            $text = $header->nodeValue;
+            $tree->push([
+                'nodeName' => strtolower($header->nodeName),
+                'level' => intval(str_replace('h', '', $header->nodeName)),
+                'link' => '#' . $header->getAttribute('id'),
+                'text' => strlen($text) > 30 ? substr($text, 0, 27) . '...' : $text
+            ]);
+        }
+
+        // Normalise headers if only smaller headers have been used
+        if (count($tree) > 0) {
+            $minLevel = $tree->pluck('level')->min();
+            $tree = $tree->map(function($header) use ($minLevel) {
+                $header['level'] -= ($minLevel - 2);
+                return $header;
+            });
+        }
+        return $tree->toArray();
+    }
+
+    /**
+     * Updates a page with any fillable data and saves it into the database.
+     * @param Page $page
+     * @param int $book_id
+     * @param array $input
+     * @return Page
+     */
+    public function updatePage(Page $page, $book_id, $input)
+    {
+        // Hold the old details to compare later
+        $oldHtml = $page->html;
+        $oldName = $page->name;
+
+        // Prevent slug being updated if no name change
+        if ($page->name !== $input['name']) {
+            $page->slug = $this->findSuitableSlug('page', $input['name'], $page->id, $book_id);
+        }
+
+        // Save page tags if present
+        if (isset($input['tags'])) {
+            $this->tagRepo->saveTagsToEntity($page, $input['tags']);
+        }
+
+        // Update with new details
+        $userId = user()->id;
+        $page->fill($input);
+        $page->html = $this->formatHtml($input['html']);
+        $page->text = $this->pageToPlainText($page);
+        if (setting('app-editor') !== 'markdown') $page->markdown = '';
+        $page->updated_by = $userId;
+        $page->revision_count++;
+        $page->save();
+
+        // Remove all update drafts for this user & page.
+        $this->userUpdatePageDraftsQuery($page, $userId)->delete();
+
+        // Save a revision after updating
+        if ($oldHtml !== $input['html'] || $oldName !== $input['name'] || $input['summary'] !== null) {
+            $this->savePageRevision($page, $input['summary']);
+        }
+
+        $this->searchService->indexEntity($page);
+
+        return $page;

     }
 
     /**
     }
 
     /**

-     * Apply extracted tag search terms onto a entity query.
-     * @param $query
-     * @param $tags
+     * The base query for getting user update drafts.
+     * @param Page $page
+     * @param $userId

      * @return mixed
      */
      * @return mixed
      */

-    protected function applyTagSearches($query, $tags) {
-        $query->where(function($query) use ($tags) {
-            foreach ($tags[1] as $index => $tagName) {
-                $query->whereHas('tags', function($query) use ($tags, $index, $tagName) {
-                    $tagOperator = $tags[3][$index];
-                    $tagValue = $tags[4][$index];
-                    if (!empty($tagOperator) && !empty($tagValue) && in_array($tagOperator, $this->queryOperators)) {
-                        if (is_numeric($tagValue) && $tagOperator !== 'like') {
-                            // We have to do a raw sql query for this since otherwise PDO will quote the value and MySQL will
-                            // search the value as a string which prevents being able to do number-based operations
-                            // on the tag values. We ensure it has a numeric value and then cast it just to be sure.
-                            $tagValue = (float) trim($query->getConnection()->getPdo()->quote($tagValue), "'");
-                            $query->where('name', '=', $tagName)->whereRaw("value ${tagOperator} ${tagValue}");
-                        } else {
-                            $query->where('name', '=', $tagName)->where('value', $tagOperator, $tagValue);
-                        }
-                    } else {
-                        $query->where('name', '=', $tagName);
-                    }
-                });
-            }
-        });
+    protected function userUpdatePageDraftsQuery(Page $page, $userId)
+    {
+        return $this->pageRevision->where('created_by', '=', $userId)
+            ->where('type', 'update_draft')
+            ->where('page_id', '=', $page->id)
+            ->orderBy('created_at', 'desc');
+    }
+
+    /**
+     * Checks whether a user has a draft version of a particular page or not.
+     * @param Page $page
+     * @param $userId
+     * @return bool
+     */
+    public function hasUserGotPageDraft(Page $page, $userId)
+    {
+        return $this->userUpdatePageDraftsQuery($page, $userId)->count() > 0;
+    }
+
+    /**
+     * Get the latest updated draft revision for a particular page and user.
+     * @param Page $page
+     * @param $userId
+     * @return mixed
+     */
+    public function getUserPageDraft(Page $page, $userId)
+    {
+        return $this->userUpdatePageDraftsQuery($page, $userId)->first();
+    }
+
+    /**
+     * Get the notification message that informs the user that they are editing a draft page.
+     * @param PageRevision $draft
+     * @return string
+     */
+    public function getUserPageDraftMessage(PageRevision $draft)
+    {
+        $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
+        if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) return $message;
+        return $message . "\n" . trans('entities.pages_draft_edited_notification');
+    }
+
+    /**
+     * Check if a page is being actively editing.
+     * Checks for edits since last page updated.
+     * Passing in a minuted range will check for edits
+     * within the last x minutes.
+     * @param Page $page
+     * @param null $minRange
+     * @return bool
+     */
+    public function isPageEditingActive(Page $page, $minRange = null)
+    {
+        $draftSearch = $this->activePageEditingQuery($page, $minRange);
+        return $draftSearch->count() > 0;
+    }
+
+    /**
+     * A query to check for active update drafts on a particular page.
+     * @param Page $page
+     * @param null $minRange
+     * @return mixed
+     */
+    protected function activePageEditingQuery(Page $page, $minRange = null)
+    {
+        $query = $this->pageRevision->where('type', '=', 'update_draft')
+            ->where('page_id', '=', $page->id)
+            ->where('updated_at', '>', $page->updated_at)
+            ->where('created_by', '!=', user()->id)
+            ->with('createdBy');
+
+        if ($minRange !== null) {
+            $query = $query->where('updated_at', '>=', Carbon::now()->subMinutes($minRange));
+        }
+

         return $query;
     }
 
     /**
         return $query;
     }
 
     /**

-     * Alias method to update the book jointPermissions in the PermissionService.
-     * @param Collection $collection collection on entities
+     * Restores a revision's content back into a page.
+     * @param Page $page
+     * @param Book $book
+     * @param  int $revisionId
+     * @return Page

      */
      */

-    public function buildJointPermissions(Collection $collection)
+    public function restorePageRevision(Page $page, Book $book, $revisionId)

     {
     {

-        $this->permissionService->buildJointPermissionsForEntities($collection);
+        $page->revision_count++;
+        $this->savePageRevision($page);
+        $revision = $page->revisions()->where('id', '=', $revisionId)->first();
+        $page->fill($revision->toArray());
+        $page->slug = $this->findSuitableSlug('page', $page->name, $page->id, $book->id);
+        $page->text = $this->pageToPlainText($page);
+        $page->updated_by = user()->id;
+        $page->save();
+        $this->searchService->indexEntity($page);
+        return $page;

     }
 
     }
 

+

     /**
     /**

-     * Format a name as a url slug.
-     * @param $name
+     * Save a page update draft.
+     * @param Page $page
+     * @param array $data
+     * @return PageRevision|Page
+     */
+    public function updatePageDraft(Page $page, $data = [])
+    {
+        // If the page itself is a draft simply update that
+        if ($page->draft) {
+            $page->fill($data);
+            if (isset($data['html'])) {
+                $page->text = $this->pageToPlainText($page);
+            }
+            $page->save();
+            return $page;
+        }
+
+        // Otherwise save the data to a revision
+        $userId = user()->id;
+        $drafts = $this->userUpdatePageDraftsQuery($page, $userId)->get();
+
+        if ($drafts->count() > 0) {
+            $draft = $drafts->first();
+        } else {
+            $draft = $this->pageRevision->newInstance();
+            $draft->page_id = $page->id;
+            $draft->slug = $page->slug;
+            $draft->book_slug = $page->book->slug;
+            $draft->created_by = $userId;
+            $draft->type = 'update_draft';
+        }
+
+        $draft->fill($data);
+        if (setting('app-editor') !== 'markdown') $draft->markdown = '';
+
+        $draft->save();
+        return $draft;
+    }
+
+    /**
+     * Get a notification message concerning the editing activity on a particular page.
+     * @param Page $page
+     * @param null $minRange

      * @return string
      */
      * @return string
      */

-    protected function nameToSlug($name)
+    public function getPageEditingActiveMessage(Page $page, $minRange = null)

     {
     {

-        $slug = str_replace(' ', '-', strtolower($name));
-        $slug = preg_replace('/[\+\/\\\?\@\}\{\.\,\=\[\]\#\&\!\*\'\;\:\$\%]/', '', $slug);
-        if ($slug === "") $slug = substr(md5(rand(1, 500)), 0, 5);
-        return $slug;
+        $pageDraftEdits = $this->activePageEditingQuery($page, $minRange)->get();
+
+        $userMessage = $pageDraftEdits->count() > 1 ? trans('entities.pages_draft_edit_active.start_a', ['count' => $pageDraftEdits->count()]): trans('entities.pages_draft_edit_active.start_b', ['userName' => $pageDraftEdits->first()->createdBy->name]);
+        $timeMessage = $minRange === null ? trans('entities.pages_draft_edit_active.time_a') : trans('entities.pages_draft_edit_active.time_b', ['minCount'=>$minRange]);
+        return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);
+    }
+
+    /**
+     * Change the page's parent to the given entity.
+     * @param Page $page
+     * @param Entity $parent
+     */
+    public function changePageParent(Page $page, Entity $parent)
+    {
+        $book = $parent->isA('book') ? $parent : $parent->book;
+        $page->chapter_id = $parent->isA('chapter') ? $parent->id : 0;
+        $page->save();
+        if ($page->book->id !== $book->id) {
+            $page = $this->changeBook('page', $book->id, $page);
+        }
+        $page->load('book');
+        $this->permissionService->buildJointPermissionsForEntity($book);
+    }
+
+    /**
+     * Destroy the provided book and all its child entities.
+     * @param Book $book
+     */
+    public function destroyBook(Book $book)
+    {
+        foreach ($book->pages as $page) {
+            $this->destroyPage($page);
+        }
+        foreach ($book->chapters as $chapter) {
+            $this->destroyChapter($chapter);
+        }
+        \Activity::removeEntity($book);
+        $book->views()->delete();
+        $book->permissions()->delete();
+        $this->permissionService->deleteJointPermissionsForEntity($book);
+        $this->searchService->deleteEntityTerms($book);
+        $book->delete();
+    }
+
+    /**
+     * Destroy a chapter and its relations.
+     * @param Chapter $chapter
+     */
+    public function destroyChapter(Chapter $chapter)
+    {
+        if (count($chapter->pages) > 0) {
+            foreach ($chapter->pages as $page) {
+                $page->chapter_id = 0;
+                $page->save();
+            }
+        }
+        \Activity::removeEntity($chapter);
+        $chapter->views()->delete();
+        $chapter->permissions()->delete();
+        $this->permissionService->deleteJointPermissionsForEntity($chapter);
+        $this->searchService->deleteEntityTerms($chapter);
+        $chapter->delete();
+    }
+
+    /**
+     * Destroy a given page along with its dependencies.
+     * @param Page $page
+     */
+    public function destroyPage(Page $page)
+    {
+        \Activity::removeEntity($page);
+        $page->views()->delete();
+        $page->tags()->delete();
+        $page->revisions()->delete();
+        $page->permissions()->delete();
+        $this->permissionService->deleteJointPermissionsForEntity($page);
+        $this->searchService->deleteEntityTerms($page);
+
+        // Delete Attached Files
+        $attachmentService = app(AttachmentService::class);
+        foreach ($page->attachments as $attachment) {
+            $attachmentService->deleteFile($attachment);
+        }
+
+        $page->delete();

     }
 
 }
     }
 
 }