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

   1 <?php
   2
   3 namespace BookStack\Entities\Repos;
   4
   5 use BookStack\Activity\ActivityType;
   6 use BookStack\Entities\Models\Book;
   7 use BookStack\Entities\Models\Chapter;
   8 use BookStack\Entities\Models\Entity;
   9 use BookStack\Entities\Models\Page;
  10 use BookStack\Entities\Models\PageRevision;
  11 use BookStack\Entities\Tools\BookContents;
  12 use BookStack\Entities\Tools\PageContent;
  13 use BookStack\Entities\Tools\PageEditorData;
  14 use BookStack\Entities\Tools\TrashCan;
  15 use BookStack\Exceptions\MoveOperationException;
  16 use BookStack\Exceptions\NotFoundException;
  17 use BookStack\Exceptions\PermissionsException;
  18 use BookStack\Facades\Activity;
  19 use BookStack\References\ReferenceStore;
  20 use BookStack\References\ReferenceUpdater;
  21 use Exception;
  22 use Illuminate\Pagination\LengthAwarePaginator;
  23
  24 class PageRepo
  25 {
  26     public function __construct(
  27         protected BaseRepo $baseRepo,
  28         protected RevisionRepo $revisionRepo,
  29         protected ReferenceStore $referenceStore,
  30         protected ReferenceUpdater $referenceUpdater
  31     ) {
  32     }
  33
  34     /**
  35      * Get a page by ID.
  36      *
  37      * @throws NotFoundException
  38      */
  39     public function getById(int $id, array $relations = ['book']): Page
  40     {
  41         /** @var Page $page */
  42         $page = Page::visible()->with($relations)->find($id);
  43
  44         if (!$page) {
  45             throw new NotFoundException(trans('errors.page_not_found'));
  46         }
  47
  48         return $page;
  49     }
  50
  51     /**
  52      * Get a page its book and own slug.
  53      *
  54      * @throws NotFoundException
  55      */
  56     public function getBySlug(string $bookSlug, string $pageSlug): Page
  57     {
  58         $page = Page::visible()->whereSlugs($bookSlug, $pageSlug)->first();
  59
  60         if (!$page) {
  61             throw new NotFoundException(trans('errors.page_not_found'));
  62         }
  63
  64         return $page;
  65     }
  66
  67     /**
  68      * Get a page by its old slug but checking the revisions table
  69      * for the last revision that matched the given page and book slug.
  70      */
  71     public function getByOldSlug(string $bookSlug, string $pageSlug): ?Page
  72     {
  73         $revision = $this->revisionRepo->getBySlugs($bookSlug, $pageSlug);
  74
  75         return $revision->page ?? null;
  76     }
  77
  78     /**
  79      * Get pages that have been marked as a template.
  80      */
  81     public function getTemplates(int $count = 10, int $page = 1, string $search = ''): LengthAwarePaginator
  82     {
  83         $query = Page::visible()
  84             ->where('template', '=', true)
  85             ->orderBy('name', 'asc')
  86             ->skip(($page - 1) * $count)
  87             ->take($count);
  88
  89         if ($search) {
  90             $query->where('name', 'like', '%' . $search . '%');
  91         }
  92
  93         $paginator = $query->paginate($count, ['*'], 'page', $page);
  94         $paginator->withPath('/templates');
  95
  96         return $paginator;
  97     }
  98
  99     /**
 100      * Get a parent item via slugs.
 101      */
 102     public function getParentFromSlugs(string $bookSlug, string $chapterSlug = null): Entity
 103     {
 104         if ($chapterSlug !== null) {
 105             return Chapter::visible()->whereSlugs($bookSlug, $chapterSlug)->firstOrFail();
 106         }
 107
 108         return Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();
 109     }
 110
 111     /**
 112      * Get the draft copy of the given page for the current user.
 113      */
 114     public function getUserDraft(Page $page): ?PageRevision
 115     {
 116         return $this->revisionRepo->getLatestDraftForCurrentUser($page);
 117     }
 118
 119     /**
 120      * Get a new draft page belonging to the given parent entity.
 121      */
 122     public function getNewDraftPage(Entity $parent)
 123     {
 124         $page = (new Page())->forceFill([
 125             'name'       => trans('entities.pages_initial_name'),
 126             'created_by' => user()->id,
 127             'owned_by'   => user()->id,
 128             'updated_by' => user()->id,
 129             'draft'      => true,
 130         ]);
 131
 132         if ($parent instanceof Chapter) {
 133             $page->chapter_id = $parent->id;
 134             $page->book_id = $parent->book_id;
 135         } else {
 136             $page->book_id = $parent->id;
 137         }
 138
 139         $defaultTemplate = $page->book->defaultTemplate;
 140         if ($defaultTemplate && userCan('view', $defaultTemplate)) {
 141             $page->forceFill([
 142                 'html'  => $defaultTemplate->html,
 143                 'markdown' => $defaultTemplate->markdown,
 144             ]);
 145         }
 146
 147         $page->save();
 148         $page->refresh()->rebuildPermissions();
 149
 150         return $page;
 151     }
 152
 153     /**
 154      * Publish a draft page to make it a live, non-draft page.
 155      */
 156     public function publishDraft(Page $draft, array $input): Page
 157     {
 158         $draft->draft = false;
 159         $draft->revision_count = 1;
 160         $draft->priority = $this->getNewPriority($draft);
 161         $this->updateTemplateStatusAndContentFromInput($draft, $input);
 162         $this->baseRepo->update($draft, $input);
 163
 164         $this->revisionRepo->storeNewForPage($draft, trans('entities.pages_initial_revision'));
 165         $this->referenceStore->updateForPage($draft);
 166         $draft->refresh();
 167
 168         Activity::add(ActivityType::PAGE_CREATE, $draft);
 169
 170         return $draft;
 171     }
 172
 173     /**
 174      * Update a page in the system.
 175      */
 176     public function update(Page $page, array $input): Page
 177     {
 178         // Hold the old details to compare later
 179         $oldHtml = $page->html;
 180         $oldName = $page->name;
 181         $oldMarkdown = $page->markdown;
 182
 183         $this->updateTemplateStatusAndContentFromInput($page, $input);
 184         $this->baseRepo->update($page, $input);
 185         $this->referenceStore->updateForPage($page);
 186
 187         // Update with new details
 188         $page->revision_count++;
 189         $page->save();
 190
 191         // Remove all update drafts for this user & page.
 192         $this->revisionRepo->deleteDraftsForCurrentUser($page);
 193
 194         // Save a revision after updating
 195         $summary = trim($input['summary'] ?? '');
 196         $htmlChanged = isset($input['html']) && $input['html'] !== $oldHtml;
 197         $nameChanged = isset($input['name']) && $input['name'] !== $oldName;
 198         $markdownChanged = isset($input['markdown']) && $input['markdown'] !== $oldMarkdown;
 199         if ($htmlChanged || $nameChanged || $markdownChanged || $summary) {
 200             $this->revisionRepo->storeNewForPage($page, $summary);
 201         }
 202
 203         Activity::add(ActivityType::PAGE_UPDATE, $page);
 204
 205         return $page;
 206     }
 207
 208     protected function updateTemplateStatusAndContentFromInput(Page $page, array $input)
 209     {
 210         if (isset($input['template']) && userCan('templates-manage')) {
 211             $page->template = ($input['template'] === 'true');
 212         }
 213
 214         $pageContent = new PageContent($page);
 215         $currentEditor = $page->editor ?: PageEditorData::getSystemDefaultEditor();
 216         $newEditor = $currentEditor;
 217
 218         $haveInput = isset($input['markdown']) || isset($input['html']);
 219         $inputEmpty = empty($input['markdown']) && empty($input['html']);
 220
 221         if ($haveInput && $inputEmpty) {
 222             $pageContent->setNewHTML('', user());
 223         } elseif (!empty($input['markdown']) && is_string($input['markdown'])) {
 224             $newEditor = 'markdown';
 225             $pageContent->setNewMarkdown($input['markdown'], user());
 226         } elseif (isset($input['html'])) {
 227             $newEditor = 'wysiwyg';
 228             $pageContent->setNewHTML($input['html'], user());
 229         }
 230
 231         if ($newEditor !== $currentEditor && userCan('editor-change')) {
 232             $page->editor = $newEditor;
 233         }
 234     }
 235
 236     /**
 237      * Save a page update draft.
 238      */
 239     public function updatePageDraft(Page $page, array $input)
 240     {
 241         // If the page itself is a draft simply update that
 242         if ($page->draft) {
 243             $this->updateTemplateStatusAndContentFromInput($page, $input);
 244             $page->fill($input);
 245             $page->save();
 246
 247             return $page;
 248         }
 249
 250         // Otherwise, save the data to a revision
 251         $draft = $this->revisionRepo->getNewDraftForCurrentUser($page);
 252         $draft->fill($input);
 253
 254         if (!empty($input['markdown'])) {
 255             $draft->markdown = $input['markdown'];
 256             $draft->html = '';
 257         } else {
 258             $draft->html = $input['html'];
 259             $draft->markdown = '';
 260         }
 261
 262         $draft->save();
 263
 264         return $draft;
 265     }
 266
 267     /**
 268      * Destroy a page from the system.
 269      *
 270      * @throws Exception
 271      */
 272     public function destroy(Page $page)
 273     {
 274         $trashCan = new TrashCan();
 275         $trashCan->softDestroyPage($page);
 276         Activity::add(ActivityType::PAGE_DELETE, $page);
 277         $trashCan->autoClearOld();
 278     }
 279
 280     /**
 281      * Restores a revision's content back into a page.
 282      */
 283     public function restoreRevision(Page $page, int $revisionId): Page
 284     {
 285         $oldUrl = $page->getUrl();
 286         $page->revision_count++;
 287
 288         /** @var PageRevision $revision */
 289         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
 290
 291         $page->fill($revision->toArray());
 292         $content = new PageContent($page);
 293
 294         if (!empty($revision->markdown)) {
 295             $content->setNewMarkdown($revision->markdown, user());
 296         } else {
 297             $content->setNewHTML($revision->html, user());
 298         }
 299
 300         $page->updated_by = user()->id;
 301         $page->refreshSlug();
 302         $page->save();
 303         $page->indexForSearch();
 304         $this->referenceStore->updateForPage($page);
 305
 306         $summary = trans('entities.pages_revision_restored_from', ['id' => strval($revisionId), 'summary' => $revision->summary]);
 307         $this->revisionRepo->storeNewForPage($page, $summary);
 308
 309         if ($oldUrl !== $page->getUrl()) {
 310             $this->referenceUpdater->updateEntityPageReferences($page, $oldUrl);
 311         }
 312
 313         Activity::add(ActivityType::PAGE_RESTORE, $page);
 314         Activity::add(ActivityType::REVISION_RESTORE, $revision);
 315
 316         return $page;
 317     }
 318
 319     /**
 320      * Move the given page into a new parent book or chapter.
 321      * The $parentIdentifier must be a string of the following format:
 322      * 'book:<id>' (book:5).
 323      *
 324      * @throws MoveOperationException
 325      * @throws PermissionsException
 326      */
 327     public function move(Page $page, string $parentIdentifier): Entity
 328     {
 329         $parent = $this->findParentByIdentifier($parentIdentifier);
 330         if (is_null($parent)) {
 331             throw new MoveOperationException('Book or chapter to move page into not found');
 332         }
 333
 334         if (!userCan('page-create', $parent)) {
 335             throw new PermissionsException('User does not have permission to create a page within the new parent');
 336         }
 337
 338         $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : null;
 339         $newBookId = ($parent instanceof Chapter) ? $parent->book->id : $parent->id;
 340         $page->changeBook($newBookId);
 341         $page->rebuildPermissions();
 342
 343         Activity::add(ActivityType::PAGE_MOVE, $page);
 344
 345         return $parent;
 346     }
 347
 348     /**
 349      * Find a page parent entity via an identifier string in the format:
 350      * {type}:{id}
 351      * Example: (book:5).
 352      *
 353      * @throws MoveOperationException
 354      */
 355     public function findParentByIdentifier(string $identifier): ?Entity
 356     {
 357         $stringExploded = explode(':', $identifier);
 358         $entityType = $stringExploded[0];
 359         $entityId = intval($stringExploded[1]);
 360
 361         if ($entityType !== 'book' && $entityType !== 'chapter') {
 362             throw new MoveOperationException('Pages can only be in books or chapters');
 363         }
 364
 365         $parentClass = $entityType === 'book' ? Book::class : Chapter::class;
 366
 367         return $parentClass::visible()->where('id', '=', $entityId)->first();
 368     }
 369
 370     /**
 371      * Get a new priority for a page.
 372      */
 373     protected function getNewPriority(Page $page): int
 374     {
 375         $parent = $page->getParent();
 376         if ($parent instanceof Chapter) {
 377             /** @var ?Page $lastPage */
 378             $lastPage = $parent->pages('desc')->first();
 379
 380             return $lastPage ? $lastPage->priority + 1 : 0;
 381         }
 382
 383         return (new BookContents($page->book))->getLastPriority() + 1;
 384     }
 385 }