namespace BookStack\Entities\Repos;
-use BookStack\Actions\ActivityType;
+use BookStack\Activity\ActivityType;
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\PageEditorType;
use BookStack\Entities\Tools\TrashCan;
use BookStack\Exceptions\MoveOperationException;
-use BookStack\Exceptions\NotFoundException;
use BookStack\Exceptions\PermissionsException;
use BookStack\Facades\Activity;
+use BookStack\References\ReferenceStore;
+use BookStack\References\ReferenceUpdater;
use Exception;
-use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Pagination\LengthAwarePaginator;
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
- {
- /** @var ?PageRevision $revision */
- $revision = PageRevision::query()
- ->whereHas('page', function (Builder $query) {
- $query->scopes('visible');
- })
- ->where('slug', '=', $pageSlug)
- ->where('type', '=', 'version')
- ->where('book_slug', '=', $bookSlug)
- ->orderBy('created_at', 'desc')
- ->with('page')
- ->first();
-
- return $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,
+ ) {
}
/**
'owned_by' => user()->id,
'updated_by' => user()->id,
'draft' => true,
+ 'editor' => PageEditorType::getSystemDefault()->value,
]);
if ($parent instanceof Chapter) {
$page->book_id = $parent->id;
}
+ $defaultTemplate = $page->chapter->defaultTemplate ?? $page->book->defaultTemplate;
+ if ($defaultTemplate && userCan('view', $defaultTemplate)) {
+ $page->forceFill([
+ 'html' => $defaultTemplate->html,
+ 'markdown' => $defaultTemplate->markdown,
+ ]);
+ }
+
$page->save();
$page->refresh()->rebuildPermissions();
*/
public function publishDraft(Page $draft, array $input): Page
{
- $this->updateTemplateStatusAndContentFromInput($draft, $input);
- $this->baseRepo->update($draft, $input);
-
$draft->draft = false;
$draft->revision_count = 1;
$draft->priority = $this->getNewPriority($draft);
- $draft->refreshSlug();
- $draft->save();
+ $this->updateTemplateStatusAndContentFromInput($draft, $input);
+ $this->baseRepo->update($draft, $input);
- $this->savePageRevision($draft, trans('entities.pages_initial_revision'));
- $draft->indexForSearch();
+ $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;
}
+ /**
+ * 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 & reference regen) without performing an official update.
+ */
+ public function setContentFromInput(Page $page, array $input): void
+ {
+ $this->updateTemplateStatusAndContentFromInput($page, $input);
+ $this->baseRepo->update($page, []);
+ }
+
/**
* Update a page in the system.
*/
$page->save();
// Remove all update drafts for this user & page.
- $this->getUserDraftQuery($page)->delete();
+ $this->revisionRepo->deleteDraftsForCurrentUser($page);
// Save a revision after updating
$summary = trim($input['summary'] ?? '');
$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::add(ActivityType::PAGE_UPDATE, $page);
+ $this->baseRepo->sortParent($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 (!empty($input['markdown'] ?? '')) {
- $pageContent->setNewMarkdown($input['markdown']);
+ $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'])) {
- $pageContent->setNewHTML($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;
+ }
}
/**
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);
- if (setting('app-editor') !== 'markdown') {
+
+ if (!empty($input['markdown'])) {
+ $draft->markdown = $input['markdown'];
+ $draft->html = '';
+ } else {
+ $draft->html = $input['html'];
$draft->markdown = '';
}
*/
public function destroy(Page $page)
{
- $trashCan = new TrashCan();
- $trashCan->softDestroyPage($page);
+ $this->trashCan->softDestroyPage($page);
Activity::add(ActivityType::PAGE_DELETE, $page);
- $trashCan->autoClearOld();
+ $this->trashCan->autoClearOld();
}
/**
*/
public function restoreRevision(Page $page, int $revisionId): Page
{
+ $oldUrl = $page->getUrl();
$page->revision_count++;
/** @var PageRevision $revision */
$content = new PageContent($page);
if (!empty($revision->markdown)) {
- $content->setNewMarkdown($revision->markdown);
+ $content->setNewMarkdown($revision->markdown, user());
} else {
- $content->setNewHTML($revision->html);
+ $content->setNewHTML($revision->html, user());
}
$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]);
- $this->savePageRevision($page, $summary);
+ $this->revisionRepo->storeNewForPage($page, $summary);
+
+ if ($oldUrl !== $page->getUrl()) {
+ $this->referenceUpdater->updateEntityReferences($page, $oldUrl);
+ }
Activity::add(ActivityType::PAGE_RESTORE, $page);
+ Activity::add(ActivityType::REVISION_RESTORE, $revision);
+
+ $this->baseRepo->sortParent($page);
return $page;
}
*/
public function move(Page $page, string $parentIdentifier): Entity
{
- $parent = $this->findParentByIdentifier($parentIdentifier);
- 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');
}
Activity::add(ActivityType::PAGE_MOVE, $page);
- return $parent;
- }
-
- /**
- * Copy an existing page in the system.
- * Optionally providing a new parent via string identifier and a new name.
- *
- * @throws MoveOperationException
- * @throws PermissionsException
- */
- public function copy(Page $page, string $parentIdentifier = null, string $newName = null): Page
- {
- $parent = $parentIdentifier ? $this->findParentByIdentifier($parentIdentifier) : $page->getParent();
- if ($parent === null) {
- throw new MoveOperationException('Book or chapter to move page into not found');
- }
-
- if (!userCan('page-create', $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();
- }
-
- /**
- * Change the page's parent to the given entity.
- */
- protected function changeParent(Page $page, Entity $parent)
- {
- $book = ($parent instanceof Chapter) ? $parent->book : $parent;
- $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : 0;
- $page->save();
-
- if ($page->book->id !== $book->id) {
- $page->changeBook($book->id);
- }
-
- $page->load('book');
- $book->rebuildPermissions();
- }
+ $this->baseRepo->sortParent($page);
- /**
- * 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();
- }
+ return $parent;
}
/**
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');
- }
}
projects / bookstack / blobdiff