BurningFlipside /
CommonCode
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:
Complex classes like AuthProvider often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AuthProvider, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class AuthProvider extends Singleton |
||
| 29 | { |
||
| 30 | /** The authentication methods loaded by the provider */ |
||
| 31 | protected $methods; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Load the authentrication providers specified in the FlipsideSettings::$authProviders array |
||
| 35 | */ |
||
| 36 | View Code Duplication | protected function __construct() |
|
| 50 | |||
| 51 | /** |
||
| 52 | * Get the Authenticator class instance by name |
||
| 53 | * |
||
| 54 | * @param string $methodName The class name of the Authenticator to get the instance for |
||
| 55 | * |
||
| 56 | * @return Auth\Authenticator|false The specified Authenticator class instance or false if it is not loaded |
||
| 57 | */ |
||
| 58 | View Code Duplication | public function getAuthenticator($methodName) |
|
| 70 | |||
| 71 | /** |
||
| 72 | * Get the Auth\User class instance for the specified login |
||
| 73 | * |
||
| 74 | * Unlike the AuthProvider::login() function. This function will not impact the SESSION |
||
| 75 | * |
||
| 76 | * @param string $username The username of the User |
||
| 77 | * @param string $password The password of the User |
||
| 78 | * |
||
| 79 | * @return Auth\User|false The User with the specified credentials or false if the credentials are not valid |
||
| 80 | */ |
||
| 81 | public function getUserByLogin($username, $password) |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Use the provided credetials to log the user on |
||
| 98 | * |
||
| 99 | * @param string $username The username of the User |
||
| 100 | * @param string $password The password of the User |
||
| 101 | * |
||
| 102 | * @return true|false true if the login was successful, false otherwise |
||
| 103 | */ |
||
| 104 | public function login($username, $password) |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Determine if the user is still logged on from the session data |
||
| 123 | * |
||
| 124 | * @param stdClass $data The AuthData from the session |
||
| 125 | * @param string $methodName The AuthMethod from the session |
||
| 126 | * |
||
| 127 | * @return true|false true if user is logged on, false otherwise |
||
| 128 | */ |
||
| 129 | public function isLoggedIn($data, $methodName) |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Obtain the currently logged in user from the session data |
||
| 137 | * |
||
| 138 | * @param stdClass $data The AuthData from the session |
||
| 139 | * @param string $methodName The AuthMethod from the session |
||
| 140 | * |
||
| 141 | * @return Auth\User|false The User instance if user is logged on, false otherwise |
||
| 142 | */ |
||
| 143 | public function getUser($data, $methodName) |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Merge or set the returnValue as appropriate |
||
| 151 | * |
||
| 152 | * @param false|Auth\Group|Auth\User $returnValue The value to merge to |
||
| 153 | * @param Auth\Group|Auth\User $res The value to merge from |
||
| 154 | * |
||
| 155 | * @return Auth\Group|false The merged returnValue |
||
| 156 | */ |
||
| 157 | private function mergeResult(&$returnValue, $res) |
||
| 170 | |||
| 171 | /** |
||
| 172 | * Calls the indicated function on each Authenticator and merges the result |
||
| 173 | * |
||
| 174 | * @param string $functionName The function to call |
||
| 175 | * @param array $args The arguments for the function |
||
| 176 | * @param string $checkField A field to check if it is set a certain way before calling the function |
||
| 177 | * @param mixed $checkValue The value that field should be set to to not call the function |
||
| 178 | * |
||
| 179 | * @return Auth\Group|Auth\User|false The merged returnValue |
||
| 180 | */ |
||
| 181 | View Code Duplication | private function callOnEach($functionName, $args, $checkField = false, $checkValue = false) |
|
| 199 | |||
| 200 | /** |
||
| 201 | * Calls the indicated function on each Authenticator and add the result |
||
| 202 | * |
||
| 203 | * @param string $functionName The function to call |
||
| 204 | * @param string $checkField A field to check if it is set a certain way before calling the function |
||
| 205 | * @param mixed $checkValue The value that field should be set to to not call the function |
||
| 206 | * |
||
| 207 | * @return integer The added returnValue |
||
| 208 | */ |
||
| 209 | View Code Duplication | private function addFromEach($functionName, $checkField = false, $checkValue = false) |
|
| 227 | |||
| 228 | /** |
||
| 229 | * Get an Auth\Group by its name |
||
| 230 | * |
||
| 231 | * @param string $name The name of the group |
||
| 232 | * @param string $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 233 | * |
||
| 234 | * @return Auth\Group|false The Group instance if a group with that name exists, false otherwise |
||
| 235 | */ |
||
| 236 | public function getGroupByName($name, $methodName = false) |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Get an array of Auth\User from a filtered set |
||
| 248 | * |
||
| 249 | * @param Data\Filter|false $filter The filter conditions or false to retreive all |
||
| 250 | * @param array|false $methodName The user fields to obtain or false to obtain all |
||
| 251 | * @param integer|false $top The number of users to obtain or false to obtain all |
||
| 252 | * @param integer|false $skip The number of users to skip or false to skip none |
||
| 253 | * @param array|false $orderby The field to sort by and the method to sort or false to not sort |
||
| 254 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 255 | * |
||
| 256 | * @return array|false An array of Auth\User objects or false if no users were found |
||
| 257 | */ |
||
| 258 | View Code Duplication | public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false, $methodName = false) |
|
| 267 | |||
| 268 | /** |
||
| 269 | * Get an array of Auth\PendingUser from a filtered set |
||
| 270 | * |
||
| 271 | * @param Data\Filter|false $filter The filter conditions or false to retreive all |
||
| 272 | * @param array|false $methodName The user fields to obtain or false to obtain all |
||
| 273 | * @param integer|false $top The number of users to obtain or false to obtain all |
||
| 274 | * @param integer|false $skip The number of users to skip or false to skip none |
||
| 275 | * @param array|false $orderby The field to sort by and the method to sort or false to not sort |
||
| 276 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 277 | * |
||
| 278 | * @return array|false An array of Auth\PendingUser objects or false if no pending users were found |
||
| 279 | */ |
||
| 280 | View Code Duplication | public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false, $methodName = false) |
|
| 289 | |||
| 290 | /** |
||
| 291 | * Get an array of Auth\Group from a filtered set |
||
| 292 | * |
||
| 293 | * @param Data\Filter|false $filter The filter conditions or false to retreive all |
||
| 294 | * @param array|false $methodName The group fields to obtain or false to obtain all |
||
| 295 | * @param integer|false $top The number of groups to obtain or false to obtain all |
||
| 296 | * @param integer|false $skip The number of groups to skip or false to skip none |
||
| 297 | * @param array|false $orderby The field to sort by and the method to sort or false to not sort |
||
| 298 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 299 | * |
||
| 300 | * @return array|false An array of Auth\Group objects or false if no pending users were found |
||
| 301 | */ |
||
| 302 | View Code Duplication | public function getGroupsByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false, $methodName = false) |
|
| 311 | |||
| 312 | /** |
||
| 313 | * Get the number of currently active users on the system |
||
| 314 | * |
||
| 315 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 316 | * |
||
| 317 | * @return integer The number of currently active users on the system |
||
| 318 | */ |
||
| 319 | public function getActiveUserCount($methodName = false) |
||
| 328 | |||
| 329 | /** |
||
| 330 | * Get the number of currently pending users on the system |
||
| 331 | * |
||
| 332 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 333 | * |
||
| 334 | * @return integer The number of currently pending users on the system |
||
| 335 | */ |
||
| 336 | public function getPendingUserCount($methodName = false) |
||
| 345 | |||
| 346 | /** |
||
| 347 | * Get the number of current groups on the system |
||
| 348 | * |
||
| 349 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 350 | * |
||
| 351 | * @return integer The number of current groups on the system |
||
| 352 | */ |
||
| 353 | public function getGroupCount($methodName = false) |
||
| 362 | |||
| 363 | /** |
||
| 364 | * Get the login links for all supplementary Authenitcation mechanisms |
||
| 365 | * |
||
| 366 | * This will return an array of links to any supplementary authentication mechanims. For example, Goodle is |
||
| 367 | * a supplementary authentication mechanism. |
||
| 368 | * |
||
| 369 | * @return array An array of suppmentary authentication mechanism links |
||
| 370 | */ |
||
| 371 | public function getSupplementaryLinks() |
||
| 383 | |||
| 384 | /** |
||
| 385 | * Impersonate the user specified |
||
| 386 | * |
||
| 387 | * This will replace the user in the session with the specified user. In order |
||
| 388 | * to undo this operation a user must logout. |
||
| 389 | * |
||
| 390 | * @param array|Auth\User $userArray Data representing the user |
||
| 391 | */ |
||
| 392 | public function impersonateUser($userArray) |
||
| 400 | |||
| 401 | /** |
||
| 402 | * Get the pending user reresented by the supplied hash |
||
| 403 | * |
||
| 404 | * @param string $hash The hash value representing the Penging User |
||
| 405 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 406 | * |
||
| 407 | * @return Auth\PendingUser|false The Auth\PendingUser instance or false if no user is matched by the provided hash |
||
| 408 | */ |
||
| 409 | public function getTempUserByHash($hash, $methodName = false) |
||
| 429 | |||
| 430 | /** |
||
| 431 | * Create a pending user |
||
| 432 | * |
||
| 433 | * @param array $user An array of information about the user to create |
||
| 434 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 435 | * |
||
| 436 | * @return true|false true if the user was successfully created. Otherwise false. |
||
| 437 | */ |
||
| 438 | public function createPendingUser($user, $methodName = false) |
||
| 458 | |||
| 459 | /** |
||
| 460 | * Convert a Auth\PendingUser into an Auth\User |
||
| 461 | * |
||
| 462 | * This will allow a previously pending user the ability to log on in the future as an active user. It will also |
||
| 463 | * have the side effect of logging the user on now. |
||
| 464 | * |
||
| 465 | * @param Auth\PendingUser $user The user to turn into a current user |
||
| 466 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 467 | * |
||
| 468 | * @return true|false true if the user was successfully created. Otherwise false. |
||
| 469 | */ |
||
| 470 | View Code Duplication | public function activatePendingUser($user, $methodName = false) |
|
| 491 | |||
| 492 | /** |
||
| 493 | * Get a current user by a password reset hash |
||
| 494 | * |
||
| 495 | * @param string $hash The current password reset hash for the user |
||
| 496 | * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator |
||
| 497 | * |
||
| 498 | * @return Auth\User|false The user if the password reset hash is valid. Otherwise false. |
||
| 499 | */ |
||
| 500 | View Code Duplication | public function getUserByResetHash($hash, $methodName = false) |
|
| 524 | |||
| 525 | /** |
||
| 526 | * Get the Auth\Authenticator by host name |
||
| 527 | * |
||
| 528 | * @param string $host The host name used by the supplemental authentication mechanism |
||
| 529 | * |
||
| 530 | * @return Auth\Authenticator|false The Authenticator if the host is supported by a loaded Authenticator. Otherwise false. |
||
| 531 | */ |
||
| 532 | public function getSuplementalProviderByHost($host) |
||
| 533 | { |
||
| 534 | $count = count($this->methods); |
||
| 535 | View Code Duplication | for($i = 0; $i < $count; $i++) |
|
| 536 | { |
||
| 537 | if($this->methods[$i]->supplement === false) continue; |
||
| 538 | |||
| 539 | if($this->methods[$i]->getHostName() === $host) |
||
| 540 | { |
||
| 541 | return $this->methods[$i]; |
||
| 542 | } |
||
| 543 | } |
||
| 544 | return false; |
||
| 545 | } |
||
| 546 | |||
| 547 | public function deletePendingUsersByFilter($filter, $methodName=false) |
||
| 561 | } |
||
| 562 | /* vim: set tabstop=4 shiftwidth=4 expandtab: */ |
||
| 564 |
Loading history...
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.