SMB::leave() - Code Metrics - Inspection of "Feature/storage 2.0" - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#32044)

by Thomas
created 2018-08-21 08:00 UTC
SMB::leave() B

↳ Parent: SMB
Complexity

Conditions	7
Paths	7
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	7
nc	7
nop	2
dl	0
loc	22
rs	8.6346
c	0
b	0
f	0
<?php
/**
 * @author Arthur Schiwon <[email protected]>
 * @author Jesús Macias <[email protected]>
 * @author Jörn Friedrich Dreyer <[email protected]>
 * @author Juan Pablo Villafañez <[email protected]>
 * @author Michael Gapczynski <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Philipp Kapfer <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Thomas Müller <[email protected]>
 * @author Vincent Petry <[email protected]>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Files_External\Lib\Storage;

use function GuzzleHttp\Psr7\copy_to_stream;
use function GuzzleHttp\Psr7\stream_for;
use Icewind\SMB\Exception\AlreadyExistsException;
use Icewind\SMB\Exception\ConnectException;
use Icewind\SMB\Exception\Exception;
use Icewind\SMB\Exception\ForbiddenException;
use Icewind\SMB\Exception\NotFoundException;
use Icewind\SMB\BasicAuth;
use Icewind\SMB\IFileInfo;
use Icewind\SMB\Native\NativeServer;
use Icewind\SMB\Wrapped\FileInfo;
use Icewind\SMB\ServerFactory;
use Icewind\SMB\System;
use Icewind\SMB\IShare;
use Icewind\Streams\CallbackWrapper;
use Icewind\Streams\IteratorDirectory;
use OC\Cache\CappedMemoryCache;
use OC\Files\Filesystem;
use OCP\Files\Cache\ICache;
use OCP\Files\Storage\StorageAdapter;
use OCP\Files\StorageNotAvailableException;
use OCP\Util;
use Psr\Http\Message\StreamInterface;

class SMB extends StorageAdapter {
	/**
	 * @var \Icewind\SMB\IServer
	 */
	protected $server;

	/**
	 * @var \Icewind\SMB\IShare
	 */
	protected $share;

	/**
	 * @var string
	 */
	protected $root;

	/**
	 * @var ICache
	 */
	protected $statCache;

	public function __construct($params) {
		$loggedParams = $params;
		// remove password from log if it is set
		if (!empty($loggedParams['password'])) {
			$loggedParams['password'] = '***removed***';
		}
		$this->log('enter: '.__FUNCTION__.'('.\json_encode($loggedParams).')');

		if (isset($params['host'], $params['user'], $params['password'], $params['share'])) {
			$auth = new BasicAuth($params['user'], '', $params['password']);
			$serverFactory = new ServerFactory();
			$this->server = $serverFactory->createServer($params['host'], $auth);
			$this->share = $this->server->getShare(\trim($params['share'], '/'));

			$shareClass = \get_class($this->share);
			$this->log("using $shareClass for the connection");

			$this->root = isset($params['root']) ? $params['root'] : '/';
			if (!$this->root || $this->root[0] != '/') {

				$this->root = '/' . $this->root;
			}
			if (\substr($this->root, -1, 1) != '/') {
				$this->root .= '/';
			}
		} else {
			$ex = new \Exception('Invalid configuration');
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		}
		$this->statCache = new CappedMemoryCache();

		$this->log('leave: '.__FUNCTION__.', getId:'.$this->getId());
	}

	/**
	 * @return string
	 */
	public function getId() {
		// FIXME: double slash to keep compatible with the old storage ids,
		// failure to do so will lead to creation of a new storage id and
		// loss of shares from the storage
		return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
	}

	/**
	 * @param string $path
	 * @return string
	 */
	protected function buildPath($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * @param string $path
	 * @return \Icewind\SMB\IFileInfo
	 * @throws StorageNotAvailableException
	 * @throws ForbiddenException
	 * @throws NotFoundException
	 */
	protected function getFileInfo($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$path = $this->buildPath($path);
		if (!isset($this->statCache[$path])) {
			try {
				$this->log("stat fetching '$path'");
				try {
					$this->statCache[$path] = $this->share->stat($path);
				} catch (NotFoundException $e) {
					if ($this->share instanceof IShare) {
						// smbclient may have problems with the allinfo cmd
						$this->log("stat for '$path' failed, trying to read parent dir");
						$infos = $this->share->dir(\dirname($path));
						foreach ($infos as $fileInfo) {
							if ($fileInfo->getName() === \basename($path)) {
								$this->statCache[$path] = $fileInfo;
								break;
							}
						}
						if (empty($this->statCache[$path])) {
							$this->leave(__FUNCTION__, $e);
							throw $e;
						}
					} else {
						// trust the results of libsmb
						$this->leave(__FUNCTION__, $e);
						throw $e;
					}
				}
				if ($this->isRootDir($path) && $this->statCache[$path]->isHidden()) {
					$this->log("unhiding stat for '$path'");
					// make root never hidden, may happen when accessing a shared drive (mode is 22, archived and readonly - neither is true ... whatever)
					if ($this->statCache[$path]->isReadOnly()) {
						$mode = IFileInfo::MODE_DIRECTORY & IFileInfo::MODE_READONLY;
					} else {
						$mode = IFileInfo::MODE_DIRECTORY;
					}
					$this->statCache[$path] = new FileInfo($path, '', 0, $this->statCache[$path]->getMTime(), $mode);
				}
			} catch (ConnectException $e) {
				$ex = new StorageNotAvailableException(
						$e->getMessage(), $e->getCode(), $e);
				$this->leave(__FUNCTION__, $ex);
				throw $ex;
			} catch (ForbiddenException $e) {
				if ($this->remoteIsShare() && $this->isRootDir($path)) { //mtime may not work for share root
					$this->log("faking stat for forbidden '$path'");
					$this->statCache[$path] = new FileInfo($path, '', 0, $this->shareMTime(), IFileInfo::MODE_DIRECTORY);
				} else {
					$this->leave(__FUNCTION__, $e);
					throw $e;
				}
			}
		} else {
			$this->log("stat cache hit for '$path'");
		}
		$result = $this->statCache[$path];
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * @param string $path
	 * @return \Icewind\SMB\IFileInfo[]
	 * @throws StorageNotAvailableException
	 */
	protected function getFolderContents($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		try {
			$path = $this->buildPath($path);
			$result = [];
			$children = $this->share->dir($path);
			foreach ($children as $fileInfo) {
				// check if the file is readable before adding it to the list
				// can't use "isReadable" function here, use smb internals instead
				try {
					if ($fileInfo->isHidden()) {
						$this->log("{$fileInfo->getName()} isn't readable, skipping", Util::DEBUG);
					} else {
						$result[] = $fileInfo;
						//remember entry so we can answer file_exists and filetype without a full stat
						$this->statCache[$path . '/' . $fileInfo->getName()] = $fileInfo;
					}
				} catch (NotFoundException $e) {
					$this->swallow(__FUNCTION__, $e);
				}
			}
		} catch (ConnectException $e) {
			$ex = new StorageNotAvailableException(
				$e->getMessage(), $e->getCode(), $e);
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * @param \Icewind\SMB\IFileInfo $info
	 * @return array
	 */
	protected function formatInfo($info) {
		$result = [
			'size' => $info->getSize(),
			'mtime' => $info->getMTime(),
		];
		if ($info->isDirectory()) {
			$result['type'] = 'dir';
		} else {
			$result['type'] = 'file';
		}
		return $result;
	}

	/**
	 * Rename the files. If the source or the target is the root, the rename won't happen.
	 *
	 * @param string $source the old name of the path
	 * @param string $target the new name of the path
	 * @return bool true if the rename is successful, false otherwise
	 */
	public function rename($source, $target) {
		$this->log("enter: rename('$source', '$target')", Util::DEBUG);

		if ($this->isRootDir($source) || $this->isRootDir($target)) {
			$this->log("refusing to rename \"$source\" to \"$target\"");
			return $this->leave(__FUNCTION__, false);
		}

		try {
			$result = $this->share->rename($this->root . $source, $this->root . $target);
			$this->removeFromCache($this->root . $source);
			$this->removeFromCache($this->root . $target);
		} catch (AlreadyExistsException $e) {

			$this->swallow(__FUNCTION__, $e);
			$this->unlink($target);
			$result = $this->share->rename($this->root . $source, $this->root . $target);
			$this->removeFromCache($this->root . $source);
			$this->removeFromCache($this->root . $target);
		} catch (Exception $e) {
			$this->swallow(__FUNCTION__, $e);
			// Icewind\SMB\Exception\Exception, not a plain exception
			if ($e->getCode() === 22) {
				$this->unlink($target);
				$result = $this->share->rename($this->root . $source, $this->root . $target);
				$this->removeFromCache($this->root . $source);
				$this->removeFromCache($this->root . $target);
			} else {
				$result = false;
			}
		} catch (\Exception $e) {
			$this->swallow(__FUNCTION__, $e);
			$result = false;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	private function removeFromCache($path) {
		$path = \trim($path, '/');
		// TODO The CappedCache does not really clear by prefix. It just clears all.
		//$this->dirCache->clear($path);
		$this->statCache->clear($path);
		//$this->xattrCache->clear($path);
	}
	/**
	 * @param string $path
	 * @return array
	 */
	public function stat($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		try {
			$result = $this->formatInfo($this->getFileInfo($path));
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
			$result = false;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * get the best guess for the modification time of the share
	 * NOTE: modification times do not bubble up the directory tree, basically
	 * we are just guessing a time
	 *
	 * @return int the calculated mtime for the folder
	 */
	private function shareMTime() {
		$this->log('enter: '.__FUNCTION__, Util::DEBUG);
		$files = $this->share->dir($this->root);
		$result = 0;
		foreach ($files as $fileInfo) {
			if ($fileInfo->getMTime() > $result) {
				$result = $fileInfo->getMTime();
			}
		}
		return $this->leave(__FUNCTION__, $result);
	}
	/**
	 * Check if the path is our root dir (not the smb one)
	 *
	 * @param string $path the path
	 * @return bool true if it's root, false if not
	 */
	private function isRootDir($path) {
		$this->log('enter: '.__FUNCTION__."($path)", Util::DEBUG);
		$result = $path === '' || $path === '/' || $path === '.';
		return $this->leave(__FUNCTION__, $result);
	}
	/**
	 * Check if our root points to a smb share
	 *
	 * @return bool true if our root points to a share false otherwise
	 */
	private function remoteIsShare() {
		$this->log('enter: '.__FUNCTION__, Util::DEBUG);
		$result = $this->share->getName() && (!$this->root || $this->root === '/');
		return $this->leave(__FUNCTION__, $result);
	}
	/**
	 * @param string $path
	 * @return bool
	 * @throws StorageNotAvailableException
	 */
	public function unlink($path) {
		$this->log('enter: '.__FUNCTION__."($path)");

		if ($this->isRootDir($path)) {
			$this->log("refusing to unlink \"$path\"");
			return $this->leave(__FUNCTION__, false);
		}

		$result = false;
		try {
			if ($this->is_dir($path)) {
				$result = $this->rmdir($path);
			} else {
				$path = $this->buildPath($path);
				unset($this->statCache[$path]);
				$this->share->del($path);
				$result = true;
			}
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ConnectException $e) {
			$ex = new StorageNotAvailableException(
				$e->getMessage(), $e->getCode(), $e);
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * check if a file or folder has been updated since $time
	 *
	 * @param string $path
	 * @param int $time
	 * @return bool
	 */
	public function hasUpdated($path, $time) {
		$this->log('enter: '.__FUNCTION__."($path, $time)");
		$actualTime = $this->filemtime($path);
		$result = $actualTime > $time;
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * @param string $path
	 * @param string $mode
	 * @return resource
	 * @throws StorageNotAvailableException
	 */
	public function fopen($path, $mode) {
		throw new \BadMethodCallException('fopen is no longer allowed to be called');
	}

	public function rmdir($path) {
		$this->log('enter: '.__FUNCTION__."($path)");

		if ($this->isRootDir($path)) {
			$this->log("refusing to delete \"$path\"");
			return $this->leave(__FUNCTION__, false);
		}

		$result = false;
		try {
			$this->removeFromCache($path);
			$content = $this->share->dir($this->buildPath($path));
			foreach ($content as $file) {
				if ($file->isDirectory()) {
					$this->rmdir($path . '/' . $file->getName());
				} else {
					$this->share->del($file->getPath());
				}
			}
			$this->share->rmdir($this->buildPath($path));
			$result = true;
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ConnectException $e) {
			$ex = new StorageNotAvailableException(
				$e->getMessage(), $e->getCode(), $e);
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function touch($path, $time = null) {
		$this->log('enter: '.__FUNCTION__."($path, $time)");
		try {
			if (!$this->file_exists($path)) {
				$fh = $this->share->write($this->buildPath($path));
				\fclose($fh);
				$result = true;
			} else {
				$result = false;
			}
		} catch (ConnectException $e) {
			$ex = new StorageNotAvailableException(
				$e->getMessage(), $e->getCode(), $e);
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function opendir($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		try {
			$files = $this->getFolderContents($path);
			$names = \array_map(function ($info) {
				/** @var \Icewind\SMB\IFileInfo $info */
				return $info->getName();
			}, $files);
			$result = IteratorDirectory::wrap($names);
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function filetype($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		try {
			$result = $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function mkdir($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		$path = $this->buildPath($path);
		try {
			$result = $this->share->mkdir($path);
		} catch (ConnectException $e) {
			$ex = new StorageNotAvailableException(
				$e->getMessage(), $e->getCode(), $e);
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		} catch (Exception $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function file_exists($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		try {
			$this->getFileInfo($path);
			$result = true;
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ConnectException $e) {
			$ex = new StorageNotAvailableException(
				$e->getMessage(), $e->getCode(), $e);
			$this->leave(__FUNCTION__, $ex);
			throw $ex;
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function isReadable($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		try {
			$info = $this->getFileInfo($path);
			$result = !$info->isHidden();
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function isUpdatable($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		try {
			$info = $this->getFileInfo($path);
			// following windows behaviour for read-only folders: they can be written into
			// (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
			$result = !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path));
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	public function isDeletable($path) {
		$this->log('enter: '.__FUNCTION__."($path)");
		$result = false;
		try {
			$info = $this->getFileInfo($path);
			$result = !$info->isHidden() && !$info->isReadOnly();
		} catch (NotFoundException $e) {
			$this->swallow(__FUNCTION__, $e);
		} catch (ForbiddenException $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * check if smbclient is installed
	 */
	public static function checkDependencies() {
		return (
			(bool)\OC_Helper::findBinaryPath('smbclient')
			|| NativeServer::available(new System())
		) ? true : ['smbclient'];
	}

	/**
	 * Test a storage for availability
	 *
	 * @return bool
	 */
	public function test() {
		$this->log('enter: '.__FUNCTION__."()");
		$result = false;
		try {
			$result = parent::test();
		} catch (Exception $e) {
			$this->swallow(__FUNCTION__, $e);
		}
		return $this->leave(__FUNCTION__, $result);
	}

	/**
	 * @param string $message
	 * @param int $level
	 * @param string $from
	 */
	private function log($message, $level = Util::DEBUG, $from = 'smb') {
		if (\OC::$server->getConfig()->getSystemValue('smb.logging.enable', false) === true) {
			Util::writeLog($from, $message, $level);
		}
	}

	/**
	 * if smb.logging.enable is set to true in the config will log a leave line
	 * with the given function, the return value or the exception
	 *
	 * @param $function
	 * @param mixed $result an exception will be logged and then returned
	 * @return mixed
	 */
	private function leave($function, $result) {
		if (\OC::$server->getConfig()->getSystemValue('smb.logging.enable', false) === false) {
			//don't bother building log strings
			return $result;
		} elseif ($result === true) {
			Util::writeLog('smb', "leave: $function, return true", Util::DEBUG);
		} elseif ($result === false) {
			Util::writeLog('smb', "leave: $function, return false", Util::DEBUG);
		} elseif (\is_string($result)) {
			Util::writeLog('smb', "leave: $function, return '$result'", Util::DEBUG);
		} elseif (\is_resource($result)) {
			Util::writeLog('smb', "leave: $function, return resource", Util::DEBUG);
		} elseif ($result instanceof \Exception) {
			Util::writeLog('smb', "leave: $function, throw ".\get_class($result)
				.' - code: '.$result->getCode()
				.' message: '.$result->getMessage()
				.' trace: '.$result->getTraceAsString(), Util::DEBUG);
		} else {
			Util::writeLog('smb', "leave: $function, return ".\json_encode($result, true), Util::DEBUG);
		}
		return $result;
	}

	private function swallow($function, \Exception $exception) {
		if (\OC::$server->getConfig()->getSystemValue('smb.logging.enable', false) === true) {
			Util::writeLog('smb', "$function swallowing ".\get_class($exception)
				.' - code: '.$exception->getCode()
				.' message: '.$exception->getMessage()
				.' trace: '.$exception->getTraceAsString(), Util::DEBUG);
		}
	}

	/**
	 * immediately close / free connection
	 */
	public function __destruct() {
		unset($this->share);
	}

	/**
	 * @param string $path
	 * @param array $options
	 * @return StreamInterface
	 * @since 11.0.0
	 */
	public function readFile(string $path, array $options = []): StreamInterface {
		$fullPath = $this->buildPath($path);
		if (!$this->file_exists($path)) {
			return stream_for($this->share->read($fullPath));
		}
		throw new NotFoundException();
	}

	/**
	 * @param string $path
	 * @param StreamInterface $stream
	 * @return int
	 * @since 11.0.0
	 */
	public function writeFile(string $path, StreamInterface $stream): int {
		$fullPath = $this->buildPath($path);
		$dest = $this->share->write($fullPath);
		copy_to_stream($stream, stream_for($dest));
		return $stream->getSize();
	}
}

owncloud / core

Pull Request — master (#32044)

SMB::leave() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
