Got chapter conversion to books working

- Added required UI within edit view.
- Added required routes and controller actions.

diff --git a/app/Actions/ActivityType.php b/app/Actions/ActivityType.php
index 8b5213a8b2af809f5e668f603a49d36f27dc1ecb..997cc041ab177d5fd466fe58889704f66bd1a44c 100644 (file)
--- a/app/Actions/ActivityType.php
+++ b/app/Actions/ActivityType.php
@@ -16,6 +16,7 @@ class ActivityType
     const CHAPTER_MOVE = 'chapter_move';
 
     const BOOK_CREATE = 'book_create';
     const CHAPTER_MOVE = 'chapter_move';
 
     const BOOK_CREATE = 'book_create';

+    const BOOK_CREATE_FROM_CHAPTER = 'book_create_from_chapter';

     const BOOK_UPDATE = 'book_update';
     const BOOK_DELETE = 'book_delete';
     const BOOK_SORT = 'book_sort';
     const BOOK_UPDATE = 'book_update';
     const BOOK_DELETE = 'book_delete';
     const BOOK_SORT = 'book_sort';

diff --git a/app/Entities/Repos/BookRepo.php b/app/Entities/Repos/BookRepo.php
index 0c62a13fc1255a3328fe10fa190049491c510c1f..b5944fd460b2f23737e9c3ddcf22be005e72df4e 100644 (file)
--- a/app/Entities/Repos/BookRepo.php
+++ b/app/Entities/Repos/BookRepo.php
@@ -91,7 +91,7 @@ class BookRepo
     {
         $book = new Book();
         $this->baseRepo->create($book, $input);
     {
         $book = new Book();
         $this->baseRepo->create($book, $input);

-        $this->baseRepo->updateCoverImage($book, $input['image']);
+        $this->baseRepo->updateCoverImage($book, $input['image'] ?? null);

         Activity::add(ActivityType::BOOK_CREATE, $book);
 
         return $book;
         Activity::add(ActivityType::BOOK_CREATE, $book);
 
         return $book;


@@ -104,7 +104,7 @@ class BookRepo
     {
         $this->baseRepo->update($book, $input);
 
     {
         $this->baseRepo->update($book, $input);
 

-        if (isset($input['image'])) {
+        if (array_key_exists('image', $input)) {

             $this->baseRepo->updateCoverImage($book, $input['image'], $input['image'] === null);
         }
 
             $this->baseRepo->updateCoverImage($book, $input['image'], $input['image'] === null);
         }
 

diff --git a/app/Entities/Tools/HierarchyTransformer.php b/app/Entities/Tools/HierarchyTransformer.php
index c95d5fa5307e4d4e7d9bd930d8a031f7b15de804..7304962b379c9a4578db8598971053631f194906 100644 (file)
--- a/app/Entities/Tools/HierarchyTransformer.php
+++ b/app/Entities/Tools/HierarchyTransformer.php
@@ -2,12 +2,14 @@
 
 namespace BookStack\Entities\Tools;
 
 
 namespace BookStack\Entities\Tools;
 

+use BookStack\Actions\ActivityType;

 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Repos\BookshelfRepo;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Repos\BookshelfRepo;

+use BookStack\Facades\Activity;

 
 class HierarchyTransformer
 {
 
 class HierarchyTransformer
 {


@@ -16,10 +18,20 @@ class HierarchyTransformer
     protected Cloner $cloner;
     protected TrashCan $trashCan;
 
     protected Cloner $cloner;
     protected TrashCan $trashCan;
 

+    public function __construct(BookRepo $bookRepo, BookshelfRepo $shelfRepo, Cloner $cloner, TrashCan $trashCan)
+    {
+        $this->bookRepo = $bookRepo;
+        $this->shelfRepo = $shelfRepo;
+        $this->cloner = $cloner;
+        $this->trashCan = $trashCan;
+    }
+
+    /**
+     * Transform a chapter into a book.
+     * Does not check permissions, check before calling.
+     */

     public function transformChapterToBook(Chapter $chapter): Book
     {
     public function transformChapterToBook(Chapter $chapter): Book
     {

-        // TODO - Check permissions before call
-        //   Permissions: edit-chapter, delete-chapter, create-book

         $inputData = $this->cloner->entityToInputData($chapter);
         $book = $this->bookRepo->create($inputData);
         $this->cloner->copyEntityPermissions($chapter, $book);
         $inputData = $this->cloner->entityToInputData($chapter);
         $book = $this->bookRepo->create($inputData);
         $this->cloner->copyEntityPermissions($chapter, $book);


@@ -32,7 +44,7 @@ class HierarchyTransformer
 
         $this->trashCan->destroyEntity($chapter);
 
 
         $this->trashCan->destroyEntity($chapter);
 

-        // TODO - Log activity for change
+        Activity::add(ActivityType::BOOK_CREATE_FROM_CHAPTER);

         return $book;
     }
 
         return $book;
     }
 

diff --git a/app/Http/Controllers/ChapterController.php b/app/Http/Controllers/ChapterController.php
index 83b9bb692da6c3173305c538ab79a6a8a836da86..d1fe5249a2ae46fd281a602e8d0966ce9dfa22a2 100644 (file)
--- a/app/Http/Controllers/ChapterController.php
+++ b/app/Http/Controllers/ChapterController.php
@@ -7,6 +7,7 @@ use BookStack\Entities\Models\Book;
 use BookStack\Entities\Repos\ChapterRepo;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\Cloner;
 use BookStack\Entities\Repos\ChapterRepo;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\Cloner;

+use BookStack\Entities\Tools\HierarchyTransformer;

 use BookStack\Entities\Tools\NextPreviousContentLocator;
 use BookStack\Entities\Tools\PermissionsUpdater;
 use BookStack\Exceptions\MoveOperationException;
 use BookStack\Entities\Tools\NextPreviousContentLocator;
 use BookStack\Entities\Tools\PermissionsUpdater;
 use BookStack\Exceptions\MoveOperationException;


@@ -272,4 +273,20 @@ class ChapterController extends Controller
 
         return redirect($chapter->getUrl());
     }
 
         return redirect($chapter->getUrl());
     }

+
+
+    /**
+     * Convert the chapter to a book.
+     */
+    public function convertToBook(HierarchyTransformer $transformer, string $bookSlug, string $chapterSlug)
+    {
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-update', $chapter);
+        $this->checkOwnablePermission('chapter-delete', $chapter);
+        $this->checkPermission('book-create-all');
+
+        $book = $transformer->transformChapterToBook($chapter);
+
+        return redirect($book->getUrl());
+    }

 }
 }

diff --git a/resources/lang/en/activities.php b/resources/lang/en/activities.php
index 77c39b50c8c3be5cb6110c074b016ef9aca122e8..0c3d2e70437e07baaff9b778debebdb8dbfbeade 100644 (file)
--- a/resources/lang/en/activities.php
+++ b/resources/lang/en/activities.php
@@ -28,6 +28,8 @@ return [
     // Books
     'book_create'                 => 'created book',
     'book_create_notification'    => 'Book successfully created',
     // Books
     'book_create'                 => 'created book',
     'book_create_notification'    => 'Book successfully created',

+    'book_create_from_chapter'              => 'converted chapter to book',
+    'book_create_from_chapter_notification' => 'Chapter successfully converted to a book',

     'book_update'                 => 'updated book',
     'book_update_notification'    => 'Book successfully updated',
     'book_delete'                 => 'deleted book',
     'book_update'                 => 'updated book',
     'book_update_notification'    => 'Book successfully updated',
     'book_delete'                 => 'deleted book',

diff --git a/resources/views/chapters/edit.blade.php b/resources/views/chapters/edit.blade.php
index 65c48c18d77aba368a7af0872ad273d672e764a2..f6fd3cc6bf5c287d147e6a63690714fc09aad63f 100644 (file)
--- a/resources/views/chapters/edit.blade.php
+++ b/resources/views/chapters/edit.blade.php
@@ -15,7 +15,7 @@
             ]])
         </div>
 
             ]])
         </div>
 

-        <main class="content-wrap card">
+        <main class="content-wrap card auto-height">

             <h1 class="list-heading">{{ trans('entities.chapters_edit') }}</h1>
             <form action="{{  $chapter->getUrl() }}" method="POST">
                 <input type="hidden" name="_method" value="PUT">
             <h1 class="list-heading">{{ trans('entities.chapters_edit') }}</h1>
             <form action="{{  $chapter->getUrl() }}" method="POST">
                 <input type="hidden" name="_method" value="PUT">


@@ -23,6 +23,36 @@
             </form>
         </main>
 
             </form>
         </main>
 

+{{--        TODO - Permissions--}}
+        <div class="content-wrap card auto-height">
+            <h2 class="list-heading">Convert to Book</h2>
+            <div class="grid half left-focus no-row-gap">
+                <p>
+                    You can convert this chapter to a new book with the same contents.
+                    Any permissions set on this chapter will be copied to the new book but any inherited permissions,
+                    from the parent book, will not be copied which could lead to a change of access control.
+                </p>
+                <div class="text-m-right">
+                    <div component="dropdown" class="dropdown-container">
+                        <button refs="dropdown@toggle" class="button outline" aria-haspopup="true" aria-expanded="false">Convert Chapter</button>
+                        <ul refs="dropdown@menu" class="dropdown-menu" role="menu">
+                            <li class="px-m py-s text-small text-muted">
+                                Are you sure you want to convert this chapter?
+                                <br>
+                                This cannot be as easily undone.
+                            </li>
+                            <li>
+                                <form action="{{ $chapter->getUrl('/convert-to-book') }}" method="POST">
+                                    {!! csrf_field() !!}
+                                    <button type="submit" class="text-primary text-item">{{ trans('common.confirm') }}</button>
+                                </form>
+                            </li>
+                        </ul>
+                    </div>
+                </div>
+            </div>
+        </div>
+

     </div>
 
 @stop
\ No newline at end of file
     </div>
 
 @stop
\ No newline at end of file

diff --git a/routes/web.php b/routes/web.php
index 37f59b9706e5caf1ce9917846fb136555e42ccf1..dfda9725351d51c16fa98e279dc37275461b5a0e 100644 (file)
--- a/routes/web.php
+++ b/routes/web.php
@@ -132,6 +132,7 @@ Route::middleware('auth')->group(function () {
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'showCopy']);
     Route::post('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'copy']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/edit', [ChapterController::class, 'edit']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'showCopy']);
     Route::post('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'copy']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/edit', [ChapterController::class, 'edit']);

+    Route::post('/books/{bookSlug}/chapter/{chapterSlug}/convert-to-book', [ChapterController::class, 'convertToBook']);

     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/permissions', [ChapterController::class, 'showPermissions']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/pdf', [ChapterExportController::class, 'pdf']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/html', [ChapterExportController::class, 'html']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/permissions', [ChapterController::class, 'showPermissions']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/pdf', [ChapterExportController::class, 'pdf']);
     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/html', [ChapterExportController::class, 'html']);