yii2mod\rbac\filters\AccessControl

Complexity

Total Complexity

22

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	beforeAction()	0	18	4
A	isActive()	0	8	4
A	isErrorPage()	0	8	2
A	isLoginPage()	0	10	3
B	isAllowedAction()	0	27	9

<?php

namespace yii2mod\rbac\filters;

use Yii;
use yii\base\Action;
use yii\base\Module;
use yii\helpers\ArrayHelper;
use yii\helpers\Url;

/**
 * Class AccessControl
 *
 * @package yii2mod\rbac\filters
 */
class AccessControl extends \yii\filters\AccessControl
{
    /**
     * @var array
     */
    public $params = [];

    /**
     * @var array list of actions that not need to check access
     */
    public $allowActions = [];

    /**
     * @inheritdoc
     */
    public function beforeAction($action): bool
    {
        $controller = $action->controller;
        $params = ArrayHelper::getValue($this->params, $action->id, []);

        if (Yii::$app->user->can('/' . $action->getUniqueId(), $params)) {
            return true;
        }

        do {
            if (Yii::$app->user->can('/' . ltrim($controller->getUniqueId() . '/*', '/'))) {
                return true;
            }
            $controller = $controller->module;
        } while ($controller !== null);

        return parent::beforeAction($action);
    }

    /**
     * @inheritdoc
     */
    protected function isActive($action): bool
    {
        if ($this->isErrorPage($action) || $this->isLoginPage($action) || $this->isAllowedAction($action)) {
            return false;
        }

        return parent::isActive($action);
    }

    /**
     * Returns a value indicating whether a current url equals `errorAction` property of the ErrorHandler component
     *
     * @param Action $action
     *
     * @return bool
     */
    private function isErrorPage(Action $action): bool
    {
        if ($action->getUniqueId() === Yii::$app->getErrorHandler()->errorAction) {
            return true;
        }

        return false;
    }

    /**
     * Returns a value indicating whether a current url equals `loginUrl` property of the User component
     *
     * @param Action $action
     *
     * @return bool
     */
    private function isLoginPage(Action $action): bool
    {
        $loginUrl = trim(Url::to(Yii::$app->user->loginUrl), '/');

        if (Yii::$app->user->isGuest && $action->getUniqueId() === $loginUrl) {
            return true;
        }

        return false;
    }

    /**
     * Returns a value indicating whether a current url exists in the `allowActions` list.
     *
     * @param Action $action
     *
     * @return bool
     */
    private function isAllowedAction(Action $action): bool
    {
        if ($this->owner instanceof Module) {
            $ownerId = $this->owner->getUniqueId();
            $id = $action->getUniqueId();
            if (!empty($ownerId) && strpos($id, $ownerId . '/') === 0) {
                $id = substr($id, strlen($ownerId) + 1);
            }
        } else {
            $id = $action->id;
        }

        foreach ($this->allowActions as $route) {
            if (substr($route, -1) === '*') {
                $route = rtrim($route, '*');
                if ($route === '' || strpos($id, $route) === 0) {
                    return true;
                }
            } else {
                if ($id === $route) {
                    return true;
                }
            }
        }

        return false;
    }
}