2015-07-12 21:01:42 +02:00
|
|
|
<?php
|
|
|
|
|
2023-05-18 21:53:39 +02:00
|
|
|
namespace BookStack\Http;
|
2015-07-12 21:01:42 +02:00
|
|
|
|
2023-05-17 18:56:55 +02:00
|
|
|
use BookStack\Activity\Models\Loggable;
|
|
|
|
use BookStack\App\Model;
|
2022-02-04 01:26:19 +01:00
|
|
|
use BookStack\Exceptions\NotifyException;
|
2020-11-19 00:38:44 +01:00
|
|
|
use BookStack\Facades\Activity;
|
2015-07-12 21:01:42 +02:00
|
|
|
use Illuminate\Foundation\Bus\DispatchesJobs;
|
2018-09-25 17:58:03 +02:00
|
|
|
use Illuminate\Foundation\Validation\ValidatesRequests;
|
2020-11-19 00:38:44 +01:00
|
|
|
use Illuminate\Http\JsonResponse;
|
2023-12-10 13:37:21 +01:00
|
|
|
use Illuminate\Http\RedirectResponse;
|
|
|
|
use Illuminate\Http\Request;
|
2015-07-12 21:01:42 +02:00
|
|
|
use Illuminate\Routing\Controller as BaseController;
|
|
|
|
|
|
|
|
abstract class Controller extends BaseController
|
|
|
|
{
|
2021-06-26 17:23:15 +02:00
|
|
|
use DispatchesJobs;
|
|
|
|
use ValidatesRequests;
|
2015-08-24 22:10:04 +02:00
|
|
|
|
|
|
|
/**
|
2019-09-20 01:18:28 +02:00
|
|
|
* Check if the current user is signed in.
|
2015-08-24 22:10:04 +02:00
|
|
|
*/
|
2019-09-20 01:18:28 +02:00
|
|
|
protected function isSignedIn(): bool
|
2015-08-24 22:10:04 +02:00
|
|
|
{
|
2019-09-20 01:18:28 +02:00
|
|
|
return auth()->check();
|
2015-08-29 16:03:42 +02:00
|
|
|
}
|
|
|
|
|
2015-12-31 18:57:34 +01:00
|
|
|
/**
|
|
|
|
* Stops the application and shows a permission error if
|
|
|
|
* the application is in demo mode.
|
|
|
|
*/
|
2019-09-19 16:12:10 +02:00
|
|
|
protected function preventAccessInDemoMode()
|
2015-12-31 18:57:34 +01:00
|
|
|
{
|
2018-01-28 17:58:52 +01:00
|
|
|
if (config('app.env') === 'demo') {
|
|
|
|
$this->showPermissionError();
|
|
|
|
}
|
2015-12-31 18:57:34 +01:00
|
|
|
}
|
|
|
|
|
2015-12-05 15:41:51 +01:00
|
|
|
/**
|
|
|
|
* Adds the page title into the view.
|
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
public function setPageTitle(string $title)
|
2015-12-05 15:41:51 +01:00
|
|
|
{
|
|
|
|
view()->share('pageTitle', $title);
|
|
|
|
}
|
|
|
|
|
2015-12-31 18:57:34 +01:00
|
|
|
/**
|
2016-02-27 20:24:42 +01:00
|
|
|
* On a permission error redirect to home and display.
|
2015-12-31 18:57:34 +01:00
|
|
|
* the error as a notification.
|
2022-01-07 14:04:49 +01:00
|
|
|
*
|
|
|
|
* @return never
|
2015-12-31 18:57:34 +01:00
|
|
|
*/
|
|
|
|
protected function showPermissionError()
|
|
|
|
{
|
2022-02-04 01:26:19 +01:00
|
|
|
$message = request()->wantsJson() ? trans('errors.permissionJson') : trans('errors.permission');
|
2022-02-08 16:29:58 +01:00
|
|
|
|
2022-02-04 01:26:19 +01:00
|
|
|
throw new NotifyException($message, '/', 403);
|
2015-12-31 18:57:34 +01:00
|
|
|
}
|
|
|
|
|
2015-08-29 16:03:42 +02:00
|
|
|
/**
|
2020-11-19 00:38:44 +01:00
|
|
|
* Checks that the current user has the given permission otherwise throw an exception.
|
2015-08-29 16:03:42 +02:00
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
protected function checkPermission(string $permission): void
|
2015-08-29 16:03:42 +02:00
|
|
|
{
|
2020-11-19 00:38:44 +01:00
|
|
|
if (!user() || !user()->can($permission)) {
|
2015-12-31 18:57:34 +01:00
|
|
|
$this->showPermissionError();
|
2015-08-29 16:03:42 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-08-16 17:02:00 +02:00
|
|
|
/**
|
|
|
|
* Prevent access for guest users beyond this point.
|
|
|
|
*/
|
|
|
|
protected function preventGuestAccess(): void
|
|
|
|
{
|
2023-09-16 14:18:35 +02:00
|
|
|
if (user()->isGuest()) {
|
2023-08-16 17:02:00 +02:00
|
|
|
$this->showPermissionError();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-27 20:24:42 +01:00
|
|
|
/**
|
2020-11-19 00:38:44 +01:00
|
|
|
* Check the current user's permissions against an ownable item otherwise throw an exception.
|
2016-02-27 20:24:42 +01:00
|
|
|
*/
|
2020-12-30 19:25:35 +01:00
|
|
|
protected function checkOwnablePermission(string $permission, Model $ownable): void
|
2016-02-27 20:24:42 +01:00
|
|
|
{
|
2020-11-19 00:38:44 +01:00
|
|
|
if (!userCan($permission, $ownable)) {
|
|
|
|
$this->showPermissionError();
|
2018-01-28 17:58:52 +01:00
|
|
|
}
|
2016-02-27 20:24:42 +01:00
|
|
|
}
|
|
|
|
|
2015-12-31 18:57:34 +01:00
|
|
|
/**
|
2020-11-19 00:38:44 +01:00
|
|
|
* Check if a user has a permission or bypass the permission
|
|
|
|
* check if the given callback resolves true.
|
2015-12-31 18:57:34 +01:00
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
protected function checkPermissionOr(string $permission, callable $callback): void
|
2015-08-29 16:03:42 +02:00
|
|
|
{
|
2020-11-19 00:38:44 +01:00
|
|
|
if ($callback() !== true) {
|
|
|
|
$this->checkPermission($permission);
|
2018-01-28 17:58:52 +01:00
|
|
|
}
|
2015-08-24 22:10:04 +02:00
|
|
|
}
|
|
|
|
|
2018-12-07 19:33:32 +01:00
|
|
|
/**
|
|
|
|
* Check if the current user has a permission or bypass if the provided user
|
|
|
|
* id matches the current user.
|
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
protected function checkPermissionOrCurrentUser(string $permission, int $userId): void
|
2018-12-07 19:33:32 +01:00
|
|
|
{
|
2020-11-19 00:38:44 +01:00
|
|
|
$this->checkPermissionOr($permission, function () use ($userId) {
|
2019-09-20 01:18:28 +02:00
|
|
|
return $userId === user()->id;
|
2018-12-07 19:33:32 +01:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2016-05-07 15:29:43 +02:00
|
|
|
/**
|
|
|
|
* Send back a json error message.
|
|
|
|
*/
|
2021-06-26 17:23:15 +02:00
|
|
|
protected function jsonError(string $messageText = '', int $statusCode = 500): JsonResponse
|
2016-05-07 15:29:43 +02:00
|
|
|
{
|
2019-10-05 13:55:01 +02:00
|
|
|
return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);
|
2016-05-07 15:29:43 +02:00
|
|
|
}
|
|
|
|
|
2018-09-22 12:34:09 +02:00
|
|
|
/**
|
2022-06-09 00:50:42 +02:00
|
|
|
* Create and return a new download response factory using the current request.
|
2018-09-22 12:34:09 +02:00
|
|
|
*/
|
2022-06-09 00:50:42 +02:00
|
|
|
protected function download(): DownloadResponseFactory
|
2018-09-22 12:34:09 +02:00
|
|
|
{
|
2022-06-09 00:50:42 +02:00
|
|
|
return new DownloadResponseFactory(request());
|
2022-04-02 19:07:43 +02:00
|
|
|
}
|
|
|
|
|
2019-09-19 16:12:10 +02:00
|
|
|
/**
|
|
|
|
* Show a positive, successful notification to the user on next view load.
|
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
protected function showSuccessNotification(string $message): void
|
2019-09-19 16:12:10 +02:00
|
|
|
{
|
|
|
|
session()->flash('success', $message);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show a warning notification to the user on next view load.
|
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
protected function showWarningNotification(string $message): void
|
2019-09-19 16:12:10 +02:00
|
|
|
{
|
|
|
|
session()->flash('warning', $message);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show an error notification to the user on next view load.
|
|
|
|
*/
|
2020-11-19 00:38:44 +01:00
|
|
|
protected function showErrorNotification(string $message): void
|
2019-09-19 16:12:10 +02:00
|
|
|
{
|
|
|
|
session()->flash('error', $message);
|
|
|
|
}
|
2019-10-05 13:55:01 +02:00
|
|
|
|
2020-11-19 00:38:44 +01:00
|
|
|
/**
|
|
|
|
* Log an activity in the system.
|
2021-06-26 17:23:15 +02:00
|
|
|
*
|
2021-11-14 23:03:22 +01:00
|
|
|
* @param string|Loggable $detail
|
2020-11-19 00:38:44 +01:00
|
|
|
*/
|
|
|
|
protected function logActivity(string $type, $detail = ''): void
|
|
|
|
{
|
|
|
|
Activity::add($type, $detail);
|
|
|
|
}
|
|
|
|
|
2019-10-05 13:55:01 +02:00
|
|
|
/**
|
|
|
|
* Get the validation rules for image files.
|
|
|
|
*/
|
2021-11-05 01:26:55 +01:00
|
|
|
protected function getImageValidationRules(): array
|
2019-10-05 13:55:01 +02:00
|
|
|
{
|
2021-11-14 23:03:22 +01:00
|
|
|
return ['image_extension', 'mimes:jpeg,png,gif,webp', 'max:' . (config('app.upload_limit') * 1000)];
|
2019-10-05 13:55:01 +02:00
|
|
|
}
|
2023-12-10 13:37:21 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Redirect to the URL provided in the request as a '_return' parameter.
|
|
|
|
* Will check that the parameter leads to a URL under the root path of the system.
|
|
|
|
*/
|
|
|
|
protected function redirectToRequest(Request $request): RedirectResponse
|
|
|
|
{
|
|
|
|
$basePath = url('/');
|
|
|
|
$returnUrl = $request->input('_return') ?? $basePath;
|
|
|
|
|
|
|
|
if (!str_starts_with($returnUrl, $basePath)) {
|
|
|
|
return redirect($basePath);
|
|
|
|
}
|
|
|
|
|
|
|
|
return redirect($returnUrl);
|
|
|
|
}
|
2015-07-12 21:01:42 +02:00
|
|
|
}
|