BookStack Code Mirror - bookstack/blob - app/Http/Controllers/BookController.php

   1 <?php namespace BookStack\Http\Controllers;
   2
   3 use Activity;
   4 use BookStack\Book;
   5 use BookStack\Repos\EntityRepo;
   6 use BookStack\Repos\UserRepo;
   7 use BookStack\Services\ExportService;
   8 use Illuminate\Http\Request;
   9 use Illuminate\Http\Response;
  10 use Views;
  11
  12 class BookController extends Controller
  13 {
  14
  15     protected $entityRepo;
  16     protected $userRepo;
  17     protected $exportService;
  18
  19     /**
  20      * BookController constructor.
  21      * @param EntityRepo $entityRepo
  22      * @param UserRepo $userRepo
  23      * @param ExportService $exportService
  24      */
  25     public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
  26     {
  27         $this->entityRepo = $entityRepo;
  28         $this->userRepo = $userRepo;
  29         $this->exportService = $exportService;
  30         parent::__construct();
  31     }
  32
  33     /**
  34      * Display a listing of the book.
  35      * @return Response
  36      */
  37     public function index()
  38     {
  39         $books = $this->entityRepo->getAllPaginated('book', 18);
  40         $recents = $this->signedIn ? $this->entityRepo->getRecentlyViewed('book', 4, 0) : false;
  41         $popular = $this->entityRepo->getPopular('book', 4, 0);
  42         $new = $this->entityRepo->getRecentlyCreated('book', 4, 0);
  43         $booksViewType = setting()->getUser($this->currentUser, 'books_view_type', config('app.views.books', 'list'));
  44         $this->setPageTitle(trans('entities.books'));
  45         return view('books/index', [
  46             'books' => $books,
  47             'recents' => $recents,
  48             'popular' => $popular,
  49             'new' => $new,
  50             'booksViewType' => $booksViewType
  51         ]);
  52     }
  53
  54     /**
  55      * Show the form for creating a new book.
  56      * @return Response
  57      */
  58     public function create()
  59     {
  60         $this->checkPermission('book-create-all');
  61         $this->setPageTitle(trans('entities.books_create'));
  62         return view('books/create');
  63     }
  64
  65     /**
  66      * Store a newly created book in storage.
  67      *
  68      * @param  Request $request
  69      * @return Response
  70      */
  71     public function store(Request $request)
  72     {
  73         $this->checkPermission('book-create-all');
  74         $this->validate($request, [
  75             'name' => 'required|string|max:255',
  76             'description' => 'string|max:1000'
  77         ]);
  78         $book = $this->entityRepo->createFromInput('book', $request->all());
  79         Activity::add($book, 'book_create', $book->id);
  80         return redirect($book->getUrl());
  81     }
  82
  83     /**
  84      * Display the specified book.
  85      * @param $slug
  86      * @return Response
  87      */
  88     public function show($slug)
  89     {
  90         $book = $this->entityRepo->getBySlug('book', $slug);
  91         $this->checkOwnablePermission('book-view', $book);
  92         $bookChildren = $this->entityRepo->getBookChildren($book);
  93         Views::add($book);
  94         $this->setPageTitle($book->getShortName());
  95         return view('books/show', [
  96             'book' => $book,
  97             'current' => $book,
  98             'bookChildren' => $bookChildren,
  99             'activity' => Activity::entityActivity($book, 20, 0)
 100         ]);
 101     }
 102
 103     /**
 104      * Show the form for editing the specified book.
 105      * @param $slug
 106      * @return Response
 107      */
 108     public function edit($slug)
 109     {
 110         $book = $this->entityRepo->getBySlug('book', $slug);
 111         $this->checkOwnablePermission('book-update', $book);
 112         $this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()]));
 113         return view('books/edit', ['book' => $book, 'current' => $book]);
 114     }
 115
 116     /**
 117      * Update the specified book in storage.
 118      * @param  Request $request
 119      * @param          $slug
 120      * @return Response
 121      */
 122     public function update(Request $request, $slug)
 123     {
 124         $book = $this->entityRepo->getBySlug('book', $slug);
 125         $this->checkOwnablePermission('book-update', $book);
 126         $this->validate($request, [
 127             'name' => 'required|string|max:255',
 128             'description' => 'string|max:1000'
 129         ]);
 130          $book = $this->entityRepo->updateFromInput('book', $book, $request->all());
 131          Activity::add($book, 'book_update', $book->id);
 132          return redirect($book->getUrl());
 133     }
 134
 135     /**
 136      * Shows the page to confirm deletion
 137      * @param $bookSlug
 138      * @return \Illuminate\View\View
 139      */
 140     public function showDelete($bookSlug)
 141     {
 142         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 143         $this->checkOwnablePermission('book-delete', $book);
 144         $this->setPageTitle(trans('entities.books_delete_named', ['bookName'=>$book->getShortName()]));
 145         return view('books/delete', ['book' => $book, 'current' => $book]);
 146     }
 147
 148     /**
 149      * Shows the view which allows pages to be re-ordered and sorted.
 150      * @param string $bookSlug
 151      * @return \Illuminate\View\View
 152      */
 153     public function sort($bookSlug)
 154     {
 155         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 156         $this->checkOwnablePermission('book-update', $book);
 157         $bookChildren = $this->entityRepo->getBookChildren($book, true);
 158         $books = $this->entityRepo->getAll('book', false, 'update');
 159         $this->setPageTitle(trans('entities.books_sort_named', ['bookName'=>$book->getShortName()]));
 160         return view('books/sort', ['book' => $book, 'current' => $book, 'books' => $books, 'bookChildren' => $bookChildren]);
 161     }
 162
 163     /**
 164      * Shows the sort box for a single book.
 165      * Used via AJAX when loading in extra books to a sort.
 166      * @param $bookSlug
 167      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 168      */
 169     public function getSortItem($bookSlug)
 170     {
 171         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 172         $bookChildren = $this->entityRepo->getBookChildren($book);
 173         return view('books/sort-box', ['book' => $book, 'bookChildren' => $bookChildren]);
 174     }
 175
 176     /**
 177      * Saves an array of sort mapping to pages and chapters.
 178      * @param  string $bookSlug
 179      * @param Request $request
 180      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 181      */
 182     public function saveSort($bookSlug, Request $request)
 183     {
 184         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 185         $this->checkOwnablePermission('book-update', $book);
 186
 187         // Return if no map sent
 188         if (!$request->filled('sort-tree')) {
 189             return redirect($book->getUrl());
 190         }
 191
 192         // Sort pages and chapters
 193         $sortMap = collect(json_decode($request->get('sort-tree')));
 194         $bookIdsInvolved = collect([$book->id]);
 195
 196         // Load models into map
 197         $sortMap->each(function ($mapItem) use ($bookIdsInvolved) {
 198             $mapItem->type = ($mapItem->type === 'page' ? 'page' : 'chapter');
 199             $mapItem->model = $this->entityRepo->getById($mapItem->type, $mapItem->id);
 200             // Store source and target books
 201             $bookIdsInvolved->push(intval($mapItem->model->book_id));
 202             $bookIdsInvolved->push(intval($mapItem->book));
 203         });
 204
 205         // Get the books involved in the sort
 206         $bookIdsInvolved = $bookIdsInvolved->unique()->toArray();
 207         $booksInvolved = $this->entityRepo->book->newQuery()->whereIn('id', $bookIdsInvolved)->get();
 208         // Throw permission error if invalid ids or inaccessible books given.
 209         if (count($bookIdsInvolved) !== count($booksInvolved)) {
 210             $this->showPermissionError();
 211         }
 212         // Check permissions of involved books
 213         $booksInvolved->each(function (Book $book) {
 214              $this->checkOwnablePermission('book-update', $book);
 215         });
 216
 217         // Perform the sort
 218         $sortMap->each(function ($mapItem) {
 219             $model = $mapItem->model;
 220
 221             $priorityChanged = intval($model->priority) !== intval($mapItem->sort);
 222             $bookChanged = intval($model->book_id) !== intval($mapItem->book);
 223             $chapterChanged = ($mapItem->type === 'page') && intval($model->chapter_id) !== $mapItem->parentChapter;
 224
 225             if ($bookChanged) {
 226                 $this->entityRepo->changeBook($mapItem->type, $mapItem->book, $model);
 227             }
 228             if ($chapterChanged) {
 229                 $model->chapter_id = intval($mapItem->parentChapter);
 230                 $model->save();
 231             }
 232             if ($priorityChanged) {
 233                 $model->priority = intval($mapItem->sort);
 234                 $model->save();
 235             }
 236         });
 237
 238         // Rebuild permissions and add activity for involved books.
 239         $booksInvolved->each(function (Book $book) {
 240             $this->entityRepo->buildJointPermissionsForBook($book);
 241             Activity::add($book, 'book_sort', $book->id);
 242         });
 243
 244         return redirect($book->getUrl());
 245     }
 246
 247     /**
 248      * Remove the specified book from storage.
 249      * @param $bookSlug
 250      * @return Response
 251      */
 252     public function destroy($bookSlug)
 253     {
 254         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 255         $this->checkOwnablePermission('book-delete', $book);
 256         Activity::addMessage('book_delete', 0, $book->name);
 257         $this->entityRepo->destroyBook($book);
 258         return redirect('/books');
 259     }
 260
 261     /**
 262      * Show the Restrictions view.
 263      * @param $bookSlug
 264      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 265      */
 266     public function showRestrict($bookSlug)
 267     {
 268         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 269         $this->checkOwnablePermission('restrictions-manage', $book);
 270         $roles = $this->userRepo->getRestrictableRoles();
 271         return view('books/restrictions', [
 272             'book' => $book,
 273             'roles' => $roles
 274         ]);
 275     }
 276
 277     /**
 278      * Set the restrictions for this book.
 279      * @param $bookSlug
 280      * @param $bookSlug
 281      * @param Request $request
 282      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 283      */
 284     public function restrict($bookSlug, Request $request)
 285     {
 286         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 287         $this->checkOwnablePermission('restrictions-manage', $book);
 288         $this->entityRepo->updateEntityPermissionsFromRequest($request, $book);
 289         session()->flash('success', trans('entities.books_permissions_updated'));
 290         return redirect($book->getUrl());
 291     }
 292
 293     /**
 294      * Export a book as a PDF file.
 295      * @param string $bookSlug
 296      * @return mixed
 297      */
 298     public function exportPdf($bookSlug)
 299     {
 300         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 301         $pdfContent = $this->exportService->bookToPdf($book);
 302         return $this->downloadResponse($pdfContent, $bookSlug . '.pdf');
 303     }
 304
 305     /**
 306      * Export a book as a contained HTML file.
 307      * @param string $bookSlug
 308      * @return mixed
 309      */
 310     public function exportHtml($bookSlug)
 311     {
 312         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 313         $htmlContent = $this->exportService->bookToContainedHtml($book);
 314         return $this->downloadResponse($htmlContent, $bookSlug . '.html');
 315     }
 316
 317     /**
 318      * Export a book as a plain text file.
 319      * @param $bookSlug
 320      * @return mixed
 321      */
 322     public function exportPlainText($bookSlug)
 323     {
 324         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 325         $textContent = $this->exportService->bookToPlainText($book);
 326         return $this->downloadResponse($textContent, $bookSlug . '.txt');
 327     }
 328 }