BookStack Code Mirror - bookstack/blob - app/Entities/Controllers/PageApiController.php

   1 <?php
   2
   3 namespace BookStack\Entities\Controllers;
   4
   5 use BookStack\Entities\Models\Book;
   6 use BookStack\Entities\Models\Chapter;
   7 use BookStack\Entities\Models\Page;
   8 use BookStack\Entities\Repos\PageRepo;
   9 use BookStack\Exceptions\PermissionsException;
  10 use BookStack\Http\ApiController;
  11 use Exception;
  12 use Illuminate\Http\Request;
  13
  14 class PageApiController extends ApiController
  15 {
  16     protected $rules = [
  17         'create' => [
  18             'book_id'    => ['required_without:chapter_id', 'integer'],
  19             'chapter_id' => ['required_without:book_id', 'integer'],
  20             'name'       => ['required', 'string', 'max:255'],
  21             'html'       => ['required_without:markdown', 'string'],
  22             'markdown'   => ['required_without:html', 'string'],
  23             'tags'       => ['array'],
  24         ],
  25         'update' => [
  26             'book_id'    => ['integer'],
  27             'chapter_id' => ['integer'],
  28             'name'       => ['string', 'min:1', 'max:255'],
  29             'html'       => ['string'],
  30             'markdown'   => ['string'],
  31             'tags'       => ['array'],
  32         ],
  33     ];
  34
  35     public function __construct(
  36         protected PageRepo $pageRepo
  37     ) {
  38     }
  39
  40     /**
  41      * Get a listing of pages visible to the user.
  42      */
  43     public function list()
  44     {
  45         $pages = Page::visible();
  46
  47         return $this->apiListingResponse($pages, [
  48             'id', 'book_id', 'chapter_id', 'name', 'slug', 'priority',
  49             'draft', 'template',
  50             'created_at', 'updated_at',
  51             'created_by', 'updated_by', 'owned_by',
  52         ]);
  53     }
  54
  55     /**
  56      * Create a new page in the system.
  57      *
  58      * The ID of a parent book or chapter is required to indicate
  59      * where this page should be located.
  60      *
  61      * Any HTML content provided should be kept to a single-block depth of plain HTML
  62      * elements to remain compatible with the BookStack front-end and editors.
  63      * Any images included via base64 data URIs will be extracted and saved as gallery
  64      * images against the page during upload.
  65      */
  66     public function create(Request $request)
  67     {
  68         $this->validate($request, $this->rules['create']);
  69
  70         if ($request->has('chapter_id')) {
  71             $parent = Chapter::visible()->findOrFail($request->get('chapter_id'));
  72         } else {
  73             $parent = Book::visible()->findOrFail($request->get('book_id'));
  74         }
  75         $this->checkOwnablePermission('page-create', $parent);
  76
  77         $draft = $this->pageRepo->getNewDraftPage($parent);
  78         $this->pageRepo->publishDraft($draft, $request->only(array_keys($this->rules['create'])));
  79
  80         return response()->json($draft->forJsonDisplay());
  81     }
  82
  83     /**
  84      * View the details of a single page.
  85      *
  86      * Pages will always have HTML content. They may have markdown content
  87      * if the markdown editor was used to last update the page.
  88      *
  89      * See the "Content Security" section of these docs for security considerations when using
  90      * the page content returned from this endpoint.
  91      */
  92     public function read(string $id)
  93     {
  94         $page = $this->pageRepo->getById($id, []);
  95
  96         return response()->json($page->forJsonDisplay());
  97     }
  98
  99     /**
 100      * Update the details of a single page.
 101      *
 102      * See the 'create' action for details on the provided HTML/Markdown.
 103      * Providing a 'book_id' or 'chapter_id' property will essentially move
 104      * the page into that parent element if you have permissions to do so.
 105      */
 106     public function update(Request $request, string $id)
 107     {
 108         $requestData = $this->validate($request, $this->rules['update']);
 109
 110         $page = $this->pageRepo->getById($id, []);
 111         $this->checkOwnablePermission('page-update', $page);
 112
 113         $parent = null;
 114         if ($request->has('chapter_id')) {
 115             $parent = Chapter::visible()->findOrFail($request->get('chapter_id'));
 116         } elseif ($request->has('book_id')) {
 117             $parent = Book::visible()->findOrFail($request->get('book_id'));
 118         }
 119
 120         if ($parent && !$parent->matches($page->getParent())) {
 121             $this->checkOwnablePermission('page-delete', $page);
 122
 123             try {
 124                 $this->pageRepo->move($page, $parent->getType() . ':' . $parent->id);
 125             } catch (Exception $exception) {
 126                 if ($exception instanceof  PermissionsException) {
 127                     $this->showPermissionError();
 128                 }
 129
 130                 return $this->jsonError(trans('errors.selected_book_chapter_not_found'));
 131             }
 132         }
 133
 134         $updatedPage = $this->pageRepo->update($page, $requestData);
 135
 136         return response()->json($updatedPage->forJsonDisplay());
 137     }
 138
 139     /**
 140      * Delete a page.
 141      * This will typically send the page to the recycle bin.
 142      */
 143     public function delete(string $id)
 144     {
 145         $page = $this->pageRepo->getById($id, []);
 146         $this->checkOwnablePermission('page-delete', $page);
 147
 148         $this->pageRepo->destroy($page);
 149
 150         return response('', 204);
 151     }
 152 }