BookStack Code Mirror - bookstack/blob - app/Http/Controller.php

   1 <?php
   2
   3 namespace BookStack\Http;
   4
   5 use BookStack\Activity\Models\Loggable;
   6 use BookStack\App\Model;
   7 use BookStack\Exceptions\NotifyException;
   8 use BookStack\Facades\Activity;
   9 use BookStack\Permissions\Permission;
  10 use Illuminate\Foundation\Bus\DispatchesJobs;
  11 use Illuminate\Foundation\Validation\ValidatesRequests;
  12 use Illuminate\Http\JsonResponse;
  13 use Illuminate\Http\RedirectResponse;
  14 use Illuminate\Http\Request;
  15 use Illuminate\Routing\Controller as BaseController;
  16
  17 abstract class Controller extends BaseController
  18 {
  19     use DispatchesJobs;
  20     use ValidatesRequests;
  21
  22     /**
  23      * Check if the current user is signed in.
  24      */
  25     protected function isSignedIn(): bool
  26     {
  27         return auth()->check();
  28     }
  29
  30     /**
  31      * Stops the application and shows a permission error if the application is in demo mode.
  32      */
  33     protected function preventAccessInDemoMode(): void
  34     {
  35         if (config('app.env') === 'demo') {
  36             $this->showPermissionError();
  37         }
  38     }
  39
  40     /**
  41      * Adds the page title into the view.
  42      */
  43     public function setPageTitle(string $title): void
  44     {
  45         view()->share('pageTitle', $title);
  46     }
  47
  48     /**
  49      * On a permission error redirect to home and display the error as a notification.
  50      *
  51      * @throws NotifyException
  52      */
  53     protected function showPermissionError(string $redirectLocation = '/'): never
  54     {
  55         $message = request()->wantsJson() ? trans('errors.permissionJson') : trans('errors.permission');
  56
  57         throw new NotifyException($message, $redirectLocation, 403);
  58     }
  59
  60     /**
  61      * Checks that the current user has the given permission otherwise throw an exception.
  62      */
  63     protected function checkPermission(string|Permission $permission): void
  64     {
  65         if (!user() || !user()->can($permission)) {
  66             $this->showPermissionError();
  67         }
  68     }
  69
  70     /**
  71      * Prevent access for guest users beyond this point.
  72      */
  73     protected function preventGuestAccess(): void
  74     {
  75         if (user()->isGuest()) {
  76             $this->showPermissionError();
  77         }
  78     }
  79
  80     /**
  81      * Check the current user's permissions against an ownable item otherwise throw an exception.
  82      */
  83     protected function checkOwnablePermission(string|Permission $permission, Model $ownable, string $redirectLocation = '/'): void
  84     {
  85         if (!userCan($permission, $ownable)) {
  86             $this->showPermissionError($redirectLocation);
  87         }
  88     }
  89
  90     /**
  91      * Check if a user has a permission or bypass the permission
  92      * check if the given callback resolves true.
  93      */
  94     protected function checkPermissionOr(string|Permission $permission, callable $callback): void
  95     {
  96         if ($callback() !== true) {
  97             $this->checkPermission($permission);
  98         }
  99     }
 100
 101     /**
 102      * Check if the current user has a permission or bypass if the provided user
 103      * id matches the current user.
 104      */
 105     protected function checkPermissionOrCurrentUser(string|Permission $permission, int $userId): void
 106     {
 107         $this->checkPermissionOr($permission, function () use ($userId) {
 108             return $userId === user()->id;
 109         });
 110     }
 111
 112     /**
 113      * Send back a JSON error message.
 114      */
 115     protected function jsonError(string $messageText = '', int $statusCode = 500): JsonResponse
 116     {
 117         return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);
 118     }
 119
 120     /**
 121      * Create and return a new download response factory using the current request.
 122      */
 123     protected function download(): DownloadResponseFactory
 124     {
 125         return new DownloadResponseFactory(request());
 126     }
 127
 128     /**
 129      * Show a positive, successful notification to the user on the next view load.
 130      */
 131     protected function showSuccessNotification(string $message): void
 132     {
 133         session()->flash('success', $message);
 134     }
 135
 136     /**
 137      * Show a warning notification to the user on the next view load.
 138      */
 139     protected function showWarningNotification(string $message): void
 140     {
 141         session()->flash('warning', $message);
 142     }
 143
 144     /**
 145      * Show an error notification to the user on the next view load.
 146      */
 147     protected function showErrorNotification(string $message): void
 148     {
 149         session()->flash('error', $message);
 150     }
 151
 152     /**
 153      * Log an activity in the system.
 154      */
 155     protected function logActivity(string $type, string|Loggable $detail = ''): void
 156     {
 157         Activity::add($type, $detail);
 158     }
 159
 160     /**
 161      * Get the validation rules for image files.
 162      */
 163     protected function getImageValidationRules(): array
 164     {
 165         return ['image_extension', 'mimes:jpeg,png,gif,webp,avif', 'max:' . (config('app.upload_limit') * 1000)];
 166     }
 167
 168     /**
 169      * Redirect to the URL provided in the request as a '_return' parameter.
 170      * Will check that the parameter leads to a URL under the root path of the system.
 171      */
 172     protected function redirectToRequest(Request $request): RedirectResponse
 173     {
 174         $basePath = url('/');
 175         $returnUrl = $request->input('_return') ?? $basePath;
 176
 177         if (!str_starts_with($returnUrl, $basePath)) {
 178             return redirect($basePath);
 179         }
 180
 181         return redirect($returnUrl);
 182     }
 183 }