TypeScript: Updated compile target, addressed issues

[bookstack] / app / Entities / Repos / PageRepo.php

diff --git a/app/Entities/Repos/PageRepo.php b/app/Entities/Repos/PageRepo.php
index 5eb882a026a3f803369b56b06b6334c46e8773c9..63e8b8370ee046ad20b14de6b122ce18e050ecd6 100644 (file)
--- a/app/Entities/Repos/PageRepo.php
+++ b/app/Entities/Repos/PageRepo.php
@@ -1,125 +1,36 @@
-<?php namespace BookStack\Entities\Repos;
+<?php

 
 

-use BookStack\Actions\ActivityType;
+namespace BookStack\Entities\Repos;
+
+use BookStack\Activity\ActivityType;

 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Entity;

+use BookStack\Entities\Models\Page;
+use BookStack\Entities\Models\PageRevision;
+use BookStack\Entities\Queries\EntityQueries;

 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\PageContent;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\PageContent;

+use BookStack\Entities\Tools\PageEditorType;

 use BookStack\Entities\Tools\TrashCan;
 use BookStack\Entities\Tools\TrashCan;

-use BookStack\Entities\Models\Page;
-use BookStack\Entities\Models\PageRevision;

 use BookStack\Exceptions\MoveOperationException;
 use BookStack\Exceptions\MoveOperationException;

-use BookStack\Exceptions\NotFoundException;

 use BookStack\Exceptions\PermissionsException;
 use BookStack\Facades\Activity;
 use BookStack\Exceptions\PermissionsException;
 use BookStack\Facades\Activity;

+use BookStack\References\ReferenceStore;
+use BookStack\References\ReferenceUpdater;
+use BookStack\Util\DatabaseTransaction;

 use Exception;
 use Exception;

-use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Pagination\LengthAwarePaginator;
-use Illuminate\Support\Collection;

 
 class PageRepo
 {
 
 class PageRepo
 {

-
-    protected $baseRepo;
-
-    /**
-     * PageRepo constructor.
-     */
-    public function __construct(BaseRepo $baseRepo)
-    {
-        $this->baseRepo = $baseRepo;
-    }
-
-    /**
-     * Get a page by ID.
-     * @throws NotFoundException
-     */
-    public function getById(int $id, array $relations = ['book']): Page
-    {
-        $page = Page::visible()->with($relations)->find($id);
-
-        if (!$page) {
-            throw new NotFoundException(trans('errors.page_not_found'));
-        }
-
-        return $page;
-    }
-
-    /**
-     * Get a page its book and own slug.
-     * @throws NotFoundException
-     */
-    public function getBySlug(string $bookSlug, string $pageSlug): Page
-    {
-        $page = Page::visible()->whereSlugs($bookSlug, $pageSlug)->first();
-
-        if (!$page) {
-            throw new NotFoundException(trans('errors.page_not_found'));
-        }
-
-        return $page;
-    }
-
-    /**
-     * Get a page by its old slug but checking the revisions table
-     * for the last revision that matched the given page and book slug.
-     */
-    public function getByOldSlug(string $bookSlug, string $pageSlug): ?Page
-    {
-        $revision = PageRevision::query()
-            ->whereHas('page', function (Builder $query) {
-                $query->visible();
-            })
-            ->where('slug', '=', $pageSlug)
-            ->where('type', '=', 'version')
-            ->where('book_slug', '=', $bookSlug)
-            ->orderBy('created_at', 'desc')
-            ->with('page')
-            ->first();
-        return $revision ? $revision->page : null;
-    }
-
-    /**
-     * Get pages that have been marked as a template.
-     */
-    public function getTemplates(int $count = 10, int $page = 1, string $search = ''): LengthAwarePaginator
-    {
-        $query = Page::visible()
-            ->where('template', '=', true)
-            ->orderBy('name', 'asc')
-            ->skip(($page - 1) * $count)
-            ->take($count);
-
-        if ($search) {
-            $query->where('name', 'like', '%' . $search . '%');
-        }
-
-        $paginator = $query->paginate($count, ['*'], 'page', $page);
-        $paginator->withPath('/templates');
-
-        return $paginator;
-    }
-
-    /**
-     * Get a parent item via slugs.
-     */
-    public function getParentFromSlugs(string $bookSlug, string $chapterSlug = null): Entity
-    {
-        if ($chapterSlug !== null) {
-            return $chapter = Chapter::visible()->whereSlugs($bookSlug, $chapterSlug)->firstOrFail();
-        }
-
-        return Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();
-    }
-
-    /**
-     * Get the draft copy of the given page for the current user.
-     */
-    public function getUserDraft(Page $page): ?PageRevision
-    {
-        $revision = $this->getUserDraftQuery($page)->first();
-        return $revision;
+    public function __construct(
+        protected BaseRepo $baseRepo,
+        protected RevisionRepo $revisionRepo,
+        protected EntityQueries $entityQueries,
+        protected ReferenceStore $referenceStore,
+        protected ReferenceUpdater $referenceUpdater,
+        protected TrashCan $trashCan,
+    ) {

     }
 
     /**
     }
 
     /**


@@ -128,11 +39,12 @@ class PageRepo
     public function getNewDraftPage(Entity $parent)
     {
         $page = (new Page())->forceFill([
     public function getNewDraftPage(Entity $parent)
     {
         $page = (new Page())->forceFill([

-            'name' => trans('entities.pages_initial_name'),
+            'name'       => trans('entities.pages_initial_name'),

             'created_by' => user()->id,
             'created_by' => user()->id,

-            'owned_by' => user()->id,
+            'owned_by'   => user()->id,

             'updated_by' => user()->id,
             'updated_by' => user()->id,

-            'draft' => true,
+            'draft'      => true,
+            'editor'     => PageEditorType::getSystemDefault()->value,

         ]);
 
         if ($parent instanceof Chapter) {
         ]);
 
         if ($parent instanceof Chapter) {


@@ -142,8 +54,19 @@ class PageRepo
             $page->book_id = $parent->id;
         }
 
             $page->book_id = $parent->id;
         }
 

-        $page->save();
-        $page->refresh()->rebuildPermissions();
+        $defaultTemplate = $page->chapter->defaultTemplate ?? $page->book->defaultTemplate;
+        if ($defaultTemplate && userCan('view', $defaultTemplate)) {
+            $page->forceFill([
+                'html'  => $defaultTemplate->html,
+                'markdown' => $defaultTemplate->markdown,
+            ]);
+        }
+
+        (new DatabaseTransaction(function () use ($page) {
+            $page->save();
+            $page->refresh()->rebuildPermissions();
+        }))->run();
+

         return $page;
     }
 
         return $page;
     }
 


@@ -152,21 +75,34 @@ class PageRepo
      */
     public function publishDraft(Page $draft, array $input): Page
     {
      */
     public function publishDraft(Page $draft, array $input): Page
     {

-        $this->baseRepo->update($draft, $input);
-        $this->updateTemplateStatusAndContentFromInput($draft, $input);
-
-        $draft->draft = false;
-        $draft->revision_count = 1;
-        $draft->priority = $this->getNewPriority($draft);
-        $draft->refreshSlug();
-        $draft->save();
-
-        $this->savePageRevision($draft, trans('entities.pages_initial_revision'));
-        $draft->indexForSearch();
-        $draft->refresh();
+        return (new DatabaseTransaction(function () use ($draft, $input) {
+            $draft->draft = false;
+            $draft->revision_count = 1;
+            $draft->priority = $this->getNewPriority($draft);
+            $this->updateTemplateStatusAndContentFromInput($draft, $input);
+            $this->baseRepo->update($draft, $input);
+            $draft->rebuildPermissions();
+
+            $summary = trim($input['summary'] ?? '') ?: trans('entities.pages_initial_revision');
+            $this->revisionRepo->storeNewForPage($draft, $summary);
+            $draft->refresh();
+
+            Activity::add(ActivityType::PAGE_CREATE, $draft);
+            $this->baseRepo->sortParent($draft);
+
+            return $draft;
+        }))->run();
+    }

 
 

-        Activity::addForEntity($draft, ActivityType::PAGE_CREATE);
-        return $draft;
+    /**
+     * Directly update the content for the given page from the provided input.
+     * Used for direct content access in a way that performs required changes
+     * (Search index and reference regen) without performing an official update.
+     */
+    public function setContentFromInput(Page $page, array $input): void
+    {
+        $this->updateTemplateStatusAndContentFromInput($page, $input);
+        $this->baseRepo->update($page, []);

     }
 
     /**
     }
 
     /**


@@ -186,55 +122,54 @@ class PageRepo
         $page->revision_count++;
         $page->save();
 
         $page->revision_count++;
         $page->save();
 

-        // Remove all update drafts for this user & page.
-        $this->getUserDraftQuery($page)->delete();
+        // Remove all update drafts for this user and page.
+        $this->revisionRepo->deleteDraftsForCurrentUser($page);

 
         // Save a revision after updating
 
         // Save a revision after updating

-        $summary = trim($input['summary'] ?? "");
+        $summary = trim($input['summary'] ?? '');

         $htmlChanged = isset($input['html']) && $input['html'] !== $oldHtml;
         $nameChanged = isset($input['name']) && $input['name'] !== $oldName;
         $markdownChanged = isset($input['markdown']) && $input['markdown'] !== $oldMarkdown;
         if ($htmlChanged || $nameChanged || $markdownChanged || $summary) {
         $htmlChanged = isset($input['html']) && $input['html'] !== $oldHtml;
         $nameChanged = isset($input['name']) && $input['name'] !== $oldName;
         $markdownChanged = isset($input['markdown']) && $input['markdown'] !== $oldMarkdown;
         if ($htmlChanged || $nameChanged || $markdownChanged || $summary) {

-            $this->savePageRevision($page, $summary);
+            $this->revisionRepo->storeNewForPage($page, $summary);

         }
 
         }
 

-        Activity::addForEntity($page, ActivityType::PAGE_UPDATE);
+        Activity::add(ActivityType::PAGE_UPDATE, $page);
+        $this->baseRepo->sortParent($page);
+

         return $page;
     }
 
         return $page;
     }
 

-    protected function updateTemplateStatusAndContentFromInput(Page $page, array $input)
+    protected function updateTemplateStatusAndContentFromInput(Page $page, array $input): void

     {
         if (isset($input['template']) && userCan('templates-manage')) {
             $page->template = ($input['template'] === 'true');
         }
 
         $pageContent = new PageContent($page);
     {
         if (isset($input['template']) && userCan('templates-manage')) {
             $page->template = ($input['template'] === 'true');
         }
 
         $pageContent = new PageContent($page);

-        if (!empty($input['markdown'] ?? '')) {
-            $pageContent->setNewMarkdown($input['markdown']);
-        } else {
-            $pageContent->setNewHTML($input['html'] ?? '');
+        $defaultEditor = PageEditorType::getSystemDefault();
+        $currentEditor = PageEditorType::forPage($page) ?: $defaultEditor;
+        $inputEditor = PageEditorType::fromRequestValue($input['editor'] ?? '') ?? $currentEditor;
+        $newEditor = $currentEditor;
+
+        $haveInput = isset($input['markdown']) || isset($input['html']);
+        $inputEmpty = empty($input['markdown']) && empty($input['html']);
+
+        if ($haveInput && $inputEmpty) {
+            $pageContent->setNewHTML('', user());
+        } elseif (!empty($input['markdown']) && is_string($input['markdown'])) {
+            $newEditor = PageEditorType::Markdown;
+            $pageContent->setNewMarkdown($input['markdown'], user());
+        } elseif (isset($input['html'])) {
+            $newEditor = ($inputEditor->isHtmlBased() ? $inputEditor : null) ?? ($defaultEditor->isHtmlBased() ? $defaultEditor : null) ?? PageEditorType::WysiwygTinymce;
+            $pageContent->setNewHTML($input['html'], user());

         }
         }

-    }

 
 

-    /**
-     * Saves a page revision into the system.
-     */
-    protected function savePageRevision(Page $page, string $summary = null): PageRevision
-    {
-        $revision = new PageRevision($page->getAttributes());
-
-        $revision->page_id = $page->id;
-        $revision->slug = $page->slug;
-        $revision->book_slug = $page->book->slug;
-        $revision->created_by = user()->id;
-        $revision->created_at = $page->updated_at;
-        $revision->type = 'version';
-        $revision->summary = $summary;
-        $revision->revision_number = $page->revision_count;
-        $revision->save();
-
-        $this->deleteOldRevisions($page);
-        return $revision;
+        if (($newEditor !== $currentEditor || empty($page->editor)) && userCan('editor-change')) {
+            $page->editor = $newEditor->value;
+        } elseif (empty($page->editor)) {
+            $page->editor = $defaultEditor->value;
+        }

     }
 
     /**
     }
 
     /**


@@ -244,35 +179,40 @@ class PageRepo
     {
         // If the page itself is a draft simply update that
         if ($page->draft) {
     {
         // If the page itself is a draft simply update that
         if ($page->draft) {

-            if (isset($input['html'])) {
-                (new PageContent($page))->setNewHTML($input['html']);
-            }
+            $this->updateTemplateStatusAndContentFromInput($page, $input);

             $page->fill($input);
             $page->save();
             $page->fill($input);
             $page->save();

+

             return $page;
         }
 
             return $page;
         }
 

-        // Otherwise save the data to a revision
-        $draft = $this->getPageRevisionToUpdate($page);
+        // Otherwise, save the data to a revision
+        $draft = $this->revisionRepo->getNewDraftForCurrentUser($page);

         $draft->fill($input);
         $draft->fill($input);

-        if (setting('app-editor') !== 'markdown') {
+
+        if (!empty($input['markdown'])) {
+            $draft->markdown = $input['markdown'];
+            $draft->html = '';
+        } else {
+            $draft->html = $input['html'];

             $draft->markdown = '';
         }
 
         $draft->save();
             $draft->markdown = '';
         }
 
         $draft->save();

+

         return $draft;
     }
 
     /**
      * Destroy a page from the system.
         return $draft;
     }
 
     /**
      * Destroy a page from the system.

+     *

      * @throws Exception
      */
     public function destroy(Page $page)
     {
      * @throws Exception
      */
     public function destroy(Page $page)
     {

-        $trashCan = new TrashCan();
-        $trashCan->softDestroyPage($page);
-        Activity::addForEntity($page, ActivityType::PAGE_DELETE);
-        $trashCan->autoClearOld();
+        $this->trashCan->softDestroyPage($page);
+        Activity::add(ActivityType::PAGE_DELETE, $page);
+        $this->trashCan->autoClearOld();

     }
 
     /**
     }
 
     /**


@@ -280,66 +220,54 @@ class PageRepo
      */
     public function restoreRevision(Page $page, int $revisionId): Page
     {
      */
     public function restoreRevision(Page $page, int $revisionId): Page
     {

+        $oldUrl = $page->getUrl();

         $page->revision_count++;
         $page->revision_count++;

+
+        /** @var PageRevision $revision */

         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
 
         $page->fill($revision->toArray());
         $content = new PageContent($page);
 
         if (!empty($revision->markdown)) {
         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
 
         $page->fill($revision->toArray());
         $content = new PageContent($page);
 
         if (!empty($revision->markdown)) {

-            $content->setNewMarkdown($revision->markdown);
+            $content->setNewMarkdown($revision->markdown, user());

         } else {
         } else {

-            $content->setNewHTML($revision->html);
+            $content->setNewHTML($revision->html, user());

         }
         }

-        
+

         $page->updated_by = user()->id;
         $page->refreshSlug();
         $page->save();
         $page->indexForSearch();
         $page->updated_by = user()->id;
         $page->refreshSlug();
         $page->save();
         $page->indexForSearch();

+        $this->referenceStore->updateForEntity($page);

 
         $summary = trans('entities.pages_revision_restored_from', ['id' => strval($revisionId), 'summary' => $revision->summary]);
 
         $summary = trans('entities.pages_revision_restored_from', ['id' => strval($revisionId), 'summary' => $revision->summary]);

-        $this->savePageRevision($page, $summary);
+        $this->revisionRepo->storeNewForPage($page, $summary);

 
 

-        Activity::addForEntity($page, ActivityType::PAGE_RESTORE);
-        return $page;
-    }
-
-    /**
-     * Move the given page into a new parent book or chapter.
-     * The $parentIdentifier must be a string of the following format:
-     * 'book:<id>' (book:5)
-     * @throws MoveOperationException
-     * @throws PermissionsException
-     */
-    public function move(Page $page, string $parentIdentifier): Entity
-    {
-        $parent = $this->findParentByIdentifier($parentIdentifier);
-        if ($parent === null) {
-            throw new MoveOperationException('Book or chapter to move page into not found');
+        if ($oldUrl !== $page->getUrl()) {
+            $this->referenceUpdater->updateEntityReferences($page, $oldUrl);

         }
 
         }
 

-        if (!userCan('page-create', $parent)) {
-            throw new PermissionsException('User does not have permission to create a page within the new parent');
-        }
+        Activity::add(ActivityType::PAGE_RESTORE, $page);
+        Activity::add(ActivityType::REVISION_RESTORE, $revision);

 
 

-        $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : null;
-        $page->changeBook($parent instanceof Book ? $parent->id : $parent->book->id);
-        $page->rebuildPermissions();
+        $this->baseRepo->sortParent($page);

 
 

-        Activity::addForEntity($page, ActivityType::PAGE_MOVE);
-        return $parent;
+        return $page;

     }
 
     /**
     }
 
     /**

-     * Copy an existing page in the system.
-     * Optionally providing a new parent via string identifier and a new name.
+     * Move the given page into a new parent book or chapter.
+     * The $parentIdentifier must be a string of the following format:
+     * 'book:<id>' (book:5).
+     *

      * @throws MoveOperationException
      * @throws PermissionsException
      */
      * @throws MoveOperationException
      * @throws PermissionsException
      */

-    public function copy(Page $page, string $parentIdentifier = null, string $newName = null): Page
+    public function move(Page $page, string $parentIdentifier): Entity

     {
     {

-        $parent = $parentIdentifier ? $this->findParentByIdentifier($parentIdentifier) : $page->getParent();
-        if ($parent === null) {
+        $parent = $this->entityQueries->findVisibleByStringIdentifier($parentIdentifier);
+        if (!$parent instanceof Chapter && !$parent instanceof Book) {

             throw new MoveOperationException('Book or chapter to move page into not found');
         }
 
             throw new MoveOperationException('Book or chapter to move page into not found');
         }
 


@@ -347,125 +275,33 @@ class PageRepo
             throw new PermissionsException('User does not have permission to create a page within the new parent');
         }
 
             throw new PermissionsException('User does not have permission to create a page within the new parent');
         }
 

-        $copyPage = $this->getNewDraftPage($parent);
-        $pageData = $page->getAttributes();
-
-        // Update name
-        if (!empty($newName)) {
-            $pageData['name'] = $newName;
-        }
-
-        // Copy tags from previous page if set
-        if ($page->tags) {
-            $pageData['tags'] = [];
-            foreach ($page->tags as $tag) {
-                $pageData['tags'][] = ['name' => $tag->name, 'value' => $tag->value];
-            }
-        }
-
-        return $this->publishDraft($copyPage, $pageData);
-    }
-
-    /**
-     * Find a page parent entity via a identifier string in the format:
-     * {type}:{id}
-     * Example: (book:5)
-     * @throws MoveOperationException
-     */
-    protected function findParentByIdentifier(string $identifier): ?Entity
-    {
-        $stringExploded = explode(':', $identifier);
-        $entityType = $stringExploded[0];
-        $entityId = intval($stringExploded[1]);
-
-        if ($entityType !== 'book' && $entityType !== 'chapter') {
-            throw new MoveOperationException('Pages can only be in books or chapters');
-        }
-
-        $parentClass = $entityType === 'book' ? Book::class : Chapter::class;
-        return $parentClass::visible()->where('id', '=', $entityId)->first();
-    }
+        return (new DatabaseTransaction(function () use ($page, $parent) {
+            $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : null;
+            $newBookId = ($parent instanceof Chapter) ? $parent->book->id : $parent->id;
+            $page->changeBook($newBookId);
+            $page->rebuildPermissions();

 
 

-    /**
-     * Change the page's parent to the given entity.
-     */
-    protected function changeParent(Page $page, Entity $parent)
-    {
-        $book = ($parent instanceof Book) ? $parent : $parent->book;
-        $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : 0;
-        $page->save();
+            Activity::add(ActivityType::PAGE_MOVE, $page);

 
 

-        if ($page->book->id !== $book->id) {
-            $page->changeBook($book->id);
-        }
+            $this->baseRepo->sortParent($page);

 
 

-        $page->load('book');
-        $book->rebuildPermissions();
+            return $parent;
+        }))->run();

     }
 
     /**
     }
 
     /**

-     * Get a page revision to update for the given page.
-     * Checks for an existing revisions before providing a fresh one.
-     */
-    protected function getPageRevisionToUpdate(Page $page): PageRevision
-    {
-        $drafts = $this->getUserDraftQuery($page)->get();
-        if ($drafts->count() > 0) {
-            return $drafts->first();
-        }
-
-        $draft = new PageRevision();
-        $draft->page_id = $page->id;
-        $draft->slug = $page->slug;
-        $draft->book_slug = $page->book->slug;
-        $draft->created_by = user()->id;
-        $draft->type = 'update_draft';
-        return $draft;
-    }
-
-    /**
-     * Delete old revisions, for the given page, from the system.
-     */
-    protected function deleteOldRevisions(Page $page)
-    {
-        $revisionLimit = config('app.revision_limit');
-        if ($revisionLimit === false) {
-            return;
-        }
-
-        $revisionsToDelete = PageRevision::query()
-            ->where('page_id', '=', $page->id)
-            ->orderBy('created_at', 'desc')
-            ->skip(intval($revisionLimit))
-            ->take(10)
-            ->get(['id']);
-        if ($revisionsToDelete->count() > 0) {
-            PageRevision::query()->whereIn('id', $revisionsToDelete->pluck('id'))->delete();
-        }
-    }
-
-    /**
-     * Get a new priority for a page
+     * Get a new priority for a page.

      */
     protected function getNewPriority(Page $page): int
     {
         $parent = $page->getParent();
         if ($parent instanceof Chapter) {
      */
     protected function getNewPriority(Page $page): int
     {
         $parent = $page->getParent();
         if ($parent instanceof Chapter) {

+            /** @var ?Page $lastPage */

             $lastPage = $parent->pages('desc')->first();
             $lastPage = $parent->pages('desc')->first();

+

             return $lastPage ? $lastPage->priority + 1 : 0;
         }
 
         return (new BookContents($page->book))->getLastPriority() + 1;
     }
             return $lastPage ? $lastPage->priority + 1 : 0;
         }
 
         return (new BookContents($page->book))->getLastPriority() + 1;
     }

-
-    /**
-     * Get the query to find the user's draft copies of the given page.
-     */
-    protected function getUserDraftQuery(Page $page)
-    {
-        return PageRevision::query()->where('created_by', '=', user()->id)
-            ->where('type', 'update_draft')
-            ->where('page_id', '=', $page->id)
-            ->orderBy('created_at', 'desc');
-    }

 }
 }