Updated template test to be more stable

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

diff --git a/app/Http/Controllers/BookController.php b/app/Http/Controllers/BookController.php
index 700f7a06f6217d22c8a894bcc0420ed8e0328a2b..a990eed9a950e4ffb45365bae858a35b279e1d43 100644 (file)
--- a/app/Http/Controllers/BookController.php
+++ b/app/Http/Controllers/BookController.php
@@ -1,10 +1,12 @@
 <?php namespace BookStack\Http\Controllers;
 
 use Activity;
 <?php namespace BookStack\Http\Controllers;
 
 use Activity;

-use BookStack\Book;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use BookStack\Auth\UserRepo;
+use BookStack\Entities\Book;
+use BookStack\Entities\EntityContextManager;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\ExportService;
+use BookStack\Uploads\ImageRepo;

 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Views;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Views;


@@ -15,18 +17,29 @@ class BookController extends Controller
     protected $entityRepo;
     protected $userRepo;
     protected $exportService;
     protected $entityRepo;
     protected $userRepo;
     protected $exportService;

+    protected $entityContextManager;
+    protected $imageRepo;

 
     /**
      * BookController constructor.
      * @param EntityRepo $entityRepo
      * @param UserRepo $userRepo
      * @param ExportService $exportService
 
     /**
      * BookController constructor.
      * @param EntityRepo $entityRepo
      * @param UserRepo $userRepo
      * @param ExportService $exportService

+     * @param EntityContextManager $entityContextManager
+     * @param ImageRepo $imageRepo

      */
      */

-    public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
-    {
+    public function __construct(
+        EntityRepo $entityRepo,
+        UserRepo $userRepo,
+        ExportService $exportService,
+        EntityContextManager $entityContextManager,
+        ImageRepo $imageRepo
+    ) {

         $this->entityRepo = $entityRepo;
         $this->userRepo = $userRepo;
         $this->exportService = $exportService;
         $this->entityRepo = $entityRepo;
         $this->userRepo = $userRepo;
         $this->exportService = $exportService;

+        $this->entityContextManager = $entityContextManager;
+        $this->imageRepo = $imageRepo;

         parent::__construct();
     }
 
         parent::__construct();
     }
 


@@ -36,67 +49,117 @@ class BookController extends Controller
      */
     public function index()
     {
      */
     public function index()
     {

-        $books = $this->entityRepo->getAllPaginated('book', 20);
+        $view = setting()->getUser($this->currentUser, 'books_view_type', config('app.views.books'));
+        $sort = setting()->getUser($this->currentUser, 'books_sort', 'name');
+        $order = setting()->getUser($this->currentUser, 'books_sort_order', 'asc');
+        $sortOptions = [
+            'name' => trans('common.sort_name'),
+            'created_at' => trans('common.sort_created_at'),
+            'updated_at' => trans('common.sort_updated_at'),
+        ];
+
+        $books = $this->entityRepo->getAllPaginated('book', 18, $sort, $order);

         $recents = $this->signedIn ? $this->entityRepo->getRecentlyViewed('book', 4, 0) : false;
         $popular = $this->entityRepo->getPopular('book', 4, 0);
         $new = $this->entityRepo->getRecentlyCreated('book', 4, 0);
         $recents = $this->signedIn ? $this->entityRepo->getRecentlyViewed('book', 4, 0) : false;
         $popular = $this->entityRepo->getPopular('book', 4, 0);
         $new = $this->entityRepo->getRecentlyCreated('book', 4, 0);

-        $booksViewType = setting()->getUser($this->currentUser, 'books_view_type', 'list');
+
+        $this->entityContextManager->clearShelfContext();
+

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

-        return view('books/index', [
+        return view('books.index', [

             'books' => $books,
             'recents' => $recents,
             'popular' => $popular,
             'new' => $new,
             'books' => $books,
             'recents' => $recents,
             'popular' => $popular,
             'new' => $new,

-            'booksViewType' => $booksViewType
+            'view' => $view,
+            'sort' => $sort,
+            'order' => $order,
+            'sortOptions' => $sortOptions,

         ]);
     }
 
     /**
      * Show the form for creating a new book.
         ]);
     }
 
     /**
      * Show the form for creating a new book.

+     * @param string $shelfSlug

      * @return Response
      * @return Response

+     * @throws \BookStack\Exceptions\NotFoundException

      */
      */

-    public function create()
+    public function create(string $shelfSlug = null)

     {
     {

+        $bookshelf = null;
+        if ($shelfSlug !== null) {
+            $bookshelf = $this->entityRepo->getBySlug('bookshelf', $shelfSlug);
+            $this->checkOwnablePermission('bookshelf-update', $bookshelf);
+        }
+

         $this->checkPermission('book-create-all');
         $this->setPageTitle(trans('entities.books_create'));
         $this->checkPermission('book-create-all');
         $this->setPageTitle(trans('entities.books_create'));

-        return view('books/create');
+        return view('books.create', [
+            'bookshelf' => $bookshelf
+        ]);

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

-     * @param  Request $request
+     * @param Request $request
+     * @param string $shelfSlug

      * @return Response
      * @return Response

+     * @throws \BookStack\Exceptions\NotFoundException
+     * @throws \BookStack\Exceptions\ImageUploadException

      */
      */

-    public function store(Request $request)
+    public function store(Request $request, string $shelfSlug = null)

     {
         $this->checkPermission('book-create-all');
         $this->validate($request, [
             'name' => 'required|string|max:255',
     {
         $this->checkPermission('book-create-all');
         $this->validate($request, [
             'name' => 'required|string|max:255',

-            'description' => 'string|max:1000'
+            'description' => 'string|max:1000',
+            'image' => $this->imageRepo->getImageValidationRules(),

         ]);
         ]);

+
+        $bookshelf = null;
+        if ($shelfSlug !== null) {
+            $bookshelf = $this->entityRepo->getBySlug('bookshelf', $shelfSlug);
+            $this->checkOwnablePermission('bookshelf-update', $bookshelf);
+        }
+

         $book = $this->entityRepo->createFromInput('book', $request->all());
         $book = $this->entityRepo->createFromInput('book', $request->all());

+        $this->bookUpdateActions($book, $request);

         Activity::add($book, 'book_create', $book->id);
         Activity::add($book, 'book_create', $book->id);

+
+        if ($bookshelf) {
+            $this->entityRepo->appendBookToShelf($bookshelf, $book);
+            Activity::add($bookshelf, 'bookshelf_update');
+        }
+

         return redirect($book->getUrl());
     }
 
     /**
      * Display the specified book.
      * @param $slug
         return redirect($book->getUrl());
     }
 
     /**
      * Display the specified book.
      * @param $slug

+     * @param Request $request

      * @return Response
      * @return Response

+     * @throws \BookStack\Exceptions\NotFoundException

      */
      */

-    public function show($slug)
+    public function show($slug, Request $request)

     {
         $book = $this->entityRepo->getBySlug('book', $slug);
         $this->checkOwnablePermission('book-view', $book);
     {
         $book = $this->entityRepo->getBySlug('book', $slug);
         $this->checkOwnablePermission('book-view', $book);

+

         $bookChildren = $this->entityRepo->getBookChildren($book);
         $bookChildren = $this->entityRepo->getBookChildren($book);

+

         Views::add($book);
         Views::add($book);

+        if ($request->has('shelf')) {
+            $this->entityContextManager->setShelfContext(intval($request->get('shelf')));
+        }
+

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

-        return view('books/show', [
+        return view('books.show', [

             'book' => $book,
             'current' => $book,
             'bookChildren' => $bookChildren,
             'book' => $book,
             'current' => $book,
             'bookChildren' => $bookChildren,

-            'activity' => Activity::entityActivity($book, 20, 0)
+            'activity' => Activity::entityActivity($book, 20, 1)

         ]);
     }
 
         ]);
     }
 


@@ -109,26 +172,33 @@ class BookController extends Controller
     {
         $book = $this->entityRepo->getBySlug('book', $slug);
         $this->checkOwnablePermission('book-update', $book);
     {
         $book = $this->entityRepo->getBySlug('book', $slug);
         $this->checkOwnablePermission('book-update', $book);

-        $this->setPageTitle(trans('entities.books_edit_named',['bookName'=>$book->getShortName()]));
-        return view('books/edit', ['book' => $book, 'current' => $book]);
+        $this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()]));
+        return view('books.edit', ['book' => $book, 'current' => $book]);

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

-     * @param  Request $request
+     * @param Request $request

      * @param          $slug
      * @return Response
      * @param          $slug
      * @return Response

+     * @throws \BookStack\Exceptions\ImageUploadException
+     * @throws \BookStack\Exceptions\NotFoundException

      */
      */

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

     {
         $book = $this->entityRepo->getBySlug('book', $slug);
         $this->checkOwnablePermission('book-update', $book);
         $this->validate($request, [
             'name' => 'required|string|max:255',
     {
         $book = $this->entityRepo->getBySlug('book', $slug);
         $this->checkOwnablePermission('book-update', $book);
         $this->validate($request, [
             'name' => 'required|string|max:255',

-            'description' => 'string|max:1000'
+            'description' => 'string|max:1000',
+            'image' => $this->imageRepo->getImageValidationRules(),

         ]);
         ]);

+

          $book = $this->entityRepo->updateFromInput('book', $book, $request->all());
          $book = $this->entityRepo->updateFromInput('book', $book, $request->all());

+         $this->bookUpdateActions($book, $request);
+

          Activity::add($book, 'book_update', $book->id);
          Activity::add($book, 'book_update', $book->id);

+

          return redirect($book->getUrl());
     }
 
          return redirect($book->getUrl());
     }
 


@@ -142,22 +212,24 @@ class BookController extends Controller
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('book-delete', $book);
         $this->setPageTitle(trans('entities.books_delete_named', ['bookName'=>$book->getShortName()]));
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('book-delete', $book);
         $this->setPageTitle(trans('entities.books_delete_named', ['bookName'=>$book->getShortName()]));

-        return view('books/delete', ['book' => $book, 'current' => $book]);
+        return view('books.delete', ['book' => $book, 'current' => $book]);

     }
 
     /**
      * Shows the view which allows pages to be re-ordered and sorted.
      * @param string $bookSlug
      * @return \Illuminate\View\View
     }
 
     /**
      * Shows the view which allows pages to be re-ordered and sorted.
      * @param string $bookSlug
      * @return \Illuminate\View\View

+     * @throws \BookStack\Exceptions\NotFoundException

      */
     public function sort($bookSlug)
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('book-update', $book);
      */
     public function sort($bookSlug)
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('book-update', $book);

+

         $bookChildren = $this->entityRepo->getBookChildren($book, true);
         $bookChildren = $this->entityRepo->getBookChildren($book, true);

-        $books = $this->entityRepo->getAll('book', false, 'update');
+

         $this->setPageTitle(trans('entities.books_sort_named', ['bookName'=>$book->getShortName()]));
         $this->setPageTitle(trans('entities.books_sort_named', ['bookName'=>$book->getShortName()]));

-        return view('books/sort', ['book' => $book, 'current' => $book, 'books' => $books, 'bookChildren' => $bookChildren]);
+        return view('books.sort', ['book' => $book, 'current' => $book, 'bookChildren' => $bookChildren]);

     }
 
     /**
     }
 
     /**


@@ -170,7 +242,7 @@ class BookController extends Controller
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $bookChildren = $this->entityRepo->getBookChildren($book);
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $bookChildren = $this->entityRepo->getBookChildren($book);

-        return view('books/sort-box', ['book' => $book, 'bookChildren' => $bookChildren]);
+        return view('books.sort-box', ['book' => $book, 'bookChildren' => $bookChildren]);

     }
 
     /**
     }
 
     /**


@@ -190,63 +262,56 @@ class BookController extends Controller
         }
 
         // Sort pages and chapters
         }
 
         // Sort pages and chapters

-        $sortedBooks = [];
-        $updatedModels = collect();
-        $sortMap = json_decode($request->get('sort-tree'));
-        $defaultBookId = $book->id;
-
-        $permissionsList = [$book->id];
-
-        // Loop through contents of provided map and update entities accordingly
-        foreach ($sortMap as $bookChild) {
-            $priority = $bookChild->sort;
-            $id = intval($bookChild->id);
-            $isPage = $bookChild->type == 'page';
-            $bookId = $defaultBookId;
-            $targetBook = $this->entityRepo->getById('book', $bookChild->book);
-
-            // Check permission for target book
-            if (!empty($targetBook)) {
-                $bookId = $targetBook->id;
-                if (!in_array($bookId, $permissionsList)) {
-                    $this->checkOwnablePermission('book-update', $targetBook);
-                    // cache the permission for future use.
-                    $permissionsList[] = $bookId;
-                }
-            }
+        $sortMap = collect(json_decode($request->get('sort-tree')));
+        $bookIdsInvolved = collect([$book->id]);

 
 

-            $chapterId = ($isPage && $bookChild->parentChapter === false) ? 0 : intval($bookChild->parentChapter);
-            $model = $this->entityRepo->getById($isPage?'page':'chapter', $id);
+        // Load models into map
+        $sortMap->each(function ($mapItem) use ($bookIdsInvolved) {
+            $mapItem->type = ($mapItem->type === 'page' ? 'page' : 'chapter');
+            $mapItem->model = $this->entityRepo->getById($mapItem->type, $mapItem->id);
+            // Store source and target books
+            $bookIdsInvolved->push(intval($mapItem->model->book_id));
+            $bookIdsInvolved->push(intval($mapItem->book));
+        });

 
 

-            // Check permissions for the source book
-            $sourceBook = $model->book;
-            if (!in_array($sourceBook->id, $permissionsList)) {
-                $this->checkOwnablePermission('book-update', $sourceBook);
-                $permissionsList[] = $sourceBook->id;
-            }
+        // Get the books involved in the sort
+        $bookIdsInvolved = $bookIdsInvolved->unique()->toArray();
+        $booksInvolved = $this->entityRepo->getManyById('book', $bookIdsInvolved, false, true);
+        // Throw permission error if invalid ids or inaccessible books given.
+        if (count($bookIdsInvolved) !== count($booksInvolved)) {
+            $this->showPermissionError();
+        }
+        // Check permissions of involved books
+        $booksInvolved->each(function (Book $book) {
+             $this->checkOwnablePermission('book-update', $book);
+        });
+
+        // Perform the sort
+        $sortMap->each(function ($mapItem) {
+            $model = $mapItem->model;
+
+            $priorityChanged = intval($model->priority) !== intval($mapItem->sort);
+            $bookChanged = intval($model->book_id) !== intval($mapItem->book);
+            $chapterChanged = ($mapItem->type === 'page') && intval($model->chapter_id) !== $mapItem->parentChapter;

 
 

-            // Update models only if there's a change in parent chain or ordering.
-            if ($model->priority !== $priority || $model->book_id !== $bookId || ($isPage && $model->chapter_id !== $chapterId)) {
-                $this->entityRepo->changeBook($isPage?'page':'chapter', $bookId, $model);
-                $model->priority = $priority;
-                if ($isPage) $model->chapter_id = $chapterId;
+            if ($bookChanged) {
+                $this->entityRepo->changeBook($mapItem->type, $mapItem->book, $model);
+            }
+            if ($chapterChanged) {
+                $model->chapter_id = intval($mapItem->parentChapter);

                 $model->save();
                 $model->save();

-                $updatedModels->push($model);

             }
             }

-
-            // Store involved books to be sorted later
-            if (!in_array($bookId, $sortedBooks)) {
-                $sortedBooks[] = $bookId;
+            if ($priorityChanged) {
+                $model->priority = intval($mapItem->sort);
+                $model->save();

             }
             }

-        }
+        });

 
 

-        // Add activity for books
-        foreach ($sortedBooks as $bookId) {
-            /** @var Book $updatedBook */
-            $updatedBook = $this->entityRepo->getById('book', $bookId);
-            $this->entityRepo->buildJointPermissionsForBook($updatedBook);
-            Activity::add($updatedBook, 'book_sort', $updatedBook->id);
-        }
+        // Rebuild permissions and add activity for involved books.
+        $booksInvolved->each(function (Book $book) {
+            $this->entityRepo->buildJointPermissionsForBook($book);
+            Activity::add($book, 'book_sort', $book->id);
+        });

 
         return redirect($book->getUrl());
     }
 
         return redirect($book->getUrl());
     }


@@ -261,7 +326,12 @@ class BookController extends Controller
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('book-delete', $book);
         Activity::addMessage('book_delete', 0, $book->name);
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('book-delete', $book);
         Activity::addMessage('book_delete', 0, $book->name);

+
+        if ($book->cover) {
+            $this->imageRepo->destroyImage($book->cover);
+        }

         $this->entityRepo->destroyBook($book);
         $this->entityRepo->destroyBook($book);

+

         return redirect('/books');
     }
 
         return redirect('/books');
     }
 


@@ -270,12 +340,12 @@ class BookController extends Controller
      * @param $bookSlug
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
      * @param $bookSlug
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */

-    public function showRestrict($bookSlug)
+    public function showPermissions($bookSlug)

     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('restrictions-manage', $book);
         $roles = $this->userRepo->getRestrictableRoles();
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('restrictions-manage', $book);
         $roles = $this->userRepo->getRestrictableRoles();

-        return view('books/restrictions', [
+        return view('books.permissions', [

             'book' => $book,
             'roles' => $roles
         ]);
             'book' => $book,
             'roles' => $roles
         ]);


@@ -284,11 +354,12 @@ class BookController extends Controller
     /**
      * Set the restrictions for this book.
      * @param $bookSlug
     /**
      * Set the restrictions for this book.
      * @param $bookSlug

-     * @param $bookSlug

      * @param Request $request
      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
      * @param Request $request
      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

+     * @throws \BookStack\Exceptions\NotFoundException
+     * @throws \Throwable

      */
      */

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

     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('restrictions-manage', $book);
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $this->checkOwnablePermission('restrictions-manage', $book);


@@ -306,10 +377,7 @@ class BookController extends Controller
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $pdfContent = $this->exportService->bookToPdf($book);
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $pdfContent = $this->exportService->bookToPdf($book);

-        return response()->make($pdfContent, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.pdf'
-        ]);
+        return $this->downloadResponse($pdfContent, $bookSlug . '.pdf');

     }
 
     /**
     }
 
     /**


@@ -321,10 +389,7 @@ class BookController extends Controller
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $htmlContent = $this->exportService->bookToContainedHtml($book);
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
         $htmlContent = $this->exportService->bookToContainedHtml($book);

-        return response()->make($htmlContent, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.html'
-        ]);
+        return $this->downloadResponse($htmlContent, $bookSlug . '.html');

     }
 
     /**
     }
 
     /**


@@ -335,10 +400,32 @@ class BookController extends Controller
     public function exportPlainText($bookSlug)
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);
     public function exportPlainText($bookSlug)
     {
         $book = $this->entityRepo->getBySlug('book', $bookSlug);

-        $htmlContent = $this->exportService->bookToPlainText($book);
-        return response()->make($htmlContent, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.txt'
-        ]);
+        $textContent = $this->exportService->bookToPlainText($book);
+        return $this->downloadResponse($textContent, $bookSlug . '.txt');
+    }
+
+    /**
+     * Common actions to run on book update.
+     * Handles updating the cover image.
+     * @param Book $book
+     * @param Request $request
+     * @throws \BookStack\Exceptions\ImageUploadException
+     */
+    protected function bookUpdateActions(Book $book, Request $request)
+    {
+        // Update the cover image if in request
+        if ($request->has('image')) {
+            $this->imageRepo->destroyImage($book->cover);
+            $newImage = $request->file('image');
+            $image = $this->imageRepo->saveNew($newImage, 'cover_book', $book->id, 512, 512, true);
+            $book->image_id = $image->id;
+            $book->save();
+        }
+
+        if ($request->has('image_reset')) {
+            $this->imageRepo->destroyImage($book->cover);
+            $book->image_id = 0;
+            $book->save();
+        }

     }
 }
     }
 }