use BookStack\Entities\Models\Entity;
use BookStack\Entities\Models\HasCoverImage;
use BookStack\Entities\Models\Page;
+use BookStack\Entities\Queries\EntityQueries;
use BookStack\Exceptions\NotifyException;
use BookStack\Facades\Activity;
use BookStack\Uploads\AttachmentService;
class TrashCan
{
+ public function __construct(
+ protected EntityQueries $queries,
+ ) {
+ }
+
/**
* Send a shelf to the recycle bin.
+ *
+ * @throws NotifyException
*/
public function softDestroyShelf(Bookshelf $shelf)
{
+ $this->ensureDeletable($shelf);
Deletion::createForEntity($shelf);
$shelf->delete();
}
*/
public function softDestroyBook(Book $book)
{
+ $this->ensureDeletable($book);
Deletion::createForEntity($book);
foreach ($book->pages as $page) {
public function softDestroyChapter(Chapter $chapter, bool $recordDelete = true)
{
if ($recordDelete) {
+ $this->ensureDeletable($chapter);
Deletion::createForEntity($chapter);
}
public function softDestroyPage(Page $page, bool $recordDelete = true)
{
if ($recordDelete) {
+ $this->ensureDeletable($page);
Deletion::createForEntity($page);
}
- // Check if set as custom homepage & remove setting if not used or throw error if active
- $customHome = setting('app-homepage', '0:');
- if (intval($page->id) === intval(explode(':', $customHome)[0])) {
- if (setting('app-homepage-type') === 'page') {
- throw new NotifyException(trans('errors.page_custom_home_deletion'), $page->getUrl());
+ $page->delete();
+ }
+
+ /**
+ * Ensure the given entity is deletable.
+ * Is not for permissions, but logical conditions within the application.
+ * Will throw if not deletable.
+ *
+ * @throws NotifyException
+ */
+ protected function ensureDeletable(Entity $entity): void
+ {
+ $customHomeId = intval(explode(':', setting('app-homepage', '0:'))[0]);
+ $customHomeActive = setting('app-homepage-type') === 'page';
+ $removeCustomHome = false;
+
+ // Check custom homepage usage for pages
+ if ($entity instanceof Page && $entity->id === $customHomeId) {
+ if ($customHomeActive) {
+ throw new NotifyException(trans('errors.page_custom_home_deletion'), $entity->getUrl());
+ }
+ $removeCustomHome = true;
+ }
+
+ // Check custom homepage usage within chapters or books
+ if ($entity instanceof Chapter || $entity instanceof Book) {
+ if ($entity->pages()->where('id', '=', $customHomeId)->exists()) {
+ if ($customHomeActive) {
+ throw new NotifyException(trans('errors.page_custom_home_deletion'), $entity->getUrl());
+ }
+ $removeCustomHome = true;
}
- setting()->remove('app-homepage');
}
- $page->delete();
+ if ($removeCustomHome) {
+ setting()->remove('app-homepage');
+ }
}
/**
$page->allRevisions()->delete();
// Delete Attached Files
- $attachmentService = app(AttachmentService::class);
+ $attachmentService = app()->make(AttachmentService::class);
foreach ($page->attachments as $attachment) {
$attachmentService->deleteFile($attachment);
}
+ // Remove book template usages
+ $this->queries->books->start()
+ ->where('default_template_id', '=', $page->id)
+ ->update(['default_template_id' => null]);
+
+ // Remove chapter template usages
+ $this->queries->chapters->start()
+ ->where('default_template_id', '=', $page->id)
+ ->update(['default_template_id' => null]);
+
$page->forceDelete();
return 1;
*
* @throws Exception
*/
- protected function destroyEntity(Entity $entity): int
+ public function destroyEntity(Entity $entity): int
{
if ($entity instanceof Page) {
return $this->destroyPage($entity);
$entity->searchTerms()->delete();
$entity->deletions()->delete();
$entity->favourites()->delete();
+ $entity->watches()->delete();
+ $entity->referencesTo()->delete();
+ $entity->referencesFrom()->delete();
if ($entity instanceof HasCoverImage && $entity->cover()->exists()) {
$imageService = app()->make(ImageService::class);