aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/smb.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_external/lib/smb.php')
-rw-r--r--apps/files_external/lib/smb.php396
1 files changed, 0 insertions, 396 deletions
diff --git a/apps/files_external/lib/smb.php b/apps/files_external/lib/smb.php
deleted file mode 100644
index 08c4b25a088..00000000000
--- a/apps/files_external/lib/smb.php
+++ /dev/null
@@ -1,396 +0,0 @@
-<?php
-/**
- * @author Arthur Schiwon <blizzz@owncloud.com>
- * @author Jesús Macias <jmacias@solidgear.es>
- * @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>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @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 OC\Files\Storage;
-
-use Icewind\SMB\Exception\ConnectException;
-use Icewind\SMB\Exception\Exception;
-use Icewind\SMB\Exception\ForbiddenException;
-use Icewind\SMB\Exception\NotFoundException;
-use Icewind\SMB\NativeServer;
-use Icewind\SMB\Server;
-use Icewind\Streams\CallbackWrapper;
-use Icewind\Streams\IteratorDirectory;
-use OC\Cache\CappedMemoryCache;
-use OC\Files\Filesystem;
-use OCP\Files\StorageNotAvailableException;
-
-class SMB extends Common {
- /**
- * @var \Icewind\SMB\Server
- */
- protected $server;
-
- /**
- * @var \Icewind\SMB\Share
- */
- protected $share;
-
- /**
- * @var string
- */
- protected $root;
-
- /**
- * @var \Icewind\SMB\FileInfo[]
- */
- protected $statCache;
-
- public function __construct($params) {
- if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) {
- if (Server::NativeAvailable()) {
- $this->server = new NativeServer($params['host'], $params['user'], $params['password']);
- } else {
- $this->server = new Server($params['host'], $params['user'], $params['password']);
- }
- $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();
- }
-
- /**
- * @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;
- }
-
- /**
- * @param string $path
- * @return string
- */
- protected function buildPath($path) {
- return Filesystem::normalizePath($this->root . '/' . $path);
- }
-
- /**
- * @param string $path
- * @return \Icewind\SMB\IFileInfo
- * @throws StorageNotAvailableException
- */
- 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);
- }
- }
-
- /**
- * @param string $path
- * @return \Icewind\SMB\IFileInfo[]
- * @throws StorageNotAvailableException
- */
- 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);
- }
- }
-
- /**
- * @param \Icewind\SMB\IFileInfo $info
- * @return array
- */
- protected function formatInfo($info) {
- return array(
- 'size' => $info->getSize(),
- 'mtime' => $info->getMTime()
- );
- }
-
- /**
- * @param string $path
- * @return array
- */
- public function stat($path) {
- return $this->formatInfo($this->getFileInfo($path));
- }
-
- /**
- * @param string $path
- * @return bool
- */
- public function unlink($path) {
- 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);
- }
- }
-
- /**
- * check if a file or folder has been updated since $time
- *
- * @param string $path
- * @param int $time
- * @return bool
- */
- 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
- return true;
- } else {
- $actualTime = $this->filemtime($path);
- return $actualTime > $time;
- }
- }
-
- /**
- * @param string $path
- * @param string $mode
- * @return resource
- */
- 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':
- $source = $this->share->write($fullPath);
- return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
- unset($this->statCache[$fullPath]);
- });
- 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 = '';
- }
- 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;
- return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
- unset($this->statCache[$fullPath]);
- $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);
- }
- }
-
- 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());
- }
- }
- $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);
- }
- }
-
- 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);
- }
- }
-
- public function opendir($path) {
- try {
- $files = $this->getFolderContents($path);
- } catch (NotFoundException $e) {
- return false;
- } catch (ForbiddenException $e) {
- return false;
- }
- $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;
- }
- }
-
- 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);
- } 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);
- }
- }
-
- 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;
- }
- }
-}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 17:02:15 +0000