LegacyAuthenticator::getCredentials() - Code Metrics - Inspection of "Feature/symfony integration" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#346)

by Mirko

created 2016-06-07 21:40 UTC

LegacyAuthenticator::getCredentials() A

↳ Parent: LegacyAuthenticator

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	7
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	14
rs	9.4285

<?php

namespace AppBundle\Legacy\Security;

use AppBundle\Legacy\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 \Symfony\Component\HttpFoundation\Request $request
     *
     * @return array
     */
    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,
        ];
    }

    /**
     * @param mixed $credentials
     * @param \Symfony\Component\Security\Core\User\UserProviderInterface $userProvider
     *
     * @return \AppBundle\Legacy\User\LegacyUser|null
     */
    public function getUser($credentials, UserProviderInterface $userProvider)
    {
        if (!$credentials['id']) {
            return null;
        }

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

    /**
     * @param mixed $credentials
     * @param \Symfony\Component\Security\Core\User\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;
    }

    /**
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @param \Symfony\Component\Security\Core\Authentication\Token\TokenInterface $token
     * @param string $providerKey
     *
     * @return null
     */
    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
    {
        // on success, let the request continue
        return null;
    }

    /**
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @param \Symfony\Component\Security\Core\Exception\AuthenticationException $exception
     *
     * @return null
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
    {
        return null;
    }

    /**
     * Called when authentication is needed, but it's not sent
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @param \Symfony\Component\Security\Core\Exception\AuthenticationException|null $authException
     *
     * @return \Symfony\Component\HttpFoundation\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 AppBundle\Legacy\Security;
4
5			use AppBundle\Legacy\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 \Symfony\Component\HttpFoundation\Request $request
21			*
22			* @return array
23			*/
24			public function getCredentials(Request $request)
			0 ignored issues – show Coding Style introduced 2016-06-07 21:48 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			* @param mixed $credentials
41			* @param \Symfony\Component\Security\Core\User\UserProviderInterface $userProvider
42			*
43			* @return \AppBundle\Legacy\User\LegacyUser\|null
44			*/
45			public function getUser($credentials, UserProviderInterface $userProvider)
46			{
47			if (!$credentials['id']) {
48			return null;
49			}
50
51			return new LegacyUser($credentials['id'], $credentials['username']);
52			}
53
54			/**
55			* @param mixed $credentials
56			* @param \Symfony\Component\Security\Core\User\UserInterface $user
57			*
58			* @return bool
59			*/
60			public function checkCredentials($credentials, UserInterface $user)
61			{
62			// check credentials - e.g. make sure the password is valid
63			// no credential check is needed in this case
64
65			// return true to cause authentication success
66			return true;
67			}
68
69			/**
70			* @param \Symfony\Component\HttpFoundation\Request $request
71			* @param \Symfony\Component\Security\Core\Authentication\Token\TokenInterface $token
72			* @param string $providerKey
73			*
74			* @return null
75			*/
76			public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
77			{
78			// on success, let the request continue
79			return null;
80			}
81
82			/**
83			* @param \Symfony\Component\HttpFoundation\Request $request
84			* @param \Symfony\Component\Security\Core\Exception\AuthenticationException $exception
85			*
86			* @return null
87			*/
88			public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
89			{
90			return null;
91			}
92
93			/**
94			* Called when authentication is needed, but it's not sent
95			*
96			* @param \Symfony\Component\HttpFoundation\Request $request
97			* @param \Symfony\Component\Security\Core\Exception\AuthenticationException\|null $authException
98			*
99			* @return \Symfony\Component\HttpFoundation\RedirectResponse
100			*/
101			public function start(Request $request, AuthenticationException $authException = null)
102			{
103			$currentUri = $request->getUri();
104			$url = '/login.php?target=' . rawurlencode($currentUri);
105
106			return new RedirectResponse($url);
107			}
108
109			/**
110			* @return bool
111			*/
112			public function supportsRememberMe()
113			{
114			return false;
115			}
116			}
117

OpencachingDeutschland / oc-server3

Pull Request — master (#346)

LegacyAuthenticator::getCredentials() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like