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

   1 <?php
   2
   3 namespace BookStack\Http\Controllers\Api;
   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 Exception;
  11 use Illuminate\Http\Request;
  12
  13 class PageApiController extends ApiController
  14 {
  15     protected $pageRepo;
  16
  17     protected $rules = [
  18         'create' => [
  19             'book_id' => 'required_without:chapter_id|integer',
  20             'chapter_id' => 'required_without:book_id|integer',
  21             'name' => 'required|string|max:255',
  22             'html' => 'required_without:markdown|string',
  23             'markdown' => 'required_without:html|string',
  24             'tags' => 'array',
  25         ],
  26         'update' => [
  27             'book_id' => 'required|integer',
  28             'chapter_id' => 'required|integer',
  29             'name' => 'string|min:1|max:255',
  30             'html' => 'string',
  31             'markdown' => 'string',
  32             'tags' => 'array',
  33         ],
  34     ];
  35
  36     public function __construct(PageRepo $pageRepo)
  37     {
  38         $this->pageRepo = $pageRepo;
  39     }
  40
  41     /**
  42      * Get a listing of pages visible to the user.
  43      */
  44     public function list()
  45     {
  46         $pages = Page::visible();
  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     public function read(string $id)
  90     {
  91         $page = $this->pageRepo->getById($id, []);
  92         return response()->json($page->forJsonDisplay());
  93     }
  94
  95     /**
  96      * Update the details of a single page.
  97      *
  98      * See the 'create' action for details on the provided HTML/Markdown.
  99      * Providing a 'book_id' or 'chapter_id' property will essentially move
 100      * the page into that parent element if you have permissions to do so.
 101      */
 102     public function update(Request $request, string $id)
 103     {
 104         $page = $this->pageRepo->getById($id, []);
 105         $this->checkOwnablePermission('page-update', $page);
 106
 107         $parent = null;
 108         if ($request->has('chapter_id')) {
 109             $parent = Chapter::visible()->findOrFail($request->get('chapter_id'));
 110         } else if ($request->has('book_id')) {
 111             $parent = Book::visible()->findOrFail($request->get('book_id'));
 112         }
 113
 114         if ($parent && !$parent->matches($page->getParent())) {
 115             $this->checkOwnablePermission('page-delete', $page);
 116             try {
 117                 $this->pageRepo->move($page, $parent->getType() . ':' . $parent->id);
 118             } catch (Exception $exception) {
 119                 if ($exception instanceof  PermissionsException) {
 120                     $this->showPermissionError();
 121                 }
 122
 123                 return $this->jsonError(trans('errors.selected_book_chapter_not_found'));
 124             }
 125         }
 126
 127         $updatedPage = $this->pageRepo->update($page, $request->all());
 128         return response()->json($updatedPage->forJsonDisplay());
 129     }
 130
 131     /**
 132      * Delete a page.
 133      * This will typically send the page to the recycle bin.
 134      */
 135     public function delete(string $id)
 136     {
 137         $page = $this->pageRepo->getById($id, []);
 138         $this->checkOwnablePermission('page-delete', $page);
 139
 140         $this->pageRepo->destroy($page);
 141         return response('', 204);
 142     }
 143 }