1 <?php namespace BookStack\Http\Controllers;
4 use BookStack\Exceptions\NotFoundException;
5 use BookStack\Repos\UserRepo;
6 use BookStack\Services\ExportService;
7 use Illuminate\Http\Request;
8 use BookStack\Http\Requests;
9 use BookStack\Repos\BookRepo;
10 use BookStack\Repos\ChapterRepo;
11 use BookStack\Repos\PageRepo;
12 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
15 class PageController extends Controller
20 protected $chapterRepo;
21 protected $exportService;
25 * PageController constructor.
26 * @param PageRepo $pageRepo
27 * @param BookRepo $bookRepo
28 * @param ChapterRepo $chapterRepo
29 * @param ExportService $exportService
30 * @param UserRepo $userRepo
32 public function __construct(PageRepo $pageRepo, BookRepo $bookRepo, ChapterRepo $chapterRepo, ExportService $exportService, UserRepo $userRepo)
34 $this->pageRepo = $pageRepo;
35 $this->bookRepo = $bookRepo;
36 $this->chapterRepo = $chapterRepo;
37 $this->exportService = $exportService;
38 $this->userRepo = $userRepo;
39 parent::__construct();
43 * Show the form for creating a new page.
45 * @param bool $chapterSlug
47 * @internal param bool $pageSlug
49 public function create($bookSlug, $chapterSlug = false)
51 $book = $this->bookRepo->getBySlug($bookSlug);
52 $chapter = $chapterSlug ? $this->chapterRepo->getBySlug($chapterSlug, $book->id) : false;
53 $parent = $chapter ? $chapter : $book;
54 $this->checkOwnablePermission('page-create', $parent);
55 $this->setPageTitle('Create New Page');
56 return view('pages/create', ['book' => $book, 'chapter' => $chapter]);
60 * Store a newly created page in storage.
61 * @param Request $request
65 public function store(Request $request, $bookSlug)
67 $this->validate($request, [
68 'name' => 'required|string|max:255'
71 $input = $request->all();
72 $book = $this->bookRepo->getBySlug($bookSlug);
73 $chapterId = ($request->has('chapter') && $this->chapterRepo->idExists($request->get('chapter'))) ? $request->get('chapter') : null;
74 $parent = $chapterId !== null ? $this->chapterRepo->getById($chapterId) : $book;
75 $this->checkOwnablePermission('page-create', $parent);
76 $input['priority'] = $this->bookRepo->getNewPriority($book);
78 $page = $this->pageRepo->saveNew($input, $book, $chapterId);
80 Activity::add($page, 'page_create', $book->id);
81 return redirect($page->getUrl());
85 * Display the specified page.
86 * If the page is not found via the slug the
87 * revisions are searched for a match.
92 public function show($bookSlug, $pageSlug)
94 $book = $this->bookRepo->getBySlug($bookSlug);
97 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
98 } catch (NotFoundException $e) {
99 $page = $this->pageRepo->findPageUsingOldSlug($pageSlug, $bookSlug);
100 if ($page === null) abort(404);
101 return redirect($page->getUrl());
104 $sidebarTree = $this->bookRepo->getChildren($book);
106 $this->setPageTitle($page->getShortName());
107 return view('pages/show', ['page' => $page, 'book' => $book, 'current' => $page, 'sidebarTree' => $sidebarTree]);
111 * Show the form for editing the specified page.
116 public function edit($bookSlug, $pageSlug)
118 $book = $this->bookRepo->getBySlug($bookSlug);
119 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
120 $this->checkOwnablePermission('page-update', $page);
121 $this->setPageTitle('Editing Page ' . $page->getShortName());
122 return view('pages/edit', ['page' => $page, 'book' => $book, 'current' => $page]);
126 * Update the specified page in storage.
127 * @param Request $request
132 public function update(Request $request, $bookSlug, $pageSlug)
134 $this->validate($request, [
135 'name' => 'required|string|max:255'
137 $book = $this->bookRepo->getBySlug($bookSlug);
138 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
139 $this->checkOwnablePermission('page-update', $page);
140 $this->pageRepo->updatePage($page, $book->id, $request->all());
141 Activity::add($page, 'page_update', $book->id);
142 return redirect($page->getUrl());
146 * Redirect from a special link url which
147 * uses the page id rather than the name.
149 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
151 public function redirectFromLink($pageId)
153 $page = $this->pageRepo->getById($pageId);
154 return redirect($page->getUrl());
158 * Show the deletion page for the specified page.
161 * @return \Illuminate\View\View
163 public function showDelete($bookSlug, $pageSlug)
165 $book = $this->bookRepo->getBySlug($bookSlug);
166 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
167 $this->checkOwnablePermission('page-delete', $page);
168 $this->setPageTitle('Delete Page ' . $page->getShortName());
169 return view('pages/delete', ['book' => $book, 'page' => $page, 'current' => $page]);
173 * Remove the specified page from storage.
178 * @internal param int $id
180 public function destroy($bookSlug, $pageSlug)
182 $book = $this->bookRepo->getBySlug($bookSlug);
183 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
184 $this->checkOwnablePermission('page-delete', $page);
185 Activity::addMessage('page_delete', $book->id, $page->name);
186 $this->pageRepo->destroy($page);
187 return redirect($book->getUrl());
191 * Shows the last revisions for this page.
194 * @return \Illuminate\View\View
196 public function showRevisions($bookSlug, $pageSlug)
198 $book = $this->bookRepo->getBySlug($bookSlug);
199 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
200 $this->setPageTitle('Revisions For ' . $page->getShortName());
201 return view('pages/revisions', ['page' => $page, 'book' => $book, 'current' => $page]);
205 * Shows a preview of a single revision
209 * @return \Illuminate\View\View
211 public function showRevision($bookSlug, $pageSlug, $revisionId)
213 $book = $this->bookRepo->getBySlug($bookSlug);
214 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
215 $revision = $this->pageRepo->getRevisionById($revisionId);
216 $page->fill($revision->toArray());
217 $this->setPageTitle('Page Revision For ' . $page->getShortName());
218 return view('pages/revision', ['page' => $page, 'book' => $book]);
222 * Restores a page using the content of the specified revision.
226 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
228 public function restoreRevision($bookSlug, $pageSlug, $revisionId)
230 $book = $this->bookRepo->getBySlug($bookSlug);
231 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
232 $this->checkOwnablePermission('page-update', $page);
233 $page = $this->pageRepo->restoreRevision($page, $book, $revisionId);
234 Activity::add($page, 'page_restore', $book->id);
235 return redirect($page->getUrl());
239 * Exports a page to pdf format using barryvdh/laravel-dompdf wrapper.
240 * https://github.com/barryvdh/laravel-dompdf
243 * @return \Illuminate\Http\Response
245 public function exportPdf($bookSlug, $pageSlug)
247 $book = $this->bookRepo->getBySlug($bookSlug);
248 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
249 $pdfContent = $this->exportService->pageToPdf($page);
250 return response()->make($pdfContent, 200, [
251 'Content-Type' => 'application/octet-stream',
252 'Content-Disposition' => 'attachment; filename="'.$pageSlug.'.pdf'
257 * Export a page to a self-contained HTML file.
260 * @return \Illuminate\Http\Response
262 public function exportHtml($bookSlug, $pageSlug)
264 $book = $this->bookRepo->getBySlug($bookSlug);
265 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
266 $containedHtml = $this->exportService->pageToContainedHtml($page);
267 return response()->make($containedHtml, 200, [
268 'Content-Type' => 'application/octet-stream',
269 'Content-Disposition' => 'attachment; filename="'.$pageSlug.'.html'
274 * Export a page to a simple plaintext .txt file.
277 * @return \Illuminate\Http\Response
279 public function exportPlainText($bookSlug, $pageSlug)
281 $book = $this->bookRepo->getBySlug($bookSlug);
282 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
283 $containedHtml = $this->exportService->pageToPlainText($page);
284 return response()->make($containedHtml, 200, [
285 'Content-Type' => 'application/octet-stream',
286 'Content-Disposition' => 'attachment; filename="'.$pageSlug.'.txt'
291 * Show a listing of recently created pages
292 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
294 public function showRecentlyCreated()
296 $pages = $this->pageRepo->getRecentlyCreatedPaginated(20);
297 return view('pages/detailed-listing', [
298 'title' => 'Recently Created Pages',
304 * Show a listing of recently created pages
305 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
307 public function showRecentlyUpdated()
309 $pages = $this->pageRepo->getRecentlyUpdatedPaginated(20);
310 return view('pages/detailed-listing', [
311 'title' => 'Recently Updated Pages',
317 * Show the Restrictions view.
320 * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
322 public function showRestrict($bookSlug, $pageSlug)
324 $book = $this->bookRepo->getBySlug($bookSlug);
325 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
326 $this->checkOwnablePermission('restrictions-manage', $page);
327 $roles = $this->userRepo->getRestrictableRoles();
328 return view('pages/restrictions', [
335 * Set the restrictions for this page.
338 * @param Request $request
339 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
341 public function restrict($bookSlug, $pageSlug, Request $request)
343 $book = $this->bookRepo->getBySlug($bookSlug);
344 $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
345 $this->checkOwnablePermission('restrictions-manage', $page);
346 $this->pageRepo->updateRestrictionsFromRequest($request, $page);
347 session()->flash('success', 'Page Restrictions Updated');
348 return redirect($page->getUrl());