Added testing to cover webhook calling

[bookstack] / app / Http / Controllers / ChapterController.php

diff --git a/app/Http/Controllers/ChapterController.php b/app/Http/Controllers/ChapterController.php
index 98e7a66781ba978e2b092346ba01fb93c6c59143..9d2bd2489b6c883e961c16936640767a3f28578a 100644 (file)
--- a/app/Http/Controllers/ChapterController.php
+++ b/app/Http/Controllers/ChapterController.php
@@ -1,158 +1,224 @@
 <?php
 
 <?php
 

-namespace Oxbow\Http\Controllers;
+namespace BookStack\Http\Controllers;

 
 

-use Activity;
+use BookStack\Actions\View;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Repos\ChapterRepo;
+use BookStack\Entities\Tools\BookContents;
+use BookStack\Entities\Tools\NextPreviousContentLocator;
+use BookStack\Entities\Tools\PermissionsUpdater;
+use BookStack\Exceptions\MoveOperationException;
+use BookStack\Exceptions\NotFoundException;

 use Illuminate\Http\Request;
 use Illuminate\Http\Request;

-
-use Illuminate\Support\Facades\Auth;
-use Oxbow\Http\Requests;
-use Oxbow\Http\Controllers\Controller;
-use Oxbow\Repos\BookRepo;
-use Oxbow\Repos\ChapterRepo;
+use Illuminate\Validation\ValidationException;
+use Throwable;

 
 class ChapterController extends Controller
 {
 
 class ChapterController extends Controller
 {

-
-    protected $bookRepo;

     protected $chapterRepo;
 
     /**
      * ChapterController constructor.
     protected $chapterRepo;
 
     /**
      * ChapterController constructor.

-     * @param $bookRepo
-     * @param $chapterRepo

      */
      */

-    public function __construct(BookRepo $bookRepo, ChapterRepo $chapterRepo)
+    public function __construct(ChapterRepo $chapterRepo)

     {
     {

-        $this->bookRepo = $bookRepo;

         $this->chapterRepo = $chapterRepo;
         $this->chapterRepo = $chapterRepo;

-        parent::__construct();

     }
 
     }
 

-

     /**
      * Show the form for creating a new chapter.
     /**
      * Show the form for creating a new chapter.

-     *
-     * @param $bookSlug
-     * @return Response

      */
      */

-    public function create($bookSlug)
+    public function create(string $bookSlug)

     {
     {

-        $this->checkPermission('chapter-create');
-        $book = $this->bookRepo->getBySlug($bookSlug);
-        return view('chapters/create', ['book' => $book, 'current' => $book]);
+        $book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();
+        $this->checkOwnablePermission('chapter-create', $book);
+
+        $this->setPageTitle(trans('entities.chapters_create'));
+
+        return view('chapters.create', ['book' => $book, 'current' => $book]);

     }
 
     /**
      * Store a newly created chapter in storage.
      *
     }
 
     /**
      * Store a newly created chapter in storage.
      *

-     * @param          $bookSlug
-     * @param  Request $request
-     * @return Response
+     * @throws ValidationException

      */
      */

-    public function store($bookSlug, Request $request)
+    public function store(Request $request, string $bookSlug)

     {
     {

-        $this->checkPermission('chapter-create');

         $this->validate($request, [
         $this->validate($request, [

-            'name' => 'required|string|max:255'
+            'name' => ['required', 'string', 'max:255'],

         ]);
 
         ]);
 

-        $book = $this->bookRepo->getBySlug($bookSlug);
-        $chapter = $this->chapterRepo->newFromInput($request->all());
-        $chapter->slug = $this->chapterRepo->findSuitableSlug($chapter->name, $book->id);
-        $chapter->priority = $this->bookRepo->getNewPriority($book);
-        $chapter->created_by = Auth::user()->id;
-        $chapter->updated_by = Auth::user()->id;
-        $book->chapters()->save($chapter);
-        Activity::add($chapter, 'chapter_create', $book->id);
-        return redirect($book->getUrl());
+        $book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();
+        $this->checkOwnablePermission('chapter-create', $book);
+
+        $chapter = $this->chapterRepo->create($request->all(), $book);
+
+        return redirect($chapter->getUrl());

     }
 
     /**
      * Display the specified chapter.
     }
 
     /**
      * Display the specified chapter.

-     *
-     * @param $bookSlug
-     * @param $chapterSlug
-     * @return Response

      */
      */

-    public function show($bookSlug, $chapterSlug)
+    public function show(string $bookSlug, string $chapterSlug)

     {
     {

-        $book = $this->bookRepo->getBySlug($bookSlug);
-        $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
-        return view('chapters/show', ['book' => $book, 'chapter' => $chapter, 'current' => $chapter]);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-view', $chapter);
+
+        $sidebarTree = (new BookContents($chapter->book))->getTree();
+        $pages = $chapter->getVisiblePages();
+        $nextPreviousLocator = new NextPreviousContentLocator($chapter, $sidebarTree);
+        View::incrementFor($chapter);
+
+        $this->setPageTitle($chapter->getShortName());
+
+        return view('chapters.show', [
+            'book'        => $chapter->book,
+            'chapter'     => $chapter,
+            'current'     => $chapter,
+            'sidebarTree' => $sidebarTree,
+            'pages'       => $pages,
+            'next'        => $nextPreviousLocator->getNext(),
+            'previous'    => $nextPreviousLocator->getPrevious(),
+        ]);

     }
 
     /**
      * Show the form for editing the specified chapter.
     }
 
     /**
      * Show the form for editing the specified chapter.

-     *
-     * @param $bookSlug
-     * @param $chapterSlug
-     * @return Response

      */
      */

-    public function edit($bookSlug, $chapterSlug)
+    public function edit(string $bookSlug, string $chapterSlug)

     {
     {

-        $this->checkPermission('chapter-update');
-        $book = $this->bookRepo->getBySlug($bookSlug);
-        $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
-        return view('chapters/edit', ['book' => $book, 'chapter' => $chapter, 'current' => $chapter]);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-update', $chapter);
+
+        $this->setPageTitle(trans('entities.chapters_edit_named', ['chapterName' => $chapter->getShortName()]));
+
+        return view('chapters.edit', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);

     }
 
     /**
      * Update the specified chapter in storage.
      *
     }
 
     /**
      * Update the specified chapter in storage.
      *

-     * @param  Request $request
-     * @param          $bookSlug
-     * @param          $chapterSlug
-     * @return Response
+     * @throws NotFoundException

      */
      */

-    public function update(Request $request, $bookSlug, $chapterSlug)
+    public function update(Request $request, string $bookSlug, string $chapterSlug)

     {
     {

-        $this->checkPermission('chapter-update');
-        $book = $this->bookRepo->getBySlug($bookSlug);
-        $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
-        $chapter->fill($request->all());
-        $chapter->slug = $this->chapterRepo->findSuitableSlug($chapter->name, $book->id, $chapter->id);
-        $chapter->updated_by = Auth::user()->id;
-        $chapter->save();
-        Activity::add($chapter, 'chapter_update', $book->id);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-update', $chapter);
+
+        $this->chapterRepo->update($chapter, $request->all());
+

         return redirect($chapter->getUrl());
     }
 
     /**
      * Shows the page to confirm deletion of this chapter.
         return redirect($chapter->getUrl());
     }
 
     /**
      * Shows the page to confirm deletion of this chapter.

-     * @param $bookSlug
-     * @param $chapterSlug
-     * @return \Illuminate\View\View
+     *
+     * @throws NotFoundException

      */
      */

-    public function showDelete($bookSlug, $chapterSlug)
+    public function showDelete(string $bookSlug, string $chapterSlug)

     {
     {

-        $this->checkPermission('chapter-delete');
-        $book = $this->bookRepo->getBySlug($bookSlug);
-        $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
-        return view('chapters/delete', ['book' => $book, 'chapter' => $chapter, 'current' => $chapter]);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-delete', $chapter);
+
+        $this->setPageTitle(trans('entities.chapters_delete_named', ['chapterName' => $chapter->getShortName()]));
+
+        return view('chapters.delete', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);

     }
 
     /**
      * Remove the specified chapter from storage.
      *
     }
 
     /**
      * Remove the specified chapter from storage.
      *

-     * @param $bookSlug
-     * @param $chapterSlug
-     * @return Response
+     * @throws NotFoundException
+     * @throws Throwable
+     */
+    public function destroy(string $bookSlug, string $chapterSlug)
+    {
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-delete', $chapter);
+
+        $this->chapterRepo->destroy($chapter);
+
+        return redirect($chapter->book->getUrl());
+    }
+
+    /**
+     * Show the page for moving a chapter.
+     *
+     * @throws NotFoundException

      */
      */

-    public function destroy($bookSlug, $chapterSlug)
+    public function showMove(string $bookSlug, string $chapterSlug)

     {
     {

-        $this->checkPermission('chapter-delete');
-        $book = $this->bookRepo->getBySlug($bookSlug);
-        $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
-        if (count($chapter->pages) > 0) {
-            foreach ($chapter->pages as $page) {
-                $page->chapter_id = 0;
-                $page->save();
-            }
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->setPageTitle(trans('entities.chapters_move_named', ['chapterName' => $chapter->getShortName()]));
+        $this->checkOwnablePermission('chapter-update', $chapter);
+        $this->checkOwnablePermission('chapter-delete', $chapter);
+
+        return view('chapters.move', [
+            'chapter' => $chapter,
+            'book'    => $chapter->book,
+        ]);
+    }
+
+    /**
+     * Perform the move action for a chapter.
+     *
+     * @throws NotFoundException
+     */
+    public function move(Request $request, string $bookSlug, string $chapterSlug)
+    {
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('chapter-update', $chapter);
+        $this->checkOwnablePermission('chapter-delete', $chapter);
+
+        $entitySelection = $request->get('entity_selection', null);
+        if ($entitySelection === null || $entitySelection === '') {
+            return redirect($chapter->getUrl());
+        }
+
+        try {
+            $newBook = $this->chapterRepo->move($chapter, $entitySelection);
+        } catch (MoveOperationException $exception) {
+            $this->showErrorNotification(trans('errors.selected_book_not_found'));
+
+            return redirect()->back();

         }
         }

-        Activity::removeEntity($chapter);
-        Activity::addMessage('chapter_delete', $book->id, $chapter->name);
-        $chapter->delete();
-        return redirect($book->getUrl());
+
+        $this->showSuccessNotification(trans('entities.chapter_move_success', ['bookName' => $newBook->name]));
+
+        return redirect($chapter->getUrl());
+    }
+
+    /**
+     * Show the Restrictions view.
+     *
+     * @throws NotFoundException
+     */
+    public function showPermissions(string $bookSlug, string $chapterSlug)
+    {
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('restrictions-manage', $chapter);
+
+        return view('chapters.permissions', [
+            'chapter' => $chapter,
+        ]);
+    }
+
+    /**
+     * Set the restrictions for this chapter.
+     *
+     * @throws NotFoundException
+     */
+    public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $bookSlug, string $chapterSlug)
+    {
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
+        $this->checkOwnablePermission('restrictions-manage', $chapter);
+
+        $permissionsUpdater->updateFromPermissionsForm($chapter, $request);
+
+        $this->showSuccessNotification(trans('entities.chapters_permissions_success'));
+
+        return redirect($chapter->getUrl());

     }
 }
     }
 }