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 |
||
| 42 | class LocalFilesService { |
||
| 43 | |||
| 44 | /** @var IRootFolder */ |
||
| 45 | private $rootFolder; |
||
| 46 | |||
| 47 | /** @var IGroupManager */ |
||
| 48 | private $groupManager; |
||
| 49 | |||
| 50 | /** @var IUserManager */ |
||
| 51 | private $userManager; |
||
| 52 | |||
| 53 | /** @var IManager */ |
||
| 54 | private $shareManager; |
||
| 55 | |||
| 56 | /** @var SharesRequest */ |
||
| 57 | private $sharesRequest; |
||
| 58 | |||
| 59 | /** @var ConfigService */ |
||
| 60 | private $configService; |
||
| 61 | |||
| 62 | /** @var MiscService */ |
||
| 63 | private $miscService; |
||
| 64 | |||
| 65 | |||
| 66 | /** |
||
| 67 | * ExternalFilesService constructor. |
||
| 68 | * |
||
| 69 | * @param IRootFolder $rootFolder |
||
| 70 | * @param IGroupManager $groupManager |
||
| 71 | * @param IUserManager $userManager |
||
| 72 | * @param IManager $shareManager |
||
| 73 | * @param SharesRequest $sharesRequest |
||
| 74 | * @param ConfigService $configService |
||
| 75 | * @param MiscService $miscService |
||
| 76 | */ |
||
| 77 | View Code Duplication | public function __construct( |
|
| 91 | |||
| 92 | |||
| 93 | /** |
||
| 94 | * @param Node $file |
||
| 95 | * @param string $source |
||
| 96 | */ |
||
| 97 | public function getFileSource(Node $file, &$source) { |
||
| 100 | |||
| 101 | |||
| 102 | /** |
||
| 103 | * @param FilesDocument $document |
||
| 104 | * @param Node $file |
||
| 105 | */ |
||
| 106 | public function updateDocumentAccess(FilesDocument $document, Node $file) { |
||
| 125 | |||
| 126 | |||
| 127 | /** |
||
| 128 | * @param Node $file |
||
| 129 | * @param array $users |
||
| 130 | */ |
||
| 131 | public function getShareUsersFromFile(Node $file, &$users) { |
||
| 151 | |||
| 152 | |||
| 153 | /** |
||
| 154 | * same a getShareUsers, but we do it 'manually' |
||
| 155 | * |
||
| 156 | * @param DocumentAccess $access |
||
| 157 | * @param array $users |
||
| 158 | */ |
||
| 159 | public function getSharedUsersFromAccess(DocumentAccess $access, &$users) { |
||
| 173 | |||
| 174 | |||
| 175 | /** |
||
| 176 | * @param DocumentAccess $access |
||
| 177 | * |
||
| 178 | * @return array |
||
| 179 | */ |
||
| 180 | private function getSharedUsersFromAccessGroups(DocumentAccess $access) { |
||
| 195 | |||
| 196 | |||
| 197 | /** |
||
| 198 | * // TODO: get users from circles. |
||
| 199 | * |
||
| 200 | * @param DocumentAccess $access |
||
| 201 | * |
||
| 202 | * @return array |
||
| 203 | */ |
||
| 204 | private function getSharedUsersFromAccessCircles(DocumentAccess $access) { |
||
| 209 | |||
| 210 | |||
| 211 | /** |
||
| 212 | * @param Node $file |
||
| 213 | * @param FileShares $fileShares |
||
| 214 | */ |
||
| 215 | private function getSharesFromFile(Node $file, FileShares $fileShares) { |
||
| 236 | |||
| 237 | |||
| 238 | /** |
||
| 239 | * @param Node $file |
||
| 240 | * @param FileShares $fileShares |
||
| 241 | */ |
||
| 242 | private function getSharesFromParent(Node $file, FileShares $fileShares) { |
||
| 252 | |||
| 253 | |||
| 254 | /** |
||
| 255 | * @param array $share |
||
| 256 | * @param FileShares $fileShares |
||
| 257 | */ |
||
| 258 | private function parseUsersShares($share, FileShares $fileShares) { |
||
| 265 | |||
| 266 | |||
| 267 | /** |
||
| 268 | * @param array $share |
||
| 269 | * @param FileShares $fileShares |
||
| 270 | */ |
||
| 271 | private function parseUsersGroups($share, FileShares $fileShares) { |
||
| 278 | |||
| 279 | |||
| 280 | /** |
||
| 281 | * @param array $share |
||
| 282 | * @param FileShares $fileShares |
||
| 283 | */ |
||
| 284 | private function parseUsersCircles($share, FileShares $fileShares) { |
||
| 291 | |||
| 292 | |||
| 293 | /** |
||
| 294 | * @param array $share |
||
| 295 | * @param FileShares $fileShares |
||
| 296 | */ |
||
| 297 | private function parseUsersLinks($share, FileShares $fileShares) { |
||
| 304 | |||
| 305 | |||
| 306 | // |
||
| 307 | // |
||
| 308 | // /** |
||
| 309 | // * @param DocumentAccess $access |
||
| 310 | // * |
||
| 311 | // * @return array |
||
| 312 | // */ |
||
| 313 | // public function getAllSharesFromExternalFile(DocumentAccess $access) { |
||
| 314 | // $result = $access->getUsers(); |
||
| 315 | // |
||
| 316 | // if ($access->getOwnerId() !== '') { |
||
| 317 | // array_push($result, $access->getOwnerId()); |
||
| 318 | // } |
||
| 319 | // |
||
| 320 | // // TODO: get users from groups & circles. |
||
| 321 | // return $result; |
||
| 322 | // } |
||
| 323 | // |
||
| 324 | // |
||
| 325 | // /** |
||
| 326 | // * @param FilesDocument $document |
||
| 327 | // * @param Node $file |
||
| 328 | // */ |
||
| 329 | // public function updateDocumentAccessFromExternalFile(FilesDocument &$document, Node $file) { |
||
| 330 | // |
||
| 331 | // if ($document->getSource() !== self::DOCUMENT_SOURCE) { |
||
| 332 | // return; |
||
| 333 | // } |
||
| 334 | // |
||
| 335 | // try { |
||
| 336 | // $mount = $this->getExternalMount($file); |
||
| 337 | // } catch (FileIsNotIndexableException $e) { |
||
| 338 | // return; |
||
| 339 | // } |
||
| 340 | // |
||
| 341 | // $access = $document->getAccess(); |
||
| 342 | // |
||
| 343 | // if ($this->isMountFullGlobal($mount)) { |
||
| 344 | // $access->addUsers(['__all']); |
||
| 345 | // } else { |
||
| 346 | // $access->addUsers($mount->getUsers()); |
||
| 347 | // $access->addGroups($mount->getGroups()); |
||
| 348 | //// $access->addCircles($mount->getCircles()); |
||
| 349 | // } |
||
| 350 | // |
||
| 351 | // // twist 'n tweak. |
||
| 352 | // if (!$mount->isGlobal()) { |
||
| 353 | // $access->setOwnerId($mount->getUsers()[0]); |
||
| 354 | // } |
||
| 355 | // |
||
| 356 | // $document->setAccess($access); |
||
| 357 | // } |
||
| 358 | // |
||
| 359 | // |
||
| 360 | // /** |
||
| 361 | // * @param ExternalMount $mount |
||
| 362 | // * |
||
| 363 | // * @return bool |
||
| 364 | // */ |
||
| 365 | // public function isMountFullGlobal(ExternalMount $mount) { |
||
| 366 | // if (sizeof($mount->getGroups()) > 0) { |
||
| 367 | // return false; |
||
| 368 | // } |
||
| 369 | // |
||
| 370 | // if (sizeof($mount->getUsers()) !== 1) { |
||
| 371 | // return false; |
||
| 372 | // } |
||
| 373 | // |
||
| 374 | // if ($mount->getUsers()[0] === 'all') { |
||
| 375 | // return true; |
||
| 376 | // } |
||
| 377 | // |
||
| 378 | // return false; |
||
| 379 | // } |
||
| 380 | // |
||
| 381 | // |
||
| 382 | // /** |
||
| 383 | // * @param Node $file |
||
| 384 | // * |
||
| 385 | // * @return ExternalMount |
||
| 386 | // * @throws FileIsNotIndexableException |
||
| 387 | // */ |
||
| 388 | // private function getExternalMount(Node $file) { |
||
| 389 | // |
||
| 390 | // foreach ($this->externalMounts as $mount) { |
||
| 391 | // if (strpos($file->getPath(), $mount->getPath()) === 0) { |
||
| 392 | // return $mount; |
||
| 393 | // } |
||
| 394 | // } |
||
| 395 | // |
||
| 396 | // throw new FileIsNotIndexableException(); |
||
| 397 | // } |
||
| 398 | // |
||
| 399 | // |
||
| 400 | // /** |
||
| 401 | // * @param $userId |
||
| 402 | // * |
||
| 403 | // * @return ExternalMount[] |
||
| 404 | // */ |
||
| 405 | // private function getExternalMountsForUser($userId) { |
||
| 406 | // |
||
| 407 | // $externalMounts = []; |
||
| 408 | // |
||
| 409 | // // TODO: deprecated - use UserGlobalStoragesService::getStorages() and UserStoragesService::getStorages() |
||
| 410 | // $mounts = \OC_Mount_Config::getAbsoluteMountPoints($userId); |
||
| 411 | // foreach ($mounts as $mountPoint => $mount) { |
||
| 412 | // $externalMount = new ExternalMount(); |
||
| 413 | // $externalMount->setId($mount['id']) |
||
| 414 | // ->setPath($mountPoint) |
||
| 415 | // ->setGroups($mount['applicable']['groups']) |
||
| 416 | // ->setUsers($mount['applicable']['users']) |
||
| 417 | // ->setGlobal((!$mount['personal'])); |
||
| 418 | // $externalMounts[] = $externalMount; |
||
| 419 | // } |
||
| 420 | // |
||
| 421 | // return $externalMounts; |
||
| 422 | // } |
||
| 423 | |||
| 424 | } |
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.