silverstripe /
silverstripe-activedirectory
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 9 | class LDAPAuthenticator extends Authenticator |
||
|
|
|||
| 10 | { |
||
| 11 | /** |
||
| 12 | * @var string |
||
| 13 | */ |
||
| 14 | private $name = 'LDAP'; |
||
| 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'; |
||
| 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'; |
||
| 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'; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @return string |
||
| 46 | */ |
||
| 47 | public static function get_name() |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @param Controller $controller |
||
| 54 | * @return LDAPLoginForm |
||
| 55 | */ |
||
| 56 | public static function get_login_form(Controller $controller) |
||
| 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( |
||
| 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) { |
|
| 89 | if (Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator') === 'yes') { |
||
| 90 | $fallbackMember = self::fallback_authenticate($data, $form); |
||
| 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) { |
|
| 106 | if (Config::inst()->get('LDAPAuthenticator', 'fallback_authenticator') === 'yes') { |
||
| 107 | $fallbackMember = self::fallback_authenticate($data, $form); |
||
| 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']); |
||
| 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 | View Code Duplication | 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 | * @param null|Form $form |
||
| 151 | * @return null|Member |
||
| 152 | */ |
||
| 153 | protected static function fallback_authenticate($data, Form $form = null) |
||
| 161 | |||
| 162 | } |
||
| 163 |
Loading history...
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.