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', 20);
  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', '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);
 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         $sortedBooks = [];
 194         $updatedModels = collect();
 195         $sortMap = json_decode($request->get('sort-tree'));
 196         $defaultBookId = $book->id;
 197
 198         $permissionsList = [$book->id];
 199
 200         // Loop through contents of provided map and update entities accordingly
 201         foreach ($sortMap as $bookChild) {
 202             $priority = $bookChild->sort;
 203             $id = intval($bookChild->id);
 204             $isPage = $bookChild->type == 'page';
 205             $bookId = $defaultBookId;
 206             $targetBook = $this->entityRepo->getById('book', $bookChild->book);
 207
 208             // Check permission for target book
 209             if (!empty($targetBook)) {
 210                 $bookId = $targetBook->id;
 211                 if (!in_array($bookId, $permissionsList)) {
 212                     $this->checkOwnablePermission('book-update', $targetBook);
 213                     // cache the permission for future use.
 214                     $permissionsList[] = $bookId;
 215                 }
 216             }
 217
 218             $chapterId = ($isPage && $bookChild->parentChapter === false) ? 0 : intval($bookChild->parentChapter);
 219             $model = $this->entityRepo->getById($isPage?'page':'chapter', $id);
 220
 221             // Check permissions for the source book
 222             $sourceBook = $model->book;
 223             if (!in_array($sourceBook->id, $permissionsList)) {
 224                 $this->checkOwnablePermission('book-update', $sourceBook);
 225                 $permissionsList[] = $sourceBook->id;
 226             }
 227
 228             // Update models only if there's a change in parent chain or ordering.
 229             if ($model->priority !== $priority || $model->book_id !== $bookId || ($isPage && $model->chapter_id !== $chapterId)) {
 230                 $this->entityRepo->changeBook($isPage?'page':'chapter', $bookId, $model);
 231                 $model->priority = $priority;
 232                 if ($isPage) {
 233                     $model->chapter_id = $chapterId;
 234                 }
 235                 $model->save();
 236                 $updatedModels->push($model);
 237             }
 238
 239             // Store involved books to be sorted later
 240             if (!in_array($bookId, $sortedBooks)) {
 241                 $sortedBooks[] = $bookId;
 242             }
 243         }
 244
 245         // Add activity for books
 246         foreach ($sortedBooks as $bookId) {
 247             /** @var Book $updatedBook */
 248             $updatedBook = $this->entityRepo->getById('book', $bookId);
 249             $this->entityRepo->buildJointPermissionsForBook($updatedBook);
 250             Activity::add($updatedBook, 'book_sort', $updatedBook->id);
 251         }
 252
 253         return redirect($book->getUrl());
 254     }
 255
 256     /**
 257      * Remove the specified book from storage.
 258      * @param $bookSlug
 259      * @return Response
 260      */
 261     public function destroy($bookSlug)
 262     {
 263         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 264         $this->checkOwnablePermission('book-delete', $book);
 265         Activity::addMessage('book_delete', 0, $book->name);
 266         $this->entityRepo->destroyBook($book);
 267         return redirect('/books');
 268     }
 269
 270     /**
 271      * Show the Restrictions view.
 272      * @param $bookSlug
 273      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
 274      */
 275     public function showRestrict($bookSlug)
 276     {
 277         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 278         $this->checkOwnablePermission('restrictions-manage', $book);
 279         $roles = $this->userRepo->getRestrictableRoles();
 280         return view('books/restrictions', [
 281             'book' => $book,
 282             'roles' => $roles
 283         ]);
 284     }
 285
 286     /**
 287      * Set the restrictions for this book.
 288      * @param $bookSlug
 289      * @param $bookSlug
 290      * @param Request $request
 291      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 292      */
 293     public function restrict($bookSlug, Request $request)
 294     {
 295         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 296         $this->checkOwnablePermission('restrictions-manage', $book);
 297         $this->entityRepo->updateEntityPermissionsFromRequest($request, $book);
 298         session()->flash('success', trans('entities.books_permissions_updated'));
 299         return redirect($book->getUrl());
 300     }
 301
 302     /**
 303      * Export a book as a PDF file.
 304      * @param string $bookSlug
 305      * @return mixed
 306      */
 307     public function exportPdf($bookSlug)
 308     {
 309         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 310         $pdfContent = $this->exportService->bookToPdf($book);
 311         return response()->make($pdfContent, 200, [
 312             'Content-Type'        => 'application/octet-stream',
 313             'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.pdf'
 314         ]);
 315     }
 316
 317     /**
 318      * Export a book as a contained HTML file.
 319      * @param string $bookSlug
 320      * @return mixed
 321      */
 322     public function exportHtml($bookSlug)
 323     {
 324         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 325         $htmlContent = $this->exportService->bookToContainedHtml($book);
 326         return response()->make($htmlContent, 200, [
 327             'Content-Type'        => 'application/octet-stream',
 328             'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.html'
 329         ]);
 330     }
 331
 332     /**
 333      * Export a book as a plain text file.
 334      * @param $bookSlug
 335      * @return mixed
 336      */
 337     public function exportPlainText($bookSlug)
 338     {
 339         $book = $this->entityRepo->getBySlug('book', $bookSlug);
 340         $htmlContent = $this->exportService->bookToPlainText($book);
 341         return response()->make($htmlContent, 200, [
 342             'Content-Type'        => 'application/octet-stream',
 343             'Content-Disposition' => 'attachment; filename="' . $bookSlug . '.txt'
 344         ]);
 345     }
 346 }