X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/f14e6e8f2dbfac04829c1819398038ec99166d8f..refs/pull/3616/head:/app/Http/Controllers/Api/RecycleBinApiController.php

diff --git a/app/Http/Controllers/Api/RecycleBinApiController.php b/app/Http/Controllers/Api/RecycleBinApiController.php
index f60115c16..f327bae93 100644
--- a/app/Http/Controllers/Api/RecycleBinApiController.php
+++ b/app/Http/Controllers/Api/RecycleBinApiController.php
@@ -3,10 +3,12 @@
 namespace BookStack\Http\Controllers\Api;
 
 use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\BookChild;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Deletion;
 use BookStack\Entities\Repos\DeletionRepo;
 use Closure;
+use Illuminate\Database\Eloquent\Builder;
 
 class RecycleBinApiController extends ApiController
 {
@@ -20,9 +22,17 @@ class RecycleBinApiController extends ApiController
         });
     }
 
+    /**
+     * Get a top-level listing of the items in the recycle bin.
+     * The "deletable" property will reflect the main item deleted.
+     * For books and chapters, counts of child pages/chapters will
+     * be loaded within this "deletable" data.
+     * For chapters & pages, the parent item will be loaded within this "deletable" data.
+     * Requires permission to manage both system settings and permissions.
+     */
     public function list()
     {
-        return $this->apiListingResponse(Deletion::query(), [
+        return $this->apiListingResponse(Deletion::query()->with('deletable'), [
             'id',
             'deleted_by',
             'created_at',
@@ -32,46 +42,49 @@ class RecycleBinApiController extends ApiController
         ], [Closure::fromCallable([$this, 'listFormatter'])]);
     }
 
-    public function restore(DeletionRepo $deletionRepo, string $id)
+    /**
+     * Restore a single deletion from the recycle bin.
+     * Requires permission to manage both system settings and permissions.
+     */
+    public function restore(DeletionRepo $deletionRepo, string $deletionId)
     {
-        $restoreCount = $deletionRepo->restore((int) $id);
+        $restoreCount = $deletionRepo->restore(intval($deletionId));
 
         return response()->json(['restore_count' => $restoreCount]);
     }
 
-    public function destroy(DeletionRepo $deletionRepo, string $id)
+    /**
+     * Remove a single deletion from the recycle bin.
+     * Use this endpoint carefully as it will entirely remove the underlying deleted items from the system.
+     * Requires permission to manage both system settings and permissions.
+     */
+    public function destroy(DeletionRepo $deletionRepo, string $deletionId)
     {
-        $deleteCount = $deletionRepo->destroy((int) $id);
+        $deleteCount = $deletionRepo->destroy(intval($deletionId));
 
         return response()->json(['delete_count' => $deleteCount]);
     }
 
+    /**
+     * Load some related details for the deletion listing.
+     */
     protected function listFormatter(Deletion $deletion)
     {
         $deletable = $deletion->deletable;
-        $isBook = $deletable instanceof Book;
-        $parent = null;
-        $children = null;
+        $withTrashedQuery = fn (Builder $query) => $query->withTrashed();
 
-        if ($isBook) {
-            $chapterCount = $deletable->chapters()->withTrashed()->count();       
-            $children['Bookstack\Chapter'] = $chapterCount;
+        if ($deletable instanceof BookChild) {
+            $parent = $deletable->getParent();
+            $parent->setAttribute('type', $parent->getType());
+            $deletable->setRelation('parent', $parent);
         }
 
-        if ($isBook || $deletion->deletable instanceof Chapter) {
-            $pageCount = $deletable->pages()->withTrashed()->count();     
-            $children['Bookstack\Page'] = $pageCount;
+        if ($deletable instanceof Book || $deletable instanceof Chapter) {
+            $countsToLoad = ['pages' => $withTrashedQuery];
+            if ($deletable instanceof Book) {
+                $countsToLoad['chapters'] = $withTrashedQuery;
+            }
+            $deletable->loadCount($countsToLoad);
         }
-
-        $parentEntity = $deletable->getParent();
-        $parent = [];
-
-        if ($parentEntity) {
-            $parent['type'] = $parentEntity->getMorphClass();
-            $parent['id'] = $parentEntity->getKey();
-        }
-
-        $deletion->setAttribute('parent', $parent);
-        $deletion->setAttribute('children', $children);
     }
 }