LDAPAuthenticator::fallback_authenticate() - Code Metrics - Inspection of "Use fallback authenticator if can't find username..." - silverstripe/silverstripe-activedirectory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2c9da8...832e0c )

by Mateusz

created 2016-07-13 02:51 UTC

LDAPAuthenticator::fallback_authenticate() A

↳ Parent: LDAPAuthenticator

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	1
eloc	5
nc	1
nop	1

<?php
/**
 * Class LDAPAuthenticator
 *
 * Authenticate a user against LDAP, without the single sign-on component.
 *
 * See SAMLAuthenticator for further information.
 */
class LDAPAuthenticator extends Authenticator
namespace YourVendor;

class YourClass { }
{
    /**
     * @var string
     */
    private $name = 'LDAP';


    /**
     * Set to 'yes' to indicate if this module should look up usernames in LDAP by matching the email addresses.
     *
     * CAVEAT #1: only set to 'yes' for systems that enforce email uniqueness.
     * Otherwise only the first LDAP user with matching email will be accessible.
     *
     * CAVEAT #2: this is untested for systems that use LDAP with principal style usernames (i.e. [email protected]).
     * The system will misunderstand emails for usernames with uncertain outcome.
     *
     * @var string 'no' or 'yes'
     */
    private static $allow_email_login = 'no';


    /**
     * Set to 'yes' to fallback login attempts to {@link $fallback_authenticator}.
     * This will occur if LDAP fails to authenticate the user.
     *
     * @var string 'no' or 'yes'
     */
    private static $fallback_authenticator = 'no';


    /**
     * The class of {@link Authenticator} to use as the fallback authenticator.
     *
     * @var string
     */
    private static $fallback_authenticator_class = 'MemberAuthenticator';


    /**
     * @return string
     */
    public static function get_name()
    {
        return Config::inst()->get('LDAPAuthenticator', 'name');
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @param Controller $controller
     * @return LDAPLoginForm
     */
    public static function get_login_form(Controller $controller)
    {
        return new LDAPLoginForm($controller, 'LoginForm');
    }

    /**
     * Performs the login, but will also create and sync the Member record on-the-fly, if not found.
     *
     * @param array $data
     * @param Form $form
     * @return bool|Member|void
     * @throws SS_HTTPResponse_Exception
     */
    public static function authenticate($data, Form $form = null)
    {
        $service = Injector::inst()->get('LDAPService');
        $login = trim($data['Login']);
        if (Email::validEmailAddress($login)) {
            if (Config::inst()->get('LDAPAuthenticator', 'allow_email_login')!='yes') {
                $form->sessionMessage(
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
                    _t(
                        'LDAPAuthenticator.PLEASEUSEUSERNAME',
                        'Please enter your username instead of your email to log in.'
                    ),
                    'bad'
                );
                return;
            }

            $username = $service->getUsernameByEmail($login);

            // No user found with this email.
            if (!$username) {

                if (Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator') === 'yes') {
                    $fallbackMember = self::fallback_authenticate($data);
                    if ($fallbackMember) {
                        return $fallbackMember;
                    }
                }

                $form->sessionMessage(_t('LDAPAuthenticator.INVALIDCREDENTIALS', 'Invalid credentials'), 'bad');
                return;
            }
        } else {
            $username = $login;
        }

        $result = $service->authenticate($username, $data['Password']);
        $success = $result['success'] === true;
        if (!$success) {

            if (Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator') === 'yes') {
                $fallbackMember = self::fallback_authenticate($data);
                if ($fallbackMember) {
                    return $fallbackMember;
                }
            }

            if ($form) {
                $form->sessionMessage($result['message'], 'bad');
            }
            return;
        }

        $data = $service->getUserByUsername($result['identity']);

        if (!$data) {
            if ($form) {
                $form->sessionMessage(
                    _t('LDAPAuthenticator.PROBLEMFINDINGDATA', 'There was a problem retrieving your user data'),
                    'bad'
                );
            }
            return;
        }

        // LDAPMemberExtension::memberLoggedIn() will update any other AD attributes mapped to Member fields
        $member = Member::get()->filter('GUID', $data['objectguid'])->limit(1)->first();
        if (!($member && $member->exists())) {
            $member = new Member();
            $member->GUID = $data['objectguid'];
        }

        // Update the users from LDAP so we are sure that the email is correct.
        // This will also write the Member record.
        $service->updateMemberFromLDAP($member);

        Session::clear('BackURL');

        return $member;
    }

    /**
     * Try to authenticate using the fallback authenticator.
     *
     * @param array $data
     * @return null|Member
     */
    protected static function fallback_authenticate($data)
    {
        return call_user_func(
            array(Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator_class'), 'authenticate'),
            array_merge($data, array('Email' => $data['Login'])),
            $form

        );
    }

}


1		<?php
2		/**
3		* Class LDAPAuthenticator
4		*
5		* Authenticate a user against LDAP, without the single sign-on component.
6		*
7		* See SAMLAuthenticator for further information.
8		*/
9		class LDAPAuthenticator extends Authenticator
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10		{
11		/**
12		* @var string
13		*/
14		private $name = 'LDAP';
		0 ignored issues – show Unused Code introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report The property `$name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
15
16		/**
17		* Set to 'yes' to indicate if this module should look up usernames in LDAP by matching the email addresses.
18		*
19		* CAVEAT #1: only set to 'yes' for systems that enforce email uniqueness.
20		* Otherwise only the first LDAP user with matching email will be accessible.
21		*
22		* CAVEAT #2: this is untested for systems that use LDAP with principal style usernames (i.e. [email protected]).
23		* The system will misunderstand emails for usernames with uncertain outcome.
24		*
25		* @var string 'no' or 'yes'
26		*/
27		private static $allow_email_login = 'no';
		0 ignored issues – show Unused Code introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report The property `$allow_email_login` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
28
29		/**
30		* Set to 'yes' to fallback login attempts to {@link $fallback_authenticator}.
31		* This will occur if LDAP fails to authenticate the user.
32		*
33		* @var string 'no' or 'yes'
34		*/
35		private static $fallback_authenticator = 'no';
		0 ignored issues – show Unused Code introduced 2016-07-11 02:12 UTC by Report Bug Copy Issue Report The property `$fallback_authenticator` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
36
37		/**
38		* The class of {@link Authenticator} to use as the fallback authenticator.
39		*
40		* @var string
41		*/
42		private static $fallback_authenticator_class = 'MemberAuthenticator';
		0 ignored issues – show Unused Code introduced 2016-07-11 02:12 UTC by Report Bug Copy Issue Report The property `$fallback_authenticator_class` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
43
44		/**
45		* @return string
46		*/
47		public static function get_name()
48		{
49		return Config::inst()->get('LDAPAuthenticator', 'name');
		0 ignored issues – show Bug Best Practice introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report The return type of `return \Config::inst()->...uthenticator', 'name');` (`array\|integer\|double\|string\|boolean`) is incompatible with the return type of the parent method `Authenticator::get_name` of type `string\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
50		}
51
52		/**
53		* @param Controller $controller
54		* @return LDAPLoginForm
55		*/
56		public static function get_login_form(Controller $controller)
57		{
58		return new LDAPLoginForm($controller, 'LoginForm');
59		}
60
61		/**
62		* Performs the login, but will also create and sync the Member record on-the-fly, if not found.
63		*
64		* @param array $data
65		* @param Form $form
66		* @return bool\|Member\|void
67		* @throws SS_HTTPResponse_Exception
68		*/
69		public static function authenticate($data, Form $form = null)
70		{
71		$service = Injector::inst()->get('LDAPService');
72		$login = trim($data['Login']);
73		if (Email::validEmailAddress($login)) {
74		if (Config::inst()->get('LDAPAuthenticator', 'allow_email_login')!='yes') {
75		$form->sessionMessage(
		0 ignored issues – show Bug introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report It seems like `$form` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
76		_t(
77		'LDAPAuthenticator.PLEASEUSEUSERNAME',
78		'Please enter your username instead of your email to log in.'
79		),
80		'bad'
81		);
82		return;
83		}
84
85		$username = $service->getUsernameByEmail($login);
86
87		// No user found with this email.
88	View Code Duplication	if (!$username) {
		0 ignored issues – show Duplication introduced 2016-07-13 02:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
89		if (Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator') === 'yes') {
90		$fallbackMember = self::fallback_authenticate($data);
91		if ($fallbackMember) {
92		return $fallbackMember;
93		}
94		}
95
96		$form->sessionMessage(_t('LDAPAuthenticator.INVALIDCREDENTIALS', 'Invalid credentials'), 'bad');
97		return;
98		}
99		} else {
100		$username = $login;
101		}
102
103		$result = $service->authenticate($username, $data['Password']);
104		$success = $result['success'] === true;
105	View Code Duplication	if (!$success) {
		0 ignored issues – show Duplication introduced 2016-07-13 02:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
106		if (Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator') === 'yes') {
107		$fallbackMember = self::fallback_authenticate($data);
108		if ($fallbackMember) {
109		return $fallbackMember;
110		}
111		}
112
113		if ($form) {
114		$form->sessionMessage($result['message'], 'bad');
115		}
116		return;
117		}
118
119		$data = $service->getUserByUsername($result['identity']);
		0 ignored issues – show Coding Style introduced 2016-07-12 20:48 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$data`. This often makes code more readable. Loading history...
120		if (!$data) {
121		if ($form) {
122		$form->sessionMessage(
123		_t('LDAPAuthenticator.PROBLEMFINDINGDATA', 'There was a problem retrieving your user data'),
124		'bad'
125		);
126		}
127		return;
128		}
129
130		// LDAPMemberExtension::memberLoggedIn() will update any other AD attributes mapped to Member fields
131		$member = Member::get()->filter('GUID', $data['objectguid'])->limit(1)->first();
132		if (!($member && $member->exists())) {
133		$member = new Member();
134		$member->GUID = $data['objectguid'];
135		}
136
137		// Update the users from LDAP so we are sure that the email is correct.
138		// This will also write the Member record.
139		$service->updateMemberFromLDAP($member);
140
141		Session::clear('BackURL');
142
143		return $member;
144		}
145
146		/**
147		* Try to authenticate using the fallback authenticator.
148		*
149		* @param array $data
150		* @return null\|Member
151		*/
152		protected static function fallback_authenticate($data)
153		{
154		return call_user_func(
155		array(Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator_class'), 'authenticate'),
156		array_merge($data, array('Email' => $data['Login'])),
157		$form
		0 ignored issues – show Bug introduced 2016-07-13 02:44 UTC by Report Bug Copy Issue Report The variable `$form` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
158		);
159		}
160
161		}
162

silverstripe / silverstripe-activedirectory

Push — master ( 2c9da8...832e0c )

LDAPAuthenticator::fallback_authenticate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like