-<?php namespace BookStack\Entities\Repos;
-
-use BookStack\Entities\Book;
-use BookStack\Entities\Chapter;
-use BookStack\Entities\Entity;
-use BookStack\Entities\Managers\BookContents;
-use BookStack\Entities\Managers\PageContent;
-use BookStack\Entities\Managers\TrashCan;
-use BookStack\Entities\Page;
-use BookStack\Entities\PageRevision;
+<?php
+
+namespace BookStack\Entities\Repos;
+
+use BookStack\Actions\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\Tools\BookContents;
+use BookStack\Entities\Tools\PageContent;
+use BookStack\Entities\Tools\TrashCan;
use BookStack\Exceptions\MoveOperationException;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Exceptions\NotifyException;
use BookStack\Exceptions\PermissionsException;
+use BookStack\Facades\Activity;
+use Exception;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Pagination\LengthAwarePaginator;
-use Illuminate\Support\Collection;
class PageRepo
{
-
protected $baseRepo;
/**
/**
* Get a page by ID.
+ *
* @throws NotFoundException
*/
- public function getById(int $id): Page
+ public function getById(int $id, array $relations = ['book']): Page
{
- $page = Page::visible()->with(['book'])->find($id);
+ $page = Page::visible()->with($relations)->find($id);
if (!$page) {
throw new NotFoundException(trans('errors.page_not_found'));
/**
* Get a page its book and own slug.
+ *
* @throws NotFoundException
*/
public function getBySlug(string $bookSlug, string $pageSlug): Page
*/
public function getByOldSlug(string $bookSlug, string $pageSlug): ?Page
{
+ /** @var ?PageRevision $revision */
$revision = PageRevision::query()
->whereHas('page', function (Builder $query) {
- $query->visible();
+ $query->scopes('visible');
})
->where('slug', '=', $pageSlug)
->where('type', '=', 'version')
->orderBy('created_at', 'desc')
->with('page')
->first();
- return $revision ? $revision->page : null;
+
+ return $revision->page ?? null;
}
/**
public function getUserDraft(Page $page): ?PageRevision
{
$revision = $this->getUserDraftQuery($page)->first();
+
return $revision;
}
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,
+ 'owned_by' => user()->id,
'updated_by' => user()->id,
- 'draft' => true,
+ 'draft' => true,
]);
if ($parent instanceof Chapter) {
$page->save();
$page->refresh()->rebuildPermissions();
+
return $page;
}
*/
public function publishDraft(Page $draft, array $input): Page
{
+ $this->updateTemplateStatusAndContentFromInput($draft, $input);
$this->baseRepo->update($draft, $input);
- if (isset($input['template']) && userCan('templates-manage')) {
- $draft->template = ($input['template'] === 'true');
- }
- $pageContent = new PageContent($draft);
- $pageContent->setNewHTML($input['html']);
$draft->draft = false;
$draft->revision_count = 1;
$draft->priority = $this->getNewPriority($draft);
$this->savePageRevision($draft, trans('entities.pages_initial_revision'));
$draft->indexForSearch();
- return $draft->refresh();
+ $draft->refresh();
+
+ Activity::add(ActivityType::PAGE_CREATE, $draft);
+
+ return $draft;
}
/**
// Hold the old details to compare later
$oldHtml = $page->html;
$oldName = $page->name;
+ $oldMarkdown = $page->markdown;
- if (isset($input['template']) && userCan('templates-manage')) {
- $page->template = ($input['template'] === 'true');
- }
-
+ $this->updateTemplateStatusAndContentFromInput($page, $input);
$this->baseRepo->update($page, $input);
// Update with new details
- $page->fill($input);
- $pageContent = new PageContent($page);
- $pageContent->setNewHTML($input['html']);
$page->revision_count++;
-
- if (setting('app-editor') !== 'markdown') {
- $page->markdown = '';
- }
-
$page->save();
// Remove all update drafts for this user & page.
$this->getUserDraftQuery($page)->delete();
// Save a revision after updating
- $summary = $input['summary'] ?? null;
- if ($oldHtml !== $input['html'] || $oldName !== $input['name'] || $summary !== null) {
+ $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) {
$this->savePageRevision($page, $summary);
}
+ Activity::add(ActivityType::PAGE_UPDATE, $page);
+
return $page;
}
+ protected function updateTemplateStatusAndContentFromInput(Page $page, array $input)
+ {
+ if (isset($input['template']) && userCan('templates-manage')) {
+ $page->template = ($input['template'] === 'true');
+ }
+
+ $pageContent = new PageContent($page);
+ if (!empty($input['markdown'] ?? '')) {
+ $pageContent->setNewMarkdown($input['markdown']);
+ } elseif (isset($input['html'])) {
+ $pageContent->setNewHTML($input['html']);
+ }
+ }
+
/**
* Saves a page revision into the system.
*/
- protected function savePageRevision(Page $page, string $summary = null)
+ protected function savePageRevision(Page $page, string $summary = null): PageRevision
{
- $revision = new PageRevision($page->toArray());
-
- if (setting('app-editor') !== 'markdown') {
- $revision->markdown = '';
- }
+ $revision = new PageRevision($page->getAttributes());
$revision->page_id = $page->id;
$revision->slug = $page->slug;
$revision->save();
$this->deleteOldRevisions($page);
+
return $revision;
}
{
// If the page itself is a draft simply update that
if ($page->draft) {
+ $this->updateTemplateStatusAndContentFromInput($page, $input);
$page->fill($input);
- if (isset($input['html'])) {
- $content = new PageContent($page);
- $content->setNewHTML($input['html']);
- }
$page->save();
+
return $page;
}
}
$draft->save();
+
return $draft;
}
/**
* Destroy a page from the system.
- * @throws NotifyException
+ *
+ * @throws Exception
*/
public function destroy(Page $page)
{
$trashCan = new TrashCan();
- $trashCan->destroyPage($page);
+ $trashCan->softDestroyPage($page);
+ Activity::add(ActivityType::PAGE_DELETE, $page);
+ $trashCan->autoClearOld();
}
/**
public function restoreRevision(Page $page, int $revisionId): Page
{
$page->revision_count++;
- $this->savePageRevision($page);
+ /** @var PageRevision $revision */
$revision = $page->revisions()->where('id', '=', $revisionId)->first();
+
$page->fill($revision->toArray());
$content = new PageContent($page);
- $content->setNewHTML($page->html);
+
+ if (!empty($revision->markdown)) {
+ $content->setNewMarkdown($revision->markdown);
+ } else {
+ $content->setNewHTML($revision->html);
+ }
+
$page->updated_by = user()->id;
$page->refreshSlug();
$page->save();
-
$page->indexForSearch();
+
+ $summary = trans('entities.pages_revision_restored_from', ['id' => strval($revisionId), 'summary' => $revision->summary]);
+ $this->savePageRevision($page, $summary);
+
+ Activity::add(ActivityType::PAGE_RESTORE, $page);
+
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)
+ * 'book:<id>' (book:5).
+ *
* @throws MoveOperationException
* @throws PermissionsException
*/
- public function move(Page $page, string $parentIdentifier): Book
+ public function move(Page $page, string $parentIdentifier): Entity
{
$parent = $this->findParentByIdentifier($parentIdentifier);
- if ($parent === null) {
+ if (is_null($parent)) {
throw new MoveOperationException('Book or chapter to move page into not found');
}
throw new PermissionsException('User does not have permission to create a page within the new parent');
}
- $page->changeBook($parent instanceof Book ? $parent->id : $parent->book->id);
+ $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : null;
+ $newBookId = ($parent instanceof Chapter) ? $parent->book->id : $parent->id;
+ $page->changeBook($newBookId);
$page->rebuildPermissions();
- 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->parent();
- if ($parent === null) {
- throw new MoveOperationException('Book or chapter to move page into not found');
- }
+ Activity::add(ActivityType::PAGE_MOVE, $page);
- 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);
+ return $parent;
}
/**
- * Find a page parent entity via a identifier string in the format:
+ * Find a page parent entity via an identifier string in the format:
* {type}:{id}
- * Example: (book:5)
+ * Example: (book:5).
+ *
* @throws MoveOperationException
*/
- protected function findParentByIdentifier(string $identifier): ?Entity
+ public function findParentByIdentifier(string $identifier): ?Entity
{
$stringExploded = explode(':', $identifier);
$entityType = $stringExploded[0];
}
$parentClass = $entityType === 'book' ? Book::class : Chapter::class;
- return $parentClass::visible()->where('id', '=', $entityId)->first();
- }
- /**
- * Update the permissions of a page.
- */
- public function updatePermissions(Page $page, bool $restricted, Collection $permissions = null)
- {
- $this->baseRepo->updatePermissions($page, $restricted, $permissions);
+ return $parentClass::visible()->where('id', '=', $entityId)->first();
}
/**
*/
protected function changeParent(Page $page, Entity $parent)
{
- $book = ($parent instanceof Book) ? $parent : $parent->book;
+ $book = ($parent instanceof Chapter) ? $parent->book : $parent;
$page->chapter_id = ($parent instanceof Chapter) ? $parent->id : 0;
$page->save();
$draft->book_slug = $page->book->slug;
$draft->created_by = user()->id;
$draft->type = 'update_draft';
+
return $draft;
}
}
/**
- * Get a new priority for a page
+ * Get a new priority for a page.
*/
protected function getNewPriority(Page $page): int
{
- if ($page->parent() instanceof Chapter) {
- $lastPage = $page->parent()->pages('desc')->first();
+ $parent = $page->getParent();
+ if ($parent instanceof Chapter) {
+ /** @var ?Page $lastPage */
+ $lastPage = $parent->pages('desc')->first();
+
return $lastPage ? $lastPage->priority + 1 : 0;
}
projects / bookstack / blobdiff