nextcloud /
server
| Total Complexity | 62 |
| Total Lines | 365 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Manager 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.
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 Manager, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 67 | class Manager extends PublicEmitter implements IGroupManager { |
||
|
Deprecated Code
introduced
by
|
|||
| 68 | /** @var GroupInterface[] */ |
||
| 69 | private $backends = []; |
||
| 70 | |||
| 71 | /** @var \OC\User\Manager */ |
||
| 72 | private $userManager; |
||
| 73 | /** @var EventDispatcherInterface */ |
||
| 74 | private $dispatcher; |
||
| 75 | private LoggerInterface $logger; |
||
| 76 | |||
| 77 | /** @var \OC\Group\Group[] */ |
||
| 78 | private $cachedGroups = []; |
||
| 79 | |||
| 80 | /** @var (string[])[] */ |
||
| 81 | private $cachedUserGroups = []; |
||
| 82 | |||
| 83 | /** @var \OC\SubAdmin */ |
||
| 84 | private $subAdmin = null; |
||
| 85 | |||
| 86 | private DisplayNameCache $displayNameCache; |
||
| 87 | |||
| 88 | public function __construct(\OC\User\Manager $userManager, |
||
| 89 | EventDispatcherInterface $dispatcher, |
||
| 90 | LoggerInterface $logger, |
||
| 91 | ICacheFactory $cacheFactory) { |
||
| 92 | $this->userManager = $userManager; |
||
| 93 | $this->dispatcher = $dispatcher; |
||
| 94 | $this->logger = $logger; |
||
| 95 | $this->displayNameCache = new DisplayNameCache($cacheFactory, $this); |
||
| 96 | |||
| 97 | $cachedGroups = &$this->cachedGroups; |
||
| 98 | $cachedUserGroups = &$this->cachedUserGroups; |
||
| 99 | $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
||
| 100 | /** |
||
| 101 | * @var \OC\Group\Group $group |
||
| 102 | */ |
||
| 103 | unset($cachedGroups[$group->getGID()]); |
||
| 104 | $cachedUserGroups = []; |
||
| 105 | }); |
||
| 106 | $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
||
| 107 | /** |
||
| 108 | * @var \OC\Group\Group $group |
||
| 109 | */ |
||
| 110 | $cachedUserGroups = []; |
||
| 111 | }); |
||
| 112 | $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
||
| 113 | /** |
||
| 114 | * @var \OC\Group\Group $group |
||
| 115 | */ |
||
| 116 | $cachedUserGroups = []; |
||
| 117 | }); |
||
| 118 | } |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Checks whether a given backend is used |
||
| 122 | * |
||
| 123 | * @param string $backendClass Full classname including complete namespace |
||
| 124 | * @return bool |
||
| 125 | */ |
||
| 126 | public function isBackendUsed($backendClass) { |
||
| 127 | $backendClass = strtolower(ltrim($backendClass, '\\')); |
||
| 128 | |||
| 129 | foreach ($this->backends as $backend) { |
||
| 130 | if (strtolower(get_class($backend)) === $backendClass) { |
||
| 131 | return true; |
||
| 132 | } |
||
| 133 | } |
||
| 134 | |||
| 135 | return false; |
||
| 136 | } |
||
| 137 | |||
| 138 | /** |
||
| 139 | * @param \OCP\GroupInterface $backend |
||
| 140 | */ |
||
| 141 | public function addBackend($backend) { |
||
| 144 | } |
||
| 145 | |||
| 146 | public function clearBackends() { |
||
| 149 | } |
||
| 150 | |||
| 151 | /** |
||
| 152 | * Get the active backends |
||
| 153 | * |
||
| 154 | * @return \OCP\GroupInterface[] |
||
| 155 | */ |
||
| 156 | public function getBackends() { |
||
| 157 | return $this->backends; |
||
| 158 | } |
||
| 159 | |||
| 160 | |||
| 161 | protected function clearCaches() { |
||
| 162 | $this->cachedGroups = []; |
||
| 163 | $this->cachedUserGroups = []; |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * @param string $gid |
||
| 168 | * @return IGroup|null |
||
| 169 | */ |
||
| 170 | public function get($gid) { |
||
| 171 | if (isset($this->cachedGroups[$gid])) { |
||
| 172 | return $this->cachedGroups[$gid]; |
||
| 173 | } |
||
| 174 | return $this->getGroupObject($gid); |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * @param string $gid |
||
| 179 | * @param string $displayName |
||
| 180 | * @return \OCP\IGroup|null |
||
| 181 | */ |
||
| 182 | protected function getGroupObject($gid, $displayName = null) { |
||
| 183 | $backends = []; |
||
| 184 | foreach ($this->backends as $backend) { |
||
| 185 | if ($backend->implementsActions(Backend::GROUP_DETAILS)) { |
||
| 186 | $groupData = $backend->getGroupDetails($gid); |
||
| 187 | if (is_array($groupData) && !empty($groupData)) { |
||
| 188 | // take the display name from the first backend that has a non-null one |
||
| 189 | if (is_null($displayName) && isset($groupData['displayName'])) { |
||
| 190 | $displayName = $groupData['displayName']; |
||
| 191 | } |
||
| 192 | $backends[] = $backend; |
||
| 193 | } |
||
| 194 | } elseif ($backend->groupExists($gid)) { |
||
| 195 | $backends[] = $backend; |
||
| 196 | } |
||
| 197 | } |
||
| 198 | if (count($backends) === 0) { |
||
| 199 | return null; |
||
| 200 | } |
||
| 201 | $this->cachedGroups[$gid] = new Group($gid, $backends, $this->dispatcher, $this->userManager, $this, $displayName); |
||
| 202 | return $this->cachedGroups[$gid]; |
||
| 203 | } |
||
| 204 | |||
| 205 | /** |
||
| 206 | * @param string $gid |
||
| 207 | * @return bool |
||
| 208 | */ |
||
| 209 | public function groupExists($gid) { |
||
| 210 | return $this->get($gid) instanceof IGroup; |
||
| 211 | } |
||
| 212 | |||
| 213 | /** |
||
| 214 | * @param string $gid |
||
| 215 | * @return IGroup|null |
||
| 216 | */ |
||
| 217 | public function createGroup($gid) { |
||
| 234 | } |
||
| 235 | } |
||
| 236 | |||
| 237 | /** |
||
| 238 | * @param string $search |
||
| 239 | * @param int $limit |
||
| 240 | * @param int $offset |
||
| 241 | * @return \OC\Group\Group[] |
||
| 242 | */ |
||
| 243 | public function search($search, $limit = null, $offset = null) { |
||
| 260 | } |
||
| 261 | |||
| 262 | /** |
||
| 263 | * @param IUser|null $user |
||
| 264 | * @return \OC\Group\Group[] |
||
| 265 | */ |
||
| 266 | public function getUserGroups(IUser $user = null) { |
||
| 271 | } |
||
| 272 | |||
| 273 | /** |
||
| 274 | * @param string $uid the user id |
||
| 275 | * @return \OC\Group\Group[] |
||
| 276 | */ |
||
| 277 | public function getUserIdGroups(string $uid): array { |
||
| 278 | $groups = []; |
||
| 279 | |||
| 280 | foreach ($this->getUserIdGroupIds($uid) as $groupId) { |
||
| 281 | $aGroup = $this->get($groupId); |
||
| 282 | if ($aGroup instanceof IGroup) { |
||
| 283 | $groups[$groupId] = $aGroup; |
||
| 284 | } else { |
||
| 285 | $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']); |
||
| 286 | } |
||
| 287 | } |
||
| 288 | |||
| 289 | return $groups; |
||
| 290 | } |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Checks if a userId is in the admin group |
||
| 294 | * |
||
| 295 | * @param string $userId |
||
| 296 | * @return bool if admin |
||
| 297 | */ |
||
| 298 | public function isAdmin($userId) { |
||
| 299 | foreach ($this->backends as $backend) { |
||
| 300 | if ($backend->implementsActions(Backend::IS_ADMIN) && $backend->isAdmin($userId)) { |
||
| 301 | return true; |
||
| 302 | } |
||
| 303 | } |
||
| 304 | return $this->isInGroup($userId, 'admin'); |
||
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | * Checks if a userId is in a group |
||
| 309 | * |
||
| 310 | * @param string $userId |
||
| 311 | * @param string $group |
||
| 312 | * @return bool if in group |
||
| 313 | */ |
||
| 314 | public function isInGroup($userId, $group) { |
||
| 315 | return array_search($group, $this->getUserIdGroupIds($userId)) !== false; |
||
| 316 | } |
||
| 317 | |||
| 318 | /** |
||
| 319 | * get a list of group ids for a user |
||
| 320 | * |
||
| 321 | * @param IUser $user |
||
| 322 | * @return string[] with group ids |
||
| 323 | */ |
||
| 324 | public function getUserGroupIds(IUser $user): array { |
||
| 325 | return $this->getUserIdGroupIds($user->getUID()); |
||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * @param string $uid the user id |
||
| 330 | * @return string[] |
||
| 331 | */ |
||
| 332 | private function getUserIdGroupIds(string $uid): array { |
||
| 333 | if (!isset($this->cachedUserGroups[$uid])) { |
||
| 334 | $groups = []; |
||
| 335 | foreach ($this->backends as $backend) { |
||
| 336 | if ($groupIds = $backend->getUserGroups($uid)) { |
||
| 337 | $groups = array_merge($groups, $groupIds); |
||
| 338 | } |
||
| 339 | } |
||
| 340 | $this->cachedUserGroups[$uid] = $groups; |
||
| 341 | } |
||
| 342 | |||
| 343 | return $this->cachedUserGroups[$uid]; |
||
| 344 | } |
||
| 345 | |||
| 346 | /** |
||
| 347 | * @param string $groupId |
||
| 348 | * @return ?string |
||
| 349 | */ |
||
| 350 | public function getDisplayName(string $groupId): ?string { |
||
| 351 | return $this->displayNameCache->getDisplayName($groupId); |
||
| 352 | } |
||
| 353 | |||
| 354 | /** |
||
| 355 | * get an array of groupid and displayName for a user |
||
| 356 | * |
||
| 357 | * @param IUser $user |
||
| 358 | * @return array ['displayName' => displayname] |
||
| 359 | */ |
||
| 360 | public function getUserGroupNames(IUser $user) { |
||
| 361 | return array_map(function ($group) { |
||
| 362 | return ['displayName' => $this->displayNameCache->getDisplayName($group->getGID())]; |
||
| 363 | }, $this->getUserGroups($user)); |
||
| 364 | } |
||
| 365 | |||
| 366 | /** |
||
| 367 | * get a list of all display names in a group |
||
| 368 | * |
||
| 369 | * @param string $gid |
||
| 370 | * @param string $search |
||
| 371 | * @param int $limit |
||
| 372 | * @param int $offset |
||
| 373 | * @return array an array of display names (value) and user ids (key) |
||
| 374 | */ |
||
| 375 | public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
||
| 376 | $group = $this->get($gid); |
||
| 377 | if (is_null($group)) { |
||
| 378 | return []; |
||
| 379 | } |
||
| 380 | |||
| 381 | $search = trim($search); |
||
| 382 | $groupUsers = []; |
||
| 383 | |||
| 384 | if (!empty($search)) { |
||
| 385 | // only user backends have the capability to do a complex search for users |
||
| 386 | $searchOffset = 0; |
||
| 387 | $searchLimit = $limit * 100; |
||
| 388 | if ($limit === -1) { |
||
| 389 | $searchLimit = 500; |
||
| 390 | } |
||
| 391 | |||
| 392 | do { |
||
| 393 | $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
||
| 394 | foreach ($filteredUsers as $filteredUser) { |
||
| 395 | if ($group->inGroup($filteredUser)) { |
||
| 396 | $groupUsers[] = $filteredUser; |
||
| 397 | } |
||
| 398 | } |
||
| 399 | $searchOffset += $searchLimit; |
||
| 400 | } while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit); |
||
| 401 | |||
| 402 | if ($limit === -1) { |
||
| 403 | $groupUsers = array_slice($groupUsers, $offset); |
||
| 404 | } else { |
||
| 405 | $groupUsers = array_slice($groupUsers, $offset, $limit); |
||
| 406 | } |
||
| 407 | } else { |
||
| 408 | $groupUsers = $group->searchUsers('', $limit, $offset); |
||
| 409 | } |
||
| 410 | |||
| 411 | $matchingUsers = []; |
||
| 412 | foreach ($groupUsers as $groupUser) { |
||
| 413 | $matchingUsers[(string) $groupUser->getUID()] = $groupUser->getDisplayName(); |
||
| 414 | } |
||
| 415 | return $matchingUsers; |
||
| 416 | } |
||
| 417 | |||
| 418 | /** |
||
| 419 | * @return \OC\SubAdmin |
||
| 420 | */ |
||
| 421 | public function getSubAdmin() { |
||
| 432 | } |
||
| 433 | } |
||
| 434 |
Loading history...
