nextcloud /
server
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 Access 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 Access, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 52 | class Access extends LDAPUtility implements IUserTools { |
||
| 53 | /** |
||
| 54 | * @var \OCA\User_LDAP\Connection |
||
| 55 | */ |
||
| 56 | public $connection; |
||
| 57 | public $userManager; |
||
| 58 | //never ever check this var directly, always use getPagedSearchResultState |
||
| 59 | protected $pagedSearchedSuccessful; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * @var string[] $cookies an array of returned Paged Result cookies |
||
| 63 | */ |
||
| 64 | protected $cookies = array(); |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @var string $lastCookie the last cookie returned from a Paged Results |
||
| 68 | * operation, defaults to an empty string |
||
| 69 | */ |
||
| 70 | protected $lastCookie = ''; |
||
| 71 | |||
| 72 | /** |
||
| 73 | * @var AbstractMapping $userMapper |
||
| 74 | */ |
||
| 75 | protected $userMapper; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * @var AbstractMapping $userMapper |
||
| 79 | */ |
||
| 80 | protected $groupMapper; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * @var \OCA\User_LDAP\Helper |
||
| 84 | */ |
||
| 85 | private $helper; |
||
| 86 | |||
| 87 | public function __construct(Connection $connection, ILDAPWrapper $ldap, |
||
| 95 | |||
| 96 | /** |
||
| 97 | * sets the User Mapper |
||
| 98 | * @param AbstractMapping $mapper |
||
| 99 | */ |
||
| 100 | public function setUserMapper(AbstractMapping $mapper) { |
||
| 103 | |||
| 104 | /** |
||
| 105 | * returns the User Mapper |
||
| 106 | * @throws \Exception |
||
| 107 | * @return AbstractMapping |
||
| 108 | */ |
||
| 109 | public function getUserMapper() { |
||
| 115 | |||
| 116 | /** |
||
| 117 | * sets the Group Mapper |
||
| 118 | * @param AbstractMapping $mapper |
||
| 119 | */ |
||
| 120 | public function setGroupMapper(AbstractMapping $mapper) { |
||
| 123 | |||
| 124 | /** |
||
| 125 | * returns the Group Mapper |
||
| 126 | * @throws \Exception |
||
| 127 | * @return AbstractMapping |
||
| 128 | */ |
||
| 129 | public function getGroupMapper() { |
||
| 135 | |||
| 136 | /** |
||
| 137 | * @return bool |
||
| 138 | */ |
||
| 139 | private function checkConnection() { |
||
| 142 | |||
| 143 | /** |
||
| 144 | * returns the Connection instance |
||
| 145 | * @return \OCA\User_LDAP\Connection |
||
| 146 | */ |
||
| 147 | public function getConnection() { |
||
| 150 | |||
| 151 | /** |
||
| 152 | * reads a given attribute for an LDAP record identified by a DN |
||
| 153 | * @param string $dn the record in question |
||
| 154 | * @param string $attr the attribute that shall be retrieved |
||
| 155 | * if empty, just check the record's existence |
||
| 156 | * @param string $filter |
||
| 157 | * @return array|false an array of values on success or an empty |
||
| 158 | * array if $attr is empty, false otherwise |
||
| 159 | */ |
||
| 160 | public function readAttribute($dn, $attr, $filter = 'objectClass=*') { |
||
| 223 | |||
| 224 | /** |
||
| 225 | * checks whether the given attributes value is probably a DN |
||
| 226 | * @param string $attr the attribute in question |
||
| 227 | * @return boolean if so true, otherwise false |
||
| 228 | */ |
||
| 229 | private function resemblesDN($attr) { |
||
| 239 | |||
| 240 | /** |
||
| 241 | * checks whether the given string is probably a DN |
||
| 242 | * @param string $string |
||
| 243 | * @return boolean |
||
| 244 | */ |
||
| 245 | public function stringResemblesDN($string) { |
||
| 251 | |||
| 252 | /** |
||
| 253 | * returns a DN-string that is cleaned from not domain parts, e.g. |
||
| 254 | * cn=foo,cn=bar,dc=foobar,dc=server,dc=org |
||
| 255 | * becomes dc=foobar,dc=server,dc=org |
||
| 256 | * @param string $dn |
||
| 257 | * @return string |
||
| 258 | */ |
||
| 259 | public function getDomainDNFromDN($dn) { |
||
| 278 | |||
| 279 | /** |
||
| 280 | * returns the LDAP DN for the given internal ownCloud name of the group |
||
| 281 | * @param string $name the ownCloud name in question |
||
| 282 | * @return string|false LDAP DN on success, otherwise false |
||
| 283 | */ |
||
| 284 | public function groupname2dn($name) { |
||
| 287 | |||
| 288 | /** |
||
| 289 | * returns the LDAP DN for the given internal ownCloud name of the user |
||
| 290 | * @param string $name the ownCloud name in question |
||
| 291 | * @return string|false with the LDAP DN on success, otherwise false |
||
| 292 | */ |
||
| 293 | public function username2dn($name) { |
||
| 304 | |||
| 305 | /** |
||
| 306 | public function ocname2dn($name, $isUser) { |
||
| 307 | * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure |
||
| 308 | * @param string $fdn the dn of the group object |
||
| 309 | * @param string $ldapName optional, the display name of the object |
||
| 310 | * @return string|false with the name to use in ownCloud, false on DN outside of search DN |
||
| 311 | */ |
||
| 312 | View Code Duplication | public function dn2groupname($fdn, $ldapName = null) { |
|
| 322 | |||
| 323 | /** |
||
| 324 | * accepts an array of group DNs and tests whether they match the user |
||
| 325 | * filter by doing read operations against the group entries. Returns an |
||
| 326 | * array of DNs that match the filter. |
||
| 327 | * |
||
| 328 | * @param string[] $groupDNs |
||
| 329 | * @return string[] |
||
| 330 | */ |
||
| 331 | public function groupsMatchFilter($groupDNs) { |
||
| 361 | |||
| 362 | /** |
||
| 363 | * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure |
||
| 364 | * @param string $dn the dn of the user object |
||
| 365 | * @param string $ldapName optional, the display name of the object |
||
| 366 | * @return string|false with with the name to use in ownCloud |
||
| 367 | */ |
||
| 368 | View Code Duplication | public function dn2username($fdn, $ldapName = null) { |
|
| 378 | |||
| 379 | /** |
||
| 380 | * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN |
||
| 381 | * @param string $dn the dn of the user object |
||
| 382 | * @param string $ldapName optional, the display name of the object |
||
| 383 | * @param bool $isUser optional, whether it is a user object (otherwise group assumed) |
||
| 384 | * @return string|false with with the name to use in ownCloud |
||
| 385 | */ |
||
| 386 | public function dn2ocname($fdn, $ldapName = null, $isUser = true) { |
||
| 461 | |||
| 462 | /** |
||
| 463 | * gives back the user names as they are used ownClod internally |
||
| 464 | * @param array $ldapUsers as returned by fetchList() |
||
| 465 | * @return array an array with the user names to use in ownCloud |
||
| 466 | * |
||
| 467 | * gives back the user names as they are used ownClod internally |
||
| 468 | */ |
||
| 469 | public function ownCloudUserNames($ldapUsers) { |
||
| 472 | |||
| 473 | /** |
||
| 474 | * gives back the group names as they are used ownClod internally |
||
| 475 | * @param array $ldapGroups as returned by fetchList() |
||
| 476 | * @return array an array with the group names to use in ownCloud |
||
| 477 | * |
||
| 478 | * gives back the group names as they are used ownClod internally |
||
| 479 | */ |
||
| 480 | public function ownCloudGroupNames($ldapGroups) { |
||
| 483 | |||
| 484 | /** |
||
| 485 | * @param array $ldapObjects as returned by fetchList() |
||
| 486 | * @param bool $isUsers |
||
| 487 | * @return array |
||
| 488 | */ |
||
| 489 | private function ldap2ownCloudNames($ldapObjects, $isUsers) { |
||
| 525 | |||
| 526 | /** |
||
| 527 | * caches the user display name |
||
| 528 | * @param string $ocName the internal ownCloud username |
||
| 529 | * @param string|false $home the home directory path |
||
| 530 | */ |
||
| 531 | public function cacheUserHome($ocName, $home) { |
||
| 535 | |||
| 536 | /** |
||
| 537 | * caches a user as existing |
||
| 538 | * @param string $ocName the internal ownCloud username |
||
| 539 | */ |
||
| 540 | public function cacheUserExists($ocName) { |
||
| 543 | |||
| 544 | /** |
||
| 545 | * caches the user display name |
||
| 546 | * @param string $ocName the internal ownCloud username |
||
| 547 | * @param string $displayName the display name |
||
| 548 | * @param string $displayName2 the second display name |
||
| 549 | */ |
||
| 550 | public function cacheUserDisplayName($ocName, $displayName, $displayName2 = '') { |
||
| 556 | |||
| 557 | /** |
||
| 558 | * creates a unique name for internal ownCloud use for users. Don't call it directly. |
||
| 559 | * @param string $name the display name of the object |
||
| 560 | * @return string|false with with the name to use in ownCloud or false if unsuccessful |
||
| 561 | * |
||
| 562 | * Instead of using this method directly, call |
||
| 563 | * createAltInternalOwnCloudName($name, true) |
||
| 564 | */ |
||
| 565 | private function _createAltInternalOwnCloudNameForUsers($name) { |
||
| 578 | |||
| 579 | /** |
||
| 580 | * creates a unique name for internal ownCloud use for groups. Don't call it directly. |
||
| 581 | * @param string $name the display name of the object |
||
| 582 | * @return string|false with with the name to use in ownCloud or false if unsuccessful. |
||
| 583 | * |
||
| 584 | * Instead of using this method directly, call |
||
| 585 | * createAltInternalOwnCloudName($name, false) |
||
| 586 | * |
||
| 587 | * Group names are also used as display names, so we do a sequential |
||
| 588 | * numbering, e.g. Developers_42 when there are 41 other groups called |
||
| 589 | * "Developers" |
||
| 590 | */ |
||
| 591 | private function _createAltInternalOwnCloudNameForGroups($name) { |
||
| 616 | |||
| 617 | /** |
||
| 618 | * creates a unique name for internal ownCloud use. |
||
| 619 | * @param string $name the display name of the object |
||
| 620 | * @param boolean $isUser whether name should be created for a user (true) or a group (false) |
||
| 621 | * @return string|false with with the name to use in ownCloud or false if unsuccessful |
||
| 622 | */ |
||
| 623 | private function createAltInternalOwnCloudName($name, $isUser) { |
||
| 635 | |||
| 636 | /** |
||
| 637 | * fetches a list of users according to a provided loginName and utilizing |
||
| 638 | * the login filter. |
||
| 639 | * |
||
| 640 | * @param string $loginName |
||
| 641 | * @param array $attributes optional, list of attributes to read |
||
| 642 | * @return array |
||
| 643 | */ |
||
| 644 | View Code Duplication | public function fetchUsersByLoginName($loginName, $attributes = array('dn')) { |
|
| 650 | |||
| 651 | /** |
||
| 652 | * counts the number of users according to a provided loginName and |
||
| 653 | * utilizing the login filter. |
||
| 654 | * |
||
| 655 | * @param string $loginName |
||
| 656 | * @return array |
||
| 657 | */ |
||
| 658 | View Code Duplication | public function countUsersByLoginName($loginName) { |
|
| 664 | |||
| 665 | /** |
||
| 666 | * @param string $filter |
||
| 667 | * @param string|string[] $attr |
||
| 668 | * @param int $limit |
||
| 669 | * @param int $offset |
||
| 670 | * @return array |
||
| 671 | */ |
||
| 672 | public function fetchListOfUsers($filter, $attr, $limit = null, $offset = null) { |
||
| 677 | |||
| 678 | /** |
||
| 679 | * provided with an array of LDAP user records the method will fetch the |
||
| 680 | * user object and requests it to process the freshly fetched attributes and |
||
| 681 | * and their values |
||
| 682 | * @param array $ldapRecords |
||
| 683 | */ |
||
| 684 | public function batchApplyUserAttributes(array $ldapRecords){ |
||
| 711 | |||
| 712 | /** |
||
| 713 | * @param string $filter |
||
| 714 | * @param string|string[] $attr |
||
| 715 | * @param int $limit |
||
| 716 | * @param int $offset |
||
| 717 | * @return array |
||
| 718 | */ |
||
| 719 | public function fetchListOfGroups($filter, $attr, $limit = null, $offset = null) { |
||
| 722 | |||
| 723 | /** |
||
| 724 | * @param array $list |
||
| 725 | * @param bool $manyAttributes |
||
| 726 | * @return array |
||
| 727 | */ |
||
| 728 | private function fetchList($list, $manyAttributes) { |
||
| 745 | |||
| 746 | /** |
||
| 747 | * executes an LDAP search, optimized for Users |
||
| 748 | * @param string $filter the LDAP filter for the search |
||
| 749 | * @param string|string[] $attr optional, when a certain attribute shall be filtered out |
||
| 750 | * @param integer $limit |
||
| 751 | * @param integer $offset |
||
| 752 | * @return array with the search result |
||
| 753 | * |
||
| 754 | * Executes an LDAP search |
||
| 755 | */ |
||
| 756 | public function searchUsers($filter, $attr = null, $limit = null, $offset = null) { |
||
| 759 | |||
| 760 | /** |
||
| 761 | * @param string $filter |
||
| 762 | * @param string|string[] $attr |
||
| 763 | * @param int $limit |
||
| 764 | * @param int $offset |
||
| 765 | * @return false|int |
||
| 766 | */ |
||
| 767 | public function countUsers($filter, $attr = array('dn'), $limit = null, $offset = null) { |
||
| 770 | |||
| 771 | /** |
||
| 772 | * executes an LDAP search, optimized for Groups |
||
| 773 | * @param string $filter the LDAP filter for the search |
||
| 774 | * @param string|string[] $attr optional, when a certain attribute shall be filtered out |
||
| 775 | * @param integer $limit |
||
| 776 | * @param integer $offset |
||
| 777 | * @return array with the search result |
||
| 778 | * |
||
| 779 | * Executes an LDAP search |
||
| 780 | */ |
||
| 781 | public function searchGroups($filter, $attr = null, $limit = null, $offset = null) { |
||
| 784 | |||
| 785 | /** |
||
| 786 | * returns the number of available groups |
||
| 787 | * @param string $filter the LDAP search filter |
||
| 788 | * @param string[] $attr optional |
||
| 789 | * @param int|null $limit |
||
| 790 | * @param int|null $offset |
||
| 791 | * @return int|bool |
||
| 792 | */ |
||
| 793 | public function countGroups($filter, $attr = array('dn'), $limit = null, $offset = null) { |
||
| 796 | |||
| 797 | /** |
||
| 798 | * returns the number of available objects on the base DN |
||
| 799 | * |
||
| 800 | * @param int|null $limit |
||
| 801 | * @param int|null $offset |
||
| 802 | * @return int|bool |
||
| 803 | */ |
||
| 804 | public function countObjects($limit = null, $offset = null) { |
||
| 807 | |||
| 808 | /** |
||
| 809 | * retrieved. Results will according to the order in the array. |
||
| 810 | * @param int $limit optional, maximum results to be counted |
||
| 811 | * @param int $offset optional, a starting point |
||
| 812 | * @return array|false array with the search result as first value and pagedSearchOK as |
||
| 813 | * second | false if not successful |
||
| 814 | */ |
||
| 815 | private function executeSearch($filter, $base, &$attr = null, $limit = null, $offset = null) { |
||
| 846 | |||
| 847 | /** |
||
| 848 | * processes an LDAP paged search operation |
||
| 849 | * @param array $sr the array containing the LDAP search resources |
||
| 850 | * @param string $filter the LDAP filter for the search |
||
| 851 | * @param array $base an array containing the LDAP subtree(s) that shall be searched |
||
| 852 | * @param int $iFoundItems number of results in the search operation |
||
| 853 | * @param int $limit maximum results to be counted |
||
| 854 | * @param int $offset a starting point |
||
| 855 | * @param bool $pagedSearchOK whether a paged search has been executed |
||
| 856 | * @param bool $skipHandling required for paged search when cookies to |
||
| 857 | * prior results need to be gained |
||
| 858 | * @return bool cookie validity, true if we have more pages, false otherwise. |
||
| 859 | */ |
||
| 860 | private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) { |
||
| 892 | |||
| 893 | /** |
||
| 894 | * executes an LDAP search, but counts the results only |
||
| 895 | * @param string $filter the LDAP filter for the search |
||
| 896 | * @param array $base an array containing the LDAP subtree(s) that shall be searched |
||
| 897 | * @param string|string[] $attr optional, array, one or more attributes that shall be |
||
| 898 | * retrieved. Results will according to the order in the array. |
||
| 899 | * @param int $limit optional, maximum results to be counted |
||
| 900 | * @param int $offset optional, a starting point |
||
| 901 | * @param bool $skipHandling indicates whether the pages search operation is |
||
| 902 | * completed |
||
| 903 | * @return int|false Integer or false if the search could not be initialized |
||
| 904 | * |
||
| 905 | */ |
||
| 906 | private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
||
| 944 | |||
| 945 | /** |
||
| 946 | * @param array $searchResults |
||
| 947 | * @return int |
||
| 948 | */ |
||
| 949 | private function countEntriesInSearchResults($searchResults) { |
||
| 960 | |||
| 961 | /** |
||
| 962 | * Executes an LDAP search |
||
| 963 | * @param string $filter the LDAP filter for the search |
||
| 964 | * @param array $base an array containing the LDAP subtree(s) that shall be searched |
||
| 965 | * @param string|string[] $attr optional, array, one or more attributes that shall be |
||
| 966 | * @param int $limit |
||
| 967 | * @param int $offset |
||
| 968 | * @param bool $skipHandling |
||
| 969 | * @return array with the search result |
||
| 970 | */ |
||
| 971 | private function search($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
||
| 1064 | |||
| 1065 | /** |
||
| 1066 | * @param string $name |
||
| 1067 | * @return bool|mixed|string |
||
| 1068 | */ |
||
| 1069 | public function sanitizeUsername($name) { |
||
| 1086 | |||
| 1087 | /** |
||
| 1088 | * escapes (user provided) parts for LDAP filter |
||
| 1089 | * @param string $input, the provided value |
||
| 1090 | * @param bool $allowAsterisk whether in * at the beginning should be preserved |
||
| 1091 | * @return string the escaped string |
||
| 1092 | */ |
||
| 1093 | public function escapeFilterPart($input, $allowAsterisk = false) { |
||
| 1103 | |||
| 1104 | /** |
||
| 1105 | * combines the input filters with AND |
||
| 1106 | * @param string[] $filters the filters to connect |
||
| 1107 | * @return string the combined filter |
||
| 1108 | */ |
||
| 1109 | public function combineFilterWithAnd($filters) { |
||
| 1112 | |||
| 1113 | /** |
||
| 1114 | * combines the input filters with OR |
||
| 1115 | * @param string[] $filters the filters to connect |
||
| 1116 | * @return string the combined filter |
||
| 1117 | * Combines Filter arguments with OR |
||
| 1118 | */ |
||
| 1119 | public function combineFilterWithOr($filters) { |
||
| 1122 | |||
| 1123 | /** |
||
| 1124 | * combines the input filters with given operator |
||
| 1125 | * @param string[] $filters the filters to connect |
||
| 1126 | * @param string $operator either & or | |
||
| 1127 | * @return string the combined filter |
||
| 1128 | */ |
||
| 1129 | private function combineFilter($filters, $operator) { |
||
| 1140 | |||
| 1141 | /** |
||
| 1142 | * creates a filter part for to perform search for users |
||
| 1143 | * @param string $search the search term |
||
| 1144 | * @return string the final filter part to use in LDAP searches |
||
| 1145 | */ |
||
| 1146 | public function getFilterPartForUserSearch($search) { |
||
| 1151 | |||
| 1152 | /** |
||
| 1153 | * creates a filter part for to perform search for groups |
||
| 1154 | * @param string $search the search term |
||
| 1155 | * @return string the final filter part to use in LDAP searches |
||
| 1156 | */ |
||
| 1157 | public function getFilterPartForGroupSearch($search) { |
||
| 1162 | |||
| 1163 | /** |
||
| 1164 | * creates a filter part for searches by splitting up the given search |
||
| 1165 | * string into single words |
||
| 1166 | * @param string $search the search term |
||
| 1167 | * @param string[] $searchAttributes needs to have at least two attributes, |
||
| 1168 | * otherwise it does not make sense :) |
||
| 1169 | * @return string the final filter part to use in LDAP searches |
||
| 1170 | * @throws \Exception |
||
| 1171 | */ |
||
| 1172 | private function getAdvancedFilterPartForSearch($search, $searchAttributes) { |
||
| 1189 | |||
| 1190 | /** |
||
| 1191 | * creates a filter part for searches |
||
| 1192 | * @param string $search the search term |
||
| 1193 | * @param string[]|null $searchAttributes |
||
| 1194 | * @param string $fallbackAttribute a fallback attribute in case the user |
||
| 1195 | * did not define search attributes. Typically the display name attribute. |
||
| 1196 | * @return string the final filter part to use in LDAP searches |
||
| 1197 | */ |
||
| 1198 | private function getFilterPartForSearch($search, $searchAttributes, $fallbackAttribute) { |
||
| 1229 | |||
| 1230 | /** |
||
| 1231 | * returns the search term depending on whether we are allowed |
||
| 1232 | * list users found by ldap with the current input appended by |
||
| 1233 | * a * |
||
| 1234 | * @return string |
||
| 1235 | */ |
||
| 1236 | private function prepareSearchTerm($term) { |
||
| 1245 | |||
| 1246 | /** |
||
| 1247 | * returns the filter used for counting users |
||
| 1248 | * @return string |
||
| 1249 | */ |
||
| 1250 | public function getFilterForUserCount() { |
||
| 1258 | |||
| 1259 | /** |
||
| 1260 | * @param string $name |
||
| 1261 | * @param string $password |
||
| 1262 | * @return bool |
||
| 1263 | */ |
||
| 1264 | public function areCredentialsValid($name, $password) { |
||
| 1276 | |||
| 1277 | /** |
||
| 1278 | * reverse lookup of a DN given a known UUID |
||
| 1279 | * |
||
| 1280 | * @param string $uuid |
||
| 1281 | * @return string |
||
| 1282 | * @throws \Exception |
||
| 1283 | */ |
||
| 1284 | public function getUserDnByUuid($uuid) { |
||
| 1324 | |||
| 1325 | /** |
||
| 1326 | * auto-detects the directory's UUID attribute |
||
| 1327 | * @param string $dn a known DN used to check against |
||
| 1328 | * @param bool $isUser |
||
| 1329 | * @param bool $force the detection should be run, even if it is not set to auto |
||
| 1330 | * @return bool true on success, false otherwise |
||
| 1331 | */ |
||
| 1332 | private function detectUuidAttribute($dn, $isUser = true, $force = false) { |
||
| 1369 | |||
| 1370 | /** |
||
| 1371 | * @param string $dn |
||
| 1372 | * @param bool $isUser |
||
| 1373 | * @return string|bool |
||
| 1374 | */ |
||
| 1375 | public function getUUID($dn, $isUser = true) { |
||
| 1400 | |||
| 1401 | /** |
||
| 1402 | * converts a binary ObjectGUID into a string representation |
||
| 1403 | * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD |
||
| 1404 | * @return string |
||
| 1405 | * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198 |
||
| 1406 | */ |
||
| 1407 | private function convertObjectGUID2Str($oguid) { |
||
| 1426 | |||
| 1427 | /** |
||
| 1428 | * the first three blocks of the string-converted GUID happen to be in |
||
| 1429 | * reverse order. In order to use it in a filter, this needs to be |
||
| 1430 | * corrected. Furthermore the dashes need to be replaced and \\ preprended |
||
| 1431 | * to every two hax figures. |
||
| 1432 | * |
||
| 1433 | * If an invalid string is passed, it will be returned without change. |
||
| 1434 | * |
||
| 1435 | * @param string $guid |
||
| 1436 | * @return string |
||
| 1437 | */ |
||
| 1438 | public function formatGuid2ForFilterUser($guid) { |
||
| 1473 | |||
| 1474 | /** |
||
| 1475 | * gets a SID of the domain of the given dn |
||
| 1476 | * @param string $dn |
||
| 1477 | * @return string|bool |
||
| 1478 | */ |
||
| 1479 | public function getSID($dn) { |
||
| 1497 | |||
| 1498 | /** |
||
| 1499 | * converts a binary SID into a string representation |
||
| 1500 | * @param string $sid |
||
| 1501 | * @return string |
||
| 1502 | */ |
||
| 1503 | public function convertSID2Str($sid) { |
||
| 1535 | |||
| 1536 | /** |
||
| 1537 | * checks if the given DN is part of the given base DN(s) |
||
| 1538 | * @param string $dn the DN |
||
| 1539 | * @param string[] $bases array containing the allowed base DN or DNs |
||
| 1540 | * @return bool |
||
| 1541 | */ |
||
| 1542 | public function isDNPartOfBase($dn, $bases) { |
||
| 1557 | |||
| 1558 | /** |
||
| 1559 | * resets a running Paged Search operation |
||
| 1560 | */ |
||
| 1561 | private function abandonPagedSearch() { |
||
| 1570 | |||
| 1571 | /** |
||
| 1572 | * get a cookie for the next LDAP paged search |
||
| 1573 | * @param string $base a string with the base DN for the search |
||
| 1574 | * @param string $filter the search filter to identify the correct search |
||
| 1575 | * @param int $limit the limit (or 'pageSize'), to identify the correct search well |
||
| 1576 | * @param int $offset the offset for the new search to identify the correct search really good |
||
| 1577 | * @return string containing the key or empty if none is cached |
||
| 1578 | */ |
||
| 1579 | private function getPagedResultCookie($base, $filter, $limit, $offset) { |
||
| 1595 | |||
| 1596 | /** |
||
| 1597 | * checks whether an LDAP paged search operation has more pages that can be |
||
| 1598 | * retrieved, typically when offset and limit are provided. |
||
| 1599 | * |
||
| 1600 | * Be very careful to use it: the last cookie value, which is inspected, can |
||
| 1601 | * be reset by other operations. Best, call it immediately after a search(), |
||
| 1602 | * searchUsers() or searchGroups() call. count-methods are probably safe as |
||
| 1603 | * well. Don't rely on it with any fetchList-method. |
||
| 1604 | * @return bool |
||
| 1605 | */ |
||
| 1606 | public function hasMoreResults() { |
||
| 1619 | |||
| 1620 | /** |
||
| 1621 | * set a cookie for LDAP paged search run |
||
| 1622 | * @param string $base a string with the base DN for the search |
||
| 1623 | * @param string $filter the search filter to identify the correct search |
||
| 1624 | * @param int $limit the limit (or 'pageSize'), to identify the correct search well |
||
| 1625 | * @param int $offset the offset for the run search to identify the correct search really good |
||
| 1626 | * @param string $cookie string containing the cookie returned by ldap_control_paged_result_response |
||
| 1627 | * @return void |
||
| 1628 | */ |
||
| 1629 | private function setPagedResultCookie($base, $filter, $limit, $offset, $cookie) { |
||
| 1637 | |||
| 1638 | /** |
||
| 1639 | * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. |
||
| 1640 | * @return boolean|null true on success, null or false otherwise |
||
| 1641 | */ |
||
| 1642 | public function getPagedSearchResultState() { |
||
| 1647 | |||
| 1648 | /** |
||
| 1649 | * Prepares a paged search, if possible |
||
| 1650 | * @param string $filter the LDAP filter for the search |
||
| 1651 | * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched |
||
| 1652 | * @param string[] $attr optional, when a certain attribute shall be filtered outside |
||
| 1653 | * @param int $limit |
||
| 1654 | * @param int $offset |
||
| 1655 | * @return bool|true |
||
| 1656 | */ |
||
| 1657 | private function initPagedSearch($filter, $bases, $attr, $limit, $offset) { |
||
| 1725 | |||
| 1726 | } |
||
| 1727 |
Loading history...
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: