Micro\Filter\AccessFilter

Complexity

Total Complexity

46

Size/Duplication

Total Lines	236
Duplicated Lines	19.49 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
C	pre()	8	25	7
B	checkRule()	0	14	6
A	matchAction()	0	12	3
D	matchUser()	0	37	10
B	matchRole()	18	19	5
C	matchIP()	0	22	9
B	matchVerb()	20	21	5
A	post()	0	4	1

<?php /** AccessFilterMicro */

namespace Micro\Filter;

use Micro\Base\Exception;
use Micro\Web\IUser;
use Micro\Web\RequestInjector;
use Micro\Web\UserInjector;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Class AccessFilter
 *
 * @author Oleg Lunegov <testuser@mail.linpax.org>
 * @link https://github.com/linpax/microphp-framework
 * @copyright Copyright (c) 2013 Oleg Lunegov
 * @license https://github.com/linpax/microphp-framework/blob/master/LICENSE
 * @package Micro
 * @subpackage Filter
 * @version 1.0
 * @since 1.0
 */
class AccessFilter extends Filter
{
    /** @var IUser $user */
    protected $user;
    /** @var ServerRequestInterface $request */
    protected $request;

    /**
     * @param array $params
     * @return bool
     * @throws Exception
     */
    public function pre(array $params)
    {
        $this->user = (new UserInjector)->build();
        $this->request = (new RequestInjector)->build();

        /** @noinspection ForeachSourceInspection */
        foreach ($params['rules'] AS $rule) {
            $res = $this->checkRule($rule);

            if ($res === true) {
                return true;
            } elseif ($res === false) {

This code seems to be duplicated across your project.

                $this->result = [
                    'redirect' => !empty($rule['redirect']) ? $rule['redirect'] : null,
                    'message' => !empty($rule['message']) ? $rule['message'] : 'Access denied!'
                ];

                return false;
            } elseif ($res === null) {
                continue;
            }
        }

        return true;
    }

    /**
     * Check one rule
     *
     * @access protected
     *
     * @param array $rule rule definition
     *
     * @return bool|null
     * @throws Exception
     */
    protected function checkRule(array $rule)
    {
        if (
            $this->matchAction($rule)
            && $this->matchUser($rule)
            && $this->matchRole($rule)
            && $this->matchIP($rule)
            && $this->matchVerb($rule)
        ) {
            return $rule['allow'];
        } else {
            return null;
        }
    }

    /**
     * Match action
     *
     * @access protected
     *
     * @param array $rule rule definition
     *
     * @return bool
     */
    protected function matchAction($rule)
    {
        if (empty($rule['actions'])) {
            return true;
        }

        if (is_array($rule['actions'])) {
            return in_array($this->action, $rule['actions'], true);
        }

        return $this->action === $rule['actions'];
    }

    /**
     * Match user
     *
     * @access protected
     *
     * @param array $rule rule definition
     *
     * @return bool
     * @throws Exception
     */
    protected function matchUser($rule)
    {
        if (empty($rule['users'])) {
            return true;
        }

        if (!is_array($rule['users'])) {
            $rule['users'][] = $rule['users'];
        }

        /** @noinspection ForeachSourceInspection */
        foreach ($rule['users'] AS $u) {
            switch ($u) {
                case '*':
                    return true;

                case '?':
                    if ($this->user->isGuest()) {
                        return true;
                    }
                    break;

                case '@':
                    if (!$this->user->isGuest()) {
                        return true;
                    }
                    break;

                default:
                    if ($this->user->getID() === $u) {
                        return true;
                    }
            }
        }

        return false;
    }

    /**
     * Match role
     *
     * @access protected
     *
     * @param array $rule rule definition
     *
     * @return bool
     * @throws Exception
     */
    protected function matchRole($rule)

This method seems to be duplicated in your project.

    {
        if (empty($rule['roles'])) {
            return true;
        }

        if (!is_array($rule['roles'])) {
            $rule['roles'][] = $rule['roles'];
        }

        /** @noinspection ForeachSourceInspection */
        foreach ($rule['roles'] AS $role) {
            if ($this->user->check($role)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Match IP
     *
     * @access protected
     *
     * @param array $rule rule definition
     *
     * @return bool
     * @throws Exception
     */
    protected function matchIP($rule)
    {
        if (empty($rule['ips'])) {
            return true;
        }

        if (!is_array($rule['ips'])) {
            $rule['ips'][] = $rule['ips'];
        }

        $server = $this->request->getServerParams();
        $userIp = ($ip = filter_var($server['REMOTE_ADDR'], FILTER_VALIDATE_IP)) ? $ip : '127.0.0.1';

        /** @noinspection ForeachSourceInspection */
        foreach ($rule['ips'] AS $r) {
            if ($r === '*' || $r === $userIp || (($pos = strpos($r, '*')) !== false && 0 === strpos($userIp, $r))) {
                return true;
            }
        }

        return false;
    }

    /**
     * Match verbose
     *
     * @access protected
     *
     * @param array $rule rule definition
     *
     * @return bool
     * @throws Exception
     */
    protected function matchVerb($rule)

This method seems to be duplicated in your project.

    {
        if (empty($rule['verb'])) {
            return true;
        }

        if (!is_array($rule['verb'])) {
            $rule['verb'][] = $rule['verb'];
        }

        $verb = $this->request->getMethod();

        /** @noinspection ForeachSourceInspection */
        foreach ($rule['verb'] AS $v) {
            if ($v === $verb) {
                return true;
            }
        }

        return false;
    }

    /**
     * @inheritdoc
     */
    public function post(array $params)
    {
        return $params['data'];
    }
}