Skip to content

Refactoring Entrust.php #424

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
imanghafoori1 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Refactoring Entrust.php #424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
275d1bd
Refactoring Entrust.php
imanghafoori1 Nov 24, 2015
b5981fb
entrust refactoring
imanghafoori1 Nov 26, 2015
8d47122
some refactoring
imanghafoori1 Nov 27, 2015
7bba935
removing redundant else conditionals
imanghafoori1 Nov 28, 2015
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
196 changes: 125 additions & 71 deletions src/Entrust/Entrust.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,12 @@ class Entrust
*
* @var \Illuminate\Foundation\Application
*/
public $app;
public $app;
private $filterNameStr;
private $route;
private $privilegesArr;
private $result;
private $requireAll = false;

/**
* Create a new confide instance.
Expand All @@ -36,26 +41,36 @@ public function __construct($app)
*
* @return bool
*/
public function hasRole($role, $requireAll = false)
public function hasRole($role)
{
if ($user = $this->user()) {
return $user->hasRole($role, $requireAll);
return $user->hasRole($role, $this->requireAll);
}

return false;
}

private function checkUserPrivileges()
{
$res = [];
foreach ($this->privilegesArr as $method => $value) {
$res[] = $this->$method($value, $this->requireAll);
}

return $res;
}

/**
* Check if the current user has a permission by its name
*
* @param string $permission Permission string.
*
* @return bool
*/
public function can($permission, $requireAll = false)
public function can($permission)
{
if ($user = $this->user()) {
return $user->can($permission, $requireAll);
return $user->can($permission, $this->requireAll);
}

return false;
Expand All @@ -64,9 +79,9 @@ public function 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
*/
Expand Down Expand Up @@ -95,32 +110,22 @@ 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
* @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
*/
public function routeNeedsRole($route, $roles, $result = null, $requireAll = true)
public function routeNeedsRole($route, $roles, $result = false, $requireAll = true)
{
$filterName = is_array($roles) ? implode('_', $roles) : $roles;
$filterName .= '_'.substr(md5($route), 0, 6);

$closure = function () use ($roles, $result, $requireAll) {
$hasRole = $this->hasRole($roles, $requireAll);
$this->privilegesArr = ['hasRole' => $roles];
$this->route = $route;
$this->result = $result;
$this->requireAll = $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->applyRouteFilters();
}

/**
Expand All @@ -129,32 +134,21 @@ 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
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all permissions
*
* @return mixed
*/
public function routeNeedsPermission($route, $permissions, $result = null, $requireAll = true)
public function routeNeedsPermission($route, $permissions, $result = false, $requireAll = true)
{
$filterName = is_array($permissions) ? implode('_', $permissions) : $permissions;
$filterName .= '_'.substr(md5($route), 0, 6);

$closure = function () use ($permissions, $result, $requireAll) {
$hasPerm = $this->can($permissions, $requireAll);
$this->privilegesArr = ['can' => $permissions];
$this->route = $route;
$this->result = $result;
$this->requireAll = $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->applyRouteFilters();
}

/**
Expand All @@ -163,40 +157,100 @@ 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 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
* @param mixed $result i.e: Redirect::to('/')
* @param bool $requireAll User must have all roles and permissions
*
* @return void
*/
public function routeNeedsRoleOrPermission($route, $roles, $permissions, $result = null, $requireAll = false)
public function routeNeedsRoleOrPermission($route, $roles, $permissions, $result = false, $requireAll = false)
{
$this->privilegesArr = ['hasRole' => $roles, 'can' => $permissions];
$this->route = $route;
$this->result = $result;
$this->requireAll = $requireAll;

$this->applyRouteFilters();
}

public function routeNeedsRoleAndPermission($route, $roles, $permissions, $result = false)
{
$this->routeNeedsRoleOrPermission($route, $roles, $permissions, $result, true);
}

private function addToFilterName($param)
{
if ($this->filterNameStr) {
$this->filterNameStr .= '_';
}
$this->filterNameStr .= is_array($param)?implode('_', $param) : $param;
}

/**
* @param $closure
* @param $filterName
*
* @internal param $route
*/
private function applyRouteFilters()
{
$filterName = is_array($roles) ? implode('_', $roles) : $roles;
$filterName .= '_'.(is_array($permissions) ? implode('_', $permissions) : $permissions);
$filterName .= '_'.substr(md5($route), 0, 6);

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

if ($requireAll) {
$hasRolePerm = $hasRole && $hasPerms;
} else {
$hasRolePerm = $hasRole || $hasPerms;
$filterName = $this->makeFilterName();
$closure = $this->makeClosure();

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

/**
* @param $has string
* @param $route
* @param $need
* @param bool|false $result
* @param bool|true $requireAll
*/
private function makeClosure()
{
$closure = function () {
$hasPerms = $this->checkUserPrivileges();

$hasRolePerm = false;
if ($this->requireAll) {
$hasRolePerm = true;
}

if (!$hasRolePerm) {
return empty($result) ? $this->app->abort(403) : $result;
foreach ($hasPerms as $hasPerms) {
if ($hasPerms and !$this->requireAll) {
$hasRolePerm = true;
break;
}
if (!$hasPerms and $this->requireAll) {
$hasRolePerm = false;
break;
}
}

if ($hasRolePerm) {
return null;
}
if ($this->result) {
return $this->result;
}
$this->app->abort(403);
};

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

private function makeFilterName()
Copy link
Author

@imanghafoori1 imanghafoori1 Jan 7, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The strategy of making the filer name is all gathered here.

{
$this->filterNameStr = '';
foreach ($this->privilegesArr as $need) {
$this->addToFilterName($need);
}
$this->addToFilterName(substr(md5($this->route), 0, 6));

// Same as Route::when, assigns a route pattern to the
// previously created filter.
$this->app->router->when($route, $filterName);
return $this->filterNameStr;
}
}
Loading