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

   1 <?php namespace BookStack\Repos;
   2
   3
   4 use Activity;
   5 use BookStack\Book;
   6 use BookStack\Chapter;
   7 use BookStack\Exceptions\NotFoundException;
   8 use BookStack\Services\RestrictionService;
   9 use Illuminate\Http\Request;
  10 use Illuminate\Support\Facades\Auth;
  11 use Illuminate\Support\Facades\Log;
  12 use Illuminate\Support\Str;
  13 use BookStack\Page;
  14 use BookStack\PageRevision;
  15 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  16
  17 class PageRepo
  18 {
  19     protected $page;
  20     protected $pageRevision;
  21     protected $restrictionService;
  22
  23     /**
  24      * PageRepo constructor.
  25      * @param Page $page
  26      * @param PageRevision $pageRevision
  27      * @param RestrictionService $restrictionService
  28      */
  29     public function __construct(Page $page, PageRevision $pageRevision, RestrictionService $restrictionService)
  30     {
  31         $this->page = $page;
  32         $this->pageRevision = $pageRevision;
  33         $this->restrictionService = $restrictionService;
  34     }
  35
  36     /**
  37      * Base query for getting pages, Takes restrictions into account.
  38      * @return mixed
  39      */
  40     private function pageQuery()
  41     {
  42         return $this->restrictionService->enforcePageRestrictions($this->page, 'view');
  43     }
  44
  45     /**
  46      * Get a page via a specific ID.
  47      * @param $id
  48      * @return mixed
  49      */
  50     public function getById($id)
  51     {
  52         return $this->pageQuery()->findOrFail($id);
  53     }
  54
  55     /**
  56      * Get a page identified by the given slug.
  57      * @param $slug
  58      * @param $bookId
  59      * @return mixed
  60      * @throws NotFoundException
  61      */
  62     public function getBySlug($slug, $bookId)
  63     {
  64         $page = $this->pageQuery()->where('slug', '=', $slug)->where('book_id', '=', $bookId)->first();
  65         if ($page === null) throw new NotFoundException('Page not found');
  66         return $page;
  67     }
  68
  69     /**
  70      * Search through page revisions and retrieve
  71      * the last page in the current book that
  72      * has a slug equal to the one given.
  73      * @param $pageSlug
  74      * @param $bookSlug
  75      * @return null | Page
  76      */
  77     public function findPageUsingOldSlug($pageSlug, $bookSlug)
  78     {
  79         $revision = $this->pageRevision->where('slug', '=', $pageSlug)
  80             ->whereHas('page', function($query) {
  81                 $this->restrictionService->enforcePageRestrictions($query);
  82             })
  83             ->where('book_slug', '=', $bookSlug)->orderBy('created_at', 'desc')
  84             ->with('page')->first();
  85         return $revision !== null ? $revision->page : null;
  86     }
  87
  88     /**
  89      * Get a new Page instance from the given input.
  90      * @param $input
  91      * @return Page
  92      */
  93     public function newFromInput($input)
  94     {
  95         $page = $this->page->fill($input);
  96         return $page;
  97     }
  98
  99
 100     /**
 101      * Save a new page into the system.
 102      * Input validation must be done beforehand.
 103      * @param array $input
 104      * @param Book  $book
 105      * @param int   $chapterId
 106      * @return Page
 107      */
 108     public function saveNew(array $input, Book $book, $chapterId = null)
 109     {
 110         $page = $this->newFromInput($input);
 111         $page->slug = $this->findSuitableSlug($page->name, $book->id);
 112
 113         if ($chapterId) $page->chapter_id = $chapterId;
 114
 115         $page->html = $this->formatHtml($input['html']);
 116         $page->text = strip_tags($page->html);
 117         $page->created_by = auth()->user()->id;
 118         $page->updated_by = auth()->user()->id;
 119
 120         $book->pages()->save($page);
 121         return $page;
 122     }
 123
 124     /**
 125      * Formats a page's html to be tagged correctly
 126      * within the system.
 127      * @param string $htmlText
 128      * @return string
 129      */
 130     protected function formatHtml($htmlText)
 131     {
 132         if($htmlText == '') return $htmlText;
 133         libxml_use_internal_errors(true);
 134         $doc = new \DOMDocument();
 135         $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
 136
 137         $container = $doc->documentElement;
 138         $body = $container->childNodes->item(0);
 139         $childNodes = $body->childNodes;
 140
 141         // Ensure no duplicate ids are used
 142         $idArray = [];
 143
 144         foreach ($childNodes as $index => $childNode) {
 145             /** @var \DOMElement $childNode */
 146             if (get_class($childNode) !== 'DOMElement') continue;
 147
 148             // Overwrite id if not a BookStack custom id
 149             if ($childNode->hasAttribute('id')) {
 150                 $id = $childNode->getAttribute('id');
 151                 if (strpos($id, 'bkmrk') === 0 && array_search($id, $idArray) === false) {
 152                     $idArray[] = $id;
 153                     continue;
 154                 };
 155             }
 156
 157             // Create an unique id for the element
 158             // Uses the content as a basis to ensure output is the same every time
 159             // the same content is passed through.
 160             $contentId = 'bkmrk-' . substr(strtolower(preg_replace('/\s+/', '-', trim($childNode->nodeValue))), 0, 20);
 161             $newId = urlencode($contentId);
 162             $loopIndex = 0;
 163             while (in_array($newId, $idArray)) {
 164                 $newId = urlencode($contentId . '-' . $loopIndex);
 165                 $loopIndex++;
 166             }
 167
 168             $childNode->setAttribute('id', $newId);
 169             $idArray[] = $newId;
 170         }
 171
 172         // Generate inner html as a string
 173         $html = '';
 174         foreach ($childNodes as $childNode) {
 175             $html .= $doc->saveHTML($childNode);
 176         }
 177
 178         return $html;
 179     }
 180
 181
 182     /**
 183      * Gets pages by a search term.
 184      * Highlights page content for showing in results.
 185      * @param string $term
 186      * @param array $whereTerms
 187      * @param int $count
 188      * @param array $paginationAppends
 189      * @return mixed
 190      */
 191     public function getBySearch($term, $whereTerms = [], $count = 20, $paginationAppends = [])
 192     {
 193         $terms = explode(' ', $term);
 194         $pages = $this->restrictionService->enforcePageRestrictions($this->page->fullTextSearchQuery(['name', 'text'], $terms, $whereTerms))
 195             ->paginate($count)->appends($paginationAppends);
 196
 197         // Add highlights to page text.
 198         $words = join('|', explode(' ', preg_quote(trim($term), '/')));
 199         //lookahead/behind assertions ensures cut between words
 200         $s = '\s\x00-/:-@\[-`{-~'; //character set for start/end of words
 201
 202         foreach ($pages as $page) {
 203             preg_match_all('#(?<=[' . $s . ']).{1,30}((' . $words . ').{1,30})+(?=[' . $s . '])#uis', $page->text, $matches, PREG_SET_ORDER);
 204             //delimiter between occurrences
 205             $results = [];
 206             foreach ($matches as $line) {
 207                 $results[] = htmlspecialchars($line[0], 0, 'UTF-8');
 208             }
 209             $matchLimit = 6;
 210             if (count($results) > $matchLimit) {
 211                 $results = array_slice($results, 0, $matchLimit);
 212             }
 213             $result = join('... ', $results);
 214
 215             //highlight
 216             $result = preg_replace('#' . $words . '#iu', "<span class=\"highlight\">\$0</span>", $result);
 217             if (strlen($result) < 5) {
 218                 $result = $page->getExcerpt(80);
 219             }
 220             $page->searchSnippet = $result;
 221         }
 222         return $pages;
 223     }
 224
 225     /**
 226      * Search for image usage.
 227      * @param $imageString
 228      * @return mixed
 229      */
 230     public function searchForImage($imageString)
 231     {
 232         $pages = $this->pageQuery()->where('html', 'like', '%' . $imageString . '%')->get();
 233         foreach ($pages as $page) {
 234             $page->url = $page->getUrl();
 235             $page->html = '';
 236             $page->text = '';
 237         }
 238         return count($pages) > 0 ? $pages : false;
 239     }
 240
 241     /**
 242      * Updates a page with any fillable data and saves it into the database.
 243      * @param Page   $page
 244      * @param int    $book_id
 245      * @param string $input
 246      * @return Page
 247      */
 248     public function updatePage(Page $page, $book_id, $input)
 249     {
 250         // Save a revision before updating
 251         if ($page->html !== $input['html'] || $page->name !== $input['name']) {
 252             $this->saveRevision($page);
 253         }
 254
 255         // Prevent slug being updated if no name change
 256         if ($page->name !== $input['name']) {
 257             $page->slug = $this->findSuitableSlug($input['name'], $book_id, $page->id);
 258         }
 259
 260         // Update with new details
 261         $page->fill($input);
 262         $page->html = $this->formatHtml($input['html']);
 263         $page->text = strip_tags($page->html);
 264         $page->updated_by = auth()->user()->id;
 265         $page->save();
 266         return $page;
 267     }
 268
 269     /**
 270      * Restores a revision's content back into a page.
 271      * @param Page $page
 272      * @param Book $book
 273      * @param  int $revisionId
 274      * @return Page
 275      */
 276     public function restoreRevision(Page $page, Book $book, $revisionId)
 277     {
 278         $this->saveRevision($page);
 279         $revision = $this->getRevisionById($revisionId);
 280         $page->fill($revision->toArray());
 281         $page->slug = $this->findSuitableSlug($page->name, $book->id, $page->id);
 282         $page->text = strip_tags($page->html);
 283         $page->updated_by = auth()->user()->id;
 284         $page->save();
 285         return $page;
 286     }
 287
 288     /**
 289      * Saves a page revision into the system.
 290      * @param Page $page
 291      * @return $this
 292      */
 293     public function saveRevision(Page $page)
 294     {
 295         $revision = $this->pageRevision->fill($page->toArray());
 296         $revision->page_id = $page->id;
 297         $revision->slug = $page->slug;
 298         $revision->book_slug = $page->book->slug;
 299         $revision->created_by = auth()->user()->id;
 300         $revision->created_at = $page->updated_at;
 301         $revision->save();
 302         // Clear old revisions
 303         if ($this->pageRevision->where('page_id', '=', $page->id)->count() > 50) {
 304             $this->pageRevision->where('page_id', '=', $page->id)
 305                 ->orderBy('created_at', 'desc')->skip(50)->take(5)->delete();
 306         }
 307         return $revision;
 308     }
 309
 310     /**
 311      * Gets a single revision via it's id.
 312      * @param $id
 313      * @return mixed
 314      */
 315     public function getRevisionById($id)
 316     {
 317         return $this->pageRevision->findOrFail($id);
 318     }
 319
 320     /**
 321      * Checks if a slug exists within a book already.
 322      * @param            $slug
 323      * @param            $bookId
 324      * @param bool|false $currentId
 325      * @return bool
 326      */
 327     public function doesSlugExist($slug, $bookId, $currentId = false)
 328     {
 329         $query = $this->page->where('slug', '=', $slug)->where('book_id', '=', $bookId);
 330         if ($currentId) $query = $query->where('id', '!=', $currentId);
 331         return $query->count() > 0;
 332     }
 333
 334     /**
 335      * Changes the related book for the specified page.
 336      * Changes the book id of any relations to the page that store the book id.
 337      * @param int  $bookId
 338      * @param Page $page
 339      * @return Page
 340      */
 341     public function changeBook($bookId, Page $page)
 342     {
 343         $page->book_id = $bookId;
 344         foreach ($page->activity as $activity) {
 345             $activity->book_id = $bookId;
 346             $activity->save();
 347         }
 348         $page->slug = $this->findSuitableSlug($page->name, $bookId, $page->id);
 349         $page->save();
 350         return $page;
 351     }
 352
 353     /**
 354      * Gets a suitable slug for the resource
 355      * @param            $name
 356      * @param            $bookId
 357      * @param bool|false $currentId
 358      * @return string
 359      */
 360     public function findSuitableSlug($name, $bookId, $currentId = false)
 361     {
 362         $slug = Str::slug($name);
 363         while ($this->doesSlugExist($slug, $bookId, $currentId)) {
 364             $slug .= '-' . substr(md5(rand(1, 500)), 0, 3);
 365         }
 366         return $slug;
 367     }
 368
 369     /**
 370      * Destroy a given page along with its dependencies.
 371      * @param $page
 372      */
 373     public function destroy($page)
 374     {
 375         Activity::removeEntity($page);
 376         $page->views()->delete();
 377         $page->revisions()->delete();
 378         $page->restrictions()->delete();
 379         $page->delete();
 380     }
 381
 382     /**
 383      * Get the latest pages added to the system.
 384      * @param $count
 385      */
 386     public function getRecentlyCreatedPaginated($count = 20)
 387     {
 388         return $this->pageQuery()->orderBy('created_at', 'desc')->paginate($count);
 389     }
 390
 391     /**
 392      * Get the latest pages added to the system.
 393      * @param $count
 394      */
 395     public function getRecentlyUpdatedPaginated($count = 20)
 396     {
 397         return $this->pageQuery()->orderBy('updated_at', 'desc')->paginate($count);
 398     }
 399
 400     /**
 401      * Updates pages restrictions from a request
 402      * @param $request
 403      * @param $page
 404      */
 405     public function updateRestrictionsFromRequest($request, $page)
 406     {
 407         // TODO - extract into shared repo
 408         $page->restricted = $request->has('restricted') && $request->get('restricted') === 'true';
 409         $page->restrictions()->delete();
 410         if ($request->has('restrictions')) {
 411             foreach($request->get('restrictions') as $roleId => $restrictions) {
 412                 foreach ($restrictions as $action => $value) {
 413                     $page->restrictions()->create([
 414                         'role_id' => $roleId,
 415                         'action'  => strtolower($action)
 416                     ]);
 417                 }
 418             }
 419         }
 420         $page->save();
 421     }
 422
 423 }