3 use BookStack\Entities\Models\Book;
4 use BookStack\Entities\Models\Bookshelf;
5 use BookStack\Entities\Models\Chapter;
6 use BookStack\Entities\Models\Deletion;
7 use BookStack\Entities\Models\Entity;
8 use BookStack\Entities\Models\Page;
10 use Illuminate\Support\Carbon;
12 class RecycleBinTest extends TestCase
14 public function test_recycle_bin_routes_permissions()
16 $page = Page::query()->first();
17 $editor = $this->getEditor();
18 $this->actingAs($editor)->delete($page->getUrl());
19 $deletion = Deletion::query()->firstOrFail();
22 'GET:/settings/recycle-bin',
23 'POST:/settings/recycle-bin/empty',
24 "GET:/settings/recycle-bin/{$deletion->id}/destroy",
25 "GET:/settings/recycle-bin/{$deletion->id}/restore",
26 "POST:/settings/recycle-bin/{$deletion->id}/restore",
27 "DELETE:/settings/recycle-bin/{$deletion->id}",
30 foreach($routes as $route) {
31 [$method, $url] = explode(':', $route);
32 $resp = $this->call($method, $url);
33 $this->assertPermissionError($resp);
36 $this->giveUserPermissions($editor, ['restrictions-manage-all']);
38 foreach($routes as $route) {
39 [$method, $url] = explode(':', $route);
40 $resp = $this->call($method, $url);
41 $this->assertPermissionError($resp);
44 $this->giveUserPermissions($editor, ['settings-manage']);
46 foreach($routes as $route) {
47 DB::beginTransaction();
48 [$method, $url] = explode(':', $route);
49 $resp = $this->call($method, $url);
50 $this->assertNotPermissionError($resp);
56 public function test_recycle_bin_view()
58 $page = Page::query()->first();
59 $book = Book::query()->whereHas('pages')->whereHas('chapters')->withCount(['pages', 'chapters'])->first();
60 $editor = $this->getEditor();
61 $this->actingAs($editor)->delete($page->getUrl());
62 $this->actingAs($editor)->delete($book->getUrl());
64 $viewReq = $this->asAdmin()->get('/settings/recycle-bin');
65 $viewReq->assertElementContains('table.table', $page->name);
66 $viewReq->assertElementContains('table.table', $editor->name);
67 $viewReq->assertElementContains('table.table', $book->name);
68 $viewReq->assertElementContains('table.table', $book->pages_count . ' Pages');
69 $viewReq->assertElementContains('table.table', $book->chapters_count . ' Chapters');
72 public function test_recycle_bin_empty()
74 $page = Page::query()->first();
75 $book = Book::query()->where('id' , '!=', $page->book_id)->whereHas('pages')->whereHas('chapters')->with(['pages', 'chapters'])->firstOrFail();
76 $editor = $this->getEditor();
77 $this->actingAs($editor)->delete($page->getUrl());
78 $this->actingAs($editor)->delete($book->getUrl());
80 $this->assertTrue(Deletion::query()->count() === 2);
81 $emptyReq = $this->asAdmin()->post('/settings/recycle-bin/empty');
82 $emptyReq->assertRedirect('/settings/recycle-bin');
84 $this->assertTrue(Deletion::query()->count() === 0);
85 $this->assertDatabaseMissing('books', ['id' => $book->id]);
86 $this->assertDatabaseMissing('pages', ['id' => $page->id]);
87 $this->assertDatabaseMissing('pages', ['id' => $book->pages->first()->id]);
88 $this->assertDatabaseMissing('chapters', ['id' => $book->chapters->first()->id]);
90 $itemCount = 2 + $book->pages->count() + $book->chapters->count();
91 $redirectReq = $this->get('/settings/recycle-bin');
92 $redirectReq->assertNotificationContains('Deleted '.$itemCount.' total items from the recycle bin');
95 public function test_entity_restore()
97 $book = Book::query()->whereHas('pages')->whereHas('chapters')->with(['pages', 'chapters'])->firstOrFail();
98 $this->asEditor()->delete($book->getUrl());
99 $deletion = Deletion::query()->firstOrFail();
101 $this->assertEquals($book->pages->count(), DB::table('pages')->where('book_id', '=', $book->id)->whereNotNull('deleted_at')->count());
102 $this->assertEquals($book->chapters->count(), DB::table('chapters')->where('book_id', '=', $book->id)->whereNotNull('deleted_at')->count());
104 $restoreReq = $this->asAdmin()->post("/settings/recycle-bin/{$deletion->id}/restore");
105 $restoreReq->assertRedirect('/settings/recycle-bin');
106 $this->assertTrue(Deletion::query()->count() === 0);
108 $this->assertEquals($book->pages->count(), DB::table('pages')->where('book_id', '=', $book->id)->whereNull('deleted_at')->count());
109 $this->assertEquals($book->chapters->count(), DB::table('chapters')->where('book_id', '=', $book->id)->whereNull('deleted_at')->count());
111 $itemCount = 1 + $book->pages->count() + $book->chapters->count();
112 $redirectReq = $this->get('/settings/recycle-bin');
113 $redirectReq->assertNotificationContains('Restored '.$itemCount.' total items from the recycle bin');
116 public function test_permanent_delete()
118 $book = Book::query()->whereHas('pages')->whereHas('chapters')->with(['pages', 'chapters'])->firstOrFail();
119 $this->asEditor()->delete($book->getUrl());
120 $deletion = Deletion::query()->firstOrFail();
122 $deleteReq = $this->asAdmin()->delete("/settings/recycle-bin/{$deletion->id}");
123 $deleteReq->assertRedirect('/settings/recycle-bin');
124 $this->assertTrue(Deletion::query()->count() === 0);
126 $this->assertDatabaseMissing('books', ['id' => $book->id]);
127 $this->assertDatabaseMissing('pages', ['id' => $book->pages->first()->id]);
128 $this->assertDatabaseMissing('chapters', ['id' => $book->chapters->first()->id]);
130 $itemCount = 1 + $book->pages->count() + $book->chapters->count();
131 $redirectReq = $this->get('/settings/recycle-bin');
132 $redirectReq->assertNotificationContains('Deleted '.$itemCount.' total items from the recycle bin');
135 public function test_permanent_delete_for_each_type()
137 /** @var Entity $entity */
138 foreach ([new Bookshelf, new Book, new Chapter, new Page] as $entity) {
139 $entity = $entity->newQuery()->first();
140 $this->asEditor()->delete($entity->getUrl());
141 $deletion = Deletion::query()->orderBy('id', 'desc')->firstOrFail();
143 $deleteReq = $this->asAdmin()->delete("/settings/recycle-bin/{$deletion->id}");
144 $deleteReq->assertRedirect('/settings/recycle-bin');
145 $this->assertDatabaseMissing('deletions', ['id' => $deletion->id]);
146 $this->assertDatabaseMissing($entity->getTable(), ['id' => $entity->id]);
150 public function test_permanent_entity_delete_updates_existing_activity_with_entity_name()
152 $page = Page::query()->firstOrFail();
153 $this->asEditor()->delete($page->getUrl());
154 $deletion = $page->deletions()->firstOrFail();
156 $this->assertDatabaseHas('activities', [
157 'type' => 'page_delete',
158 'entity_id' => $page->id,
159 'entity_type' => $page->getMorphClass(),
162 $this->asAdmin()->delete("/settings/recycle-bin/{$deletion->id}");
164 $this->assertDatabaseMissing('activities', [
165 'type' => 'page_delete',
166 'entity_id' => $page->id,
167 'entity_type' => $page->getMorphClass(),
170 $this->assertDatabaseHas('activities', [
171 'type' => 'page_delete',
173 'entity_type' => null,
174 'detail' => $page->name,
178 public function test_auto_clear_functionality_works()
180 config()->set('app.recycle_bin_lifetime', 5);
181 $page = Page::query()->firstOrFail();
182 $otherPage = Page::query()->where('id', '!=', $page->id)->firstOrFail();
184 $this->asEditor()->delete($page->getUrl());
185 $this->assertDatabaseHas('pages', ['id' => $page->id]);
186 $this->assertEquals(1, Deletion::query()->count());
188 Carbon::setTestNow(Carbon::now()->addDays(6));
189 $this->asEditor()->delete($otherPage->getUrl());
190 $this->assertEquals(1, Deletion::query()->count());
192 $this->assertDatabaseMissing('pages', ['id' => $page->id]);
195 public function test_auto_clear_functionality_with_negative_time_keeps_forever()
197 config()->set('app.recycle_bin_lifetime', -1);
198 $page = Page::query()->firstOrFail();
199 $otherPage = Page::query()->where('id', '!=', $page->id)->firstOrFail();
201 $this->asEditor()->delete($page->getUrl());
202 $this->assertEquals(1, Deletion::query()->count());
204 Carbon::setTestNow(Carbon::now()->addDays(6000));
205 $this->asEditor()->delete($otherPage->getUrl());
206 $this->assertEquals(2, Deletion::query()->count());
208 $this->assertDatabaseHas('pages', ['id' => $page->id]);
211 public function test_auto_clear_functionality_with_zero_time_deletes_instantly()
213 config()->set('app.recycle_bin_lifetime', 0);
214 $page = Page::query()->firstOrFail();
216 $this->asEditor()->delete($page->getUrl());
217 $this->assertDatabaseMissing('pages', ['id' => $page->id]);
218 $this->assertEquals(0, Deletion::query()->count());
221 public function test_restore_flow_when_restoring_nested_delete_first()
223 $book = Book::query()->whereHas('pages')->whereHas('chapters')->with(['pages', 'chapters'])->firstOrFail();
224 $chapter = $book->chapters->first();
225 $this->asEditor()->delete($chapter->getUrl());
226 $this->asEditor()->delete($book->getUrl());
228 $bookDeletion = $book->deletions()->first();
229 $chapterDeletion = $chapter->deletions()->first();
231 $chapterRestoreView = $this->asAdmin()->get("/settings/recycle-bin/{$chapterDeletion->id}/restore");
232 $chapterRestoreView->assertStatus(200);
233 $chapterRestoreView->assertSeeText($chapter->name);
235 $chapterRestore = $this->post("/settings/recycle-bin/{$chapterDeletion->id}/restore");
236 $chapterRestore->assertRedirect("/settings/recycle-bin");
237 $this->assertDatabaseMissing("deletions", ["id" => $chapterDeletion->id]);
240 $this->assertNotNull($chapter->deleted_at);
242 $bookRestoreView = $this->asAdmin()->get("/settings/recycle-bin/{$bookDeletion->id}/restore");
243 $bookRestoreView->assertStatus(200);
244 $bookRestoreView->assertSeeText($chapter->name);
246 $this->post("/settings/recycle-bin/{$bookDeletion->id}/restore");
248 $this->assertNull($chapter->deleted_at);