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

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Facades\Activity;
   6 use BookStack\Interfaces\Loggable;
   7 use BookStack\Model;
   8 use BookStack\Util\WebSafeMimeSniffer;
   9 use Illuminate\Foundation\Bus\DispatchesJobs;
  10 use Illuminate\Foundation\Validation\ValidatesRequests;
  11 use Illuminate\Http\Exceptions\HttpResponseException;
  12 use Illuminate\Http\JsonResponse;
  13 use Illuminate\Http\Response;
  14 use Illuminate\Routing\Controller as BaseController;
  15
  16 abstract class Controller extends BaseController
  17 {
  18     use DispatchesJobs;
  19     use ValidatesRequests;
  20
  21     /**
  22      * Check if the current user is signed in.
  23      */
  24     protected function isSignedIn(): bool
  25     {
  26         return auth()->check();
  27     }
  28
  29     /**
  30      * Stops the application and shows a permission error if
  31      * the application is in demo mode.
  32      */
  33     protected function preventAccessInDemoMode()
  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)
  44     {
  45         view()->share('pageTitle', $title);
  46     }
  47
  48     /**
  49      * On a permission error redirect to home and display.
  50      * the error as a notification.
  51      *
  52      * @return never
  53      */
  54     protected function showPermissionError()
  55     {
  56         if (request()->wantsJson()) {
  57             $response = response()->json(['error' => trans('errors.permissionJson')], 403);
  58         } else {
  59             $response = redirect('/');
  60             $this->showErrorNotification(trans('errors.permission'));
  61         }
  62
  63         throw new HttpResponseException($response);
  64     }
  65
  66     /**
  67      * Checks that the current user has the given permission otherwise throw an exception.
  68      */
  69     protected function checkPermission(string $permission): void
  70     {
  71         if (!user() || !user()->can($permission)) {
  72             $this->showPermissionError();
  73         }
  74     }
  75
  76     /**
  77      * Check the current user's permissions against an ownable item otherwise throw an exception.
  78      */
  79     protected function checkOwnablePermission(string $permission, Model $ownable): void
  80     {
  81         if (!userCan($permission, $ownable)) {
  82             $this->showPermissionError();
  83         }
  84     }
  85
  86     /**
  87      * Check if a user has a permission or bypass the permission
  88      * check if the given callback resolves true.
  89      */
  90     protected function checkPermissionOr(string $permission, callable $callback): void
  91     {
  92         if ($callback() !== true) {
  93             $this->checkPermission($permission);
  94         }
  95     }
  96
  97     /**
  98      * Check if the current user has a permission or bypass if the provided user
  99      * id matches the current user.
 100      */
 101     protected function checkPermissionOrCurrentUser(string $permission, int $userId): void
 102     {
 103         $this->checkPermissionOr($permission, function () use ($userId) {
 104             return $userId === user()->id;
 105         });
 106     }
 107
 108     /**
 109      * Send back a json error message.
 110      */
 111     protected function jsonError(string $messageText = '', int $statusCode = 500): JsonResponse
 112     {
 113         return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);
 114     }
 115
 116     /**
 117      * Create a response that forces a download in the browser.
 118      */
 119     protected function downloadResponse(string $content, string $fileName): Response
 120     {
 121         return response()->make($content, 200, [
 122             'Content-Type'           => 'application/octet-stream',
 123             'Content-Disposition'    => 'attachment; filename="' . $fileName . '"',
 124             'X-Content-Type-Options' => 'nosniff',
 125         ]);
 126     }
 127
 128     /**
 129      * Create a file download response that provides the file with a content-type
 130      * correct for the file, in a way so the browser can show the content in browser.
 131      */
 132     protected function inlineDownloadResponse(string $content, string $fileName): Response
 133     {
 134         $mime = (new WebSafeMimeSniffer())->sniff($content);
 135
 136         return response()->make($content, 200, [
 137             'Content-Type'           => $mime,
 138             'Content-Disposition'    => 'inline; filename="' . $fileName . '"',
 139             'X-Content-Type-Options' => 'nosniff',
 140         ]);
 141     }
 142
 143     /**
 144      * Show a positive, successful notification to the user on next view load.
 145      */
 146     protected function showSuccessNotification(string $message): void
 147     {
 148         session()->flash('success', $message);
 149     }
 150
 151     /**
 152      * Show a warning notification to the user on next view load.
 153      */
 154     protected function showWarningNotification(string $message): void
 155     {
 156         session()->flash('warning', $message);
 157     }
 158
 159     /**
 160      * Show an error notification to the user on next view load.
 161      */
 162     protected function showErrorNotification(string $message): void
 163     {
 164         session()->flash('error', $message);
 165     }
 166
 167     /**
 168      * Log an activity in the system.
 169      *
 170      * @param string|Loggable $detail
 171      */
 172     protected function logActivity(string $type, $detail = ''): void
 173     {
 174         Activity::add($type, $detail);
 175     }
 176
 177     /**
 178      * Get the validation rules for image files.
 179      */
 180     protected function getImageValidationRules(): array
 181     {
 182         return ['image_extension', 'mimes:jpeg,png,gif,webp', 'max:' . (config('app.upload_limit') * 1000)];
 183     }
 184 }