Fleshed out and checked over theme system docs

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

diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php
index 4cc865d29237738dce5ee22d4d0b4d8bda65c9cb..034dfa524192013b4766880ebb878176ef95d496 100644 (file)
--- a/app/Http/Controllers/Controller.php
+++ b/app/Http/Controllers/Controller.php
@@ -2,69 +2,163 @@
 
 namespace BookStack\Http\Controllers;
 
 
 namespace BookStack\Http\Controllers;
 

-use HttpRequestException;
+use BookStack\Facades\Activity;
+use BookStack\Interfaces\Loggable;
+use BookStack\HasCreatorAndUpdater;
+use BookStack\Model;

 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Bus\DispatchesJobs;

-use Illuminate\Http\Exception\HttpResponseException;
-use Illuminate\Routing\Controller as BaseController;

 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Foundation\Validation\ValidatesRequests;

-use Illuminate\Support\Facades\Auth;
-use Illuminate\Support\Facades\Session;
-use BookStack\User;
+use Illuminate\Http\Exceptions\HttpResponseException;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Response;
+use Illuminate\Routing\Controller as BaseController;

 
 abstract class Controller extends BaseController
 {
     use DispatchesJobs, ValidatesRequests;
 
     /**
 
 abstract class Controller extends BaseController
 {
     use DispatchesJobs, ValidatesRequests;
 
     /**

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

      */
      */

-    protected $currentUser;
+    protected function isSignedIn(): bool
+    {
+        return auth()->check();
+    }
+

     /**
     /**

-     * @var bool
+     * Stops the application and shows a permission error if
+     * the application is in demo mode.

      */
      */

-    protected $signedIn;
+    protected function preventAccessInDemoMode()
+    {
+        if (config('app.env') === 'demo') {
+            $this->showPermissionError();
+        }
+    }

 
     /**
 
     /**

-     * Controller constructor.
+     * Adds the page title into the view.

      */
      */

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

     {
     {

-        // Get a user instance for the current user
-        $user = auth()->user();
-        if (!$user) $user = User::getDefault();
+        view()->share('pageTitle', $title);
+    }
+
+    /**
+     * On a permission error redirect to home and display.
+     * the error as a notification.
+     */
+    protected function showPermissionError()
+    {
+        if (request()->wantsJson()) {
+            $response = response()->json(['error' => trans('errors.permissionJson')], 403);
+        } else {
+            $response = redirect('/');
+            $this->showErrorNotification(trans('errors.permission'));
+        }
+
+        throw new HttpResponseException($response);
+    }

 
 

-        // Share variables with views
-        view()->share('signedIn', auth()->check());
-        view()->share('currentUser', $user);
+    /**
+     * Checks that the current user has the given permission otherwise throw an exception.
+     */
+    protected function checkPermission(string $permission): void
+    {
+        if (!user() || !user()->can($permission)) {
+            $this->showPermissionError();
+        }
+    }

 
 

-        // Share variables with controllers
-        $this->currentUser = $user;
-        $this->signedIn = auth()->check();
+    /**
+     * Check the current user's permissions against an ownable item otherwise throw an exception.
+     */
+    protected function checkOwnablePermission(string $permission, Model $ownable): void
+    {
+        if (!userCan($permission, $ownable)) {
+            $this->showPermissionError();
+        }

     }
 
     /**
     }
 
     /**

-     * Checks for a permission.
-     *
-     * @param $permissionName
-     * @return bool|\Illuminate\Http\RedirectResponse
+     * Check if a user has a permission or bypass the permission
+     * check if the given callback resolves true.

      */
      */

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

     {
     {

-        if (!$this->currentUser || !$this->currentUser->can($permissionName)) {
-            Session::flash('error', trans('errors.permission'));
-            throw new HttpResponseException(
-                redirect('/')
-            );
+        if ($callback() !== true) {
+            $this->checkPermission($permission);

         }
         }

+    }
+
+    /**
+     * 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.
+     */
+    protected function jsonError(string $messageText = "", int $statusCode = 500): JsonResponse
+    {
+        return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);
+    }
+
+    /**
+     * Create a response that forces a download in the browser.
+     */
+    protected function downloadResponse(string $content, string $fileName): Response
+    {
+        return response()->make($content, 200, [
+            'Content-Type'        => 'application/octet-stream',
+            'Content-Disposition' => 'attachment; filename="' . $fileName . '"'
+        ]);
+    }
+
+    /**
+     * Show a positive, successful notification to the user on next view load.
+     */
+    protected function showSuccessNotification(string $message): void
+    {
+        session()->flash('success', $message);
+    }

 
 

-        return true;
+    /**
+     * Show a warning notification to the user on next view load.
+     */
+    protected function showWarningNotification(string $message): void
+    {
+        session()->flash('warning', $message);

     }
 
     }
 

-    protected function checkPermissionOr($permissionName, $callback)
+    /**
+     * Show an error notification to the user on next view load.
+     */
+    protected function showErrorNotification(string $message): void

     {
     {

-        $callbackResult = $callback();
-        if ($callbackResult === false) $this->checkPermission($permissionName);
-        return true;
+        session()->flash('error', $message);

     }
 
     }
 

+    /**
+     * Log an activity in the system.
+     * @param string|Loggable
+     */
+    protected function logActivity(string $type, $detail = ''): void
+    {
+        Activity::add($type, $detail);
+    }
+
+    /**
+     * Get the validation rules for image files.
+     */
+    protected function getImageValidationRules(): string
+    {
+        return 'image_extension|mimes:jpeg,png,gif,webp';
+    }

 }
 }