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 Shared 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 Shared, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 42 | class Shared extends \OC\Files\Storage\Common implements ISharedStorage { |
||
| 43 | |||
| 44 | private $share; // the shared resource |
||
| 45 | private $files = array(); |
||
| 46 | private static $isInitialized = array(); |
||
| 47 | |||
| 48 | /** |
||
| 49 | * @var \OC\Files\View |
||
| 50 | */ |
||
| 51 | private $ownerView; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @var \OCA\Files_Sharing\Propagation\PropagationManager |
||
| 55 | */ |
||
| 56 | private $propagationManager; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var string |
||
| 60 | */ |
||
| 61 | private $user; |
||
| 62 | |||
| 63 | private $initialized = false; |
||
| 64 | |||
| 65 | 95 | public function __construct($arguments) { |
|
| 66 | 95 | $this->share = $arguments['share']; |
|
| 67 | 95 | $this->ownerView = $arguments['ownerView']; |
|
| 68 | 95 | $this->propagationManager = $arguments['propagationManager']; |
|
| 69 | 95 | $this->user = $arguments['user']; |
|
| 70 | 95 | } |
|
| 71 | |||
| 72 | 79 | private function init() { |
|
| 73 | 79 | if ($this->initialized) { |
|
| 74 | 69 | return; |
|
| 75 | } |
||
| 76 | 79 | $this->initialized = true; |
|
| 77 | 79 | Filesystem::initMountPoints($this->share['uid_owner']); |
|
| 78 | |||
| 79 | // for updating our etags when changes are made to the share from the owners side (probably indirectly by us trough another share) |
||
| 80 | 79 | $this->propagationManager->listenToOwnerChanges($this->share['uid_owner'], $this->user); |
|
| 81 | 79 | } |
|
| 82 | |||
| 83 | /** |
||
| 84 | * get id of the mount point |
||
| 85 | * |
||
| 86 | * @return string |
||
| 87 | */ |
||
| 88 | 82 | public function getId() { |
|
| 91 | |||
| 92 | /** |
||
| 93 | * get file cache of the shared item source |
||
| 94 | * |
||
| 95 | * @return int |
||
| 96 | */ |
||
| 97 | 44 | public function getSourceId() { |
|
| 100 | |||
| 101 | /** |
||
| 102 | * Get the source file path, permissions, and owner for a shared file |
||
| 103 | * |
||
| 104 | * @param string $target Shared target file path |
||
| 105 | * @return array Returns array with the keys path, permissions, and owner or false if not found |
||
| 106 | */ |
||
| 107 | 79 | public function getFile($target) { |
|
| 125 | |||
| 126 | /** |
||
| 127 | * Get the source file path for a shared file |
||
| 128 | * |
||
| 129 | * @param string $target Shared target file path |
||
| 130 | * @return string|false source file path or false if not found |
||
| 131 | */ |
||
| 132 | 60 | public function getSourcePath($target) { |
|
| 133 | 60 | $source = $this->getFile($target); |
|
| 134 | 60 | if ($source) { |
|
| 135 | 60 | if (!isset($source['fullPath'])) { |
|
| 136 | 60 | \OC\Files\Filesystem::initMountPoints($source['fileOwner']); |
|
| 137 | 60 | $mount = \OC\Files\Filesystem::getMountByNumericId($source['storage']); |
|
| 138 | 60 | if (is_array($mount) && !empty($mount)) { |
|
| 139 | 60 | $this->files[$target]['fullPath'] = $mount[key($mount)]->getMountPoint() . $source['path']; |
|
| 140 | 60 | } else { |
|
| 141 | $this->files[$target]['fullPath'] = false; |
||
| 142 | \OCP\Util::writeLog('files_sharing', "Unable to get mount for shared storage '" . $source['storage'] . "' user '" . $source['fileOwner'] . "'", \OCP\Util::ERROR); |
||
| 143 | } |
||
| 144 | 60 | } |
|
| 145 | 60 | return $this->files[$target]['fullPath']; |
|
| 146 | } |
||
| 147 | return false; |
||
| 148 | } |
||
| 149 | |||
| 150 | /** |
||
| 151 | * Get the permissions granted for a shared file |
||
| 152 | * |
||
| 153 | * @param string $target Shared target file path |
||
| 154 | * @return int CRUDS permissions granted |
||
| 155 | */ |
||
| 156 | 74 | public function getPermissions($target = '') { |
|
| 157 | 74 | $permissions = $this->share['permissions']; |
|
| 158 | // part files and the mount point always have delete permissions |
||
| 159 | 74 | if ($target === '' || pathinfo($target, PATHINFO_EXTENSION) === 'part') { |
|
| 160 | 72 | $permissions |= \OCP\Constants::PERMISSION_DELETE; |
|
| 161 | 72 | } |
|
| 162 | |||
| 163 | 74 | if (\OCP\Util::isSharingDisabledForUser()) { |
|
| 164 | $permissions &= ~\OCP\Constants::PERMISSION_SHARE; |
||
| 165 | } |
||
| 166 | |||
| 167 | 74 | return $permissions; |
|
| 168 | } |
||
| 169 | |||
| 170 | 1 | public function mkdir($path) { |
|
| 171 | 1 | if ($path == '' || $path == '/' || !$this->isCreatable(dirname($path))) { |
|
| 172 | return false; |
||
| 173 | 1 | } else if ($source = $this->getSourcePath($path)) { |
|
| 174 | 1 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 175 | 1 | return $storage->mkdir($internalPath); |
|
| 176 | } |
||
| 177 | return false; |
||
| 178 | } |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Delete the directory if DELETE permission is granted |
||
| 182 | * |
||
| 183 | * @param string $path |
||
| 184 | * @return boolean |
||
| 185 | */ |
||
| 186 | 1 | View Code Duplication | public function rmdir($path) { |
| 187 | |||
| 188 | // never delete a share mount point |
||
| 189 | 1 | if (empty($path)) { |
|
| 190 | return false; |
||
| 191 | } |
||
| 192 | |||
| 193 | 1 | if (($source = $this->getSourcePath($path)) && $this->isDeletable($path)) { |
|
| 194 | 1 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 195 | 1 | return $storage->rmdir($internalPath); |
|
| 196 | } |
||
| 197 | return false; |
||
| 198 | } |
||
| 199 | |||
| 200 | 2 | public function opendir($path) { |
|
| 201 | 2 | $source = $this->getSourcePath($path); |
|
| 202 | 2 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 203 | 2 | return $storage->opendir($internalPath); |
|
| 204 | } |
||
| 205 | |||
| 206 | 22 | public function is_dir($path) { |
|
| 207 | 22 | $source = $this->getSourcePath($path); |
|
| 208 | 22 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 209 | 22 | return $storage->is_dir($internalPath); |
|
| 210 | } |
||
| 211 | |||
| 212 | View Code Duplication | public function is_file($path) { |
|
| 213 | if ($source = $this->getSourcePath($path)) { |
||
| 214 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
||
| 215 | return $storage->is_file($internalPath); |
||
| 216 | } |
||
| 217 | return false; |
||
| 218 | } |
||
| 219 | |||
| 220 | public function stat($path) { |
||
| 231 | |||
| 232 | View Code Duplication | public function filetype($path) { |
|
| 241 | |||
| 242 | 14 | public function filesize($path) { |
|
| 243 | 14 | $source = $this->getSourcePath($path); |
|
| 244 | 14 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 245 | 14 | return $storage->filesize($internalPath); |
|
| 246 | } |
||
| 247 | |||
| 248 | 7 | public function isCreatable($path) { |
|
| 251 | |||
| 252 | public function isReadable($path) { |
||
| 253 | $isReadable = false; |
||
| 254 | if ($source = $this->getSourcePath($path)) { |
||
| 255 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
||
| 256 | $isReadable = $storage->isReadable($internalPath); |
||
| 257 | } |
||
| 258 | |||
| 259 | return $isReadable && $this->file_exists($path); |
||
| 260 | } |
||
| 261 | |||
| 262 | 13 | public function isUpdatable($path) { |
|
| 265 | |||
| 266 | 10 | public function isDeletable($path) { |
|
| 269 | |||
| 270 | 33 | public function isSharable($path) { |
|
| 271 | 33 | if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) { |
|
| 272 | return false; |
||
| 273 | } |
||
| 274 | 33 | return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_SHARE); |
|
| 275 | } |
||
| 276 | |||
| 277 | 49 | View Code Duplication | public function file_exists($path) { |
| 278 | 49 | if ($path == '' || $path == '/') { |
|
| 279 | 21 | return true; |
|
| 280 | 32 | } else if ($source = $this->getSourcePath($path)) { |
|
| 281 | 32 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 282 | 32 | return $storage->file_exists($internalPath); |
|
| 283 | } |
||
| 284 | return false; |
||
| 285 | } |
||
| 286 | |||
| 287 | 49 | public function filemtime($path) { |
|
| 288 | 49 | $source = $this->getSourcePath($path); |
|
| 289 | 49 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 290 | 49 | return $storage->filemtime($internalPath); |
|
| 291 | } |
||
| 292 | |||
| 293 | 2 | public function file_get_contents($path) { |
|
| 294 | 2 | $source = $this->getSourcePath($path); |
|
| 295 | 2 | if ($source) { |
|
| 296 | $info = array( |
||
| 297 | 2 | 'target' => $this->getMountPoint() . $path, |
|
| 298 | 2 | 'source' => $source, |
|
| 299 | 2 | ); |
|
| 300 | 2 | \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_get_contents', $info); |
|
| 301 | 2 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 302 | 2 | return $storage->file_get_contents($internalPath); |
|
| 303 | } |
||
| 304 | } |
||
| 305 | |||
| 306 | 12 | public function file_put_contents($path, $data) { |
|
| 307 | 12 | if ($source = $this->getSourcePath($path)) { |
|
| 308 | // Check if permission is granted |
||
| 309 | 12 | if (($this->file_exists($path) && !$this->isUpdatable($path)) |
|
| 310 | 12 | || ($this->is_dir($path) && !$this->isCreatable($path)) |
|
| 311 | 12 | ) { |
|
| 312 | return false; |
||
| 313 | } |
||
| 314 | $info = array( |
||
| 315 | 12 | 'target' => $this->getMountPoint() . '/' . $path, |
|
| 316 | 12 | 'source' => $source, |
|
| 317 | 12 | ); |
|
| 318 | 12 | \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_put_contents', $info); |
|
| 319 | 12 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 320 | 12 | $result = $storage->file_put_contents($internalPath, $data); |
|
| 321 | 12 | return $result; |
|
| 322 | } |
||
| 323 | return false; |
||
| 324 | } |
||
| 325 | |||
| 326 | /** |
||
| 327 | * Delete the file if DELETE permission is granted |
||
| 328 | * |
||
| 329 | * @param string $path |
||
| 330 | * @return boolean |
||
| 331 | */ |
||
| 332 | 6 | View Code Duplication | public function unlink($path) { |
| 333 | |||
| 334 | // never delete a share mount point |
||
| 335 | 6 | if (empty($path)) { |
|
| 336 | return false; |
||
| 337 | } |
||
| 338 | 6 | if ($source = $this->getSourcePath($path)) { |
|
| 339 | 6 | if ($this->isDeletable($path)) { |
|
| 340 | 6 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 341 | 6 | return $storage->unlink($internalPath); |
|
| 342 | } |
||
| 343 | } |
||
| 344 | return false; |
||
| 345 | } |
||
| 346 | |||
| 347 | 9 | public function rename($path1, $path2) { |
|
| 348 | 9 | $this->init(); |
|
| 349 | // we need the paths relative to data/user/files |
||
| 350 | 9 | $relPath1 = $this->getMountPoint() . '/' . $path1; |
|
| 351 | 9 | $relPath2 = $this->getMountPoint() . '/' . $path2; |
|
| 352 | 9 | $pathinfo = pathinfo($relPath1); |
|
| 353 | |||
| 354 | 9 | $isPartFile = (isset($pathinfo['extension']) && $pathinfo['extension'] === 'part'); |
|
| 355 | 9 | $targetExists = $this->file_exists($path2); |
|
| 356 | 9 | $sameFolder = (dirname($relPath1) === dirname($relPath2)); |
|
| 357 | 9 | if ($targetExists || ($sameFolder && !$isPartFile)) { |
|
| 358 | // note that renaming a share mount point is always allowed |
||
| 359 | 7 | if (!$this->isUpdatable('')) { |
|
| 360 | 3 | return false; |
|
| 361 | } |
||
| 362 | 4 | } else { |
|
| 363 | 3 | if (!$this->isCreatable('')) { |
|
| 364 | 1 | return false; |
|
| 365 | } |
||
| 366 | } |
||
| 367 | |||
| 368 | |||
| 369 | /** |
||
| 370 | * @var \OC\Files\Storage\Storage $sourceStorage |
||
| 371 | */ |
||
| 372 | 6 | list($sourceStorage, $sourceInternalPath) = $this->resolvePath($path1); |
|
| 373 | /** |
||
| 374 | * @var \OC\Files\Storage\Storage $targetStorage |
||
| 375 | */ |
||
| 376 | 6 | list($targetStorage, $targetInternalPath) = $this->resolvePath($path2); |
|
| 377 | |||
| 378 | 6 | return $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
| 379 | } |
||
| 380 | |||
| 381 | public function copy($path1, $path2) { |
||
| 382 | // Copy the file if CREATE permission is granted |
||
| 383 | if ($this->isCreatable(dirname($path2))) { |
||
| 384 | /** |
||
| 385 | * @var \OC\Files\Storage\Storage $sourceStorage |
||
| 386 | */ |
||
| 387 | list($sourceStorage, $sourceInternalPath) = $this->resolvePath($path1); |
||
| 388 | /** |
||
| 389 | * @var \OC\Files\Storage\Storage $targetStorage |
||
| 390 | */ |
||
| 391 | list($targetStorage, $targetInternalPath) = $this->resolvePath($path2); |
||
| 392 | |||
| 393 | return $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
||
| 394 | } |
||
| 395 | return false; |
||
| 396 | } |
||
| 397 | |||
| 398 | 4 | public function fopen($path, $mode) { |
|
| 399 | 4 | if ($source = $this->getSourcePath($path)) { |
|
| 400 | switch ($mode) { |
||
| 401 | 4 | case 'r+': |
|
| 402 | 4 | case 'rb+': |
|
| 403 | 4 | case 'w+': |
|
| 404 | 4 | case 'wb+': |
|
| 405 | 4 | case 'x+': |
|
| 406 | 4 | case 'xb+': |
|
| 407 | 4 | case 'a+': |
|
| 408 | 4 | case 'ab+': |
|
| 409 | 4 | case 'w': |
|
| 410 | 4 | case 'wb': |
|
| 411 | 4 | case 'x': |
|
| 412 | 4 | case 'xb': |
|
| 413 | 4 | case 'a': |
|
| 414 | 4 | case 'ab': |
|
| 415 | 4 | $creatable = $this->isCreatable($path); |
|
| 416 | 4 | $updatable = $this->isUpdatable($path); |
|
| 417 | // if neither permissions given, no need to continue |
||
| 418 | 4 | if (!$creatable && !$updatable) { |
|
| 419 | 2 | return false; |
|
| 420 | } |
||
| 421 | |||
| 422 | 2 | $exists = $this->file_exists($path); |
|
| 423 | // if a file exists, updatable permissions are required |
||
| 424 | 2 | if ($exists && !$updatable) { |
|
| 425 | 1 | return false; |
|
| 426 | } |
||
| 427 | |||
| 428 | // part file is allowed if !$creatable but the final file is $updatable |
||
| 429 | 2 | if (pathinfo($path, PATHINFO_EXTENSION) !== 'part') { |
|
| 430 | 2 | if (!$exists && !$creatable) { |
|
| 431 | 1 | return false; |
|
| 432 | } |
||
| 433 | 2 | } |
|
| 434 | 2 | } |
|
| 435 | $info = array( |
||
| 436 | 2 | 'target' => $this->getMountPoint() . $path, |
|
| 437 | 2 | 'source' => $source, |
|
| 438 | 2 | 'mode' => $mode, |
|
| 439 | 2 | ); |
|
| 440 | 2 | \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'fopen', $info); |
|
| 441 | 2 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 442 | 2 | return $storage->fopen($internalPath, $mode); |
|
| 443 | } |
||
| 444 | return false; |
||
| 445 | } |
||
| 446 | |||
| 447 | 13 | View Code Duplication | public function getMimeType($path) { |
| 448 | 13 | if ($source = $this->getSourcePath($path)) { |
|
| 449 | 13 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 450 | 13 | return $storage->getMimeType($internalPath); |
|
| 451 | } |
||
| 452 | return false; |
||
| 453 | } |
||
| 454 | |||
| 455 | public function free_space($path) { |
||
| 456 | $source = $this->getSourcePath($path); |
||
| 457 | if ($source) { |
||
| 458 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
||
| 459 | return $storage->free_space($internalPath); |
||
| 460 | } |
||
| 461 | return \OCP\Files\FileInfo::SPACE_UNKNOWN; |
||
| 462 | } |
||
| 463 | |||
| 464 | View Code Duplication | public function getLocalFile($path) { |
|
| 465 | if ($source = $this->getSourcePath($path)) { |
||
| 466 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
||
| 467 | return $storage->getLocalFile($internalPath); |
||
| 468 | } |
||
| 469 | return false; |
||
| 470 | } |
||
| 471 | |||
| 472 | View Code Duplication | public function touch($path, $mtime = null) { |
|
| 473 | if ($source = $this->getSourcePath($path)) { |
||
| 474 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
||
| 475 | return $storage->touch($internalPath, $mtime); |
||
| 476 | } |
||
| 477 | return false; |
||
| 478 | } |
||
| 479 | |||
| 480 | /** |
||
| 481 | * return mount point of share, relative to data/user/files |
||
| 482 | * |
||
| 483 | * @return string |
||
| 484 | */ |
||
| 485 | 82 | public function getMountPoint() { |
|
| 488 | |||
| 489 | 42 | public function setMountPoint($path) { |
|
| 492 | |||
| 493 | public function getShareType() { |
||
| 496 | |||
| 497 | /** |
||
| 498 | * does the group share already has a user specific unique name |
||
| 499 | * |
||
| 500 | * @return bool |
||
| 501 | */ |
||
| 502 | public function uniqueNameSet() { |
||
| 505 | |||
| 506 | /** |
||
| 507 | * the share now uses a unique name of this user |
||
| 508 | * |
||
| 509 | * @brief the share now uses a unique name of this user |
||
| 510 | */ |
||
| 511 | 42 | public function setUniqueName() { |
|
| 514 | |||
| 515 | /** |
||
| 516 | * get share ID |
||
| 517 | * |
||
| 518 | * @return integer unique share ID |
||
| 519 | */ |
||
| 520 | public function getShareId() { |
||
| 523 | |||
| 524 | /** |
||
| 525 | * get the user who shared the file |
||
| 526 | * |
||
| 527 | * @return string |
||
| 528 | */ |
||
| 529 | 72 | public function getSharedFrom() { |
|
| 532 | |||
| 533 | /** |
||
| 534 | * @return array |
||
| 535 | */ |
||
| 536 | 89 | public function getShare() { |
|
| 539 | |||
| 540 | /** |
||
| 541 | * return share type, can be "file" or "folder" |
||
| 542 | * |
||
| 543 | * @return string |
||
| 544 | */ |
||
| 545 | 5 | public function getItemType() { |
|
| 548 | |||
| 549 | 49 | public function hasUpdated($path, $time) { |
|
| 552 | |||
| 553 | 76 | public function getCache($path = '', $storage = null) { |
|
| 554 | 76 | if (!$storage) { |
|
| 555 | $storage = $this; |
||
| 556 | } |
||
| 557 | 76 | return new \OC\Files\Cache\Shared_Cache($storage); |
|
| 558 | } |
||
| 559 | |||
| 560 | 49 | public function getScanner($path = '', $storage = null) { |
|
| 561 | 49 | if (!$storage) { |
|
| 562 | $storage = $this; |
||
| 563 | } |
||
| 564 | 49 | return new \OC\Files\Cache\SharedScanner($storage); |
|
| 565 | } |
||
| 566 | |||
| 567 | 49 | public function getWatcher($path = '', $storage = null) { |
|
| 568 | 49 | if (!$storage) { |
|
| 569 | $storage = $this; |
||
| 570 | } |
||
| 571 | 49 | return new \OC\Files\Cache\Shared_Watcher($storage); |
|
| 572 | } |
||
| 573 | |||
| 574 | 72 | public function getOwner($path) { |
|
| 575 | 72 | if ($path == '') { |
|
| 576 | 69 | $path = $this->getMountPoint(); |
|
| 577 | 69 | } |
|
| 578 | 72 | $source = $this->getFile($path); |
|
| 579 | 72 | if ($source) { |
|
| 580 | 72 | return $source['fileOwner']; |
|
| 581 | } |
||
| 582 | return false; |
||
| 583 | } |
||
| 584 | |||
| 585 | 26 | View Code Duplication | public function getETag($path) { |
| 586 | 26 | if ($source = $this->getSourcePath($path)) { |
|
| 587 | 26 | list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath($source); |
|
| 588 | 26 | return $storage->getETag($internalPath); |
|
| 589 | } |
||
| 590 | return null; |
||
| 591 | } |
||
| 592 | |||
| 593 | /** |
||
| 594 | * unshare complete storage, also the grouped shares |
||
| 595 | * |
||
| 596 | * @return bool |
||
| 597 | */ |
||
| 598 | 5 | public function unshareStorage() { |
|
| 599 | 5 | $result = true; |
|
| 600 | 5 | if (!empty($this->share['grouped'])) { |
|
| 601 | 2 | foreach ($this->share['grouped'] as $share) { |
|
| 602 | 2 | $result = $result && \OCP\Share::unshareFromSelf($share['item_type'], $share['file_target']); |
|
| 603 | 2 | } |
|
| 604 | 2 | } |
|
| 605 | 5 | $result = $result && \OCP\Share::unshareFromSelf($this->getItemType(), $this->getMountPoint()); |
|
| 606 | |||
| 607 | 5 | return $result; |
|
| 608 | } |
||
| 609 | |||
| 610 | /** |
||
| 611 | * Resolve the path for the source of the share |
||
| 612 | * |
||
| 613 | * @param string $path |
||
| 614 | * @return array |
||
| 615 | */ |
||
| 616 | 33 | private function resolvePath($path) { |
|
| 620 | |||
| 621 | /** |
||
| 622 | * @param \OCP\Files\Storage $sourceStorage |
||
| 623 | * @param string $sourceInternalPath |
||
| 624 | * @param string $targetInternalPath |
||
| 625 | * @return bool |
||
| 626 | */ |
||
| 627 | 1 | public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
| 628 | /** @var \OCP\Files\Storage $targetStorage */ |
||
| 629 | 1 | list($targetStorage, $targetInternalPath) = $this->resolvePath($targetInternalPath); |
|
| 630 | 1 | return $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
| 631 | } |
||
| 632 | |||
| 633 | /** |
||
| 634 | * @param \OCP\Files\Storage $sourceStorage |
||
| 635 | * @param string $sourceInternalPath |
||
| 636 | * @param string $targetInternalPath |
||
| 637 | * @return bool |
||
| 638 | */ |
||
| 639 | 3 | public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) { |
|
| 640 | /** @var \OCP\Files\Storage $targetStorage */ |
||
| 641 | 3 | list($targetStorage, $targetInternalPath) = $this->resolvePath($targetInternalPath); |
|
| 642 | 3 | return $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
| 643 | } |
||
| 644 | |||
| 645 | /** |
||
| 646 | * @param string $path |
||
| 647 | * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
||
| 648 | * @param \OCP\Lock\ILockingProvider $provider |
||
| 649 | * @throws \OCP\Lock\LockedException |
||
| 650 | */ |
||
| 651 | 31 | View Code Duplication | public function acquireLock($path, $type, ILockingProvider $provider) { |
| 652 | /** @var \OCP\Files\Storage $targetStorage */ |
||
| 653 | 31 | list($targetStorage, $targetInternalPath) = $this->resolvePath($path); |
|
| 654 | 31 | $targetStorage->acquireLock($targetInternalPath, $type, $provider); |
|
| 655 | // lock the parent folders of the owner when locking the share as recipient |
||
| 656 | 31 | if ($path === '') { |
|
| 657 | 30 | $sourcePath = $this->ownerView->getPath($this->share['file_source']); |
|
| 658 | 30 | $this->ownerView->lockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true); |
|
| 659 | 30 | } |
|
| 660 | 31 | } |
|
| 661 | |||
| 662 | /** |
||
| 663 | * @param string $path |
||
| 664 | * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
||
| 665 | * @param \OCP\Lock\ILockingProvider $provider |
||
| 666 | */ |
||
| 667 | 30 | View Code Duplication | public function releaseLock($path, $type, ILockingProvider $provider) { |
| 668 | /** @var \OCP\Files\Storage $targetStorage */ |
||
| 669 | 30 | list($targetStorage, $targetInternalPath) = $this->resolvePath($path); |
|
| 670 | 30 | $targetStorage->releaseLock($targetInternalPath, $type, $provider); |
|
| 671 | // unlock the parent folders of the owner when unlocking the share as recipient |
||
| 672 | 30 | if ($path === '') { |
|
| 673 | 29 | $sourcePath = $this->ownerView->getPath($this->share['file_source']); |
|
| 674 | 29 | $this->ownerView->unlockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true); |
|
| 675 | 29 | } |
|
| 676 | 30 | } |
|
| 677 | |||
| 678 | /** |
||
| 679 | * @param string $path |
||
| 680 | * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
||
| 681 | * @param \OCP\Lock\ILockingProvider $provider |
||
| 682 | */ |
||
| 683 | 27 | public function changeLock($path, $type, ILockingProvider $provider) { |
|
| 684 | /** @var \OCP\Files\Storage $targetStorage */ |
||
| 685 | 27 | list($targetStorage, $targetInternalPath) = $this->resolvePath($path); |
|
| 686 | 27 | $targetStorage->changeLock($targetInternalPath, $type, $provider); |
|
| 687 | 27 | } |
|
| 688 | |||
| 689 | /** |
||
| 690 | * @return array [ available, last_checked ] |
||
| 691 | */ |
||
| 692 | 86 | public function getAvailability() { |
|
| 693 | // shares do not participate in availability logic |
||
| 694 | return [ |
||
| 695 | 86 | 'available' => true, |
|
| 696 | 'last_checked' => 0 |
||
| 697 | 86 | ]; |
|
| 698 | } |
||
| 699 | |||
| 700 | /** |
||
| 701 | * @param bool $available |
||
| 702 | */ |
||
| 703 | public function setAvailability($available) { |
||
| 706 | |||
| 707 | public function isLocal() { |
||
| 708 | $this->init(); |
||
| 709 | $ownerPath = $this->ownerView->getPath($this->share['item_source']); |
||
| 710 | list($targetStorage) = $this->ownerView->resolvePath($ownerPath); |
||
| 711 | return $targetStorage->isLocal(); |
||
| 712 | } |
||
| 713 | } |
||
| 714 |
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.