]> BookStack Code Mirror - bookstack/blob - app/Entities/Repos/ChapterRepo.php
Permissions: Cleanup after review of enum implementation PR
[bookstack] / app / Entities / Repos / ChapterRepo.php
1 <?php
2
3 namespace BookStack\Entities\Repos;
4
5 use BookStack\Activity\ActivityType;
6 use BookStack\Entities\Models\Book;
7 use BookStack\Entities\Models\Chapter;
8 use BookStack\Entities\Queries\EntityQueries;
9 use BookStack\Entities\Tools\BookContents;
10 use BookStack\Entities\Tools\TrashCan;
11 use BookStack\Exceptions\MoveOperationException;
12 use BookStack\Exceptions\PermissionsException;
13 use BookStack\Facades\Activity;
14 use BookStack\Permissions\Permission;
15 use BookStack\Util\DatabaseTransaction;
16 use Exception;
17
18 class ChapterRepo
19 {
20     public function __construct(
21         protected BaseRepo $baseRepo,
22         protected EntityQueries $entityQueries,
23         protected TrashCan $trashCan,
24     ) {
25     }
26
27     /**
28      * Create a new chapter in the system.
29      */
30     public function create(array $input, Book $parentBook): Chapter
31     {
32         return (new DatabaseTransaction(function () use ($input, $parentBook) {
33             $chapter = new Chapter();
34             $chapter->book_id = $parentBook->id;
35             $chapter->priority = (new BookContents($parentBook))->getLastPriority() + 1;
36             $this->baseRepo->create($chapter, $input);
37             $this->baseRepo->updateDefaultTemplate($chapter, intval($input['default_template_id'] ?? null));
38             Activity::add(ActivityType::CHAPTER_CREATE, $chapter);
39
40             $this->baseRepo->sortParent($chapter);
41
42             return $chapter;
43         }))->run();
44     }
45
46     /**
47      * Update the given chapter.
48      */
49     public function update(Chapter $chapter, array $input): Chapter
50     {
51         $this->baseRepo->update($chapter, $input);
52
53         if (array_key_exists('default_template_id', $input)) {
54             $this->baseRepo->updateDefaultTemplate($chapter, intval($input['default_template_id']));
55         }
56
57         Activity::add(ActivityType::CHAPTER_UPDATE, $chapter);
58
59         $this->baseRepo->sortParent($chapter);
60
61         return $chapter;
62     }
63
64     /**
65      * Remove a chapter from the system.
66      *
67      * @throws Exception
68      */
69     public function destroy(Chapter $chapter)
70     {
71         $this->trashCan->softDestroyChapter($chapter);
72         Activity::add(ActivityType::CHAPTER_DELETE, $chapter);
73         $this->trashCan->autoClearOld();
74     }
75
76     /**
77      * Move the given chapter into a new parent book.
78      * The $parentIdentifier must be a string of the following format:
79      * 'book:<id>' (book:5).
80      *
81      * @throws MoveOperationException
82      * @throws PermissionsException
83      */
84     public function move(Chapter $chapter, string $parentIdentifier): Book
85     {
86         $parent = $this->entityQueries->findVisibleByStringIdentifier($parentIdentifier);
87         if (!$parent instanceof Book) {
88             throw new MoveOperationException('Book to move chapter into not found');
89         }
90
91         if (!userCan(Permission::ChapterCreate, $parent)) {
92             throw new PermissionsException('User does not have permission to create a chapter within the chosen book');
93         }
94
95         return (new DatabaseTransaction(function () use ($chapter, $parent) {
96             $chapter->changeBook($parent->id);
97             $chapter->rebuildPermissions();
98             Activity::add(ActivityType::CHAPTER_MOVE, $chapter);
99
100             $this->baseRepo->sortParent($chapter);
101
102             return $parent;
103         }))->run();
104     }
105 }