Merge pull request #5917 from BookStackApp/copy_references

[bookstack] / app / Entities / Controllers / PageApiController.php

diff --git a/app/Entities/Controllers/PageApiController.php b/app/Entities/Controllers/PageApiController.php
index 8fcba3dc6a1563e54075c6b9057831e4a16a39d5..197018ccafec4495995d8d5b1bd0ebd256b045f4 100644 (file)
--- a/app/Entities/Controllers/PageApiController.php
+++ b/app/Entities/Controllers/PageApiController.php
@@ -2,11 +2,13 @@
 
 namespace BookStack\Entities\Controllers;
 
 
 namespace BookStack\Entities\Controllers;
 

+use BookStack\Activity\Tools\CommentTree;

 use BookStack\Entities\Queries\EntityQueries;
 use BookStack\Entities\Queries\PageQueries;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Exceptions\PermissionsException;
 use BookStack\Http\ApiController;
 use BookStack\Entities\Queries\EntityQueries;
 use BookStack\Entities\Queries\PageQueries;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Exceptions\PermissionsException;
 use BookStack\Http\ApiController;

+use BookStack\Permissions\Permission;

 use Exception;
 use Illuminate\Http\Request;
 
 use Exception;
 use Illuminate\Http\Request;
 


@@ -76,7 +78,7 @@ class PageApiController extends ApiController
         } else {
             $parent = $this->entityQueries->books->findVisibleByIdOrFail(intval($request->get('book_id')));
         }
         } else {
             $parent = $this->entityQueries->books->findVisibleByIdOrFail(intval($request->get('book_id')));
         }

-        $this->checkOwnablePermission('page-create', $parent);
+        $this->checkOwnablePermission(Permission::PageCreate, $parent);

 
         $draft = $this->pageRepo->getNewDraftPage($parent);
         $this->pageRepo->publishDraft($draft, $request->only(array_keys($this->rules['create'])));
 
         $draft = $this->pageRepo->getNewDraftPage($parent);
         $this->pageRepo->publishDraft($draft, $request->only(array_keys($this->rules['create'])));


@@ -87,21 +89,32 @@ class PageApiController extends ApiController
     /**
      * View the details of a single page.
      * Pages will always have HTML content. They may have markdown content
     /**
      * View the details of a single page.
      * Pages will always have HTML content. They may have markdown content

-     * if the markdown editor was used to last update the page.
+     * if the Markdown editor was used to last update the page.

      *
      *

-     * The 'html' property is the fully rendered & escaped HTML content that BookStack
+     * The 'html' property is the fully rendered and escaped HTML content that BookStack

      * would show on page view, with page includes handled.
      * The 'raw_html' property is the direct database stored HTML content, which would be
      * what BookStack shows on page edit.
      *
      * See the "Content Security" section of these docs for security considerations when using
      * the page content returned from this endpoint.
      * would show on page view, with page includes handled.
      * The 'raw_html' property is the direct database stored HTML content, which would be
      * what BookStack shows on page edit.
      *
      * See the "Content Security" section of these docs for security considerations when using
      * the page content returned from this endpoint.

+     *
+     * Comments for the page are provided in a tree-structure representing the hierarchy of top-level
+     * comments and replies, for both archived and active comments.

      */
     public function read(string $id)
     {
         $page = $this->queries->findVisibleByIdOrFail($id);
 
      */
     public function read(string $id)
     {
         $page = $this->queries->findVisibleByIdOrFail($id);
 

-        return response()->json($page->forJsonDisplay());
+        $page = $page->forJsonDisplay();
+        $commentTree = (new CommentTree($page));
+        $commentTree->loadVisibleHtml();
+        $page->setAttribute('comments', [
+            'active' => $commentTree->getActive(),
+            'archived' => $commentTree->getArchived(),
+        ]);
+
+        return response()->json($page);

     }
 
     /**
     }
 
     /**


@@ -116,7 +129,7 @@ class PageApiController extends ApiController
         $requestData = $this->validate($request, $this->rules['update']);
 
         $page = $this->queries->findVisibleByIdOrFail($id);
         $requestData = $this->validate($request, $this->rules['update']);
 
         $page = $this->queries->findVisibleByIdOrFail($id);

-        $this->checkOwnablePermission('page-update', $page);
+        $this->checkOwnablePermission(Permission::PageUpdate, $page);

 
         $parent = null;
         if ($request->has('chapter_id')) {
 
         $parent = null;
         if ($request->has('chapter_id')) {


@@ -126,7 +139,7 @@ class PageApiController extends ApiController
         }
 
         if ($parent && !$parent->matches($page->getParent())) {
         }
 
         if ($parent && !$parent->matches($page->getParent())) {

-            $this->checkOwnablePermission('page-delete', $page);
+            $this->checkOwnablePermission(Permission::PageDelete, $page);

 
             try {
                 $this->pageRepo->move($page, $parent->getType() . ':' . $parent->id);
 
             try {
                 $this->pageRepo->move($page, $parent->getType() . ':' . $parent->id);


@@ -151,7 +164,7 @@ class PageApiController extends ApiController
     public function delete(string $id)
     {
         $page = $this->queries->findVisibleByIdOrFail($id);
     public function delete(string $id)
     {
         $page = $this->queries->findVisibleByIdOrFail($id);

-        $this->checkOwnablePermission('page-delete', $page);
+        $this->checkOwnablePermission(Permission::PageDelete, $page);

 
         $this->pageRepo->destroy($page);
 
 
         $this->pageRepo->destroy($page);