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

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Exceptions\NotifyException;
   6 use BookStack\Facades\Activity;
   7 use BookStack\Interfaces\Loggable;
   8 use BookStack\Model;
   9 use BookStack\Util\WebSafeMimeSniffer;
  10 use Illuminate\Foundation\Bus\DispatchesJobs;
  11 use Illuminate\Foundation\Validation\ValidatesRequests;
  12 use Illuminate\Http\JsonResponse;
  13 use Illuminate\Http\Response;
  14 use Illuminate\Routing\Controller as BaseController;
  15 use Symfony\Component\HttpFoundation\StreamedResponse;
  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
  32      * the application is in demo mode.
  33      */
  34     protected function preventAccessInDemoMode()
  35     {
  36         if (config('app.env') === 'demo') {
  37             $this->showPermissionError();
  38         }
  39     }
  40
  41     /**
  42      * Adds the page title into the view.
  43      */
  44     public function setPageTitle(string $title)
  45     {
  46         view()->share('pageTitle', $title);
  47     }
  48
  49     /**
  50      * On a permission error redirect to home and display.
  51      * the error as a notification.
  52      *
  53      * @return never
  54      */
  55     protected function showPermissionError()
  56     {
  57         $message = request()->wantsJson() ? trans('errors.permissionJson') : trans('errors.permission');
  58
  59         throw new NotifyException($message, '/', 403);
  60     }
  61
  62     /**
  63      * Checks that the current user has the given permission otherwise throw an exception.
  64      */
  65     protected function checkPermission(string $permission): void
  66     {
  67         if (!user() || !user()->can($permission)) {
  68             $this->showPermissionError();
  69         }
  70     }
  71
  72     /**
  73      * Check the current user's permissions against an ownable item otherwise throw an exception.
  74      */
  75     protected function checkOwnablePermission(string $permission, Model $ownable): void
  76     {
  77         if (!userCan($permission, $ownable)) {
  78             $this->showPermissionError();
  79         }
  80     }
  81
  82     /**
  83      * Check if a user has a permission or bypass the permission
  84      * check if the given callback resolves true.
  85      */
  86     protected function checkPermissionOr(string $permission, callable $callback): void
  87     {
  88         if ($callback() !== true) {
  89             $this->checkPermission($permission);
  90         }
  91     }
  92
  93     /**
  94      * Check if the current user has a permission or bypass if the provided user
  95      * id matches the current user.
  96      */
  97     protected function checkPermissionOrCurrentUser(string $permission, int $userId): void
  98     {
  99         $this->checkPermissionOr($permission, function () use ($userId) {
 100             return $userId === user()->id;
 101         });
 102     }
 103
 104     /**
 105      * Send back a json error message.
 106      */
 107     protected function jsonError(string $messageText = '', int $statusCode = 500): JsonResponse
 108     {
 109         return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);
 110     }
 111
 112     /**
 113      * Create a response that forces a download in the browser.
 114      */
 115     protected function downloadResponse(string $content, string $fileName): Response
 116     {
 117         return response()->make($content, 200, [
 118             'Content-Type'           => 'application/octet-stream',
 119             'Content-Disposition'    => 'attachment; filename="' . str_replace('"', '', $fileName) . '"',
 120             'X-Content-Type-Options' => 'nosniff',
 121         ]);
 122     }
 123
 124     /**
 125      * Create a response that forces a download, from a given stream of content.
 126      */
 127     protected function streamedDownloadResponse($stream, string $fileName): StreamedResponse
 128     {
 129         return response()->stream(function () use ($stream) {
 130
 131             // End & flush the output buffer, if we're in one, otherwise we still use memory.
 132             // Output buffer may or may not exist depending on PHP `output_buffering` setting.
 133             // Ignore in testing since output buffers are used to gather a response.
 134             if (!empty(ob_get_status()) && !app()->runningUnitTests()) {
 135                 ob_end_clean();
 136             }
 137
 138             fpassthru($stream);
 139             fclose($stream);
 140         }, 200, [
 141             'Content-Type'           => 'application/octet-stream',
 142             'Content-Disposition'    => 'attachment; filename="' . str_replace('"', '', $fileName) . '"',
 143             'X-Content-Type-Options' => 'nosniff',
 144         ]);
 145     }
 146
 147     /**
 148      * Create a file download response that provides the file with a content-type
 149      * correct for the file, in a way so the browser can show the content in browser.
 150      */
 151     protected function inlineDownloadResponse(string $content, string $fileName): Response
 152     {
 153         $mime = (new WebSafeMimeSniffer())->sniff($content);
 154
 155         return response()->make($content, 200, [
 156             'Content-Type'           => $mime,
 157             'Content-Disposition'    => 'inline; filename="' . str_replace('"', '', $fileName) . '"',
 158             'X-Content-Type-Options' => 'nosniff',
 159         ]);
 160     }
 161
 162     /**
 163      * Create a file download response that provides the file with a content-type
 164      * correct for the file, in a way so the browser can show the content in browser,
 165      * for a given content stream.
 166      */
 167     protected function streamedInlineDownloadResponse($stream, string $fileName): StreamedResponse
 168     {
 169         $sniffContent = fread($stream, 1000);
 170         $mime = (new WebSafeMimeSniffer())->sniff($sniffContent);
 171
 172         return response()->stream(function () use ($sniffContent, $stream) {
 173             echo $sniffContent;
 174             fpassthru($stream);
 175             fclose($stream);
 176         }, 200, [
 177             'Content-Type'           => $mime,
 178             'Content-Disposition'    => 'inline; filename="' . str_replace('"', '', $fileName) . '"',
 179             'X-Content-Type-Options' => 'nosniff',
 180         ]);
 181     }
 182
 183     /**
 184      * Show a positive, successful notification to the user on next view load.
 185      */
 186     protected function showSuccessNotification(string $message): void
 187     {
 188         session()->flash('success', $message);
 189     }
 190
 191     /**
 192      * Show a warning notification to the user on next view load.
 193      */
 194     protected function showWarningNotification(string $message): void
 195     {
 196         session()->flash('warning', $message);
 197     }
 198
 199     /**
 200      * Show an error notification to the user on next view load.
 201      */
 202     protected function showErrorNotification(string $message): void
 203     {
 204         session()->flash('error', $message);
 205     }
 206
 207     /**
 208      * Log an activity in the system.
 209      *
 210      * @param string|Loggable $detail
 211      */
 212     protected function logActivity(string $type, $detail = ''): void
 213     {
 214         Activity::add($type, $detail);
 215     }
 216
 217     /**
 218      * Get the validation rules for image files.
 219      */
 220     protected function getImageValidationRules(): array
 221     {
 222         return ['image_extension', 'mimes:jpeg,png,gif,webp,svg', 'max:' . (config('app.upload_limit') * 1000)];
 223     }
 224 }