Themes: Documented public file serving

[bookstack] / app / Entities / Tools / Cloner.php

diff --git a/app/Entities/Tools/Cloner.php b/app/Entities/Tools/Cloner.php
index 3ce4dff2064ee64deebff78610d4360c991e1b9d..2be6083e3ddcb810871ab42ad973070d1f41fd8e 100644 (file)
--- a/app/Entities/Tools/Cloner.php
+++ b/app/Entities/Tools/Cloner.php
@@ -2,43 +2,156 @@
 
 namespace BookStack\Entities\Tools;
 
 
 namespace BookStack\Entities\Tools;
 

+use BookStack\Activity\Models\Tag;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Models\Chapter;

 use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Models\Entity;

+use BookStack\Entities\Models\HasCoverImage;

 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Models\Page;

+use BookStack\Entities\Repos\BookRepo;
+use BookStack\Entities\Repos\ChapterRepo;

 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Entities\Repos\PageRepo;

+use BookStack\Uploads\Image;
+use BookStack\Uploads\ImageService;
+use Illuminate\Http\UploadedFile;

 
 class Cloner
 {
 
 class Cloner
 {

+    public function __construct(
+        protected PageRepo $pageRepo,
+        protected ChapterRepo $chapterRepo,
+        protected BookRepo $bookRepo,
+        protected ImageService $imageService,
+    ) {
+    }

 
     /**
 
     /**

-     * @var PageRepo
+     * Clone the given page into the given parent using the provided name.

      */
      */

-    protected $pageRepo;
-
-    public function __construct(PageRepo $pageRepo)
+    public function clonePage(Page $original, Entity $parent, string $newName): Page

     {
     {

-        $this->pageRepo = $pageRepo;
+        $copyPage = $this->pageRepo->getNewDraftPage($parent);
+        $pageData = $this->entityToInputData($original);
+        $pageData['name'] = $newName;
+
+        return $this->pageRepo->publishDraft($copyPage, $pageData);

     }
 
     /**
      * Clone the given page into the given parent using the provided name.
     }
 
     /**
      * Clone the given page into the given parent using the provided name.

+     * Clones all child pages.

      */
      */

-    public function clonePage(Page $original, Entity $parent, string $newName): Page
+    public function cloneChapter(Chapter $original, Book $parent, string $newName): Chapter

     {
     {

-        $copyPage = $this->pageRepo->getNewDraftPage($parent);
-        $pageData = $original->getAttributes();
+        $chapterDetails = $this->entityToInputData($original);
+        $chapterDetails['name'] = $newName;

 
 

-        // Update name
-        $pageData['name'] = $newName;
+        $copyChapter = $this->chapterRepo->create($chapterDetails, $parent);

 
 

-        // Copy tags from previous page if set
-        if ($original->tags) {
-            $pageData['tags'] = [];
-            foreach ($original->tags as $tag) {
-                $pageData['tags'][] = ['name' => $tag->name, 'value' => $tag->value];
+        if (userCan('page-create', $copyChapter)) {
+            /** @var Page $page */
+            foreach ($original->getVisiblePages() as $page) {
+                $this->clonePage($page, $copyChapter, $page->name);

             }
         }
 
             }
         }
 

-        return $this->pageRepo->publishDraft($copyPage, $pageData);
+        return $copyChapter;
+    }
+
+    /**
+     * Clone the given book.
+     * Clones all child chapters & pages.
+     */
+    public function cloneBook(Book $original, string $newName): Book
+    {
+        $bookDetails = $this->entityToInputData($original);
+        $bookDetails['name'] = $newName;
+
+        // Clone book
+        $copyBook = $this->bookRepo->create($bookDetails);
+
+        // Clone contents
+        $directChildren = $original->getDirectVisibleChildren();
+        foreach ($directChildren as $child) {
+            if ($child instanceof Chapter && userCan('chapter-create', $copyBook)) {
+                $this->cloneChapter($child, $copyBook, $child->name);
+            }
+
+            if ($child instanceof Page && !$child->draft && userCan('page-create', $copyBook)) {
+                $this->clonePage($child, $copyBook, $child->name);
+            }
+        }
+
+        // Clone bookshelf relationships
+        /** @var Bookshelf $shelf */
+        foreach ($original->shelves as $shelf) {
+            if (userCan('bookshelf-update', $shelf)) {
+                $shelf->appendBook($copyBook);
+            }
+        }
+
+        return $copyBook;

     }
 
     }
 

-}
\ No newline at end of file
+    /**
+     * Convert an entity to a raw data array of input data.
+     *
+     * @return array<string, mixed>
+     */
+    public function entityToInputData(Entity $entity): array
+    {
+        $inputData = $entity->getAttributes();
+        $inputData['tags'] = $this->entityTagsToInputArray($entity);
+
+        // Add a cover to the data if existing on the original entity
+        if ($entity instanceof HasCoverImage) {
+            $cover = $entity->cover()->first();
+            if ($cover) {
+                $inputData['image'] = $this->imageToUploadedFile($cover);
+            }
+        }
+
+        return $inputData;
+    }
+
+    /**
+     * Copy the permission settings from the source entity to the target entity.
+     */
+    public function copyEntityPermissions(Entity $sourceEntity, Entity $targetEntity): void
+    {
+        $permissions = $sourceEntity->permissions()->get(['role_id', 'view', 'create', 'update', 'delete'])->toArray();
+        $targetEntity->permissions()->delete();
+        $targetEntity->permissions()->createMany($permissions);
+        $targetEntity->rebuildPermissions();
+    }
+
+    /**
+     * Convert an image instance to an UploadedFile instance to mimic
+     * a file being uploaded.
+     */
+    protected function imageToUploadedFile(Image $image): ?UploadedFile
+    {
+        $imgData = $this->imageService->getImageData($image);
+        $tmpImgFilePath = tempnam(sys_get_temp_dir(), 'bs_cover_clone_');
+        file_put_contents($tmpImgFilePath, $imgData);
+
+        return new UploadedFile($tmpImgFilePath, basename($image->path));
+    }
+
+    /**
+     * Convert the tags on the given entity to the raw format
+     * that's used for incoming request data.
+     */
+    protected function entityTagsToInputArray(Entity $entity): array
+    {
+        $tags = [];
+
+        /** @var Tag $tag */
+        foreach ($entity->tags as $tag) {
+            $tags[] = ['name' => $tag->name, 'value' => $tag->value];
+        }
+
+        return $tags;
+    }
+}