BookStack/app/Http/Controllers/Controller.php

185 lines
4.8 KiB
PHP
Raw Normal View History

2015-07-12 15:01:42 -04:00
<?php
namespace BookStack\Http\Controllers;
2015-07-12 15:01:42 -04:00
use BookStack\Ownable;
2015-07-12 15:01:42 -04:00
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
2017-01-25 14:35:40 -05:00
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Http\Request;
2015-07-12 15:01:42 -04:00
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Validation\ValidationException;
2015-07-12 15:01:42 -04:00
abstract class Controller extends BaseController
{
use DispatchesJobs, ValidatesRequests;
2015-08-24 16:10:04 -04:00
2015-08-29 10:03:42 -04:00
/**
* Controller constructor.
2015-08-29 10:03:42 -04:00
*/
public function __construct()
{
//
}
2015-08-29 10:03:42 -04:00
2015-08-24 16:10:04 -04:00
/**
* Check if the current user is signed in.
2015-08-24 16:10:04 -04:00
*/
protected function isSignedIn(): bool
2015-08-24 16:10:04 -04:00
{
return auth()->check();
2015-08-29 10:03:42 -04:00
}
/**
* Stops the application and shows a permission error if
* the application is in demo mode.
*/
protected function preventAccessInDemoMode()
{
if (config('app.env') === 'demo') {
$this->showPermissionError();
}
}
/**
* Adds the page title into the view.
* @param $title
*/
public function setPageTitle($title)
{
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);
}
2015-08-29 10:03:42 -04:00
/**
* Checks for a permission.
* @param string $permissionName
2015-08-29 10:03:42 -04:00
* @return bool|\Illuminate\Http\RedirectResponse
*/
protected function checkPermission($permissionName)
{
if (!user() || !user()->can($permissionName)) {
$this->showPermissionError();
2015-08-29 10:03:42 -04:00
}
return true;
}
/**
* Check the current user's permissions against an ownable item.
* @param $permission
* @param Ownable $ownable
* @return bool
*/
protected function checkOwnablePermission($permission, Ownable $ownable)
{
if (userCan($permission, $ownable)) {
return true;
}
return $this->showPermissionError();
}
/**
* Check if a user has a permission or bypass if the callback is true.
* @param $permissionName
* @param $callback
* @return bool
*/
2015-08-29 10:03:42 -04:00
protected function checkPermissionOr($permissionName, $callback)
{
$callbackResult = $callback();
if ($callbackResult === false) {
$this->checkPermission($permissionName);
}
2015-08-29 10:03:42 -04:00
return true;
2015-08-24 16:10:04 -04:00
}
/**
* Check if the current user has a permission or bypass if the provided user
* id matches the current user.
* @param string $permissionName
* @param int $userId
* @return bool
*/
protected function checkPermissionOrCurrentUser(string $permissionName, int $userId)
{
2019-05-05 09:54:37 -04:00
return $this->checkPermissionOr($permissionName, function () use ($userId) {
return $userId === user()->id;
});
}
/**
* Send back a json error message.
* @param string $messageText
* @param int $statusCode
* @return mixed
*/
protected function jsonError($messageText = "", $statusCode = 500)
{
return response()->json(['message' => $messageText, 'status' => 'error'], $statusCode);
}
/**
* Create a response that forces a download in the browser.
* @param string $content
* @param string $fileName
* @return \Illuminate\Http\Response
*/
protected function downloadResponse(string $content, string $fileName)
{
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.
* @param string $message
*/
protected function showSuccessNotification(string $message)
{
session()->flash('success', $message);
}
/**
* Show a warning notification to the user on next view load.
* @param string $message
*/
protected function showWarningNotification(string $message)
{
session()->flash('warning', $message);
}
/**
* Show an error notification to the user on next view load.
* @param string $message
*/
protected function showErrorNotification(string $message)
{
session()->flash('error', $message);
}
/**
* Get the validation rules for image files.
*/
protected function getImageValidationRules(): string
{
return 'image_extension|no_double_extension|mimes:jpeg,png,gif,webp';
}
2015-07-12 15:01:42 -04:00
}