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