3 namespace Tests\Permissions;
5 use BookStack\Auth\Role;
6 use BookStack\Auth\User;
7 use BookStack\Entities\Models\Book;
8 use BookStack\Entities\Models\Bookshelf;
9 use BookStack\Entities\Models\Chapter;
10 use BookStack\Entities\Models\Entity;
11 use BookStack\Entities\Models\Page;
13 use Illuminate\Support\Str;
16 class EntityPermissionsTest extends TestCase
19 protected User $viewer;
21 protected function setUp(): void
24 $this->user = $this->getEditor();
25 $this->viewer = $this->getViewer();
28 protected function setRestrictionsForTestRoles(Entity $entity, array $actions = [])
31 $this->user->roles->first(),
32 $this->viewer->roles->first(),
34 $this->entities->setPermissions($entity, $actions, $roles);
37 public function test_bookshelf_view_restriction()
39 $shelf = $this->entities->shelf();
41 $this->actingAs($this->user)
42 ->get($shelf->getUrl())
45 $this->setRestrictionsForTestRoles($shelf, []);
47 $this->followingRedirects()->get($shelf->getUrl())
48 ->assertSee('Shelf not found');
50 $this->setRestrictionsForTestRoles($shelf, ['view']);
52 $this->get($shelf->getUrl())
53 ->assertSee($shelf->name);
56 public function test_bookshelf_update_restriction()
58 $shelf = $this->entities->shelf();
60 $this->actingAs($this->user)
61 ->get($shelf->getUrl('/edit'))
62 ->assertSee('Edit Shelf');
64 $this->setRestrictionsForTestRoles($shelf, ['view', 'delete']);
66 $resp = $this->get($shelf->getUrl('/edit'))
67 ->assertRedirect('/');
68 $this->followRedirects($resp)->assertSee('You do not have permission');
70 $this->setRestrictionsForTestRoles($shelf, ['view', 'update']);
72 $this->get($shelf->getUrl('/edit'))
76 public function test_bookshelf_delete_restriction()
78 $shelf = $this->entities->shelf();
80 $this->actingAs($this->user)
81 ->get($shelf->getUrl('/delete'))
82 ->assertSee('Delete Shelf');
84 $this->setRestrictionsForTestRoles($shelf, ['view', 'update']);
86 $this->get($shelf->getUrl('/delete'))->assertRedirect('/');
87 $this->get('/')->assertSee('You do not have permission');
89 $this->setRestrictionsForTestRoles($shelf, ['view', 'delete']);
91 $this->get($shelf->getUrl('/delete'))
93 ->assertSee('Delete Shelf');
96 public function test_book_view_restriction()
98 $book = $this->entities->book();
99 $bookPage = $book->pages->first();
100 $bookChapter = $book->chapters->first();
102 $bookUrl = $book->getUrl();
103 $this->actingAs($this->user)
107 $this->setRestrictionsForTestRoles($book, []);
109 $this->followingRedirects()->get($bookUrl)
110 ->assertSee('Book not found');
111 $this->followingRedirects()->get($bookPage->getUrl())
112 ->assertSee('Page not found');
113 $this->followingRedirects()->get($bookChapter->getUrl())
114 ->assertSee('Chapter not found');
116 $this->setRestrictionsForTestRoles($book, ['view']);
119 ->assertSee($book->name);
120 $this->get($bookPage->getUrl())
121 ->assertSee($bookPage->name);
122 $this->get($bookChapter->getUrl())
123 ->assertSee($bookChapter->name);
126 public function test_book_create_restriction()
128 $book = $this->entities->book();
130 $bookUrl = $book->getUrl();
131 $resp = $this->actingAs($this->viewer)->get($bookUrl);
132 $this->withHtml($resp)->assertElementNotContains('.actions', 'New Page')
133 ->assertElementNotContains('.actions', 'New Chapter');
134 $resp = $this->actingAs($this->user)->get($bookUrl);
135 $this->withHtml($resp)->assertElementContains('.actions', 'New Page')
136 ->assertElementContains('.actions', 'New Chapter');
138 $this->setRestrictionsForTestRoles($book, ['view', 'delete', 'update']);
140 $this->get($bookUrl . '/create-chapter')->assertRedirect('/');
141 $this->get('/')->assertSee('You do not have permission');
143 $this->get($bookUrl . '/create-page')->assertRedirect('/');
144 $this->get('/')->assertSee('You do not have permission');
146 $resp = $this->get($bookUrl);
147 $this->withHtml($resp)->assertElementNotContains('.actions', 'New Page')
148 ->assertElementNotContains('.actions', 'New Chapter');
150 $this->setRestrictionsForTestRoles($book, ['view', 'create']);
152 $resp = $this->post($book->getUrl('/create-chapter'), [
153 'name' => 'test chapter',
154 'description' => 'desc',
156 $resp->assertRedirect($book->getUrl('/chapter/test-chapter'));
158 $this->get($book->getUrl('/create-page'));
159 /** @var Page $page */
160 $page = Page::query()->where('draft', '=', true)->orderBy('id', 'desc')->first();
161 $resp = $this->post($page->getUrl(), [
162 'name' => 'test page',
163 'html' => 'test content',
165 $resp->assertRedirect($book->getUrl('/page/test-page'));
167 $resp = $this->get($bookUrl);
168 $this->withHtml($resp)->assertElementContains('.actions', 'New Page')
169 ->assertElementContains('.actions', 'New Chapter');
172 public function test_book_update_restriction()
174 $book = $this->entities->book();
175 $bookPage = $book->pages->first();
176 $bookChapter = $book->chapters->first();
178 $bookUrl = $book->getUrl();
179 $this->actingAs($this->user)
180 ->get($bookUrl . '/edit')
181 ->assertSee('Edit Book');
183 $this->setRestrictionsForTestRoles($book, ['view', 'delete']);
185 $this->get($bookUrl . '/edit')->assertRedirect('/');
186 $this->get('/')->assertSee('You do not have permission');
187 $this->get($bookPage->getUrl() . '/edit')->assertRedirect('/');
188 $this->get('/')->assertSee('You do not have permission');
189 $this->get($bookChapter->getUrl() . '/edit')->assertRedirect('/');
190 $this->get('/')->assertSee('You do not have permission');
192 $this->setRestrictionsForTestRoles($book, ['view', 'update']);
194 $this->get($bookUrl . '/edit')->assertOk();
195 $this->get($bookPage->getUrl() . '/edit')->assertOk();
196 $this->get($bookChapter->getUrl() . '/edit')->assertSee('Edit Chapter');
199 public function test_book_delete_restriction()
201 $book = $this->entities->book();
202 $bookPage = $book->pages->first();
203 $bookChapter = $book->chapters->first();
205 $bookUrl = $book->getUrl();
206 $this->actingAs($this->user)->get($bookUrl . '/delete')
207 ->assertSee('Delete Book');
209 $this->setRestrictionsForTestRoles($book, ['view', 'update']);
211 $this->get($bookUrl . '/delete')->assertRedirect('/');
212 $this->get('/')->assertSee('You do not have permission');
213 $this->get($bookPage->getUrl() . '/delete')->assertRedirect('/');
214 $this->get('/')->assertSee('You do not have permission');
215 $this->get($bookChapter->getUrl() . '/delete')->assertRedirect('/');
216 $this->get('/')->assertSee('You do not have permission');
218 $this->setRestrictionsForTestRoles($book, ['view', 'delete']);
220 $this->get($bookUrl . '/delete')->assertOk()->assertSee('Delete Book');
221 $this->get($bookPage->getUrl('/delete'))->assertOk()->assertSee('Delete Page');
222 $this->get($bookChapter->getUrl('/delete'))->assertSee('Delete Chapter');
225 public function test_chapter_view_restriction()
227 $chapter = $this->entities->chapter();
228 $chapterPage = $chapter->pages->first();
230 $chapterUrl = $chapter->getUrl();
231 $this->actingAs($this->user)->get($chapterUrl)->assertOk();
233 $this->setRestrictionsForTestRoles($chapter, []);
235 $this->followingRedirects()->get($chapterUrl)->assertSee('Chapter not found');
236 $this->followingRedirects()->get($chapterPage->getUrl())->assertSee('Page not found');
238 $this->setRestrictionsForTestRoles($chapter, ['view']);
240 $this->get($chapterUrl)->assertSee($chapter->name);
241 $this->get($chapterPage->getUrl())->assertSee($chapterPage->name);
244 public function test_chapter_create_restriction()
246 $chapter = $this->entities->chapter();
248 $chapterUrl = $chapter->getUrl();
249 $resp = $this->actingAs($this->user)->get($chapterUrl);
250 $this->withHtml($resp)->assertElementContains('.actions', 'New Page');
252 $this->setRestrictionsForTestRoles($chapter, ['view', 'delete', 'update']);
254 $this->get($chapterUrl . '/create-page')->assertRedirect('/');
255 $this->get('/')->assertSee('You do not have permission');
256 $this->withHtml($this->get($chapterUrl))->assertElementNotContains('.actions', 'New Page');
258 $this->setRestrictionsForTestRoles($chapter, ['view', 'create']);
260 $this->get($chapter->getUrl('/create-page'));
261 /** @var Page $page */
262 $page = Page::query()->where('draft', '=', true)->orderBy('id', 'desc')->first();
263 $resp = $this->post($page->getUrl(), [
264 'name' => 'test page',
265 'html' => 'test content',
267 $resp->assertRedirect($chapter->book->getUrl('/page/test-page'));
269 $this->withHtml($this->get($chapterUrl))->assertElementContains('.actions', 'New Page');
272 public function test_chapter_update_restriction()
274 $chapter = $this->entities->chapter();
275 $chapterPage = $chapter->pages->first();
277 $chapterUrl = $chapter->getUrl();
278 $this->actingAs($this->user)->get($chapterUrl . '/edit')
279 ->assertSee('Edit Chapter');
281 $this->setRestrictionsForTestRoles($chapter, ['view', 'delete']);
283 $this->get($chapterUrl . '/edit')->assertRedirect('/');
284 $this->get('/')->assertSee('You do not have permission');
285 $this->get($chapterPage->getUrl() . '/edit')->assertRedirect('/');
286 $this->get('/')->assertSee('You do not have permission');
288 $this->setRestrictionsForTestRoles($chapter, ['view', 'update']);
290 $this->get($chapterUrl . '/edit')->assertOk()->assertSee('Edit Chapter');
291 $this->get($chapterPage->getUrl() . '/edit')->assertOk();
294 public function test_chapter_delete_restriction()
296 $chapter = $this->entities->chapter();
297 $chapterPage = $chapter->pages->first();
299 $chapterUrl = $chapter->getUrl();
300 $this->actingAs($this->user)
301 ->get($chapterUrl . '/delete')
302 ->assertSee('Delete Chapter');
304 $this->setRestrictionsForTestRoles($chapter, ['view', 'update']);
306 $this->get($chapterUrl . '/delete')->assertRedirect('/');
307 $this->get('/')->assertSee('You do not have permission');
308 $this->get($chapterPage->getUrl() . '/delete')->assertRedirect('/');
309 $this->get('/')->assertSee('You do not have permission');
311 $this->setRestrictionsForTestRoles($chapter, ['view', 'delete']);
313 $this->get($chapterUrl . '/delete')->assertOk()->assertSee('Delete Chapter');
314 $this->get($chapterPage->getUrl() . '/delete')->assertOk()->assertSee('Delete Page');
317 public function test_page_view_restriction()
319 $page = $this->entities->page();
321 $pageUrl = $page->getUrl();
322 $this->actingAs($this->user)->get($pageUrl)->assertOk();
324 $this->setRestrictionsForTestRoles($page, ['update', 'delete']);
326 $this->get($pageUrl)->assertSee('Page not found');
328 $this->setRestrictionsForTestRoles($page, ['view']);
330 $this->get($pageUrl)->assertSee($page->name);
333 public function test_page_update_restriction()
335 $page = $this->entities->page();
337 $pageUrl = $page->getUrl();
338 $resp = $this->actingAs($this->user)
339 ->get($pageUrl . '/edit');
340 $this->withHtml($resp)->assertElementExists('input[name="name"][value="' . $page->name . '"]');
342 $this->setRestrictionsForTestRoles($page, ['view', 'delete']);
344 $this->get($pageUrl . '/edit')->assertRedirect('/');
345 $this->get('/')->assertSee('You do not have permission');
347 $this->setRestrictionsForTestRoles($page, ['view', 'update']);
349 $resp = $this->get($pageUrl . '/edit')
351 $this->withHtml($resp)->assertElementExists('input[name="name"][value="' . $page->name . '"]');
354 public function test_page_delete_restriction()
356 $page = $this->entities->page();
358 $pageUrl = $page->getUrl();
359 $this->actingAs($this->user)
360 ->get($pageUrl . '/delete')
361 ->assertSee('Delete Page');
363 $this->setRestrictionsForTestRoles($page, ['view', 'update']);
365 $this->get($pageUrl . '/delete')->assertRedirect('/');
366 $this->get('/')->assertSee('You do not have permission');
368 $this->setRestrictionsForTestRoles($page, ['view', 'delete']);
370 $this->get($pageUrl . '/delete')->assertOk()->assertSee('Delete Page');
373 protected function entityRestrictionFormTest(string $model, string $title, string $permission, string $roleId)
375 /** @var Entity $modelInstance */
376 $modelInstance = $model::query()->first();
377 $this->asAdmin()->get($modelInstance->getUrl('/permissions'))
380 $this->put($modelInstance->getUrl('/permissions'), [
384 $permission => 'true',
390 $this->assertDatabaseHas('entity_permissions', [
391 'entity_id' => $modelInstance->id,
392 'entity_type' => $modelInstance->getMorphClass(),
393 'role_id' => $roleId,
398 public function test_bookshelf_restriction_form()
400 $this->entityRestrictionFormTest(Bookshelf::class, 'Shelf Permissions', 'view', '2');
403 public function test_book_restriction_form()
405 $this->entityRestrictionFormTest(Book::class, 'Book Permissions', 'view', '2');
408 public function test_chapter_restriction_form()
410 $this->entityRestrictionFormTest(Chapter::class, 'Chapter Permissions', 'update', '2');
413 public function test_page_restriction_form()
415 $this->entityRestrictionFormTest(Page::class, 'Page Permissions', 'delete', '2');
418 public function test_restricted_pages_not_visible_in_book_navigation_on_pages()
420 $chapter = $this->entities->chapter();
421 $page = $chapter->pages->first();
422 $page2 = $chapter->pages[2];
424 $this->setRestrictionsForTestRoles($page, []);
426 $resp = $this->actingAs($this->user)->get($page2->getUrl());
427 $this->withHtml($resp)->assertElementNotContains('.sidebar-page-list', $page->name);
430 public function test_restricted_pages_not_visible_in_book_navigation_on_chapters()
432 $chapter = $this->entities->chapter();
433 $page = $chapter->pages->first();
435 $this->setRestrictionsForTestRoles($page, []);
437 $resp = $this->actingAs($this->user)->get($chapter->getUrl());
438 $this->withHtml($resp)->assertElementNotContains('.sidebar-page-list', $page->name);
441 public function test_restricted_pages_not_visible_on_chapter_pages()
443 $chapter = $this->entities->chapter();
444 $page = $chapter->pages->first();
446 $this->setRestrictionsForTestRoles($page, []);
448 $this->actingAs($this->user)
449 ->get($chapter->getUrl())
450 ->assertDontSee($page->name);
453 public function test_restricted_chapter_pages_not_visible_on_book_page()
455 $chapter = $this->entities->chapter();
456 $this->actingAs($this->user)
457 ->get($chapter->book->getUrl())
458 ->assertSee($chapter->pages->first()->name);
460 foreach ($chapter->pages as $page) {
461 $this->setRestrictionsForTestRoles($page, []);
464 $this->actingAs($this->user)
465 ->get($chapter->book->getUrl())
466 ->assertDontSee($chapter->pages->first()->name);
469 public function test_bookshelf_update_restriction_override()
471 $shelf = $this->entities->shelf();
473 $this->actingAs($this->viewer)
474 ->get($shelf->getUrl('/edit'))
475 ->assertDontSee('Edit Book');
477 $this->setRestrictionsForTestRoles($shelf, ['view', 'delete']);
479 $this->get($shelf->getUrl('/edit'))->assertRedirect('/');
480 $this->get('/')->assertSee('You do not have permission');
482 $this->setRestrictionsForTestRoles($shelf, ['view', 'update']);
484 $this->get($shelf->getUrl('/edit'))->assertOk();
487 public function test_bookshelf_delete_restriction_override()
489 $shelf = $this->entities->shelf();
491 $this->actingAs($this->viewer)
492 ->get($shelf->getUrl('/delete'))
493 ->assertDontSee('Delete Book');
495 $this->setRestrictionsForTestRoles($shelf, ['view', 'update']);
497 $this->get($shelf->getUrl('/delete'))->assertRedirect('/');
498 $this->get('/')->assertSee('You do not have permission');
500 $this->setRestrictionsForTestRoles($shelf, ['view', 'delete']);
502 $this->get($shelf->getUrl('/delete'))->assertOk()->assertSee('Delete Shelf');
505 public function test_book_create_restriction_override()
507 $book = $this->entities->book();
509 $bookUrl = $book->getUrl();
510 $resp = $this->actingAs($this->viewer)->get($bookUrl);
511 $this->withHtml($resp)->assertElementNotContains('.actions', 'New Page')
512 ->assertElementNotContains('.actions', 'New Chapter');
514 $this->setRestrictionsForTestRoles($book, ['view', 'delete', 'update']);
516 $this->get($bookUrl . '/create-chapter')->assertRedirect('/');
517 $this->get('/')->assertSee('You do not have permission');
518 $this->get($bookUrl . '/create-page')->assertRedirect('/');
519 $this->get('/')->assertSee('You do not have permission');
520 $resp = $this->get($bookUrl);
521 $this->withHtml($resp)->assertElementNotContains('.actions', 'New Page')
522 ->assertElementNotContains('.actions', 'New Chapter');
524 $this->setRestrictionsForTestRoles($book, ['view', 'create']);
526 $resp = $this->post($book->getUrl('/create-chapter'), [
527 'name' => 'test chapter',
528 'description' => 'test desc',
530 $resp->assertRedirect($book->getUrl('/chapter/test-chapter'));
532 $this->get($book->getUrl('/create-page'));
533 /** @var Page $page */
534 $page = Page::query()->where('draft', '=', true)->orderByDesc('id')->first();
535 $resp = $this->post($page->getUrl(), [
536 'name' => 'test page',
537 'html' => 'test desc',
539 $resp->assertRedirect($book->getUrl('/page/test-page'));
541 $resp = $this->get($bookUrl);
542 $this->withHtml($resp)->assertElementContains('.actions', 'New Page')
543 ->assertElementContains('.actions', 'New Chapter');
546 public function test_book_update_restriction_override()
548 $book = $this->entities->book();
549 $bookPage = $book->pages->first();
550 $bookChapter = $book->chapters->first();
552 $bookUrl = $book->getUrl();
553 $this->actingAs($this->viewer)->get($bookUrl . '/edit')
554 ->assertDontSee('Edit Book');
556 $this->setRestrictionsForTestRoles($book, ['view', 'delete']);
558 $this->get($bookUrl . '/edit')->assertRedirect('/');
559 $this->get('/')->assertSee('You do not have permission');
560 $this->get($bookPage->getUrl() . '/edit')->assertRedirect('/');
561 $this->get('/')->assertSee('You do not have permission');
562 $this->get($bookChapter->getUrl() . '/edit')->assertRedirect('/');
563 $this->get('/')->assertSee('You do not have permission');
565 $this->setRestrictionsForTestRoles($book, ['view', 'update']);
567 $this->get($bookUrl . '/edit')->assertOk();
568 $this->get($bookPage->getUrl() . '/edit')->assertOk();
569 $this->get($bookChapter->getUrl() . '/edit')->assertSee('Edit Chapter');
572 public function test_book_delete_restriction_override()
574 $book = $this->entities->book();
575 $bookPage = $book->pages->first();
576 $bookChapter = $book->chapters->first();
578 $bookUrl = $book->getUrl();
579 $this->actingAs($this->viewer)
580 ->get($bookUrl . '/delete')
581 ->assertDontSee('Delete Book');
583 $this->setRestrictionsForTestRoles($book, ['view', 'update']);
585 $this->get($bookUrl . '/delete')->assertRedirect('/');
586 $this->get('/')->assertSee('You do not have permission');
587 $this->get($bookPage->getUrl() . '/delete')->assertRedirect('/');
588 $this->get('/')->assertSee('You do not have permission');
589 $this->get($bookChapter->getUrl() . '/delete')->assertRedirect('/');
590 $this->get('/')->assertSee('You do not have permission');
592 $this->setRestrictionsForTestRoles($book, ['view', 'delete']);
594 $this->get($bookUrl . '/delete')->assertOk()->assertSee('Delete Book');
595 $this->get($bookPage->getUrl() . '/delete')->assertOk()->assertSee('Delete Page');
596 $this->get($bookChapter->getUrl() . '/delete')->assertSee('Delete Chapter');
599 public function test_page_visible_if_has_permissions_when_book_not_visible()
601 $book = $this->entities->book();
602 $bookChapter = $book->chapters->first();
603 $bookPage = $bookChapter->pages->first();
605 foreach ([$book, $bookChapter, $bookPage] as $entity) {
606 $entity->name = Str::random(24);
610 $this->setRestrictionsForTestRoles($book, []);
611 $this->setRestrictionsForTestRoles($bookPage, ['view']);
613 $this->actingAs($this->viewer);
614 $resp = $this->get($bookPage->getUrl());
616 $resp->assertSee($bookPage->name);
617 $resp->assertDontSee(substr($book->name, 0, 15));
618 $resp->assertDontSee(substr($bookChapter->name, 0, 15));
621 public function test_book_sort_view_permission()
623 /** @var Book $firstBook */
624 $firstBook = Book::query()->first();
625 /** @var Book $secondBook */
626 $secondBook = Book::query()->find(2);
628 $this->setRestrictionsForTestRoles($firstBook, ['view', 'update']);
629 $this->setRestrictionsForTestRoles($secondBook, ['view']);
631 // Test sort page visibility
632 $this->actingAs($this->user)->get($secondBook->getUrl('/sort'))->assertRedirect('/');
633 $this->get('/')->assertSee('You do not have permission');
635 // Check sort page on first book
636 $this->actingAs($this->user)->get($firstBook->getUrl('/sort'));
639 public function test_can_create_page_if_chapter_has_permissions_when_book_not_visible()
641 $book = $this->entities->book();
642 $this->setRestrictionsForTestRoles($book, []);
643 $bookChapter = $book->chapters->first();
644 $this->setRestrictionsForTestRoles($bookChapter, ['view']);
646 $this->actingAs($this->user)->get($bookChapter->getUrl())
647 ->assertDontSee('New Page');
649 $this->setRestrictionsForTestRoles($bookChapter, ['view', 'create']);
651 $this->get($bookChapter->getUrl('/create-page'));
652 /** @var Page $page */
653 $page = Page::query()->where('draft', '=', true)->orderByDesc('id')->first();
654 $resp = $this->post($page->getUrl(), [
655 'name' => 'test page',
656 'html' => 'test content',
658 $resp->assertRedirect($book->getUrl('/page/test-page'));
661 public function test_access_to_item_prevented_if_inheritance_active_but_permission_prevented_via_role()
663 $user = $this->getViewer();
664 $viewerRole = $user->roles->first();
665 $chapter = $this->entities->chapter();
666 $book = $chapter->book;
668 $this->entities->setPermissions($book, ['edit'], [$viewerRole], false);
669 $this->entities->setPermissions($chapter, [], [$viewerRole], true);
671 $this->assertFalse(userCan('chapter-update', $chapter));
674 public function test_access_to_item_allowed_if_inheritance_active_and_permission_prevented_via_role_but_allowed_via_parent()
676 $user = $this->getViewer();
677 $viewerRole = $user->roles->first();
678 $editorRole = Role::getRole('Editor');
679 $user->attachRole($editorRole);
680 $chapter = $this->entities->chapter();
681 $book = $chapter->book;
683 $this->entities->setPermissions($book, ['edit'], [$editorRole], false);
684 $this->entities->setPermissions($chapter, [], [$viewerRole], true);
686 $this->assertTrue(userCan('chapter-update', $chapter));
689 public function test_book_permissions_can_be_generated_without_error_if_child_chapter_is_in_recycle_bin()
691 $book = $this->entities->bookHasChaptersAndPages();
692 /** @var Chapter $chapter */
693 $chapter = $book->chapters()->first();
695 $this->asAdmin()->delete($chapter->getUrl());
699 $this->entities->setPermissions($book, ['view'], []);
700 } catch (Exception $e) {
704 $this->assertNull($error);