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 SMB 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 SMB, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 59 | class SMB extends Common implements INotifyStorage { |
||
| 60 | /** |
||
| 61 | * @var \Icewind\SMB\IServer |
||
| 62 | */ |
||
| 63 | protected $server; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @var \Icewind\SMB\IShare |
||
| 67 | */ |
||
| 68 | protected $share; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @var string |
||
| 72 | */ |
||
| 73 | protected $root; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * @var \Icewind\SMB\IFileInfo[] |
||
| 77 | */ |
||
| 78 | protected $statCache; |
||
| 79 | |||
| 80 | public function __construct($params) { |
||
| 81 | if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) { |
||
| 82 | list($workgroup, $user) = $this->splitUser($params['user']); |
||
| 83 | $auth = new BasicAuth($user, $workgroup, $params['password']); |
||
| 84 | $serverFactory = new ServerFactory(); |
||
| 85 | $this->server = $serverFactory->createServer($params['host'], $auth); |
||
| 86 | $this->share = $this->server->getShare(trim($params['share'], '/')); |
||
| 87 | |||
| 88 | $this->root = $params['root'] ?? '/'; |
||
| 89 | $this->root = '/' . ltrim($this->root, '/'); |
||
| 90 | $this->root = rtrim($this->root, '/') . '/'; |
||
| 91 | } else { |
||
| 92 | throw new \Exception('Invalid configuration'); |
||
| 93 | } |
||
| 94 | $this->statCache = new CappedMemoryCache(); |
||
|
|
|||
| 95 | parent::__construct($params); |
||
| 96 | } |
||
| 97 | |||
| 98 | private function splitUser($user) { |
||
| 99 | if (strpos($user, '/')) { |
||
| 100 | return explode('/', $user, 2); |
||
| 101 | } elseif (strpos($user, '\\')) { |
||
| 102 | return explode('\\', $user); |
||
| 103 | } else { |
||
| 104 | return [null, $user]; |
||
| 105 | } |
||
| 106 | } |
||
| 107 | |||
| 108 | /** |
||
| 109 | * @return string |
||
| 110 | */ |
||
| 111 | public function getId() { |
||
| 112 | // FIXME: double slash to keep compatible with the old storage ids, |
||
| 113 | // failure to do so will lead to creation of a new storage id and |
||
| 114 | // loss of shares from the storage |
||
| 115 | return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root; |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * @param string $path |
||
| 120 | * @return string |
||
| 121 | */ |
||
| 122 | protected function buildPath($path) { |
||
| 123 | return Filesystem::normalizePath($this->root . '/' . $path, true, false, true); |
||
| 124 | } |
||
| 125 | |||
| 126 | View Code Duplication | protected function relativePath($fullPath) { |
|
| 127 | if ($fullPath === $this->root) { |
||
| 128 | return ''; |
||
| 129 | } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) { |
||
| 130 | return substr($fullPath, strlen($this->root)); |
||
| 131 | } else { |
||
| 132 | return null; |
||
| 133 | } |
||
| 134 | } |
||
| 135 | |||
| 136 | /** |
||
| 137 | * @param string $path |
||
| 138 | * @return \Icewind\SMB\IFileInfo |
||
| 139 | * @throws StorageNotAvailableException |
||
| 140 | */ |
||
| 141 | protected function getFileInfo($path) { |
||
| 142 | try { |
||
| 143 | $path = $this->buildPath($path); |
||
| 144 | if (!isset($this->statCache[$path])) { |
||
| 145 | $this->statCache[$path] = $this->share->stat($path); |
||
| 146 | } |
||
| 147 | return $this->statCache[$path]; |
||
| 148 | } catch (ConnectException $e) { |
||
| 149 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 150 | } |
||
| 151 | } |
||
| 152 | |||
| 153 | /** |
||
| 154 | * @param string $path |
||
| 155 | * @return \Icewind\SMB\IFileInfo[] |
||
| 156 | * @throws StorageNotAvailableException |
||
| 157 | */ |
||
| 158 | protected function getFolderContents($path) { |
||
| 159 | try { |
||
| 160 | $path = $this->buildPath($path); |
||
| 161 | $files = $this->share->dir($path); |
||
| 162 | foreach ($files as $file) { |
||
| 163 | $this->statCache[$path . '/' . $file->getName()] = $file; |
||
| 164 | } |
||
| 165 | return array_filter($files, function (IFileInfo $file) { |
||
| 166 | try { |
||
| 167 | return !$file->isHidden(); |
||
| 168 | } catch (ForbiddenException $e) { |
||
| 169 | return false; |
||
| 170 | } catch (NotFoundException $e) { |
||
| 171 | return false; |
||
| 172 | } |
||
| 173 | }); |
||
| 174 | } catch (ConnectException $e) { |
||
| 175 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 176 | } |
||
| 177 | } |
||
| 178 | |||
| 179 | /** |
||
| 180 | * @param \Icewind\SMB\IFileInfo $info |
||
| 181 | * @return array |
||
| 182 | */ |
||
| 183 | protected function formatInfo($info) { |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Rename the files. If the source or the target is the root, the rename won't happen. |
||
| 198 | * |
||
| 199 | * @param string $source the old name of the path |
||
| 200 | * @param string $target the new name of the path |
||
| 201 | * @return bool true if the rename is successful, false otherwise |
||
| 202 | */ |
||
| 203 | public function rename($source, $target) { |
||
| 204 | if ($this->isRootDir($source) || $this->isRootDir($target)) { |
||
| 205 | return false; |
||
| 206 | } |
||
| 207 | |||
| 208 | $absoluteSource = $this->buildPath($source); |
||
| 209 | $absoluteTarget = $this->buildPath($target); |
||
| 210 | try { |
||
| 211 | $result = $this->share->rename($absoluteSource, $absoluteTarget); |
||
| 212 | } catch (AlreadyExistsException $e) { |
||
| 213 | $this->remove($target); |
||
| 214 | $result = $this->share->rename($absoluteSource, $absoluteTarget); |
||
| 215 | } catch (\Exception $e) { |
||
| 216 | \OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]); |
||
| 217 | return false; |
||
| 218 | } |
||
| 219 | unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]); |
||
| 220 | return $result; |
||
| 221 | } |
||
| 222 | |||
| 223 | public function stat($path) { |
||
| 236 | |||
| 237 | /** |
||
| 238 | * get the best guess for the modification time of the share |
||
| 239 | * |
||
| 240 | * @return int |
||
| 241 | */ |
||
| 242 | private function shareMTime() { |
||
| 243 | $highestMTime = 0; |
||
| 244 | $files = $this->share->dir($this->root); |
||
| 245 | foreach ($files as $fileInfo) { |
||
| 246 | try { |
||
| 247 | if ($fileInfo->getMTime() > $highestMTime) { |
||
| 248 | $highestMTime = $fileInfo->getMTime(); |
||
| 249 | } |
||
| 250 | } catch (NotFoundException $e) { |
||
| 251 | // Ignore this, can happen on unavailable DFS shares |
||
| 252 | } |
||
| 253 | } |
||
| 254 | return $highestMTime; |
||
| 255 | } |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Check if the path is our root dir (not the smb one) |
||
| 259 | * |
||
| 260 | * @param string $path the path |
||
| 261 | * @return bool |
||
| 262 | */ |
||
| 263 | private function isRootDir($path) { |
||
| 264 | return $path === '' || $path === '/' || $path === '.'; |
||
| 265 | } |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Check if our root points to a smb share |
||
| 269 | * |
||
| 270 | * @return bool true if our root points to a share false otherwise |
||
| 271 | */ |
||
| 272 | private function remoteIsShare() { |
||
| 273 | return $this->share->getName() && (!$this->root || $this->root === '/'); |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * @param string $path |
||
| 278 | * @return bool |
||
| 279 | */ |
||
| 280 | public function unlink($path) { |
||
| 281 | if ($this->isRootDir($path)) { |
||
| 282 | return false; |
||
| 283 | } |
||
| 284 | |||
| 285 | try { |
||
| 286 | if ($this->is_dir($path)) { |
||
| 287 | return $this->rmdir($path); |
||
| 288 | } else { |
||
| 289 | $path = $this->buildPath($path); |
||
| 290 | unset($this->statCache[$path]); |
||
| 291 | $this->share->del($path); |
||
| 292 | return true; |
||
| 293 | } |
||
| 294 | } catch (NotFoundException $e) { |
||
| 295 | return false; |
||
| 296 | } catch (ForbiddenException $e) { |
||
| 297 | return false; |
||
| 298 | } catch (ConnectException $e) { |
||
| 299 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 300 | } |
||
| 301 | } |
||
| 302 | |||
| 303 | /** |
||
| 304 | * check if a file or folder has been updated since $time |
||
| 305 | * |
||
| 306 | * @param string $path |
||
| 307 | * @param int $time |
||
| 308 | * @return bool |
||
| 309 | */ |
||
| 310 | public function hasUpdated($path, $time) { |
||
| 311 | if (!$path and $this->root === '/') { |
||
| 312 | // mtime doesn't work for shares, but giving the nature of the backend, |
||
| 313 | // doing a full update is still just fast enough |
||
| 314 | return true; |
||
| 315 | } else { |
||
| 316 | $actualTime = $this->filemtime($path); |
||
| 317 | return $actualTime > $time; |
||
| 318 | } |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * @param string $path |
||
| 323 | * @param string $mode |
||
| 324 | * @return resource|false |
||
| 325 | */ |
||
| 326 | public function fopen($path, $mode) { |
||
| 327 | $fullPath = $this->buildPath($path); |
||
| 328 | try { |
||
| 329 | switch ($mode) { |
||
| 330 | case 'r': |
||
| 331 | case 'rb': |
||
| 332 | if (!$this->file_exists($path)) { |
||
| 333 | return false; |
||
| 334 | } |
||
| 335 | return $this->share->read($fullPath); |
||
| 336 | case 'w': |
||
| 337 | case 'wb': |
||
| 338 | $source = $this->share->write($fullPath); |
||
| 339 | return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) { |
||
| 340 | unset($this->statCache[$fullPath]); |
||
| 341 | }); |
||
| 342 | case 'a': |
||
| 343 | case 'ab': |
||
| 344 | case 'r+': |
||
| 345 | case 'w+': |
||
| 346 | case 'wb+': |
||
| 347 | case 'a+': |
||
| 348 | case 'x': |
||
| 349 | case 'x+': |
||
| 350 | case 'c': |
||
| 351 | case 'c+': |
||
| 352 | //emulate these |
||
| 353 | if (strrpos($path, '.') !== false) { |
||
| 354 | $ext = substr($path, strrpos($path, '.')); |
||
| 355 | } else { |
||
| 356 | $ext = ''; |
||
| 357 | } |
||
| 358 | View Code Duplication | if ($this->file_exists($path)) { |
|
| 359 | if (!$this->isUpdatable($path)) { |
||
| 360 | return false; |
||
| 361 | } |
||
| 362 | $tmpFile = $this->getCachedFile($path); |
||
| 363 | } else { |
||
| 364 | if (!$this->isCreatable(dirname($path))) { |
||
| 365 | return false; |
||
| 366 | } |
||
| 367 | $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
||
| 368 | } |
||
| 369 | $source = fopen($tmpFile, $mode); |
||
| 370 | $share = $this->share; |
||
| 371 | return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) { |
||
| 372 | unset($this->statCache[$fullPath]); |
||
| 373 | $share->put($tmpFile, $fullPath); |
||
| 374 | unlink($tmpFile); |
||
| 375 | }); |
||
| 376 | } |
||
| 377 | return false; |
||
| 378 | } catch (NotFoundException $e) { |
||
| 379 | return false; |
||
| 380 | } catch (ForbiddenException $e) { |
||
| 381 | return false; |
||
| 382 | } catch (ConnectException $e) { |
||
| 383 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 384 | } |
||
| 385 | } |
||
| 386 | |||
| 387 | public function rmdir($path) { |
||
| 388 | if ($this->isRootDir($path)) { |
||
| 389 | return false; |
||
| 390 | } |
||
| 391 | |||
| 392 | try { |
||
| 393 | $this->statCache = array(); |
||
| 394 | $content = $this->share->dir($this->buildPath($path)); |
||
| 395 | foreach ($content as $file) { |
||
| 396 | if ($file->isDirectory()) { |
||
| 397 | $this->rmdir($path . '/' . $file->getName()); |
||
| 398 | } else { |
||
| 399 | $this->share->del($file->getPath()); |
||
| 400 | } |
||
| 401 | } |
||
| 402 | $this->share->rmdir($this->buildPath($path)); |
||
| 403 | return true; |
||
| 404 | } catch (NotFoundException $e) { |
||
| 405 | return false; |
||
| 406 | } catch (ForbiddenException $e) { |
||
| 407 | return false; |
||
| 408 | } catch (ConnectException $e) { |
||
| 409 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 410 | } |
||
| 411 | } |
||
| 412 | |||
| 413 | View Code Duplication | public function touch($path, $time = null) { |
|
| 414 | try { |
||
| 415 | if (!$this->file_exists($path)) { |
||
| 416 | $fh = $this->share->write($this->buildPath($path)); |
||
| 417 | fclose($fh); |
||
| 418 | return true; |
||
| 419 | } |
||
| 420 | return false; |
||
| 421 | } catch (ConnectException $e) { |
||
| 422 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 423 | } |
||
| 424 | } |
||
| 425 | |||
| 426 | public function opendir($path) { |
||
| 440 | |||
| 441 | public function filetype($path) { |
||
| 450 | |||
| 451 | View Code Duplication | public function mkdir($path) { |
|
| 452 | $path = $this->buildPath($path); |
||
| 453 | try { |
||
| 454 | $this->share->mkdir($path); |
||
| 455 | return true; |
||
| 456 | } catch (ConnectException $e) { |
||
| 457 | throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e); |
||
| 458 | } catch (Exception $e) { |
||
| 459 | return false; |
||
| 460 | } |
||
| 461 | } |
||
| 462 | |||
| 463 | public function file_exists($path) { |
||
| 464 | try { |
||
| 465 | $this->getFileInfo($path); |
||
| 466 | return true; |
||
| 467 | } catch (NotFoundException $e) { |
||
| 475 | |||
| 476 | View Code Duplication | public function isReadable($path) { |
|
| 486 | |||
| 487 | View Code Duplication | public function isUpdatable($path) { |
|
| 499 | |||
| 500 | View Code Duplication | public function isDeletable($path) { |
|
| 510 | |||
| 511 | /** |
||
| 512 | * check if smbclient is installed |
||
| 513 | */ |
||
| 514 | public static function checkDependencies() { |
||
| 520 | |||
| 521 | /** |
||
| 522 | * Test a storage for availability |
||
| 523 | * |
||
| 524 | * @return bool |
||
| 525 | */ |
||
| 526 | public function test() { |
||
| 533 | |||
| 534 | public function listen($path, callable $callback) { |
||
| 543 | |||
| 544 | public function notify($path) { |
||
| 549 | } |
||
| 550 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..