BookStack Code Mirror - bookstack/blob - app/Repos/EntityRepo.php

   1 <?php namespace BookStack\Repos;
   2
   3 use BookStack\Book;
   4 use BookStack\Chapter;
   5 use BookStack\Entity;
   6 use BookStack\Exceptions\NotFoundException;
   7 use BookStack\Exceptions\NotifyException;
   8 use BookStack\Page;
   9 use BookStack\PageRevision;
  10 use BookStack\Services\AttachmentService;
  11 use BookStack\Services\PermissionService;
  12 use BookStack\Services\SearchService;
  13 use BookStack\Services\ViewService;
  14 use Carbon\Carbon;
  15 use DOMDocument;
  16 use DOMXPath;
  17 use Illuminate\Support\Collection;
  18
  19 class EntityRepo
  20 {
  21
  22     /**
  23      * @var Book $book
  24      */
  25     public $book;
  26
  27     /**
  28      * @var Chapter
  29      */
  30     public $chapter;
  31
  32     /**
  33      * @var Page
  34      */
  35     public $page;
  36
  37     /**
  38      * @var PageRevision
  39      */
  40     protected $pageRevision;
  41
  42     /**
  43      * Base entity instances keyed by type
  44      * @var []Entity
  45      */
  46     protected $entities;
  47
  48     /**
  49      * @var PermissionService
  50      */
  51     protected $permissionService;
  52
  53     /**
  54      * @var ViewService
  55      */
  56     protected $viewService;
  57
  58     /**
  59      * @var TagRepo
  60      */
  61     protected $tagRepo;
  62
  63     /**
  64      * @var SearchService
  65      */
  66     protected $searchService;
  67
  68     /**
  69      * EntityRepo constructor.
  70      * @param Book $book
  71      * @param Chapter $chapter
  72      * @param Page $page
  73      * @param PageRevision $pageRevision
  74      * @param ViewService $viewService
  75      * @param PermissionService $permissionService
  76      * @param TagRepo $tagRepo
  77      * @param SearchService $searchService
  78      */
  79     public function __construct(
  80         Book $book,
  81         Chapter $chapter,
  82         Page $page,
  83         PageRevision $pageRevision,
  84         ViewService $viewService,
  85         PermissionService $permissionService,
  86         TagRepo $tagRepo,
  87         SearchService $searchService
  88     ) {
  89         $this->book = $book;
  90         $this->chapter = $chapter;
  91         $this->page = $page;
  92         $this->pageRevision = $pageRevision;
  93         $this->entities = [
  94             'page' => $this->page,
  95             'chapter' => $this->chapter,
  96             'book' => $this->book
  97         ];
  98         $this->viewService = $viewService;
  99         $this->permissionService = $permissionService;
 100         $this->tagRepo = $tagRepo;
 101         $this->searchService = $searchService;
 102     }
 103
 104     /**
 105      * Get an entity instance via type.
 106      * @param $type
 107      * @return Entity
 108      */
 109     protected function getEntity($type)
 110     {
 111         return $this->entities[strtolower($type)];
 112     }
 113
 114     /**
 115      * Base query for searching entities via permission system
 116      * @param string $type
 117      * @param bool $allowDrafts
 118      * @return \Illuminate\Database\Query\Builder
 119      */
 120     protected function entityQuery($type, $allowDrafts = false, $permission = 'view')
 121     {
 122         $q = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type), $permission);
 123         if (strtolower($type) === 'page' && !$allowDrafts) {
 124             $q = $q->where('draft', '=', false);
 125         }
 126         return $q;
 127     }
 128
 129     /**
 130      * Check if an entity with the given id exists.
 131      * @param $type
 132      * @param $id
 133      * @return bool
 134      */
 135     public function exists($type, $id)
 136     {
 137         return $this->entityQuery($type)->where('id', '=', $id)->exists();
 138     }
 139
 140     /**
 141      * Get an entity by ID
 142      * @param string $type
 143      * @param integer $id
 144      * @param bool $allowDrafts
 145      * @param bool $ignorePermissions
 146      * @return Entity
 147      */
 148     public function getById($type, $id, $allowDrafts = false, $ignorePermissions = false)
 149     {
 150         if ($ignorePermissions) {
 151             $entity = $this->getEntity($type);
 152             return $entity->newQuery()->find($id);
 153         }
 154         return $this->entityQuery($type, $allowDrafts)->find($id);
 155     }
 156
 157     /**
 158      * Get an entity by its url slug.
 159      * @param string $type
 160      * @param string $slug
 161      * @param string|bool $bookSlug
 162      * @return Entity
 163      * @throws NotFoundException
 164      */
 165     public function getBySlug($type, $slug, $bookSlug = false)
 166     {
 167         $q = $this->entityQuery($type)->where('slug', '=', $slug);
 168
 169         if (strtolower($type) === 'chapter' || strtolower($type) === 'page') {
 170             $q = $q->where('book_id', '=', function ($query) use ($bookSlug) {
 171                 $query->select('id')
 172                     ->from($this->book->getTable())
 173                     ->where('slug', '=', $bookSlug)->limit(1);
 174             });
 175         }
 176         $entity = $q->first();
 177         if ($entity === null) {
 178             throw new NotFoundException(trans('errors.' . strtolower($type) . '_not_found'));
 179         }
 180         return $entity;
 181     }
 182
 183
 184     /**
 185      * Search through page revisions and retrieve the last page in the
 186      * current book that has a slug equal to the one given.
 187      * @param string $pageSlug
 188      * @param string $bookSlug
 189      * @return null|Page
 190      */
 191     public function getPageByOldSlug($pageSlug, $bookSlug)
 192     {
 193         $revision = $this->pageRevision->where('slug', '=', $pageSlug)
 194             ->whereHas('page', function ($query) {
 195                 $this->permissionService->enforceEntityRestrictions('page', $query);
 196             })
 197             ->where('type', '=', 'version')
 198             ->where('book_slug', '=', $bookSlug)
 199             ->orderBy('created_at', 'desc')
 200             ->with('page')->first();
 201         return $revision !== null ? $revision->page : null;
 202     }
 203
 204     /**
 205      * Get all entities of a type with the given permission, limited by count unless count is false.
 206      * @param string $type
 207      * @param integer|bool $count
 208      * @param string $permission
 209      * @return Collection
 210      */
 211     public function getAll($type, $count = 20, $permission = 'view')
 212     {
 213         $q = $this->entityQuery($type, false, $permission)->orderBy('name', 'asc');
 214         if ($count !== false) {
 215             $q = $q->take($count);
 216         }
 217         return $q->get();
 218     }
 219
 220     /**
 221      * Get all entities in a paginated format
 222      * @param $type
 223      * @param int $count
 224      * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
 225      */
 226     public function getAllPaginated($type, $count = 10)
 227     {
 228         return $this->entityQuery($type)->orderBy('name', 'asc')->paginate($count);
 229     }
 230
 231     /**
 232      * Get the most recently created entities of the given type.
 233      * @param string $type
 234      * @param int $count
 235      * @param int $page
 236      * @param bool|callable $additionalQuery
 237      * @return Collection
 238      */
 239     public function getRecentlyCreated($type, $count = 20, $page = 0, $additionalQuery = false)
 240     {
 241         $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
 242             ->orderBy('created_at', 'desc');
 243         if (strtolower($type) === 'page') {
 244             $query = $query->where('draft', '=', false);
 245         }
 246         if ($additionalQuery !== false && is_callable($additionalQuery)) {
 247             $additionalQuery($query);
 248         }
 249         return $query->skip($page * $count)->take($count)->get();
 250     }
 251
 252     /**
 253      * Get the most recently updated entities of the given type.
 254      * @param string $type
 255      * @param int $count
 256      * @param int $page
 257      * @param bool|callable $additionalQuery
 258      * @return Collection
 259      */
 260     public function getRecentlyUpdated($type, $count = 20, $page = 0, $additionalQuery = false)
 261     {
 262         $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
 263             ->orderBy('updated_at', 'desc');
 264         if (strtolower($type) === 'page') {
 265             $query = $query->where('draft', '=', false);
 266         }
 267         if ($additionalQuery !== false && is_callable($additionalQuery)) {
 268             $additionalQuery($query);
 269         }
 270         return $query->skip($page * $count)->take($count)->get();
 271     }
 272
 273     /**
 274      * Get the most recently viewed entities.
 275      * @param string|bool $type
 276      * @param int $count
 277      * @param int $page
 278      * @return mixed
 279      */
 280     public function getRecentlyViewed($type, $count = 10, $page = 0)
 281     {
 282         $filter = is_bool($type) ? false : $this->getEntity($type);
 283         return $this->viewService->getUserRecentlyViewed($count, $page, $filter);
 284     }
 285
 286     /**
 287      * Get the latest pages added to the system with pagination.
 288      * @param string $type
 289      * @param int $count
 290      * @return mixed
 291      */
 292     public function getRecentlyCreatedPaginated($type, $count = 20)
 293     {
 294         return $this->entityQuery($type)->orderBy('created_at', 'desc')->paginate($count);
 295     }
 296
 297     /**
 298      * Get the latest pages added to the system with pagination.
 299      * @param string $type
 300      * @param int $count
 301      * @return mixed
 302      */
 303     public function getRecentlyUpdatedPaginated($type, $count = 20)
 304     {
 305         return $this->entityQuery($type)->orderBy('updated_at', 'desc')->paginate($count);
 306     }
 307
 308     /**
 309      * Get the most popular entities base on all views.
 310      * @param string|bool $type
 311      * @param int $count
 312      * @param int $page
 313      * @return mixed
 314      */
 315     public function getPopular($type, $count = 10, $page = 0)
 316     {
 317         $filter = is_bool($type) ? false : $this->getEntity($type);
 318         return $this->viewService->getPopular($count, $page, $filter);
 319     }
 320
 321     /**
 322      * Get draft pages owned by the current user.
 323      * @param int $count
 324      * @param int $page
 325      */
 326     public function getUserDraftPages($count = 20, $page = 0)
 327     {
 328         return $this->page->where('draft', '=', true)
 329             ->where('created_by', '=', user()->id)
 330             ->orderBy('updated_at', 'desc')
 331             ->skip($count * $page)->take($count)->get();
 332     }
 333
 334     /**
 335      * Get all child objects of a book.
 336      * Returns a sorted collection of Pages and Chapters.
 337      * Loads the book slug onto child elements to prevent access database access for getting the slug.
 338      * @param Book $book
 339      * @param bool $filterDrafts
 340      * @param bool $renderPages
 341      * @return mixed
 342      */
 343     public function getBookChildren(Book $book, $filterDrafts = false, $renderPages = false)
 344     {
 345         $q = $this->permissionService->bookChildrenQuery($book->id, $filterDrafts, $renderPages)->get();
 346         $entities = [];
 347         $parents = [];
 348         $tree = [];
 349
 350         foreach ($q as $index => $rawEntity) {
 351             if ($rawEntity->entity_type === 'BookStack\\Page') {
 352                 $entities[$index] = $this->page->newFromBuilder($rawEntity);
 353                 if ($renderPages) {
 354                     $entities[$index]->html = $rawEntity->html;
 355                     $entities[$index]->html = $this->renderPage($entities[$index]);
 356                 };
 357             } else if ($rawEntity->entity_type === 'BookStack\\Chapter') {
 358                 $entities[$index] = $this->chapter->newFromBuilder($rawEntity);
 359                 $key = $entities[$index]->entity_type . ':' . $entities[$index]->id;
 360                 $parents[$key] = $entities[$index];
 361                 $parents[$key]->setAttribute('pages', collect());
 362             }
 363             if ($entities[$index]->chapter_id === 0 || $entities[$index]->chapter_id === '0') {
 364                 $tree[] = $entities[$index];
 365             }
 366             $entities[$index]->book = $book;
 367         }
 368
 369         foreach ($entities as $entity) {
 370             if ($entity->chapter_id === 0 || $entity->chapter_id === '0') {
 371                 continue;
 372             }
 373             $parentKey = 'BookStack\\Chapter:' . $entity->chapter_id;
 374             if (!isset($parents[$parentKey])) {
 375                 $tree[] = $entity;
 376                 continue;
 377             }
 378             $chapter = $parents[$parentKey];
 379             $chapter->pages->push($entity);
 380         }
 381
 382         return collect($tree);
 383     }
 384
 385     /**
 386      * Get the child items for a chapter sorted by priority but
 387      * with draft items floated to the top.
 388      * @param Chapter $chapter
 389      * @return \Illuminate\Database\Eloquent\Collection|static[]
 390      */
 391     public function getChapterChildren(Chapter $chapter)
 392     {
 393         return $this->permissionService->enforceEntityRestrictions('page', $chapter->pages())
 394             ->orderBy('draft', 'DESC')->orderBy('priority', 'ASC')->get();
 395     }
 396
 397
 398     /**
 399      * Get the next sequential priority for a new child element in the given book.
 400      * @param Book $book
 401      * @return int
 402      */
 403     public function getNewBookPriority(Book $book)
 404     {
 405         $lastElem = $this->getBookChildren($book)->pop();
 406         return $lastElem ? $lastElem->priority + 1 : 0;
 407     }
 408
 409     /**
 410      * Get a new priority for a new page to be added to the given chapter.
 411      * @param Chapter $chapter
 412      * @return int
 413      */
 414     public function getNewChapterPriority(Chapter $chapter)
 415     {
 416         $lastPage = $chapter->pages('DESC')->first();
 417         return $lastPage !== null ? $lastPage->priority + 1 : 0;
 418     }
 419
 420     /**
 421      * Find a suitable slug for an entity.
 422      * @param string $type
 423      * @param string $name
 424      * @param bool|integer $currentId
 425      * @param bool|integer $bookId Only pass if type is not a book
 426      * @return string
 427      */
 428     public function findSuitableSlug($type, $name, $currentId = false, $bookId = false)
 429     {
 430         $slug = $this->nameToSlug($name);
 431         while ($this->slugExists($type, $slug, $currentId, $bookId)) {
 432             $slug .= '-' . substr(md5(rand(1, 500)), 0, 3);
 433         }
 434         return $slug;
 435     }
 436
 437     /**
 438      * Check if a slug already exists in the database.
 439      * @param string $type
 440      * @param string $slug
 441      * @param bool|integer $currentId
 442      * @param bool|integer $bookId
 443      * @return bool
 444      */
 445     protected function slugExists($type, $slug, $currentId = false, $bookId = false)
 446     {
 447         $query = $this->getEntity($type)->where('slug', '=', $slug);
 448         if (strtolower($type) === 'page' || strtolower($type) === 'chapter') {
 449             $query = $query->where('book_id', '=', $bookId);
 450         }
 451         if ($currentId) {
 452             $query = $query->where('id', '!=', $currentId);
 453         }
 454         return $query->count() > 0;
 455     }
 456
 457     /**
 458      * Updates entity restrictions from a request
 459      * @param $request
 460      * @param Entity $entity
 461      */
 462     public function updateEntityPermissionsFromRequest($request, Entity $entity)
 463     {
 464         $entity->restricted = $request->get('restricted', '') === 'true';
 465         $entity->permissions()->delete();
 466
 467         if ($request->filled('restrictions')) {
 468             foreach ($request->get('restrictions') as $roleId => $restrictions) {
 469                 foreach ($restrictions as $action => $value) {
 470                     $entity->permissions()->create([
 471                         'role_id' => $roleId,
 472                         'action'  => strtolower($action)
 473                     ]);
 474                 }
 475             }
 476         }
 477
 478         $entity->save();
 479         $this->permissionService->buildJointPermissionsForEntity($entity);
 480     }
 481
 482
 483
 484     /**
 485      * Create a new entity from request input.
 486      * Used for books and chapters.
 487      * @param string $type
 488      * @param array $input
 489      * @param bool|Book $book
 490      * @return Entity
 491      */
 492     public function createFromInput($type, $input = [], $book = false)
 493     {
 494         $isChapter = strtolower($type) === 'chapter';
 495         $entity = $this->getEntity($type)->newInstance($input);
 496         $entity->slug = $this->findSuitableSlug($type, $entity->name, false, $isChapter ? $book->id : false);
 497         $entity->created_by = user()->id;
 498         $entity->updated_by = user()->id;
 499         $isChapter ? $book->chapters()->save($entity) : $entity->save();
 500         $this->permissionService->buildJointPermissionsForEntity($entity);
 501         $this->searchService->indexEntity($entity);
 502         return $entity;
 503     }
 504
 505     /**
 506      * Update entity details from request input.
 507      * Used for books and chapters
 508      * @param string $type
 509      * @param Entity $entityModel
 510      * @param array $input
 511      * @return Entity
 512      */
 513     public function updateFromInput($type, Entity $entityModel, $input = [])
 514     {
 515         if ($entityModel->name !== $input['name']) {
 516             $entityModel->slug = $this->findSuitableSlug($type, $input['name'], $entityModel->id);
 517         }
 518         $entityModel->fill($input);
 519         $entityModel->updated_by = user()->id;
 520         $entityModel->save();
 521         $this->permissionService->buildJointPermissionsForEntity($entityModel);
 522         $this->searchService->indexEntity($entityModel);
 523         return $entityModel;
 524     }
 525
 526     /**
 527      * Change the book that an entity belongs to.
 528      * @param string $type
 529      * @param integer $newBookId
 530      * @param Entity $entity
 531      * @param bool $rebuildPermissions
 532      * @return Entity
 533      */
 534     public function changeBook($type, $newBookId, Entity $entity, $rebuildPermissions = false)
 535     {
 536         $entity->book_id = $newBookId;
 537         // Update related activity
 538         foreach ($entity->activity as $activity) {
 539             $activity->book_id = $newBookId;
 540             $activity->save();
 541         }
 542         $entity->slug = $this->findSuitableSlug($type, $entity->name, $entity->id, $newBookId);
 543         $entity->save();
 544
 545         // Update all child pages if a chapter
 546         if (strtolower($type) === 'chapter') {
 547             foreach ($entity->pages as $page) {
 548                 $this->changeBook('page', $newBookId, $page, false);
 549             }
 550         }
 551
 552         // Update permissions if applicable
 553         if ($rebuildPermissions) {
 554             $entity->load('book');
 555             $this->permissionService->buildJointPermissionsForEntity($entity->book);
 556         }
 557
 558         return $entity;
 559     }
 560
 561     /**
 562      * Alias method to update the book jointPermissions in the PermissionService.
 563      * @param Book $book
 564      */
 565     public function buildJointPermissionsForBook(Book $book)
 566     {
 567         $this->permissionService->buildJointPermissionsForEntity($book);
 568     }
 569
 570     /**
 571      * Format a name as a url slug.
 572      * @param $name
 573      * @return string
 574      */
 575     protected function nameToSlug($name)
 576     {
 577         $slug = preg_replace('/[\+\/\\\?\@\}\{\.\,\=\[\]\#\&\!\*\'\;\:\$\%]/', '', mb_strtolower($name));
 578         $slug = preg_replace('/\s{2,}/', ' ', $slug);
 579         $slug = str_replace(' ', '-', $slug);
 580         if ($slug === "") {
 581             $slug = substr(md5(rand(1, 500)), 0, 5);
 582         }
 583         return $slug;
 584     }
 585
 586     /**
 587      * Publish a draft page to make it a normal page.
 588      * Sets the slug and updates the content.
 589      * @param Page $draftPage
 590      * @param array $input
 591      * @return Page
 592      */
 593     public function publishPageDraft(Page $draftPage, array $input)
 594     {
 595         $draftPage->fill($input);
 596
 597         // Save page tags if present
 598         if (isset($input['tags'])) {
 599             $this->tagRepo->saveTagsToEntity($draftPage, $input['tags']);
 600         }
 601
 602         $draftPage->slug = $this->findSuitableSlug('page', $draftPage->name, false, $draftPage->book->id);
 603         $draftPage->html = $this->formatHtml($input['html']);
 604         $draftPage->text = $this->pageToPlainText($draftPage);
 605         $draftPage->draft = false;
 606         $draftPage->revision_count = 1;
 607
 608         $draftPage->save();
 609         $this->savePageRevision($draftPage, trans('entities.pages_initial_revision'));
 610         $this->searchService->indexEntity($draftPage);
 611         return $draftPage;
 612     }
 613
 614     /**
 615      * Saves a page revision into the system.
 616      * @param Page $page
 617      * @param null|string $summary
 618      * @return PageRevision
 619      */
 620     public function savePageRevision(Page $page, $summary = null)
 621     {
 622         $revision = $this->pageRevision->newInstance($page->toArray());
 623         if (setting('app-editor') !== 'markdown') {
 624             $revision->markdown = '';
 625         }
 626         $revision->page_id = $page->id;
 627         $revision->slug = $page->slug;
 628         $revision->book_slug = $page->book->slug;
 629         $revision->created_by = user()->id;
 630         $revision->created_at = $page->updated_at;
 631         $revision->type = 'version';
 632         $revision->summary = $summary;
 633         $revision->revision_number = $page->revision_count;
 634         $revision->save();
 635
 636         // Clear old revisions
 637         if ($this->pageRevision->where('page_id', '=', $page->id)->count() > 50) {
 638             $this->pageRevision->where('page_id', '=', $page->id)
 639                 ->orderBy('created_at', 'desc')->skip(50)->take(5)->delete();
 640         }
 641
 642         return $revision;
 643     }
 644
 645     /**
 646      * Formats a page's html to be tagged correctly
 647      * within the system.
 648      * @param string $htmlText
 649      * @return string
 650      */
 651     protected function formatHtml($htmlText)
 652     {
 653         if ($htmlText == '') {
 654             return $htmlText;
 655         }
 656         libxml_use_internal_errors(true);
 657         $doc = new DOMDocument();
 658         $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
 659
 660         $container = $doc->documentElement;
 661         $body = $container->childNodes->item(0);
 662         $childNodes = $body->childNodes;
 663
 664         // Ensure no duplicate ids are used
 665         $idArray = [];
 666
 667         foreach ($childNodes as $index => $childNode) {
 668             /** @var \DOMElement $childNode */
 669             if (get_class($childNode) !== 'DOMElement') {
 670                 continue;
 671             }
 672
 673             // Overwrite id if not a BookStack custom id
 674             if ($childNode->hasAttribute('id')) {
 675                 $id = $childNode->getAttribute('id');
 676                 if (strpos($id, 'bkmrk') === 0 && array_search($id, $idArray) === false) {
 677                     $idArray[] = $id;
 678                     continue;
 679                 };
 680             }
 681
 682             // Create an unique id for the element
 683             // Uses the content as a basis to ensure output is the same every time
 684             // the same content is passed through.
 685             $contentId = 'bkmrk-' . substr(strtolower(preg_replace('/\s+/', '-', trim($childNode->nodeValue))), 0, 20);
 686             $newId = urlencode($contentId);
 687             $loopIndex = 0;
 688             while (in_array($newId, $idArray)) {
 689                 $newId = urlencode($contentId . '-' . $loopIndex);
 690                 $loopIndex++;
 691             }
 692
 693             $childNode->setAttribute('id', $newId);
 694             $idArray[] = $newId;
 695         }
 696
 697         // Generate inner html as a string
 698         $html = '';
 699         foreach ($childNodes as $childNode) {
 700             $html .= $doc->saveHTML($childNode);
 701         }
 702
 703         return $html;
 704     }
 705
 706
 707     /**
 708      * Render the page for viewing, Parsing and performing features such as page transclusion.
 709      * @param Page $page
 710      * @param bool $ignorePermissions
 711      * @return mixed|string
 712      */
 713     public function renderPage(Page $page, $ignorePermissions = false)
 714     {
 715         $content = $page->html;
 716         $matches = [];
 717         preg_match_all("/{{@\s?([0-9].*?)}}/", $content, $matches);
 718         if (count($matches[0]) === 0) {
 719             return $content;
 720         }
 721
 722         $topLevelTags = ['table', 'ul', 'ol'];
 723         foreach ($matches[1] as $index => $includeId) {
 724             $splitInclude = explode('#', $includeId, 2);
 725             $pageId = intval($splitInclude[0]);
 726             if (is_nan($pageId)) {
 727                 continue;
 728             }
 729
 730             $matchedPage = $this->getById('page', $pageId, false, $ignorePermissions);
 731             if ($matchedPage === null) {
 732                 $content = str_replace($matches[0][$index], '', $content);
 733                 continue;
 734             }
 735
 736             if (count($splitInclude) === 1) {
 737                 $content = str_replace($matches[0][$index], $matchedPage->html, $content);
 738                 continue;
 739             }
 740
 741             $doc = new DOMDocument();
 742             $doc->loadHTML(mb_convert_encoding('<body>'.$matchedPage->html.'</body>', 'HTML-ENTITIES', 'UTF-8'));
 743             $matchingElem = $doc->getElementById($splitInclude[1]);
 744             if ($matchingElem === null) {
 745                 $content = str_replace($matches[0][$index], '', $content);
 746                 continue;
 747             }
 748             $innerContent = '';
 749             $isTopLevel = in_array(strtolower($matchingElem->nodeName), $topLevelTags);
 750             if ($isTopLevel) {
 751                 $innerContent .= $doc->saveHTML($matchingElem);
 752             } else {
 753                 foreach ($matchingElem->childNodes as $childNode) {
 754                     $innerContent .= $doc->saveHTML($childNode);
 755                 }
 756             }
 757             $content = str_replace($matches[0][$index], trim($innerContent), $content);
 758         }
 759
 760         return $content;
 761     }
 762
 763     /**
 764      * Get the plain text version of a page's content.
 765      * @param Page $page
 766      * @return string
 767      */
 768     public function pageToPlainText(Page $page)
 769     {
 770         $html = $this->renderPage($page);
 771         return strip_tags($html);
 772     }
 773
 774     /**
 775      * Get a new draft page instance.
 776      * @param Book $book
 777      * @param Chapter|bool $chapter
 778      * @return Page
 779      */
 780     public function getDraftPage(Book $book, $chapter = false)
 781     {
 782         $page = $this->page->newInstance();
 783         $page->name = trans('entities.pages_initial_name');
 784         $page->created_by = user()->id;
 785         $page->updated_by = user()->id;
 786         $page->draft = true;
 787
 788         if ($chapter) {
 789             $page->chapter_id = $chapter->id;
 790         }
 791
 792         $book->pages()->save($page);
 793         $page = $this->page->find($page->id);
 794         $this->permissionService->buildJointPermissionsForEntity($page);
 795         return $page;
 796     }
 797
 798     /**
 799      * Search for image usage within page content.
 800      * @param $imageString
 801      * @return mixed
 802      */
 803     public function searchForImage($imageString)
 804     {
 805         $pages = $this->entityQuery('page')->where('html', 'like', '%' . $imageString . '%')->get();
 806         foreach ($pages as $page) {
 807             $page->url = $page->getUrl();
 808             $page->html = '';
 809             $page->text = '';
 810         }
 811         return count($pages) > 0 ? $pages : false;
 812     }
 813
 814     /**
 815      * Parse the headers on the page to get a navigation menu
 816      * @param String $pageContent
 817      * @return array
 818      */
 819     public function getPageNav($pageContent)
 820     {
 821         if ($pageContent == '') {
 822             return [];
 823         }
 824         libxml_use_internal_errors(true);
 825         $doc = new DOMDocument();
 826         $doc->loadHTML(mb_convert_encoding($pageContent, 'HTML-ENTITIES', 'UTF-8'));
 827         $xPath = new DOMXPath($doc);
 828         $headers = $xPath->query("//h1|//h2|//h3|//h4|//h5|//h6");
 829
 830         if (is_null($headers)) {
 831             return [];
 832         }
 833
 834         $tree = collect([]);
 835         foreach ($headers as $header) {
 836             $text = $header->nodeValue;
 837             $tree->push([
 838                 'nodeName' => strtolower($header->nodeName),
 839                 'level' => intval(str_replace('h', '', $header->nodeName)),
 840                 'link' => '#' . $header->getAttribute('id'),
 841                 'text' => strlen($text) > 30 ? substr($text, 0, 27) . '...' : $text
 842             ]);
 843         }
 844
 845         // Normalise headers if only smaller headers have been used
 846         if (count($tree) > 0) {
 847             $minLevel = $tree->pluck('level')->min();
 848             $tree = $tree->map(function ($header) use ($minLevel) {
 849                 $header['level'] -= ($minLevel - 2);
 850                 return $header;
 851             });
 852         }
 853         return $tree->toArray();
 854     }
 855
 856     /**
 857      * Updates a page with any fillable data and saves it into the database.
 858      * @param Page $page
 859      * @param int $book_id
 860      * @param array $input
 861      * @return Page
 862      */
 863     public function updatePage(Page $page, $book_id, $input)
 864     {
 865         // Hold the old details to compare later
 866         $oldHtml = $page->html;
 867         $oldName = $page->name;
 868
 869         // Prevent slug being updated if no name change
 870         if ($page->name !== $input['name']) {
 871             $page->slug = $this->findSuitableSlug('page', $input['name'], $page->id, $book_id);
 872         }
 873
 874         // Save page tags if present
 875         if (isset($input['tags'])) {
 876             $this->tagRepo->saveTagsToEntity($page, $input['tags']);
 877         }
 878
 879         // Update with new details
 880         $userId = user()->id;
 881         $page->fill($input);
 882         $page->html = $this->formatHtml($input['html']);
 883         $page->text = $this->pageToPlainText($page);
 884         if (setting('app-editor') !== 'markdown') {
 885             $page->markdown = '';
 886         }
 887         $page->updated_by = $userId;
 888         $page->revision_count++;
 889         $page->save();
 890
 891         // Remove all update drafts for this user & page.
 892         $this->userUpdatePageDraftsQuery($page, $userId)->delete();
 893
 894         // Save a revision after updating
 895         if ($oldHtml !== $input['html'] || $oldName !== $input['name'] || $input['summary'] !== null) {
 896             $this->savePageRevision($page, $input['summary']);
 897         }
 898
 899         $this->searchService->indexEntity($page);
 900
 901         return $page;
 902     }
 903
 904     /**
 905      * The base query for getting user update drafts.
 906      * @param Page $page
 907      * @param $userId
 908      * @return mixed
 909      */
 910     protected function userUpdatePageDraftsQuery(Page $page, $userId)
 911     {
 912         return $this->pageRevision->where('created_by', '=', $userId)
 913             ->where('type', 'update_draft')
 914             ->where('page_id', '=', $page->id)
 915             ->orderBy('created_at', 'desc');
 916     }
 917
 918     /**
 919      * Checks whether a user has a draft version of a particular page or not.
 920      * @param Page $page
 921      * @param $userId
 922      * @return bool
 923      */
 924     public function hasUserGotPageDraft(Page $page, $userId)
 925     {
 926         return $this->userUpdatePageDraftsQuery($page, $userId)->count() > 0;
 927     }
 928
 929     /**
 930      * Get the latest updated draft revision for a particular page and user.
 931      * @param Page $page
 932      * @param $userId
 933      * @return mixed
 934      */
 935     public function getUserPageDraft(Page $page, $userId)
 936     {
 937         return $this->userUpdatePageDraftsQuery($page, $userId)->first();
 938     }
 939
 940     /**
 941      * Get the notification message that informs the user that they are editing a draft page.
 942      * @param PageRevision $draft
 943      * @return string
 944      */
 945     public function getUserPageDraftMessage(PageRevision $draft)
 946     {
 947         $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
 948         if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
 949             return $message;
 950         }
 951         return $message . "\n" . trans('entities.pages_draft_edited_notification');
 952     }
 953
 954     /**
 955      * Check if a page is being actively editing.
 956      * Checks for edits since last page updated.
 957      * Passing in a minuted range will check for edits
 958      * within the last x minutes.
 959      * @param Page $page
 960      * @param null $minRange
 961      * @return bool
 962      */
 963     public function isPageEditingActive(Page $page, $minRange = null)
 964     {
 965         $draftSearch = $this->activePageEditingQuery($page, $minRange);
 966         return $draftSearch->count() > 0;
 967     }
 968
 969     /**
 970      * A query to check for active update drafts on a particular page.
 971      * @param Page $page
 972      * @param null $minRange
 973      * @return mixed
 974      */
 975     protected function activePageEditingQuery(Page $page, $minRange = null)
 976     {
 977         $query = $this->pageRevision->where('type', '=', 'update_draft')
 978             ->where('page_id', '=', $page->id)
 979             ->where('updated_at', '>', $page->updated_at)
 980             ->where('created_by', '!=', user()->id)
 981             ->with('createdBy');
 982
 983         if ($minRange !== null) {
 984             $query = $query->where('updated_at', '>=', Carbon::now()->subMinutes($minRange));
 985         }
 986
 987         return $query;
 988     }
 989
 990     /**
 991      * Restores a revision's content back into a page.
 992      * @param Page $page
 993      * @param Book $book
 994      * @param  int $revisionId
 995      * @return Page
 996      */
 997     public function restorePageRevision(Page $page, Book $book, $revisionId)
 998     {
 999         $page->revision_count++;
1000         $this->savePageRevision($page);
1001         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
1002         $page->fill($revision->toArray());
1003         $page->slug = $this->findSuitableSlug('page', $page->name, $page->id, $book->id);
1004         $page->text = $this->pageToPlainText($page);
1005         $page->updated_by = user()->id;
1006         $page->save();
1007         $this->searchService->indexEntity($page);
1008         return $page;
1009     }
1010
1011
1012     /**
1013      * Save a page update draft.
1014      * @param Page $page
1015      * @param array $data
1016      * @return PageRevision|Page
1017      */
1018     public function updatePageDraft(Page $page, $data = [])
1019     {
1020         // If the page itself is a draft simply update that
1021         if ($page->draft) {
1022             $page->fill($data);
1023             if (isset($data['html'])) {
1024                 $page->text = $this->pageToPlainText($page);
1025             }
1026             $page->save();
1027             return $page;
1028         }
1029
1030         // Otherwise save the data to a revision
1031         $userId = user()->id;
1032         $drafts = $this->userUpdatePageDraftsQuery($page, $userId)->get();
1033
1034         if ($drafts->count() > 0) {
1035             $draft = $drafts->first();
1036         } else {
1037             $draft = $this->pageRevision->newInstance();
1038             $draft->page_id = $page->id;
1039             $draft->slug = $page->slug;
1040             $draft->book_slug = $page->book->slug;
1041             $draft->created_by = $userId;
1042             $draft->type = 'update_draft';
1043         }
1044
1045         $draft->fill($data);
1046         if (setting('app-editor') !== 'markdown') {
1047             $draft->markdown = '';
1048         }
1049
1050         $draft->save();
1051         return $draft;
1052     }
1053
1054     /**
1055      * Get a notification message concerning the editing activity on a particular page.
1056      * @param Page $page
1057      * @param null $minRange
1058      * @return string
1059      */
1060     public function getPageEditingActiveMessage(Page $page, $minRange = null)
1061     {
1062         $pageDraftEdits = $this->activePageEditingQuery($page, $minRange)->get();
1063
1064         $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]);
1065         $timeMessage = $minRange === null ? trans('entities.pages_draft_edit_active.time_a') : trans('entities.pages_draft_edit_active.time_b', ['minCount'=>$minRange]);
1066         return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);
1067     }
1068
1069     /**
1070      * Change the page's parent to the given entity.
1071      * @param Page $page
1072      * @param Entity $parent
1073      */
1074     public function changePageParent(Page $page, Entity $parent)
1075     {
1076         $book = $parent->isA('book') ? $parent : $parent->book;
1077         $page->chapter_id = $parent->isA('chapter') ? $parent->id : 0;
1078         $page->save();
1079         if ($page->book->id !== $book->id) {
1080             $page = $this->changeBook('page', $book->id, $page);
1081         }
1082         $page->load('book');
1083         $this->permissionService->buildJointPermissionsForEntity($book);
1084     }
1085
1086     /**
1087      * Destroy the provided book and all its child entities.
1088      * @param Book $book
1089      */
1090     public function destroyBook(Book $book)
1091     {
1092         foreach ($book->pages as $page) {
1093             $this->destroyPage($page);
1094         }
1095         foreach ($book->chapters as $chapter) {
1096             $this->destroyChapter($chapter);
1097         }
1098         \Activity::removeEntity($book);
1099         $book->views()->delete();
1100         $book->permissions()->delete();
1101         $this->permissionService->deleteJointPermissionsForEntity($book);
1102         $this->searchService->deleteEntityTerms($book);
1103         $book->delete();
1104     }
1105
1106     /**
1107      * Destroy a chapter and its relations.
1108      * @param Chapter $chapter
1109      */
1110     public function destroyChapter(Chapter $chapter)
1111     {
1112         if (count($chapter->pages) > 0) {
1113             foreach ($chapter->pages as $page) {
1114                 $page->chapter_id = 0;
1115                 $page->save();
1116             }
1117         }
1118         \Activity::removeEntity($chapter);
1119         $chapter->views()->delete();
1120         $chapter->permissions()->delete();
1121         $this->permissionService->deleteJointPermissionsForEntity($chapter);
1122         $this->searchService->deleteEntityTerms($chapter);
1123         $chapter->delete();
1124     }
1125
1126     /**
1127      * Destroy a given page along with its dependencies.
1128      * @param Page $page
1129      * @throws NotifyException
1130      */
1131     public function destroyPage(Page $page)
1132     {
1133         \Activity::removeEntity($page);
1134         $page->views()->delete();
1135         $page->tags()->delete();
1136         $page->revisions()->delete();
1137         $page->permissions()->delete();
1138         $this->permissionService->deleteJointPermissionsForEntity($page);
1139         $this->searchService->deleteEntityTerms($page);
1140
1141         // Check if set as custom homepage
1142         $customHome = setting('app-homepage', '0:');
1143         if (intval($page->id) === intval(explode(':', $customHome)[0])) {
1144             throw new NotifyException(trans('errors.page_custom_home_deletion'), $page->getUrl());
1145         }
1146
1147         // Delete Attached Files
1148         $attachmentService = app(AttachmentService::class);
1149         foreach ($page->attachments as $attachment) {
1150             $attachmentService->deleteFile($attachment);
1151         }
1152
1153         $page->delete();
1154     }
1155 }