nextcloud/apps/files_external/lib/Lib/Storage/SMB.php

474 lines
12 KiB
PHP
Raw Normal View History

2012-05-24 20:22:33 +04:00
<?php
/**
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Jesús Macias <jmacias@solidgear.es>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Philipp Kapfer <philipp.kapfer@gmx.at>
* @author Robin Appelman <icewind@owncloud.com>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @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/>
*
2012-05-24 20:22:33 +04:00
*/
namespace OCA\Files_External\Lib\Storage;
2012-09-07 20:30:48 +04:00
use Icewind\SMB\Exception\ConnectException;
2014-08-26 20:46:07 +04:00
use Icewind\SMB\Exception\Exception;
use Icewind\SMB\Exception\ForbiddenException;
2014-08-26 20:46:07 +04:00
use Icewind\SMB\Exception\NotFoundException;
2016-07-14 15:46:01 +03:00
use Icewind\SMB\IShare;
2014-08-26 20:46:07 +04:00
use Icewind\SMB\NativeServer;
use Icewind\SMB\Server;
2015-12-15 16:20:16 +03:00
use Icewind\Streams\CallbackWrapper;
2014-08-26 20:46:07 +04:00
use Icewind\Streams\IteratorDirectory;
use OC\Cache\CappedMemoryCache;
2014-08-26 20:46:07 +04:00
use OC\Files\Filesystem;
2016-07-14 15:46:01 +03:00
use OC\Files\Storage\Common;
use OCP\Files\Storage\INotifyStorage;
use OCP\Files\StorageNotAvailableException;
2012-05-24 20:22:33 +04:00
2016-07-14 15:46:01 +03:00
class SMB extends Common implements INotifyStorage {
2014-08-26 20:46:07 +04:00
/**
* @var \Icewind\SMB\Server
*/
protected $server;
/**
* @var \Icewind\SMB\Share
*/
protected $share;
/**
* @var string
*/
protected $root;
2014-08-26 20:46:07 +04:00
/**
* @var \Icewind\SMB\FileInfo[]
*/
protected $statCache;
2012-05-24 20:22:33 +04:00
2012-09-07 17:22:01 +04:00
public function __construct($params) {
if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) {
2014-08-26 20:46:07 +04:00
if (Server::NativeAvailable()) {
$this->server = new NativeServer($params['host'], $params['user'], $params['password']);
} else {
$this->server = new Server($params['host'], $params['user'], $params['password']);
}
2014-08-26 20:46:07 +04:00
$this->share = $this->server->getShare(trim($params['share'], '/'));
$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 {
throw new \Exception('Invalid configuration');
}
$this->statCache = new CappedMemoryCache();
2012-11-16 15:14:29 +04:00
}
2012-05-24 20:22:33 +04:00
2014-08-26 20:46:07 +04:00
/**
* @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->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
2012-05-24 20:22:33 +04:00
}
2014-08-26 20:46:07 +04:00
/**
* @param string $path
* @return string
*/
protected function buildPath($path) {
return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
2014-08-26 20:46:07 +04:00
}
2016-07-14 15:46:01 +03:00
protected function relativePath($fullPath) {
if ($fullPath === $this->root) {
return '';
} else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
return substr($fullPath, strlen($this->root));
} else {
return null;
}
}
2014-08-26 20:46:07 +04:00
/**
* @param string $path
* @return \Icewind\SMB\IFileInfo
* @throws StorageNotAvailableException
2014-08-26 20:46:07 +04:00
*/
protected function getFileInfo($path) {
try {
$path = $this->buildPath($path);
if (!isset($this->statCache[$path])) {
$this->statCache[$path] = $this->share->stat($path);
}
return $this->statCache[$path];
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
}
2012-06-17 04:54:23 +04:00
}
2014-08-26 20:46:07 +04:00
/**
* @param string $path
* @return \Icewind\SMB\IFileInfo[]
* @throws StorageNotAvailableException
2014-08-26 20:46:07 +04:00
*/
protected function getFolderContents($path) {
try {
$path = $this->buildPath($path);
$files = $this->share->dir($path);
foreach ($files as $file) {
$this->statCache[$path . '/' . $file->getName()] = $file;
}
return $files;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
2014-08-26 20:46:07 +04:00
}
}
2014-08-26 20:46:07 +04:00
/**
* @param \Icewind\SMB\IFileInfo $info
* @return array
*/
protected function formatInfo($info) {
return array(
'size' => $info->getSize(),
'mtime' => $info->getMTime()
);
}
2014-08-26 20:46:07 +04:00
/**
* @param string $path
* @return array
*/
public function stat($path) {
return $this->formatInfo($this->getFileInfo($path));
2012-06-17 04:54:23 +04:00
}
/**
2014-05-15 16:19:32 +04:00
* @param string $path
2014-08-26 20:46:07 +04:00
* @return bool
*/
public function unlink($path) {
2015-02-09 15:13:39 +03:00
try {
if ($this->is_dir($path)) {
return $this->rmdir($path);
} else {
$path = $this->buildPath($path);
unset($this->statCache[$path]);
$this->share->del($path);
return true;
}
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
}
}
/**
* @param string $path1 the old name
* @param string $path2 the new name
* @return bool
*/
public function rename($path1, $path2) {
try {
$this->remove($path2);
$path1 = $this->buildPath($path1);
$path2 = $this->buildPath($path2);
return $this->share->rename($path1, $path2);
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
}
}
2012-06-17 04:54:23 +04:00
/**
* check if a file or folder has been updated since $time
2014-08-26 20:46:07 +04:00
*
* @param string $path
2012-06-17 04:54:23 +04:00
* @param int $time
* @return bool
*/
2014-08-26 20:46:07 +04:00
public function hasUpdated($path, $time) {
if (!$path and $this->root == '/') {
// mtime doesn't work for shares, but giving the nature of the backend,
// doing a full update is still just fast enough
2012-06-17 04:54:23 +04:00
return true;
} else {
2014-08-26 20:46:07 +04:00
$actualTime = $this->filemtime($path);
return $actualTime > $time;
2012-06-17 04:54:23 +04:00
}
}
/**
2014-08-26 20:46:07 +04:00
* @param string $path
* @param string $mode
2016-07-06 00:18:41 +03:00
* @return resource|false
2012-06-17 04:54:23 +04:00
*/
2014-08-26 20:46:07 +04:00
public function fopen($path, $mode) {
$fullPath = $this->buildPath($path);
try {
switch ($mode) {
case 'r':
case 'rb':
if (!$this->file_exists($path)) {
return false;
}
return $this->share->read($fullPath);
case 'w':
case 'wb':
2015-12-15 16:20:16 +03:00
$source = $this->share->write($fullPath);
return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
unset($this->statCache[$fullPath]);
});
2014-08-26 20:46:07 +04:00
case 'a':
case 'ab':
case 'r+':
case 'w+':
case 'wb+':
case 'a+':
case 'x':
case 'x+':
case 'c':
case 'c+':
//emulate these
if (strrpos($path, '.') !== false) {
$ext = substr($path, strrpos($path, '.'));
} else {
$ext = '';
}
2014-08-26 20:46:07 +04:00
if ($this->file_exists($path)) {
if (!$this->isUpdatable($path)) {
return false;
}
$tmpFile = $this->getCachedFile($path);
} else {
if (!$this->isCreatable(dirname($path))) {
return false;
}
$tmpFile = \OCP\Files::tmpFile($ext);
}
$source = fopen($tmpFile, $mode);
$share = $this->share;
2015-12-15 16:20:16 +03:00
return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
unset($this->statCache[$fullPath]);
2014-08-26 20:46:07 +04:00
$share->put($tmpFile, $fullPath);
unlink($tmpFile);
});
}
return false;
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
2014-08-26 20:46:07 +04:00
}
}
public function rmdir($path) {
try {
$this->statCache = array();
$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());
2012-06-17 04:54:23 +04:00
}
}
2014-08-26 20:46:07 +04:00
$this->share->rmdir($this->buildPath($path));
return true;
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
2014-08-26 20:46:07 +04:00
}
}
public function touch($path, $time = null) {
try {
if (!$this->file_exists($path)) {
$fh = $this->share->write($this->buildPath($path));
fclose($fh);
return true;
}
return false;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
2014-08-26 20:46:07 +04:00
}
}
public function opendir($path) {
try {
$files = $this->getFolderContents($path);
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
}
2014-08-26 20:46:07 +04:00
$names = array_map(function ($info) {
/** @var \Icewind\SMB\IFileInfo $info */
return $info->getName();
}, $files);
return IteratorDirectory::wrap($names);
}
public function filetype($path) {
try {
return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
2014-08-26 20:46:07 +04:00
}
}
public function mkdir($path) {
$path = $this->buildPath($path);
try {
$this->share->mkdir($path);
return true;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
2014-08-26 20:46:07 +04:00
} catch (Exception $e) {
return false;
}
}
public function file_exists($path) {
try {
$this->getFileInfo($path);
return true;
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
2012-06-17 04:54:23 +04:00
}
2012-05-24 20:22:33 +04:00
}
2016-03-21 16:35:41 +03:00
public function isReadable($path) {
try {
$info = $this->getFileInfo($path);
return !$info->isHidden();
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
}
}
public function isUpdatable($path) {
try {
$info = $this->getFileInfo($path);
return !$info->isHidden() && !$info->isReadOnly();
} catch (NotFoundException $e) {
return false;
} catch (ForbiddenException $e) {
return false;
}
}
/**
* check if smbclient is installed
*/
public static function checkDependencies() {
return (
(bool)\OC_Helper::findBinaryPath('smbclient')
|| Server::NativeAvailable()
) ? true : ['smbclient'];
}
/**
* Test a storage for availability
*
* @return bool
*/
public function test() {
try {
return parent::test();
} catch (Exception $e) {
return false;
}
}
2016-07-14 15:46:01 +03:00
public function listen($path, callable $callback) {
$fullPath = $this->buildPath($path);
$oldRenamePath = null;
$this->share->notify($fullPath, function ($smbType, $fullPath) use (&$oldRenamePath, $callback) {
$path = $this->relativePath($fullPath);
if (is_null($path)) {
return true;
}
if ($smbType === IShare::NOTIFY_RENAMED_OLD) {
$oldRenamePath = $path;
return true;
}
$type = $this->mapNotifyType($smbType);
if (is_null($type)) {
return true;
}
if ($type === INotifyStorage::NOTIFY_RENAMED && !is_null($oldRenamePath)) {
$result = $callback($type, $path, $oldRenamePath);
$oldRenamePath = null;
} else {
$result = $callback($type, $path);
}
return $result;
});
}
private function mapNotifyType($smbType) {
switch ($smbType) {
case IShare::NOTIFY_ADDED:
return INotifyStorage::NOTIFY_ADDED;
case IShare::NOTIFY_REMOVED:
return INotifyStorage::NOTIFY_REMOVED;
case IShare::NOTIFY_MODIFIED:
case IShare::NOTIFY_ADDED_STREAM:
case IShare::NOTIFY_MODIFIED_STREAM:
case IShare::NOTIFY_REMOVED_STREAM:
return INotifyStorage::NOTIFY_MODIFIED;
case IShare::NOTIFY_RENAMED_NEW:
return INotifyStorage::NOTIFY_RENAMED;
default:
return null;
}
}
2012-05-24 20:22:33 +04:00
}