| Conditions | 17 |
| Paths | 390 |
| Total Lines | 157 |
| Code Lines | 104 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 3 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 72 | protected function login(string $username, string $password): array |
||
| 73 | { |
||
| 74 | $encryption = $this->ldapConfig->getString('encryption', 'ssl'); |
||
| 75 | Assert::oneOf($encryption, ['none', 'ssl', 'tls']); |
||
| 76 | |||
| 77 | $version = $this->ldapConfig->getInteger('version', 3); |
||
| 78 | Assert::positiveInteger($version); |
||
| 79 | |||
| 80 | $ldapServers = []; |
||
| 81 | foreach (explode(' ', $this->ldapConfig->getString('connection_string')) as $connection_string) { |
||
| 82 | Assert::regex($connection_string, '#^ldap[s]?:\/\/#'); |
||
| 83 | |||
| 84 | $ldap_servers[] = LdapObject::create( |
||
| 85 | $this->ldapConfig->getString('extension', 'ext_ldap'), |
||
| 86 | [ |
||
| 87 | 'connection_string' => $connection_string, |
||
| 88 | 'encryption' => 'ssl', |
||
| 89 | 'version' => $version, |
||
| 90 | ] |
||
| 91 | ); |
||
| 92 | } |
||
| 93 | |||
| 94 | $searchScope = $this->ldapConfig->getString('search.scope', Query::SCOPE_SUB); |
||
| 95 | Assert::oneOf($searchScope, [Query::SCOPE_BASE, Query::SCOPE_ONE, Query::SCOPE_SUB]); |
||
| 96 | |||
| 97 | $referrals = $this->ldapConfig->getValue('referrals', Query::DEREF_NEVER); |
||
| 98 | Assert::oneOf($referrals, [Query::DEREF_ALWAYS, Query::DEREF_NEVER, Query::DEREF_FINDING, Query::DEREF_SEARCHING]); |
||
| 99 | |||
| 100 | $timeout = $this->ldapConfig->getString('timeout', 3); |
||
| 101 | $searchBase = $this->ldapConfig->getArray('search.base'); |
||
| 102 | $options = [ |
||
| 103 | 'scope' => $searchScope, |
||
| 104 | 'timeout' => $timeout, |
||
| 105 | 'deref' => $referrals, |
||
| 106 | ]; |
||
| 107 | |||
| 108 | $searchEnable = $this->ldapConfig->getBoolean('search.enable', false); |
||
| 109 | if ($searchEnable === false) { |
||
| 110 | $dnPattern = $this->ldapConfig->getString('dnpattern'); |
||
| 111 | $dn = str_replace('%username%', $username, $dnPattern); |
||
| 112 | |||
| 113 | $filter = ''; |
||
| 114 | } else { |
||
| 115 | $searchUsername = $this->ldapConfig->getString('search.username'); |
||
| 116 | Assert::notWhitespaceOnly($searchUsername); |
||
| 117 | |||
| 118 | $searchPassword = $this->ldapConfig->getString('search.password', null); |
||
| 119 | Assert::nullOrnotWhitespaceOnly($searchPassword); |
||
| 120 | |||
| 121 | $searchAttributes = $this->ldapConfig->getArray('search.attributes'); |
||
| 122 | $searchFilter = $this->ldapConfig->getString('search.filter', null); |
||
| 123 | |||
| 124 | $ldap = $this->bind($ldapServers, $searchUsername, $searchPassword); |
||
| 125 | |||
| 126 | $filter = ''; |
||
| 127 | foreach ($searchAttributes as $attr) { |
||
| 128 | $filter .= '(' . $attr . '=' . $username . ')'; |
||
| 129 | } |
||
| 130 | $filter = '(|' . $filter . ')'; |
||
| 131 | |||
| 132 | // Append LDAP filters if defined |
||
| 133 | if ($searchFilter !== null) { |
||
| 134 | $filter = "(&" . $filter . $searchFilter . ")"; |
||
| 135 | } |
||
| 136 | |||
| 137 | $entry = null; |
||
| 138 | foreach ($searchBase as $base) { |
||
| 139 | $query = $ldap->query($base, $filter, $options); |
||
| 140 | $result = $query->execute(); |
||
| 141 | $result = is_array($result) ? $result : $result->toArray(); |
||
| 142 | |||
| 143 | if (count($result) > 1) { |
||
| 144 | throw new Error\Exception( |
||
| 145 | sprintf( |
||
| 146 | "Library - LDAP search(): Found %d entries searching base '%s' for '%s'", |
||
| 147 | count($result), |
||
| 148 | $base, |
||
| 149 | $filter, |
||
| 150 | ) |
||
| 151 | ); |
||
| 152 | } elseif (count($result) === 1) { |
||
| 153 | $entry = array_pop($result); |
||
| 154 | break; |
||
| 155 | } else { |
||
| 156 | Logger::debug( |
||
| 157 | sprintf( |
||
| 158 | "Library - LDAP search(): Found no entries searching base '%s' for '%s'", |
||
| 159 | count($result), |
||
| 160 | $base, |
||
| 161 | $filter, |
||
| 162 | ) |
||
| 163 | ); |
||
| 164 | } |
||
| 165 | } |
||
| 166 | |||
| 167 | if ($entry === null) { |
||
| 168 | throw new Error\UserNotFound("User not found"); |
||
| 169 | } |
||
| 170 | |||
| 171 | $dn = $entry->getDn(); |
||
| 172 | } |
||
| 173 | |||
| 174 | $ldap = $this->bind($ldapServers, $dn, $password); |
||
| 175 | |||
| 176 | $entry = null; |
||
| 177 | foreach ($searchBase as $base) { |
||
| 178 | $query = $ldap->query($base, sprintf('(distinguishedName=%s)', $dn), $options); |
||
| 179 | $result = $query->execute(); |
||
| 180 | $result = is_array($result) ? $result : $result->toArray(); |
||
| 181 | |||
| 182 | if (count($result) > 1) { |
||
| 183 | throw new Error\Exception( |
||
| 184 | sprintf( |
||
| 185 | "Library - LDAP search(): Found %d entries searching base '%s' for '%s'", |
||
| 186 | count($result), |
||
| 187 | $base, |
||
| 188 | $filter, |
||
| 189 | ) |
||
| 190 | ); |
||
| 191 | } elseif (count($result) === 1) { |
||
| 192 | $entry = array_pop($result); |
||
| 193 | break; |
||
| 194 | } else { |
||
| 195 | Logger::debug( |
||
| 196 | sprintf( |
||
| 197 | "Library - LDAP search(): Found no entries searching base '%s' for '%s'", |
||
| 198 | count($result), |
||
| 199 | $base, |
||
| 200 | $filter, |
||
| 201 | ) |
||
| 202 | ); |
||
| 203 | } |
||
| 204 | } |
||
| 205 | |||
| 206 | if ($entry === null) { |
||
| 207 | throw new Error\UserNotFound("User not found"); |
||
| 208 | } |
||
| 209 | |||
| 210 | $attributes = $this->ldapConfig->getArray('attributes', []); |
||
| 211 | if ($attributes === ['*']) { |
||
| 212 | $result = $entry->getAttributes(); |
||
| 213 | } else { |
||
| 214 | $result = array_intersect_key( |
||
| 215 | $entry->getAttributes(), |
||
| 216 | array_fill_keys(array_values($attributes), null) |
||
| 217 | ); |
||
| 218 | } |
||
| 219 | |||
| 220 | $binaries = array_intersect( |
||
| 221 | array_keys($result), |
||
| 222 | $this->ldapConfig->getArray('attributes.binary', []), |
||
| 223 | ); |
||
| 224 | foreach ($binaries as $binary) { |
||
| 225 | $result[$binary] = array_map('base64_encode', $result[$binary]); |
||
| 226 | } |
||
| 227 | |||
| 228 | return $result; |
||
| 229 | } |
||
| 249 |