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