Code cleanup, bug squashing

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

diff --git a/app/Http/Controllers/ChapterController.php b/app/Http/Controllers/ChapterController.php
index a4e0b64091efafc3fe22f1e034f4acb24d07786b..0059f202b9df7702d1b1baecd485056fd909affa 100644 (file)
--- a/app/Http/Controllers/ChapterController.php
+++ b/app/Http/Controllers/ChapterController.php
@@ -1,84 +1,72 @@
 <?php namespace BookStack\Http\Controllers;
 
 <?php namespace BookStack\Http\Controllers;
 

-use Activity;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Tools\BookContents;
+use BookStack\Entities\Repos\ChapterRepo;
+use BookStack\Exceptions\MoveOperationException;
+use BookStack\Exceptions\NotFoundException;

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

-use Illuminate\Http\Response;
+use Illuminate\Validation\ValidationException;
+use Throwable;

 use Views;
 
 class ChapterController extends Controller
 {
 
 use Views;
 
 class ChapterController extends Controller
 {
 

-    protected $userRepo;
-    protected $entityRepo;
-    protected $exportService;
+    protected $chapterRepo;

 
     /**
      * ChapterController constructor.
 
     /**
      * ChapterController constructor.

-     * @param EntityRepo $entityRepo
-     * @param UserRepo $userRepo
-     * @param ExportService $exportService

      */
      */

-    public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
+    public function __construct(ChapterRepo $chapterRepo)

     {
     {

-        $this->entityRepo = $entityRepo;
-        $this->userRepo = $userRepo;
-        $this->exportService = $exportService;
-        parent::__construct();
+        $this->chapterRepo = $chapterRepo;

     }
 
     /**
      * 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)

     {
     {

-        $book = $this->entityRepo->getBySlug('book', $bookSlug);
+        $book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();

         $this->checkOwnablePermission('chapter-create', $book);
         $this->checkOwnablePermission('chapter-create', $book);

+

         $this->setPageTitle(trans('entities.chapters_create'));
         $this->setPageTitle(trans('entities.chapters_create'));

-        return view('chapters/create', ['book' => $book, 'current' => $book]);
+        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->validate($request, [
             'name' => 'required|string|max:255'
         ]);
 
     {
         $this->validate($request, [
             'name' => 'required|string|max:255'
         ]);
 

-        $book = $this->entityRepo->getBySlug('book', $bookSlug);
+        $book = Book::visible()->where('slug', '=', $bookSlug)->firstOrFail();

         $this->checkOwnablePermission('chapter-create', $book);
 
         $this->checkOwnablePermission('chapter-create', $book);
 

-        $input = $request->all();
-        $input['priority'] = $this->entityRepo->getNewBookPriority($book);
-        $chapter = $this->entityRepo->createFromInput('chapter', $input, $book);
-        Activity::add($chapter, 'chapter_create', $book->id);
+        $chapter = $this->chapterRepo->create($request->all(), $book);
+

         return redirect($chapter->getUrl());
     }
 
     /**
      * Display the specified chapter.
         return redirect($chapter->getUrl());
     }
 
     /**
      * Display the specified chapter.

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

      */
      */

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

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('chapter-view', $chapter);
         $this->checkOwnablePermission('chapter-view', $chapter);

-        $sidebarTree = $this->entityRepo->getBookChildren($chapter->book);
+
+        $sidebarTree = (new BookContents($chapter->book))->getTree();
+        $pages = $chapter->getVisiblePages();

         Views::add($chapter);
         Views::add($chapter);

+

         $this->setPageTitle($chapter->getShortName());
         $this->setPageTitle($chapter->getShortName());

-        $pages = $this->entityRepo->getChapterChildren($chapter);
-        return view('chapters/show', [
+        return view('chapters.show', [

             'book' => $chapter->book,
             'chapter' => $chapter,
             'current' => $chapter,
             'book' => $chapter->book,
             'chapter' => $chapter,
             'current' => $chapter,


@@ -89,82 +77,70 @@ class ChapterController extends Controller
 
     /**
      * 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)

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('chapter-update', $chapter);
         $this->checkOwnablePermission('chapter-update', $chapter);

+

         $this->setPageTitle(trans('entities.chapters_edit_named', ['chapterName' => $chapter->getShortName()]));
         $this->setPageTitle(trans('entities.chapters_edit_named', ['chapterName' => $chapter->getShortName()]));

-        return view('chapters/edit', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);
+        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)

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('chapter-update', $chapter);
         $this->checkOwnablePermission('chapter-update', $chapter);

-        if ($chapter->name !== $request->get('name')) {
-            $chapter->slug = $this->entityRepo->findSuitableSlug('chapter', $request->get('name'), $chapter->id, $chapter->book->id);
-        }
-        $chapter->fill($request->all());
-        $chapter->updated_by = user()->id;
-        $chapter->save();
-        Activity::add($chapter, 'chapter_update', $chapter->book->id);
+
+        $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)

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('chapter-delete', $chapter);
         $this->checkOwnablePermission('chapter-delete', $chapter);

+

         $this->setPageTitle(trans('entities.chapters_delete_named', ['chapterName' => $chapter->getShortName()]));
         $this->setPageTitle(trans('entities.chapters_delete_named', ['chapterName' => $chapter->getShortName()]));

-        return view('chapters/delete', ['book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter]);
+        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($bookSlug, $chapterSlug)
+    public function destroy(string $bookSlug, string $chapterSlug)

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
-        $book = $chapter->book;
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('chapter-delete', $chapter);
         $this->checkOwnablePermission('chapter-delete', $chapter);

-        Activity::addMessage('chapter_delete', $book->id, $chapter->name);
-        $this->entityRepo->destroyChapter($chapter);
-        return redirect($book->getUrl());
+
+        $this->chapterRepo->destroy($chapter);
+
+        return redirect($chapter->book->getUrl());

     }
 
     /**
      * Show the page for moving a chapter.
     }
 
     /**
      * Show the page for moving a chapter.

-     * @param $bookSlug
-     * @param $chapterSlug
-     * @return mixed
-     * @throws \BookStack\Exceptions\NotFoundException
+     * @throws NotFoundException

      */
      */

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

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->setPageTitle(trans('entities.chapters_move_named', ['chapterName' => $chapter->getShortName()]));
         $this->checkOwnablePermission('chapter-update', $chapter);
         $this->setPageTitle(trans('entities.chapters_move_named', ['chapterName' => $chapter->getShortName()]));
         $this->checkOwnablePermission('chapter-update', $chapter);

-        return view('chapters/move', [
+        $this->checkOwnablePermission('chapter-delete', $chapter);
+
+        return view('chapters.move', [

             'chapter' => $chapter,
             'book' => $chapter->book
         ]);
             'chapter' => $chapter,
             'book' => $chapter->book
         ]);


@@ -172,122 +148,58 @@ class ChapterController extends Controller
 
     /**
      * Perform the move action for a chapter.
 
     /**
      * Perform the move action for a chapter.

-     * @param $bookSlug
-     * @param $chapterSlug
-     * @param Request $request
-     * @return mixed
-     * @throws \BookStack\Exceptions\NotFoundException
+     * @throws NotFoundException

      */
      */

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

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('chapter-update', $chapter);
         $this->checkOwnablePermission('chapter-update', $chapter);

+        $this->checkOwnablePermission('chapter-delete', $chapter);

 
         $entitySelection = $request->get('entity_selection', null);
         if ($entitySelection === null || $entitySelection === '') {
             return redirect($chapter->getUrl());
         }
 
 
         $entitySelection = $request->get('entity_selection', null);
         if ($entitySelection === null || $entitySelection === '') {
             return redirect($chapter->getUrl());
         }
 

-        $stringExploded = explode(':', $entitySelection);
-        $entityType = $stringExploded[0];
-        $entityId = intval($stringExploded[1]);
-
-        $parent = false;
-
-        if ($entityType == 'book') {
-            $parent = $this->entityRepo->getById('book', $entityId);
-        }
-
-        if ($parent === false || $parent === null) {
-            session()->flash('error', trans('errors.selected_book_not_found'));
+        try {
+            $newBook = $this->chapterRepo->move($chapter, $entitySelection);
+        } catch (MoveOperationException $exception) {
+            $this->showErrorNotification(trans('errors.selected_book_not_found'));

             return redirect()->back();
         }
 
             return redirect()->back();
         }
 

-        $this->entityRepo->changeBook('chapter', $parent->id, $chapter, true);
-        Activity::add($chapter, 'chapter_move', $chapter->book->id);
-        session()->flash('success', trans('entities.chapter_move_success', ['bookName' => $parent->name]));
-
+        $this->showSuccessNotification(trans('entities.chapter_move_success', ['bookName' => $newBook->name]));

         return redirect($chapter->getUrl());
     }
 
     /**
      * Show the Restrictions view.
         return redirect($chapter->getUrl());
     }
 
     /**
      * Show the Restrictions view.

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

      */
      */

-    public function showRestrict($bookSlug, $chapterSlug)
+    public function showPermissions(string $bookSlug, string $chapterSlug)

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('restrictions-manage', $chapter);
         $this->checkOwnablePermission('restrictions-manage', $chapter);

-        $roles = $this->userRepo->getRestrictableRoles();
-        return view('chapters/restrictions', [
+
+        return view('chapters.permissions', [

             'chapter' => $chapter,
             'chapter' => $chapter,

-            'roles' => $roles

         ]);
     }
 
     /**
      * Set the restrictions for this chapter.
         ]);
     }
 
     /**
      * Set the restrictions for this chapter.

-     * @param $bookSlug
-     * @param $chapterSlug
-     * @param Request $request
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     * @throws NotFoundException

      */
      */

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

     {
     {

-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+        $chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);

         $this->checkOwnablePermission('restrictions-manage', $chapter);
         $this->checkOwnablePermission('restrictions-manage', $chapter);

-        $this->entityRepo->updateEntityPermissionsFromRequest($request, $chapter);
-        session()->flash('success', trans('entities.chapters_permissions_success'));
-        return redirect($chapter->getUrl());
-    }

 
 

-    /**
-     * Exports a chapter to pdf .
-     * @param string $bookSlug
-     * @param string $chapterSlug
-     * @return \Illuminate\Http\Response
-     */
-    public function exportPdf($bookSlug, $chapterSlug)
-    {
-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
-        $pdfContent = $this->exportService->chapterToPdf($chapter);
-        return response()->make($pdfContent, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $chapterSlug . '.pdf'
-        ]);
-    }
+        $restricted = $request->get('restricted') === 'true';
+        $permissions = $request->filled('restrictions') ? collect($request->get('restrictions')) : null;
+        $this->chapterRepo->updatePermissions($chapter, $restricted, $permissions);

 
 

-    /**
-     * Export a chapter to a self-contained HTML file.
-     * @param string $bookSlug
-     * @param string $chapterSlug
-     * @return \Illuminate\Http\Response
-     */
-    public function exportHtml($bookSlug, $chapterSlug)
-    {
-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
-        $containedHtml = $this->exportService->chapterToContainedHtml($chapter);
-        return response()->make($containedHtml, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $chapterSlug . '.html'
-        ]);
-    }
-
-    /**
-     * Export a chapter to a simple plaintext .txt file.
-     * @param string $bookSlug
-     * @param string $chapterSlug
-     * @return \Illuminate\Http\Response
-     */
-    public function exportPlainText($bookSlug, $chapterSlug)
-    {
-        $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
-        $containedHtml = $this->exportService->chapterToPlainText($chapter);
-        return response()->make($containedHtml, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $chapterSlug . '.txt'
-        ]);
+        $this->showSuccessNotification(trans('entities.chapters_permissions_success'));
+        return redirect($chapter->getUrl());

     }
 }
     }
 }