Updated js dev docs with latest component changes

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

diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php
index 80f567eaa80279e8f49599f9703f5ab29e6276c3..f6dc1dbca43cb9b46ce60ef9d48105f16a04c575 100644 (file)
--- a/app/Http/Controllers/Controller.php
+++ b/app/Http/Controllers/Controller.php
@@ -2,54 +2,34 @@
 
 namespace BookStack\Http\Controllers;
 
 
 namespace BookStack\Http\Controllers;
 

-use BookStack\Auth\User;
-use BookStack\Ownable;
+use BookStack\Exceptions\NotifyException;
+use BookStack\Facades\Activity;
+use BookStack\Http\Responses\DownloadResponseFactory;
+use BookStack\Interfaces\Loggable;
+use BookStack\Model;

 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;

-use Illuminate\Http\Exceptions\HttpResponseException;
-use Illuminate\Http\Request;
+use Illuminate\Http\JsonResponse;

 use Illuminate\Routing\Controller as BaseController;
 
 abstract class Controller extends BaseController
 {
 use Illuminate\Routing\Controller as BaseController;
 
 abstract class Controller extends BaseController
 {

-    use DispatchesJobs, ValidatesRequests;
+    use DispatchesJobs;
+    use ValidatesRequests;

 
     /**
 
     /**

-     * @var User static
+     * Check if the current user is signed in.

      */
      */

-    protected $currentUser;
-    /**
-     * @var bool
-     */
-    protected $signedIn;
-
-    /**
-     * Controller constructor.
-     */
-    public function __construct()
+    protected function isSignedIn(): bool

     {
     {

-        $this->middleware(function ($request, $next) {
-
-            // Get a user instance for the current user
-            $user = user();
-
-            // Share variables with controllers
-            $this->currentUser = $user;
-            $this->signedIn = auth()->check();
-
-            // Share variables with views
-            view()->share('signedIn', $this->signedIn);
-            view()->share('currentUser', $user);
-
-            return $next($request);
-        });
+        return auth()->check();

     }
 
     /**
      * Stops the application and shows a permission error if
      * the application is in demo mode.
      */
     }
 
     /**
      * Stops the application and shows a permission error if
      * the application is in demo mode.
      */

-    protected function preventAccessForDemoUsers()
+    protected function preventAccessInDemoMode()

     {
         if (config('app.env') === 'demo') {
             $this->showPermissionError();
     {
         if (config('app.env') === 'demo') {
             $this->showPermissionError();


@@ -58,9 +38,8 @@ abstract class Controller extends BaseController
 
     /**
      * Adds the page title into the view.
 
     /**
      * Adds the page title into the view.

-     * @param $title

      */
      */

-    public function setPageTitle($title)
+    public function setPageTitle(string $title)

     {
         view()->share('pageTitle', $title);
     }
     {
         view()->share('pageTitle', $title);
     }


@@ -68,100 +47,113 @@ abstract class Controller extends BaseController
     /**
      * On a permission error redirect to home and display.
      * the error as a notification.
     /**
      * On a permission error redirect to home and display.
      * the error as a notification.

+     *
+     * @return never

      */
     protected function showPermissionError()
     {
      */
     protected function showPermissionError()
     {

-        if (request()->wantsJson()) {
-            $response = response()->json(['error' => trans('errors.permissionJson')], 403);
-        } else {
-            $response = redirect('/');
-            session()->flash('error', trans('errors.permission'));
-        }
+        $message = request()->wantsJson() ? trans('errors.permissionJson') : trans('errors.permission');

 
 

-        throw new HttpResponseException($response);
+        throw new NotifyException($message, '/', 403);

     }
 
     /**
     }
 
     /**

-     * Checks for a permission.
-     * @param string $permissionName
-     * @return bool|\Illuminate\Http\RedirectResponse
+     * Checks that the current user has the given permission otherwise throw an exception.

      */
      */

-    protected function checkPermission($permissionName)
+    protected function checkPermission(string $permission): void

     {
     {

-        if (!user() || !user()->can($permissionName)) {
+        if (!user() || !user()->can($permission)) {

             $this->showPermissionError();
         }
             $this->showPermissionError();
         }

-        return true;

     }
 
     /**
     }
 
     /**

-     * Check the current user's permissions against an ownable item.
-     * @param $permission
-     * @param Ownable $ownable
-     * @return bool
+     * Check the current user's permissions against an ownable item otherwise throw an exception.

      */
      */

-    protected function checkOwnablePermission($permission, Ownable $ownable)
+    protected function checkOwnablePermission(string $permission, Model $ownable): void

     {
     {

-        if (userCan($permission, $ownable)) {
-            return true;
+        if (!userCan($permission, $ownable)) {
+            $this->showPermissionError();

         }
         }

-        return $this->showPermissionError();

     }
 
     /**
     }
 
     /**

-     * Check if a user has a permission or bypass if the callback is true.
-     * @param $permissionName
-     * @param $callback
-     * @return bool
+     * Check if a user has a permission or bypass the permission
+     * check if the given callback resolves true.

      */
      */

-    protected function checkPermissionOr($permissionName, $callback)
+    protected function checkPermissionOr(string $permission, callable $callback): void

     {
     {

-        $callbackResult = $callback();
-        if ($callbackResult === false) {
-            $this->checkPermission($permissionName);
+        if ($callback() !== true) {
+            $this->checkPermission($permission);

         }
         }

-        return true;
+    }
+
+    /**
+     * Check if the current user has a permission or bypass if the provided user
+     * id matches the current user.
+     */
+    protected function checkPermissionOrCurrentUser(string $permission, int $userId): void
+    {
+        $this->checkPermissionOr($permission, function () use ($userId) {
+            return $userId === user()->id;
+        });

     }
 
     /**
      * Send back a json error message.
     }
 
     /**
      * Send back a json error message.

-     * @param string $messageText
-     * @param int $statusCode
-     * @return mixed

      */
      */

-    protected function jsonError($messageText = "", $statusCode = 500)
+    protected function jsonError(string $messageText = '', int $statusCode = 500): JsonResponse

     {
     {

-        return response()->json(['message' => $messageText], $statusCode);
+        return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);

     }
 
     /**
     }
 
     /**

-     * Create the response for when a request fails validation.
-     * @param  \Illuminate\Http\Request  $request
-     * @param  array  $errors
-     * @return \Symfony\Component\HttpFoundation\Response
+     * Create and return a new download response factory using the current request.

      */
      */

-    protected function buildFailedValidationResponse(Request $request, array $errors)
+    protected function download(): DownloadResponseFactory

     {
     {

-        if ($request->expectsJson()) {
-            return response()->json(['validation' => $errors], 422);
-        }
+        return new DownloadResponseFactory(request());
+    }
+
+    /**
+     * Show a positive, successful notification to the user on next view load.
+     */
+    protected function showSuccessNotification(string $message): void
+    {
+        session()->flash('success', $message);
+    }

 
 

-        return redirect()->to($this->getRedirectUrl())
-            ->withInput($request->input())
-            ->withErrors($errors, $this->errorBag());
+    /**
+     * Show a warning notification to the user on next view load.
+     */
+    protected function showWarningNotification(string $message): void
+    {
+        session()->flash('warning', $message);
+    }
+
+    /**
+     * Show an error notification to the user on next view load.
+     */
+    protected function showErrorNotification(string $message): void
+    {
+        session()->flash('error', $message);
+    }
+
+    /**
+     * Log an activity in the system.
+     *
+     * @param string|Loggable $detail
+     */
+    protected function logActivity(string $type, $detail = ''): void
+    {
+        Activity::add($type, $detail);

     }
 
     /**
     }
 
     /**

-     * Create a response that forces a download in the browser.
-     * @param string $content
-     * @param string $fileName
-     * @return \Illuminate\Http\Response
+     * Get the validation rules for image files.

      */
      */

-    protected function downloadResponse(string $content, string $fileName)
+    protected function getImageValidationRules(): array

     {
     {

-        return response()->make($content, 200, [
-            'Content-Type'        => 'application/octet-stream',
-            'Content-Disposition' => 'attachment; filename="' . $fileName . '"'
-        ]);
+        return ['image_extension', 'mimes:jpeg,png,gif,webp', 'max:' . (config('app.upload_limit') * 1000)];

     }
 }
     }
 }