AuthenticatorService - Code Metrics - FloKnapp/faulancer - Measure and Improve Code Quality continuously with Scrutinizer

AuthenticatorService A
last analyzed 2019-03-10 18:38 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	18
lcom	1
cbo	6
dl	0
loc	148
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
B	loginUser()	42	8
A	redirectToAuthentication()	8	1
A	isPermitted()	19	4
A	saveUserInSession()	4	1
A	getUserFromSession()	17	3

<?php

namespace Faulancer\Service;

use Faulancer\Controller\Controller;
use Faulancer\Exception\DbException;
use Faulancer\Exception\InvalidArgumentException;
use Faulancer\ORM\User\Entity;
use Faulancer\Security\Crypt;
use Faulancer\ServiceLocator\ServiceInterface;

/**
 * Class AuthenticatorService | AuthenticatorService.php
 *
 * @package Faulancer\Service
 * @author  Florian Knapp <[email protected]>
 */
class AuthenticatorService implements ServiceInterface
{

    /** @var Controller */
    protected $controller;

    /** @var DbService */
    protected $orm;

    /** @var Config */
    protected $config;

    /** @var string */
    protected $redirectAfterAuth;

    /**
     * Authenticator constructor.
     *
     * @param Controller $controller
     * @param Config     $config
     */
    public function __construct(Controller $controller, Config $config)
    {
        $this->controller = $controller;
        $this->config     = $config;
    }

    /**
     * Login user with given entity
     *
     * @param Entity $user
     * @param bool   $shouldBeActive
     * @param string $redirectUrl
     *
     * @return bool
     */
    public function loginUser(Entity $user, $shouldBeActive = true, $redirectUrl = '')
    {
        /** @var Entity $userData */
        $userData = $this->controller
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->getDb()
            ->fetch(get_class($user))
            ->where('login', '=', $user->login)
            ->orWhere('email', '=', $user->login)
            ->one();

        if (empty($userData)) {
            $this->controller->setFlashMessage('error.login', 'invalid_username_or_password');
            return $this->redirectToAuthentication();
        }

        if ($shouldBeActive && $userData->active !== 1) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->controller->setFlashMessage('error.active', 'user_is_not_activated');
            return $this->redirectToAuthentication();
        }

        $passOk = Crypt::verifyPassword($user->password, $userData->password);

        if ($passOk && $userData instanceof Entity) {

            $this->saveUserInSession($userData);

            if ($redirectUrl) {
                return $this->controller->redirect($redirectUrl);
            }

            if ($userData->roles[0]->roleName === 'registered') {
                return $this->controller->redirect($this->controller->route('user'));
            } else {
                return $this->controller->redirect($this->controller->route('admin'));
            }

        }

        $this->controller->setFlashMessage('error.login', 'invalid_username_or_password');

        return $this->redirectToAuthentication();
    }

    /**
     * @return bool
     */
    public function redirectToAuthentication()
    {
        /** @var Config $config */
        $config  = $this->controller->getServiceLocator()->get(Config::class);
        $authUrl = $config->get('auth:authUrl');

        return $this->controller->redirect($authUrl);
    }

    /**
     * @param array $roles
     * @return bool
     */
    public function isPermitted(array $roles): bool
    {
        /** @var Entity $user */
        $user = $this->getUserFromSession();

        if (!$user instanceof Entity) {
            return false;
        }

        foreach ($user->roles as $userRole) {

            if (in_array($userRole->roleName, $roles, true)) {
                return true;
            }

        }

        return false;
    }

    /**
     * @param Entity $user
     * @codeCoverageIgnore
     */
    public function saveUserInSession(Entity $user)
    {
        $this->controller->getSessionManager()->set('user', $user->id);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * @param string $entity
     * @return Entity     *
     * @codeCoverageIgnore
     */
    public function getUserFromSession(string $entity = '')
    {
        $id = $this->controller->getSessionManager()->get('user');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        if (empty($id)) {
            return null;
        }

        /** @var Entity $user */
        if (!empty($entity)) {
            $user = $this->controller->getDb()->fetch($entity, $id);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        } else {
            $user = $this->controller->getDb()->fetch(Entity::class, $id);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        return $user;
    }

}

1			<?php
2
3			namespace Faulancer\Service;
4
5			use Faulancer\Controller\Controller;
6			use Faulancer\Exception\DbException;
7			use Faulancer\Exception\InvalidArgumentException;
8			use Faulancer\ORM\User\Entity;
9			use Faulancer\Security\Crypt;
10			use Faulancer\ServiceLocator\ServiceInterface;
11
12			/**
13			* Class AuthenticatorService \| AuthenticatorService.php
14			*
15			* @package Faulancer\Service
16			* @author Florian Knapp <[email protected]>
17			*/
18			class AuthenticatorService implements ServiceInterface
19			{
20
21			/** @var Controller */
22			protected $controller;
23
24			/** @var DbService */
25			protected $orm;
26
27			/** @var Config */
28			protected $config;
29
30			/** @var string */
31			protected $redirectAfterAuth;
32
33			/**
34			* Authenticator constructor.
35			*
36			* @param Controller $controller
37			* @param Config $config
38			*/
39			public function __construct(Controller $controller, Config $config)
40			{
41			$this->controller = $controller;
42			$this->config = $config;
43			}
44
45			/**
46			* Login user with given entity
47			*
48			* @param Entity $user
49			* @param bool $shouldBeActive
50			* @param string $redirectUrl
51			*
52			* @return bool
53			*/
54			public function loginUser(Entity $user, $shouldBeActive = true, $redirectUrl = '')
55			{
56			/** @var Entity $userData */
57			$userData = $this->controller
			0 ignored issues – show Bug introduced 2017-02-06 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Faulancer\ServiceLocator\ServiceInterface` as the method `fetch()` does only exist in the following implementations of said interface: `Faulancer\Service\DbService`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
58			->getDb()
59			->fetch(get_class($user))
60			->where('login', '=', $user->login)
61			->orWhere('email', '=', $user->login)
62			->one();
63
64			if (empty($userData)) {
65			$this->controller->setFlashMessage('error.login', 'invalid_username_or_password');
66			return $this->redirectToAuthentication();
67			}
68
69			if ($shouldBeActive && $userData->active !== 1) {
			0 ignored issues – show Documentation introduced 2017-07-13 23:24 UTC by Report Bug Copy Issue Report The property `active` does not exist on `object<Faulancer\ORM\User\Entity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
70			$this->controller->setFlashMessage('error.active', 'user_is_not_activated');
71			return $this->redirectToAuthentication();
72			}
73
74			$passOk = Crypt::verifyPassword($user->password, $userData->password);
75
76			if ($passOk && $userData instanceof Entity) {
77
78			$this->saveUserInSession($userData);
79
80			if ($redirectUrl) {
81			return $this->controller->redirect($redirectUrl);
82			}
83
84			if ($userData->roles[0]->roleName === 'registered') {
85			return $this->controller->redirect($this->controller->route('user'));
86			} else {
87			return $this->controller->redirect($this->controller->route('admin'));
88			}
89
90			}
91
92			$this->controller->setFlashMessage('error.login', 'invalid_username_or_password');
93
94			return $this->redirectToAuthentication();
95			}
96
97			/**
98			* @return bool
99			*/
100			public function redirectToAuthentication()
101			{
102			/** @var Config $config */
103			$config = $this->controller->getServiceLocator()->get(Config::class);
104			$authUrl = $config->get('auth:authUrl');
105
106			return $this->controller->redirect($authUrl);
107			}
108
109			/**
110			* @param array $roles
111			* @return bool
112			*/
113			public function isPermitted(array $roles): bool
114			{
115			/** @var Entity $user */
116			$user = $this->getUserFromSession();
117
118			if (!$user instanceof Entity) {
119			return false;
120			}
121
122			foreach ($user->roles as $userRole) {
123
124			if (in_array($userRole->roleName, $roles, true)) {
125			return true;
126			}
127
128			}
129
130			return false;
131			}
132
133			/**
134			* @param Entity $user
135			* @codeCoverageIgnore
136			*/
137			public function saveUserInSession(Entity $user)
138			{
139			$this->controller->getSessionManager()->set('user', $user->id);
			0 ignored issues – show Bug introduced 2018-08-06 23:54 UTC by Report Bug Copy Issue Report The method `set` does only exist in `Faulancer\Session\SessionManager`, but not in `Faulancer\ServiceLocator\ServiceInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
140			}
141
142			/**
143			* @param string $entity
144			* @return Entity *
145			* @codeCoverageIgnore
146			*/
147			public function getUserFromSession(string $entity = '')
148			{
149			$id = $this->controller->getSessionManager()->get('user');
			0 ignored issues – show Bug introduced 2018-08-06 23:54 UTC by Report Bug Copy Issue Report The method `get` does only exist in `Faulancer\Session\SessionManager`, but not in `Faulancer\ServiceLocator\ServiceInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
150
151			if (empty($id)) {
152			return null;
153			}
154
155			/** @var Entity $user */
156			if (!empty($entity)) {
157			$user = $this->controller->getDb()->fetch($entity, $id);
			0 ignored issues – show Bug introduced 2017-08-24 16:25 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Faulancer\ServiceLocator\ServiceInterface` as the method `fetch()` does only exist in the following implementations of said interface: `Faulancer\Service\DbService`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
158			} else {
159			$user = $this->controller->getDb()->fetch(Entity::class, $id);
			0 ignored issues – show Bug introduced 2017-02-06 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Faulancer\ServiceLocator\ServiceInterface` as the method `fetch()` does only exist in the following implementations of said interface: `Faulancer\Service\DbService`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
160			}
161
162			return $user;
163			}
164
165			}

FloKnapp / faulancer

AuthenticatorService A last analyzed 2019-03-10 18:38 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

AuthenticatorService A
last analyzed 2019-03-10 18:38 UTC