LegacyAuthenticator::onAuthenticationFailure() - Code Metrics - Inspection of "Restructure symfony application part 2" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — development (#673)

by Nick

created 2017-10-11 21:00 UTC

LegacyAuthenticator::onAuthenticationFailure() A

↳ Parent: LegacyAuthenticator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace OcLegacy\Security;

use OcLegacy\User\LegacyUser;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Guard\AbstractGuardAuthenticator;

class LegacyAuthenticator extends AbstractGuardAuthenticator
{
    /**
     * Called on every request. Return whatever credentials you want,
     * or null to stop authentication.
     *
     * @param Request $request

     *
     * @return mixed|null
     */
    public function getCredentials(Request $request)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // What you return here will be passed to getUser() as $credentials
        $login = $GLOBALS['login'];

        if (!$login->logged_in()) {
            return false;
        }

        return [
            'id' => $login->userid,
            'username' => $login->username,
        ];
    }

    /**
     * Returns a UserInterface object based on the credentials.
     *
     * @param mixed $credentials
     * @param UserProviderInterface $userProvider

     *
     * @return \OcLegacy\User\LegacyUser|null
     */
    public function getUser($credentials, UserProviderInterface $userProvider)
    {
        if (!$credentials['id'] || !$credentials['username']) {
            return null;
        }

        return new LegacyUser($credentials['id'], $credentials['username']);
    }

    /**
     * Returns true if the credentials are valid.
     *
     * @param mixed $credentials
     * @param UserInterface $user

     *
     * @return bool
     */
    public function checkCredentials($credentials, UserInterface $user)
    {
        // check credentials - e.g. make sure the password is valid
        // no credential check is needed in this case

        // return true to cause authentication success
        return true;
    }

    /**
     * Called when the authentication is successful.
     *
     * @param Request $request

     * @param TokenInterface $token

     * @param string $providerKey
     *
     * @return null
     */
    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
    {
        // on success, let the request continue
        return null;
    }

    /**
     * Called when the authentication fails.
     *
     * @param Request $request

     * @param AuthenticationException $exception

     *
     * @return null
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
    {
        return null;
    }

    /**
     * Called when authentication is needed, but it's not sent
     *
     * @param Request $request

     * @param AuthenticationException|null $authException

     *
     * @return RedirectResponse

     */
    public function start(Request $request, AuthenticationException $authException = null)
    {
        $currentUri = $request->getUri();
        $url = '/login.php?target=' . rawurlencode($currentUri);

        return new RedirectResponse($url);
    }

    /**
     * @return bool
     */
    public function supportsRememberMe()
    {
        return false;
    }
}


1			<?php
2
3			namespace OcLegacy\Security;
4
5			use OcLegacy\User\LegacyUser;
6			use Symfony\Component\HttpFoundation\RedirectResponse;
7			use Symfony\Component\HttpFoundation\Request;
8			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
9			use Symfony\Component\Security\Core\Exception\AuthenticationException;
10			use Symfony\Component\Security\Core\User\UserInterface;
11			use Symfony\Component\Security\Core\User\UserProviderInterface;
12			use Symfony\Component\Security\Guard\AbstractGuardAuthenticator;
13
14			class LegacyAuthenticator extends AbstractGuardAuthenticator
15			{
16			/**
17			* Called on every request. Return whatever credentials you want,
18			* or null to stop authentication.
19			*
20			* @param Request $request
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report Request => \Symfony\Component\HttpFoundation\Request Loading history...
21			*
22			* @return mixed\|null
23			*/
24			public function getCredentials(Request $request)
			0 ignored issues – show Coding Style introduced 2017-08-03 15:22 UTC by Report Bug Copy Issue Report `getCredentials` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
25			{
26			// What you return here will be passed to getUser() as $credentials
27			$login = $GLOBALS['login'];
28
29			if (!$login->logged_in()) {
30			return false;
31			}
32
33			return [
34			'id' => $login->userid,
35			'username' => $login->username,
36			];
37			}
38
39			/**
40			* Returns a UserInterface object based on the credentials.
41			*
42			* @param mixed $credentials
43			* @param UserProviderInterface $userProvider
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report UserProviderInterface => \Symfony\Component\Security\Core\User\UserProviderInterface Loading history...
44			*
45			* @return \OcLegacy\User\LegacyUser\|null
46			*/
47			public function getUser($credentials, UserProviderInterface $userProvider)
48			{
49			if (!$credentials['id'] \|\| !$credentials['username']) {
50			return null;
51			}
52
53			return new LegacyUser($credentials['id'], $credentials['username']);
54			}
55
56			/**
57			* Returns true if the credentials are valid.
58			*
59			* @param mixed $credentials
60			* @param UserInterface $user
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report UserInterface => \Symfony\Component\Security\Core\User\UserInterface Loading history...
61			*
62			* @return bool
63			*/
64			public function checkCredentials($credentials, UserInterface $user)
65			{
66			// check credentials - e.g. make sure the password is valid
67			// no credential check is needed in this case
68
69			// return true to cause authentication success
70			return true;
71			}
72
73			/**
74			* Called when the authentication is successful.
75			*
76			* @param Request $request
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report Request => \Symfony\Component\HttpFoundation\Request Loading history...
77			* @param TokenInterface $token
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report TokenInterface => \Symfony\Component\Security\Core\Authentication\Token\TokenInterface Loading history...
78			* @param string $providerKey
79			*
80			* @return null
81			*/
82			public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
83			{
84			// on success, let the request continue
85			return null;
86			}
87
88			/**
89			* Called when the authentication fails.
90			*
91			* @param Request $request
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report Request => \Symfony\Component\HttpFoundation\Request Loading history...
92			* @param AuthenticationException $exception
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report AuthenticationException => \Symfony\Component\Security\Core\Exception\AuthenticationException Loading history...
93			*
94			* @return null
95			*/
96			public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
97			{
98			return null;
99			}
100
101			/**
102			* Called when authentication is needed, but it's not sent
103			*
104			* @param Request $request
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report Request => \Symfony\Component\HttpFoundation\Request Loading history...
105			* @param AuthenticationException\|null $authException
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report AuthenticationException => \Symfony\Component\Security\Core\Exception\AuthenticationException Loading history...
106			*
107			* @return RedirectResponse
			0 ignored issues – show introduced 2017-10-11 21:11 UTC by Report Bug Copy Issue Report RedirectResponse => \Symfony\Component\HttpFoundation\RedirectResponse Loading history...
108			*/
109			public function start(Request $request, AuthenticationException $authException = null)
110			{
111			$currentUri = $request->getUri();
112			$url = '/login.php?target=' . rawurlencode($currentUri);
113
114			return new RedirectResponse($url);
115			}
116
117			/**
118			* @return bool
119			*/
120			public function supportsRememberMe()
121			{
122			return false;
123			}
124			}
125

OpencachingDeutschland / oc-server3

Pull Request — development (#673)

LegacyAuthenticator::onAuthenticationFailure() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like