285 lines
7 KiB
PHP
285 lines
7 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
||
|
|
*
|
||
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
||
|
|
* @author Björn Schießle <bjoern@schiessle.org>
|
||
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
||
|
|
* @author Georg Ehrke <oc.list@georgehrke.com>
|
||
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
||
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
||
|
|
* @author Robin Appelman <robin@icewind.nl>
|
||
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
||
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
||
|
|
*
|
||
|
|
* @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\Mount;
|
||
|
|
|
||
|
|
use OC\Files\Filesystem;
|
||
|
|
use OC\Files\Storage\Storage;
|
||
|
|
use OC\Files\Storage\StorageFactory;
|
||
|
|
use OCP\Files\Mount\IMountPoint;
|
||
|
|
use OCP\ILogger;
|
||
|
|
|
||
|
|
class MountPoint implements IMountPoint {
|
||
|
|
/**
|
||
|
|
* @var \OC\Files\Storage\Storage $storage
|
||
|
|
*/
|
||
|
|
protected $storage = null;
|
||
|
|
protected $class;
|
||
|
|
protected $storageId;
|
||
|
|
protected $rootId = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Configuration options for the storage backend
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
protected $arguments = [];
|
||
|
|
protected $mountPoint;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Mount specific options
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
protected $mountOptions = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var \OC\Files\Storage\StorageFactory $loader
|
||
|
|
*/
|
||
|
|
private $loader;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Specified whether the storage is invalid after failing to
|
||
|
|
* instantiate it.
|
||
|
|
*
|
||
|
|
* @var bool
|
||
|
|
*/
|
||
|
|
private $invalidStorage = false;
|
||
|
|
|
||
|
|
/** @var int|null */
|
||
|
|
protected $mountId;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string|\OC\Files\Storage\Storage $storage
|
||
|
|
* @param string $mountpoint
|
||
|
|
* @param array $arguments (optional) configuration for the storage backend
|
||
|
|
* @param \OCP\Files\Storage\IStorageFactory $loader
|
||
|
|
* @param array $mountOptions mount specific options
|
||
|
|
* @param int|null $mountId
|
||
|
|
* @throws \Exception
|
||
|
|
*/
|
||
|
|
public function __construct($storage, $mountpoint, $arguments = null, $loader = null, $mountOptions = null, $mountId = null) {
|
||
|
|
if (is_null($arguments)) {
|
||
|
|
$arguments = [];
|
||
|
|
}
|
||
|
|
if (is_null($loader)) {
|
||
|
|
$this->loader = new StorageFactory();
|
||
|
|
} else {
|
||
|
|
$this->loader = $loader;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!is_null($mountOptions)) {
|
||
|
|
$this->mountOptions = $mountOptions;
|
||
|
|
}
|
||
|
|
|
||
|
|
$mountpoint = $this->formatPath($mountpoint);
|
||
|
|
$this->mountPoint = $mountpoint;
|
||
|
|
$this->mountId = $mountId;
|
||
|
|
if ($storage instanceof Storage) {
|
||
|
|
$this->class = get_class($storage);
|
||
|
|
$this->storage = $this->loader->wrap($this, $storage);
|
||
|
|
} else {
|
||
|
|
// Update old classes to new namespace
|
||
|
|
if (strpos($storage, 'OC_Filestorage_') !== false) {
|
||
|
|
$storage = '\OC\Files\Storage\\' . substr($storage, 15);
|
||
|
|
}
|
||
|
|
$this->class = $storage;
|
||
|
|
$this->arguments = $arguments;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* get complete path to the mount point, relative to data/
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getMountPoint() {
|
||
|
|
return $this->mountPoint;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the mount point path, relative to data/
|
||
|
|
*
|
||
|
|
* @param string $mountPoint new mount point
|
||
|
|
*/
|
||
|
|
public function setMountPoint($mountPoint) {
|
||
|
|
$this->mountPoint = $this->formatPath($mountPoint);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* create the storage that is mounted
|
||
|
|
*/
|
||
|
|
private function createStorage() {
|
||
|
|
if ($this->invalidStorage) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (class_exists($this->class)) {
|
||
|
|
try {
|
||
|
|
$class = $this->class;
|
||
|
|
// prevent recursion by setting the storage before applying wrappers
|
||
|
|
$this->storage = new $class($this->arguments);
|
||
|
|
$this->storage = $this->loader->wrap($this, $this->storage);
|
||
|
|
} catch (\Exception $exception) {
|
||
|
|
$this->storage = null;
|
||
|
|
$this->invalidStorage = true;
|
||
|
|
if ($this->mountPoint === '/') {
|
||
|
|
// the root storage could not be initialized, show the user!
|
||
|
|
throw new \Exception('The root storage could not be initialized. Please contact your local administrator.', $exception->getCode(), $exception);
|
||
|
|
} else {
|
||
|
|
\OC::$server->getLogger()->logException($exception, ['level' => ILogger::ERROR]);
|
||
|
|
}
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
\OCP\Util::writeLog('core', 'storage backend ' . $this->class . ' not found', ILogger::ERROR);
|
||
|
|
$this->invalidStorage = true;
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return \OC\Files\Storage\Storage
|
||
|
|
*/
|
||
|
|
public function getStorage() {
|
||
|
|
if (is_null($this->storage)) {
|
||
|
|
$this->createStorage();
|
||
|
|
}
|
||
|
|
return $this->storage;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getStorageId() {
|
||
|
|
if (!$this->storageId) {
|
||
|
|
if (is_null($this->storage)) {
|
||
|
|
$storage = $this->createStorage(); //FIXME: start using exceptions
|
||
|
|
if (is_null($storage)) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->storage = $storage;
|
||
|
|
}
|
||
|
|
$this->storageId = $this->storage->getId();
|
||
|
|
if (strlen($this->storageId) > 64) {
|
||
|
|
$this->storageId = md5($this->storageId);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $this->storageId;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getNumericStorageId() {
|
||
|
|
return $this->getStorage()->getStorageCache()->getNumericId();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $path
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getInternalPath($path) {
|
||
|
|
$path = Filesystem::normalizePath($path, true, false, true);
|
||
|
|
if ($this->mountPoint === $path or $this->mountPoint . '/' === $path) {
|
||
|
|
$internalPath = '';
|
||
|
|
} else {
|
||
|
|
$internalPath = substr($path, strlen($this->mountPoint));
|
||
|
|
}
|
||
|
|
// substr returns false instead of an empty string, we always want a string
|
||
|
|
return (string)$internalPath;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $path
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
private function formatPath($path) {
|
||
|
|
$path = Filesystem::normalizePath($path);
|
||
|
|
if (strlen($path) > 1) {
|
||
|
|
$path .= '/';
|
||
|
|
}
|
||
|
|
return $path;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param callable $wrapper
|
||
|
|
*/
|
||
|
|
public function wrapStorage($wrapper) {
|
||
|
|
$storage = $this->getStorage();
|
||
|
|
// storage can be null if it couldn't be initialized
|
||
|
|
if ($storage != null) {
|
||
|
|
$this->storage = $wrapper($this->mountPoint, $storage, $this);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get a mount option
|
||
|
|
*
|
||
|
|
* @param string $name Name of the mount option to get
|
||
|
|
* @param mixed $default Default value for the mount option
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function getOption($name, $default) {
|
||
|
|
return isset($this->mountOptions[$name]) ? $this->mountOptions[$name] : $default;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get all options for the mount
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getOptions() {
|
||
|
|
return $this->mountOptions;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the file id of the root of the storage
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getStorageRootId() {
|
||
|
|
if (is_null($this->rootId) || $this->rootId === -1) {
|
||
|
|
$this->rootId = (int)$this->getStorage()->getCache()->getId('');
|
||
|
|
}
|
||
|
|
return $this->rootId;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getMountId() {
|
||
|
|
return $this->mountId;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getMountType() {
|
||
|
|
return '';
|
||
|
|
}
|
||
|
|
}
|