Skip to content

Update Entrust.php #996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Entrust.php #996

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 89 additions & 109 deletions src/Entrust/Entrust.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
<?php namespace Zizaco\Entrust;
<?php

namespace Zizaco\Entrust;

use Illuminate\Foundation\Application;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Routing\Router;

/**
* This class is the main entry point of entrust. Usually the interaction
Expand All @@ -7,84 +13,62 @@
* @license MIT
* @package Zizaco\Entrust
*/

class Entrust
{
/**
* Laravel application
*
* @var \Illuminate\Foundation\Application
*/
public $app;
protected Application $app;

/**
* Create a new confide instance.
*
* @param \Illuminate\Foundation\Application $app
*
* @return void
*/
public function __construct($app)
public function __construct(Application $app)
{
$this->app = $app;
}

/**
* Checks if the current user has a role by its name
*
* @param string $name Role name.
*
* @param string|array $role Role name or array of role names.
* @param bool $requireAll Whether all roles are required.
* @return bool
*/
public function hasRole($role, $requireAll = false)
public function hasRole($role, bool $requireAll = false): bool
{
if ($user = $this->user()) {
return $user->hasRole($role, $requireAll);
}

return false;
return $this->user()?->hasRole($role, $requireAll) ?? false;
}

/**
* Check if the current user has a permission by its name
*
* @param string $permission Permission string.
*
* @param string|array $permission Permission string or array of permissions.
* @param bool $requireAll Whether all permissions are required.
* @return bool
*/
public function can($permission, $requireAll = false)
public function can($permission, bool $requireAll = false): bool
{
if ($user = $this->user()) {
return $user->can($permission, $requireAll);
}

return false;
return $this->user()?->can($permission, $requireAll) ?? false;
}

/**
* Check if the current user has a role or permission by its name
*
* @param array|string $roles The role(s) needed.
* @param array|string $permissions The permission(s) needed.
* @param array $options The Options.
*
* @param array|string $roles The role(s) needed.
* @param array|string $permissions The permission(s) needed.
* @param array $options The Options.
* @return bool
*/
public function ability($roles, $permissions, $options = [])
public function ability($roles, $permissions, array $options = []): bool
{
if ($user = $this->user()) {
return $user->ability($roles, $permissions, $options);
}

return false;
return $this->user()?->ability($roles, $permissions, $options) ?? false;
}

/**
* Get the currently authenticated user or null.
*
* @return Illuminate\Auth\UserInterface|null
*/
public function user()
public function user(): ?Authenticatable
{
return $this->app->auth->user();
}
Expand All @@ -95,32 +79,19 @@ public function user()
* If the third parameter is null then abort with status code 403.
* Otherwise the $result is returned.
*
* @param string $route Route pattern. i.e: "admin/*"
* @param array|string $roles The role(s) needed
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all roles
*
* @return mixed
* @param string $route Route pattern. i.e: "admin/*"
* @param array|string $roles The role(s) needed
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all roles
*/
public function routeNeedsRole($route, $roles, $result = null, $requireAll = true)
public function routeNeedsRole(string $route, $roles, $result = null, bool $requireAll = true): void
{
$filterName = is_array($roles) ? implode('_', $roles) : $roles;
$filterName .= '_'.substr(md5($route), 0, 6);

$closure = function () use ($roles, $result, $requireAll) {
$hasRole = $this->hasRole($roles, $requireAll);

if (!$hasRole) {
return empty($result) ? $this->app->abort(403) : $result;
}
};

// Same as Route::filter, registers a new filter
$this->app->router->filter($filterName, $closure);

// Same as Route::when, assigns a route pattern to the
// previously created filter.
$this->app->router->when($route, $filterName);
$this->registerRouteFilter(
$route,
$roles,
fn () => $this->handleRouteAccessCheck($this->hasRole($roles, $requireAll), $result),
'role'
);
}

/**
Expand All @@ -129,32 +100,19 @@ public function routeNeedsRole($route, $roles, $result = null, $requireAll = tru
* If the third parameter is null then abort with status code 403.
* Otherwise the $result is returned.
*
* @param string $route Route pattern. i.e: "admin/*"
* @param string $route Route pattern. i.e: "admin/*"
* @param array|string $permissions The permission(s) needed
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all permissions
*
* @return mixed
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all permissions
*/
public function routeNeedsPermission($route, $permissions, $result = null, $requireAll = true)
public function routeNeedsPermission(string $route, $permissions, $result = null, bool $requireAll = true): void
{
$filterName = is_array($permissions) ? implode('_', $permissions) : $permissions;
$filterName .= '_'.substr(md5($route), 0, 6);

$closure = function () use ($permissions, $result, $requireAll) {
$hasPerm = $this->can($permissions, $requireAll);

if (!$hasPerm) {
return empty($result) ? $this->app->abort(403) : $result;
}
};

// Same as Route::filter, registers a new filter
$this->app->router->filter($filterName, $closure);

// Same as Route::when, assigns a route pattern to the
// previously created filter.
$this->app->router->when($route, $filterName);
$this->registerRouteFilter(
$route,
$permissions,
fn () => $this->handleRouteAccessCheck($this->can($permissions, $requireAll), $result),
'permission'
);
}

/**
Expand All @@ -163,40 +121,62 @@ public function routeNeedsPermission($route, $permissions, $result = null, $requ
* If the third parameter is null then abort with status code 403.
* Otherwise the $result is returned.
*
* @param string $route Route pattern. i.e: "admin/*"
* @param array|string $roles The role(s) needed
* @param string $route Route pattern. i.e: "admin/*"
* @param array|string $roles The role(s) needed
* @param array|string $permissions The permission(s) needed
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all roles and permissions
*
* @return void
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all roles and permissions
*/
public function routeNeedsRoleOrPermission($route, $roles, $permissions, $result = null, $requireAll = false)
{
$filterName = is_array($roles) ? implode('_', $roles) : $roles;
$filterName .= '_'.(is_array($permissions) ? implode('_', $permissions) : $permissions);
$filterName .= '_'.substr(md5($route), 0, 6);
public function routeNeedsRoleOrPermission(
string $route,
$roles,
$permissions,
$result = null,
bool $requireAll = false
): void {
$filterName = $this->generateFilterName([$roles, $permissions], $route);

$closure = function () use ($roles, $permissions, $result, $requireAll) {
$hasRole = $this->hasRole($roles, $requireAll);
$hasRole = $this->hasRole($roles, $requireAll);
$hasPerms = $this->can($permissions, $requireAll);

if ($requireAll) {
$hasRolePerm = $hasRole && $hasPerms;
} else {
$hasRolePerm = $hasRole || $hasPerms;
}
$hasAccess = $requireAll ? ($hasRole && $hasPerms) : ($hasRole || $hasPerms);

if (!$hasRolePerm) {
return empty($result) ? $this->app->abort(403) : $result;
}
$this->handleRouteAccessCheck($hasAccess, $result);
};

// Same as Route::filter, registers a new filter
$this->app->router->filter($filterName, $closure);
$this->app->router->when($route, $filterName);
}

// Same as Route::when, assigns a route pattern to the
// previously created filter.
/**
* Register a route filter with the router.
*/
protected function registerRouteFilter(string $route, $items, callable $closure, string $type): void
{
$filterName = $this->generateFilterName($items, $route, $type);

$this->app->router->filter($filterName, $closure);
$this->app->router->when($route, $filterName);
}

/**
* Generate a unique filter name based on items and route.
*/
protected function generateFilterName($items, string $route, string $type = ''): string
{
$parts = array_map(fn ($item) => is_array($item) ? implode('_', $item) : $item, (array) $items);

return ($type ? $type . '_' : '') . implode('_', $parts) . '_' . substr(md5($route), 0, 6);
}

/**
* Handle the route access check result.
*/
protected function handleRouteAccessCheck(bool $hasAccess, $result): void
{
if (!$hasAccess) {
empty($result) ? $this->app->abort(403) : $result;
}
}
}