Make building of search results work for multi-byte encoded characters

[bookstack] / app / Http / Controllers / PageController.php

diff --git a/app/Http/Controllers/PageController.php b/app/Http/Controllers/PageController.php
index 862ba3d7ffe3822169cd9b51ad6b060945f6db80..7d5d93ffa5ab7839c26f328ce6e1324fd28f68a5 100644 (file)
--- a/app/Http/Controllers/PageController.php
+++ b/app/Http/Controllers/PageController.php
@@ -1,24 +1,24 @@
-<?php namespace BookStack\Http\Controllers;
-
-use Activity;
-use BookStack\Actions\ActivityType;
-use BookStack\Entities\Managers\BookContents;
-use BookStack\Entities\Managers\PageContent;
-use BookStack\Entities\Managers\PageEditActivity;
-use BookStack\Entities\Page;
+<?php
+
+namespace BookStack\Http\Controllers;
+
+use BookStack\Actions\View;
+use BookStack\Entities\Models\Page;

 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Entities\Repos\PageRepo;

+use BookStack\Entities\Tools\BookContents;
+use BookStack\Entities\Tools\NextPreviousContentLocator;
+use BookStack\Entities\Tools\PageContent;
+use BookStack\Entities\Tools\PageEditActivity;
+use BookStack\Entities\Tools\PermissionsUpdater;

 use BookStack\Exceptions\NotFoundException;
 use BookStack\Exceptions\NotFoundException;

-use BookStack\Exceptions\NotifyException;

 use BookStack\Exceptions\PermissionsException;
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use Throwable;
 use BookStack\Exceptions\PermissionsException;
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use Throwable;

-use Views;

 
 class PageController extends Controller
 {
 
 class PageController extends Controller
 {

-

     protected $pageRepo;
 
     /**
     protected $pageRepo;
 
     /**


@@ -27,11 +27,11 @@ class PageController extends Controller
     public function __construct(PageRepo $pageRepo)
     {
         $this->pageRepo = $pageRepo;
     public function __construct(PageRepo $pageRepo)
     {
         $this->pageRepo = $pageRepo;

-        parent::__construct();

     }
 
     /**
      * Show the form for creating a new page.
     }
 
     /**
      * Show the form for creating a new page.

+     *

      * @throws Throwable
      */
     public function create(string $bookSlug, string $chapterSlug = null)
      * @throws Throwable
      */
     public function create(string $bookSlug, string $chapterSlug = null)


@@ -42,22 +42,25 @@ class PageController extends Controller
         // Redirect to draft edit screen if signed in
         if ($this->isSignedIn()) {
             $draft = $this->pageRepo->getNewDraftPage($parent);
         // Redirect to draft edit screen if signed in
         if ($this->isSignedIn()) {
             $draft = $this->pageRepo->getNewDraftPage($parent);

+

             return redirect($draft->getUrl());
         }
 
         // Otherwise show the edit view if they're a guest
         $this->setPageTitle(trans('entities.pages_new'));
             return redirect($draft->getUrl());
         }
 
         // Otherwise show the edit view if they're a guest
         $this->setPageTitle(trans('entities.pages_new'));

+

         return view('pages.guest-create', ['parent' => $parent]);
     }
 
     /**
      * Create a new page as a guest user.
         return view('pages.guest-create', ['parent' => $parent]);
     }
 
     /**
      * Create a new page as a guest user.

+     *

      * @throws ValidationException
      */
     public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)
     {
         $this->validate($request, [
      * @throws ValidationException
      */
     public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)
     {
         $this->validate($request, [

-            'name' => 'required|string|max:255'
+            'name' => ['required', 'string', 'max:255'],

         ]);
 
         $parent = $this->pageRepo->getParentFromSlugs($bookSlug, $chapterSlug);
         ]);
 
         $parent = $this->pageRepo->getParentFromSlugs($bookSlug, $chapterSlug);


@@ -66,7 +69,7 @@ class PageController extends Controller
         $page = $this->pageRepo->getNewDraftPage($parent);
         $this->pageRepo->publishDraft($page, [
             'name' => $request->get('name'),
         $page = $this->pageRepo->getNewDraftPage($parent);
         $this->pageRepo->publishDraft($page, [
             'name' => $request->get('name'),

-            'html' => ''
+            'html' => '',

         ]);
 
         return redirect($page->getUrl('/edit'));
         ]);
 
         return redirect($page->getUrl('/edit'));


@@ -74,6 +77,7 @@ class PageController extends Controller
 
     /**
      * Show form to continue editing a draft page.
 
     /**
      * Show form to continue editing a draft page.

+     *

      * @throws NotFoundException
      */
     public function editDraft(string $bookSlug, int $pageId)
      * @throws NotFoundException
      */
     public function editDraft(string $bookSlug, int $pageId)


@@ -86,23 +90,24 @@ class PageController extends Controller
         $templates = $this->pageRepo->getTemplates(10);
 
         return view('pages.edit', [
         $templates = $this->pageRepo->getTemplates(10);
 
         return view('pages.edit', [

-            'page' => $draft,
-            'book' => $draft->book,
-            'isDraft' => true,
+            'page'          => $draft,
+            'book'          => $draft->book,
+            'isDraft'       => true,

             'draftsEnabled' => $draftsEnabled,
             'draftsEnabled' => $draftsEnabled,

-            'templates' => $templates,
+            'templates'     => $templates,

         ]);
     }
 
     /**
      * Store a new page by changing a draft into a page.
         ]);
     }
 
     /**
      * Store a new page by changing a draft into a page.

+     *

      * @throws NotFoundException
      * @throws ValidationException
      */
     public function store(Request $request, string $bookSlug, int $pageId)
     {
         $this->validate($request, [
      * @throws NotFoundException
      * @throws ValidationException
      */
     public function store(Request $request, string $bookSlug, int $pageId)
     {
         $this->validate($request, [

-            'name' => 'required|string|max:255'
+            'name' => ['required', 'string', 'max:255'],

         ]);
         $draftPage = $this->pageRepo->getById($pageId);
         $this->checkOwnablePermission('page-create', $draftPage->getParent());
         ]);
         $draftPage = $this->pageRepo->getById($pageId);
         $this->checkOwnablePermission('page-create', $draftPage->getParent());


@@ -115,6 +120,7 @@ class PageController extends Controller
     /**
      * Display the specified page.
      * If the page is not found via the slug the revisions are searched for a match.
     /**
      * Display the specified page.
      * If the page is not found via the slug the revisions are searched for a match.

+     *

      * @throws NotFoundException
      */
     public function show(string $bookSlug, string $pageSlug)
      * @throws NotFoundException
      */
     public function show(string $bookSlug, string $pageSlug)


@@ -144,32 +150,40 @@ class PageController extends Controller
             $page->load(['comments.createdBy']);
         }
 
             $page->load(['comments.createdBy']);
         }
 

-        Views::add($page);
+        $nextPreviousLocator = new NextPreviousContentLocator($page, $sidebarTree);
+
+        View::incrementFor($page);

         $this->setPageTitle($page->getShortName());
         $this->setPageTitle($page->getShortName());

+

         return view('pages.show', [
         return view('pages.show', [

-            'page' => $page,
-            'book' => $page->book,
-            'current' => $page,
-            'sidebarTree' => $sidebarTree,
+            'page'            => $page,
+            'book'            => $page->book,
+            'current'         => $page,
+            'sidebarTree'     => $sidebarTree,

             'commentsEnabled' => $commentsEnabled,
             'commentsEnabled' => $commentsEnabled,

-            'pageNav' => $pageNav
+            'pageNav'         => $pageNav,
+            'next'            => $nextPreviousLocator->getNext(),
+            'previous'        => $nextPreviousLocator->getPrevious(),

         ]);
     }
 
     /**
      * Get page from an ajax request.
         ]);
     }
 
     /**
      * Get page from an ajax request.

+     *

      * @throws NotFoundException
      */
     public function getPageAjax(int $pageId)
     {
         $page = $this->pageRepo->getById($pageId);
         $page->setHidden(array_diff($page->getHidden(), ['html', 'markdown']));
      * @throws NotFoundException
      */
     public function getPageAjax(int $pageId)
     {
         $page = $this->pageRepo->getById($pageId);
         $page->setHidden(array_diff($page->getHidden(), ['html', 'markdown']));

-        $page->addHidden(['book']);
+        $page->makeHidden(['book']);
+

         return response()->json($page);
     }
 
     /**
      * Show the form for editing the specified page.
         return response()->json($page);
     }
 
     /**
      * Show the form for editing the specified page.

+     *

      * @throws NotFoundException
      */
     public function edit(string $bookSlug, string $pageSlug)
      * @throws NotFoundException
      */
     public function edit(string $bookSlug, string $pageSlug)


@@ -201,24 +215,26 @@ class PageController extends Controller
         $templates = $this->pageRepo->getTemplates(10);
         $draftsEnabled = $this->isSignedIn();
         $this->setPageTitle(trans('entities.pages_editing_named', ['pageName' => $page->getShortName()]));
         $templates = $this->pageRepo->getTemplates(10);
         $draftsEnabled = $this->isSignedIn();
         $this->setPageTitle(trans('entities.pages_editing_named', ['pageName' => $page->getShortName()]));

+

         return view('pages.edit', [
         return view('pages.edit', [

-            'page' => $page,
-            'book' => $page->book,
-            'current' => $page,
+            'page'          => $page,
+            'book'          => $page->book,
+            'current'       => $page,

             'draftsEnabled' => $draftsEnabled,
             'draftsEnabled' => $draftsEnabled,

-            'templates' => $templates,
+            'templates'     => $templates,

         ]);
     }
 
     /**
      * Update the specified page in storage.
         ]);
     }
 
     /**
      * Update the specified page in storage.

+     *

      * @throws ValidationException
      * @throws NotFoundException
      */
     public function update(Request $request, string $bookSlug, string $pageSlug)
     {
         $this->validate($request, [
      * @throws ValidationException
      * @throws NotFoundException
      */
     public function update(Request $request, string $bookSlug, string $pageSlug)
     {
         $this->validate($request, [

-            'name' => 'required|string|max:255'
+            'name' => ['required', 'string', 'max:255'],

         ]);
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-update', $page);
         ]);
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-update', $page);


@@ -230,6 +246,7 @@ class PageController extends Controller
 
     /**
      * Save a draft update as a revision.
 
     /**
      * Save a draft update as a revision.

+     *

      * @throws NotFoundException
      */
     public function saveDraft(Request $request, int $pageId)
      * @throws NotFoundException
      */
     public function saveDraft(Request $request, int $pageId)


@@ -242,62 +259,69 @@ class PageController extends Controller
         }
 
         $draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
         }
 
         $draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));

+        $warnings = (new PageEditActivity($page))->getWarningMessagesForDraft($draft);

 
 

-        $updateTime = $draft->updated_at->timestamp;

         return response()->json([
             'status'    => 'success',
             'message'   => trans('entities.pages_edit_draft_save_at'),
         return response()->json([
             'status'    => 'success',
             'message'   => trans('entities.pages_edit_draft_save_at'),

-            'timestamp' => $updateTime
+            'warning'   => implode("\n", $warnings),
+            'timestamp' => $draft->updated_at->timestamp,

         ]);
     }
 
     /**
      * Redirect from a special link url which uses the page id rather than the name.
         ]);
     }
 
     /**
      * Redirect from a special link url which uses the page id rather than the name.

+     *

      * @throws NotFoundException
      */
     public function redirectFromLink(int $pageId)
     {
         $page = $this->pageRepo->getById($pageId);
      * @throws NotFoundException
      */
     public function redirectFromLink(int $pageId)
     {
         $page = $this->pageRepo->getById($pageId);

+

         return redirect($page->getUrl());
     }
 
     /**
      * Show the deletion page for the specified page.
         return redirect($page->getUrl());
     }
 
     /**
      * Show the deletion page for the specified page.

+     *

      * @throws NotFoundException
      */
     public function showDelete(string $bookSlug, string $pageSlug)
     {
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-delete', $page);
      * @throws NotFoundException
      */
     public function showDelete(string $bookSlug, string $pageSlug)
     {
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-delete', $page);

-        $this->setPageTitle(trans('entities.pages_delete_named', ['pageName'=>$page->getShortName()]));
+        $this->setPageTitle(trans('entities.pages_delete_named', ['pageName' => $page->getShortName()]));
+

         return view('pages.delete', [
         return view('pages.delete', [

-            'book' => $page->book,
-            'page' => $page,
-            'current' => $page
+            'book'    => $page->book,
+            'page'    => $page,
+            'current' => $page,

         ]);
     }
 
     /**
      * Show the deletion page for the specified page.
         ]);
     }
 
     /**
      * Show the deletion page for the specified page.

+     *

      * @throws NotFoundException
      */
     public function showDeleteDraft(string $bookSlug, int $pageId)
     {
         $page = $this->pageRepo->getById($pageId);
         $this->checkOwnablePermission('page-update', $page);
      * @throws NotFoundException
      */
     public function showDeleteDraft(string $bookSlug, int $pageId)
     {
         $page = $this->pageRepo->getById($pageId);
         $this->checkOwnablePermission('page-update', $page);

-        $this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName'=>$page->getShortName()]));
+        $this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName' => $page->getShortName()]));
+

         return view('pages.delete', [
         return view('pages.delete', [

-            'book' => $page->book,
-            'page' => $page,
-            'current' => $page
+            'book'    => $page->book,
+            'page'    => $page,
+            'current' => $page,

         ]);
     }
 
     /**
      * Remove the specified page from storage.
         ]);
     }
 
     /**
      * Remove the specified page from storage.

+     *

      * @throws NotFoundException
      * @throws Throwable
      * @throws NotFoundException
      * @throws Throwable

-     * @throws NotifyException

      */
     public function destroy(string $bookSlug, string $pageSlug)
     {
      */
     public function destroy(string $bookSlug, string $pageSlug)
     {


@@ -312,8 +336,8 @@ class PageController extends Controller
 
     /**
      * Remove the specified draft page from storage.
 
     /**
      * Remove the specified draft page from storage.

+     *

      * @throws NotFoundException
      * @throws NotFoundException

-     * @throws NotifyException

      * @throws Throwable
      */
     public function destroyDraft(string $bookSlug, int $pageId)
      * @throws Throwable
      */
     public function destroyDraft(string $bookSlug, int $pageId)


@@ -330,6 +354,7 @@ class PageController extends Controller
         if ($chapter && userCan('view', $chapter)) {
             return redirect($chapter->getUrl());
         }
         if ($chapter && userCan('view', $chapter)) {
             return redirect($chapter->getUrl());
         }

+

         return redirect($book->getUrl());
     }
 
         return redirect($book->getUrl());
     }
 


@@ -342,14 +367,15 @@ class PageController extends Controller
             ->paginate(20)
             ->setPath(url('/pages/recently-updated'));
 
             ->paginate(20)
             ->setPath(url('/pages/recently-updated'));
 

-        return view('pages.detailed-listing', [
-            'title' => trans('entities.recently_updated_pages'),
-            'pages' => $pages
+        return view('common.detailed-listing-paginated', [
+            'title'    => trans('entities.recently_updated_pages'),
+            'entities' => $pages,

         ]);
     }
 
     /**
      * Show the view to choose a new parent to move a page into.
         ]);
     }
 
     /**
      * Show the view to choose a new parent to move a page into.

+     *

      * @throws NotFoundException
      */
     public function showMove(string $bookSlug, string $pageSlug)
      * @throws NotFoundException
      */
     public function showMove(string $bookSlug, string $pageSlug)


@@ -357,14 +383,16 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-update', $page);
         $this->checkOwnablePermission('page-delete', $page);
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-update', $page);
         $this->checkOwnablePermission('page-delete', $page);

+

         return view('pages.move', [
             'book' => $page->book,
         return view('pages.move', [
             'book' => $page->book,

-            'page' => $page
+            'page' => $page,

         ]);
     }
 
     /**
      * Does the action of moving the location of a page.
         ]);
     }
 
     /**
      * Does the action of moving the location of a page.

+     *

      * @throws NotFoundException
      * @throws Throwable
      */
      * @throws NotFoundException
      * @throws Throwable
      */


@@ -382,20 +410,23 @@ class PageController extends Controller
         try {
             $parent = $this->pageRepo->move($page, $entitySelection);
         } catch (Exception $exception) {
         try {
             $parent = $this->pageRepo->move($page, $entitySelection);
         } catch (Exception $exception) {

-            if ($exception instanceof  PermissionsException) {
+            if ($exception instanceof PermissionsException) {

                 $this->showPermissionError();
             }
 
             $this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
                 $this->showPermissionError();
             }
 
             $this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));

+

             return redirect()->back();
         }
 
         $this->showSuccessNotification(trans('entities.pages_move_success', ['parentName' => $parent->name]));
             return redirect()->back();
         }
 
         $this->showSuccessNotification(trans('entities.pages_move_success', ['parentName' => $parent->name]));

+

         return redirect($page->getUrl());
     }
 
     /**
      * Show the view to copy a page.
         return redirect($page->getUrl());
     }
 
     /**
      * Show the view to copy a page.

+     *

      * @throws NotFoundException
      */
     public function showCopy(string $bookSlug, string $pageSlug)
      * @throws NotFoundException
      */
     public function showCopy(string $bookSlug, string $pageSlug)


@@ -403,15 +434,16 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-view', $page);
         session()->flashInput(['name' => $page->name]);
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('page-view', $page);
         session()->flashInput(['name' => $page->name]);

+

         return view('pages.copy', [
             'book' => $page->book,
         return view('pages.copy', [
             'book' => $page->book,

-            'page' => $page
+            'page' => $page,

         ]);
     }
 
         ]);
     }
 

-

     /**
      * Create a copy of a page within the requested target destination.
     /**
      * Create a copy of a page within the requested target destination.

+     *

      * @throws NotFoundException
      * @throws Throwable
      */
      * @throws NotFoundException
      * @throws Throwable
      */


@@ -426,46 +458,50 @@ class PageController extends Controller
         try {
             $pageCopy = $this->pageRepo->copy($page, $entitySelection, $newName);
         } catch (Exception $exception) {
         try {
             $pageCopy = $this->pageRepo->copy($page, $entitySelection, $newName);
         } catch (Exception $exception) {

-            if ($exception instanceof  PermissionsException) {
+            if ($exception instanceof PermissionsException) {

                 $this->showPermissionError();
             }
 
             $this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
                 $this->showPermissionError();
             }
 
             $this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));

+

             return redirect()->back();
         }
 
         $this->showSuccessNotification(trans('entities.pages_copy_success'));
             return redirect()->back();
         }
 
         $this->showSuccessNotification(trans('entities.pages_copy_success'));

+

         return redirect($pageCopy->getUrl());
     }
 
     /**
      * Show the Permissions view.
         return redirect($pageCopy->getUrl());
     }
 
     /**
      * Show the Permissions view.

+     *

      * @throws NotFoundException
      */
     public function showPermissions(string $bookSlug, string $pageSlug)
     {
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('restrictions-manage', $page);
      * @throws NotFoundException
      */
     public function showPermissions(string $bookSlug, string $pageSlug)
     {
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('restrictions-manage', $page);

+

         return view('pages.permissions', [
         return view('pages.permissions', [

-            'page'  => $page,
+            'page' => $page,

         ]);
     }
 
     /**
      * Set the permissions for this page.
         ]);
     }
 
     /**
      * Set the permissions for this page.

+     *

      * @throws NotFoundException
      * @throws Throwable
      */
      * @throws NotFoundException
      * @throws Throwable
      */

-    public function permissions(Request $request, string $bookSlug, string $pageSlug)
+    public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $bookSlug, string $pageSlug)

     {
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('restrictions-manage', $page);
 
     {
         $page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
         $this->checkOwnablePermission('restrictions-manage', $page);
 

-        $restricted = $request->get('restricted') === 'true';
-        $permissions = $request->filled('restrictions') ? collect($request->get('restrictions')) : null;
-        $this->pageRepo->updatePermissions($page, $restricted, $permissions);
+        $permissionsUpdater->updateFromPermissionsForm($page, $request);

 
         $this->showSuccessNotification(trans('entities.pages_permissions_success'));
 
         $this->showSuccessNotification(trans('entities.pages_permissions_success'));

+

         return redirect($page->getUrl());
     }
 }
         return redirect($page->getUrl());
     }
 }