123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author J0WI <J0WI@users.noreply.github.com>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Tigran Mkrtchyan <tigran.mkrtchyan@desy.de>
- * @author Vincent Petry <vincent@nextcloud.com>
- * @author Vinicius Cubas Brand <vinicius@eita.org.br>
- *
- * @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\Wrapper;
- use OC\Files\Storage\FailedStorage;
- use OCP\Files\InvalidPathException;
- use OCP\Files\Storage\ILockingStorage;
- use OCP\Files\Storage\IStorage;
- use OCP\Files\Storage\IWriteStreamStorage;
- use OCP\Lock\ILockingProvider;
- use OCP\Server;
- use Psr\Log\LoggerInterface;
- class Wrapper implements \OC\Files\Storage\Storage, ILockingStorage, IWriteStreamStorage {
- /**
- * @var \OC\Files\Storage\Storage $storage
- */
- protected $storage;
- public $cache;
- public $scanner;
- public $watcher;
- public $propagator;
- public $updater;
- /**
- * @param array $parameters
- */
- public function __construct($parameters) {
- $this->storage = $parameters['storage'];
- }
- /**
- * @return \OC\Files\Storage\Storage
- */
- public function getWrapperStorage() {
- if (!$this->storage) {
- $message = "storage wrapper " . get_class($this) . " doesn't have a wrapped storage set";
- $logger = Server::get(LoggerInterface::class);
- $logger->error($message);
- $this->storage = new FailedStorage(['exception' => new \Exception($message)]);
- }
- return $this->storage;
- }
- /**
- * Get the identifier for the storage,
- * the returned id should be the same for every storage object that is created with the same parameters
- * and two storage objects with the same id should refer to two storages that display the same files.
- *
- * @return string
- */
- public function getId() {
- return $this->getWrapperStorage()->getId();
- }
- /**
- * see https://www.php.net/manual/en/function.mkdir.php
- *
- * @param string $path
- * @return bool
- */
- public function mkdir($path) {
- return $this->getWrapperStorage()->mkdir($path);
- }
- /**
- * see https://www.php.net/manual/en/function.rmdir.php
- *
- * @param string $path
- * @return bool
- */
- public function rmdir($path) {
- return $this->getWrapperStorage()->rmdir($path);
- }
- /**
- * see https://www.php.net/manual/en/function.opendir.php
- *
- * @param string $path
- * @return resource|false
- */
- public function opendir($path) {
- return $this->getWrapperStorage()->opendir($path);
- }
- /**
- * see https://www.php.net/manual/en/function.is_dir.php
- *
- * @param string $path
- * @return bool
- */
- public function is_dir($path) {
- return $this->getWrapperStorage()->is_dir($path);
- }
- /**
- * see https://www.php.net/manual/en/function.is_file.php
- *
- * @param string $path
- * @return bool
- */
- public function is_file($path) {
- return $this->getWrapperStorage()->is_file($path);
- }
- /**
- * see https://www.php.net/manual/en/function.stat.php
- * only the following keys are required in the result: size and mtime
- *
- * @param string $path
- * @return array|bool
- */
- public function stat($path) {
- return $this->getWrapperStorage()->stat($path);
- }
- /**
- * see https://www.php.net/manual/en/function.filetype.php
- *
- * @param string $path
- * @return string|bool
- */
- public function filetype($path) {
- return $this->getWrapperStorage()->filetype($path);
- }
- /**
- * see https://www.php.net/manual/en/function.filesize.php
- * The result for filesize when called on a folder is required to be 0
- */
- public function filesize($path): false|int|float {
- return $this->getWrapperStorage()->filesize($path);
- }
- /**
- * check if a file can be created in $path
- *
- * @param string $path
- * @return bool
- */
- public function isCreatable($path) {
- return $this->getWrapperStorage()->isCreatable($path);
- }
- /**
- * check if a file can be read
- *
- * @param string $path
- * @return bool
- */
- public function isReadable($path) {
- return $this->getWrapperStorage()->isReadable($path);
- }
- /**
- * check if a file can be written to
- *
- * @param string $path
- * @return bool
- */
- public function isUpdatable($path) {
- return $this->getWrapperStorage()->isUpdatable($path);
- }
- /**
- * check if a file can be deleted
- *
- * @param string $path
- * @return bool
- */
- public function isDeletable($path) {
- return $this->getWrapperStorage()->isDeletable($path);
- }
- /**
- * check if a file can be shared
- *
- * @param string $path
- * @return bool
- */
- public function isSharable($path) {
- return $this->getWrapperStorage()->isSharable($path);
- }
- /**
- * get the full permissions of a path.
- * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
- *
- * @param string $path
- * @return int
- */
- public function getPermissions($path) {
- return $this->getWrapperStorage()->getPermissions($path);
- }
- /**
- * see https://www.php.net/manual/en/function.file_exists.php
- *
- * @param string $path
- * @return bool
- */
- public function file_exists($path) {
- return $this->getWrapperStorage()->file_exists($path);
- }
- /**
- * see https://www.php.net/manual/en/function.filemtime.php
- *
- * @param string $path
- * @return int|bool
- */
- public function filemtime($path) {
- return $this->getWrapperStorage()->filemtime($path);
- }
- /**
- * see https://www.php.net/manual/en/function.file_get_contents.php
- *
- * @param string $path
- * @return string|false
- */
- public function file_get_contents($path) {
- return $this->getWrapperStorage()->file_get_contents($path);
- }
- /**
- * see https://www.php.net/manual/en/function.file_put_contents.php
- *
- * @param string $path
- * @param mixed $data
- * @return int|float|false
- */
- public function file_put_contents($path, $data) {
- return $this->getWrapperStorage()->file_put_contents($path, $data);
- }
- /**
- * see https://www.php.net/manual/en/function.unlink.php
- *
- * @param string $path
- * @return bool
- */
- public function unlink($path) {
- return $this->getWrapperStorage()->unlink($path);
- }
- /**
- * see https://www.php.net/manual/en/function.rename.php
- *
- * @param string $source
- * @param string $target
- * @return bool
- */
- public function rename($source, $target) {
- return $this->getWrapperStorage()->rename($source, $target);
- }
- /**
- * see https://www.php.net/manual/en/function.copy.php
- *
- * @param string $source
- * @param string $target
- * @return bool
- */
- public function copy($source, $target) {
- return $this->getWrapperStorage()->copy($source, $target);
- }
- /**
- * see https://www.php.net/manual/en/function.fopen.php
- *
- * @param string $path
- * @param string $mode
- * @return resource|bool
- */
- public function fopen($path, $mode) {
- return $this->getWrapperStorage()->fopen($path, $mode);
- }
- /**
- * get the mimetype for a file or folder
- * The mimetype for a folder is required to be "httpd/unix-directory"
- *
- * @param string $path
- * @return string|bool
- */
- public function getMimeType($path) {
- return $this->getWrapperStorage()->getMimeType($path);
- }
- /**
- * see https://www.php.net/manual/en/function.hash.php
- *
- * @param string $type
- * @param string $path
- * @param bool $raw
- * @return string|bool
- */
- public function hash($type, $path, $raw = false) {
- return $this->getWrapperStorage()->hash($type, $path, $raw);
- }
- /**
- * see https://www.php.net/manual/en/function.free_space.php
- *
- * @param string $path
- * @return int|float|bool
- */
- public function free_space($path) {
- return $this->getWrapperStorage()->free_space($path);
- }
- /**
- * search for occurrences of $query in file names
- *
- * @param string $query
- * @return array|bool
- */
- public function search($query) {
- return $this->getWrapperStorage()->search($query);
- }
- /**
- * see https://www.php.net/manual/en/function.touch.php
- * If the backend does not support the operation, false should be returned
- *
- * @param string $path
- * @param int $mtime
- * @return bool
- */
- public function touch($path, $mtime = null) {
- return $this->getWrapperStorage()->touch($path, $mtime);
- }
- /**
- * get the path to a local version of the file.
- * The local version of the file can be temporary and doesn't have to be persistent across requests
- *
- * @param string $path
- * @return string|false
- */
- public function getLocalFile($path) {
- return $this->getWrapperStorage()->getLocalFile($path);
- }
- /**
- * check if a file or folder has been updated since $time
- *
- * @param string $path
- * @param int $time
- * @return bool
- *
- * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
- * returning true for other changes in the folder is optional
- */
- public function hasUpdated($path, $time) {
- return $this->getWrapperStorage()->hasUpdated($path, $time);
- }
- /**
- * get a cache instance for the storage
- *
- * @param string $path
- * @param \OC\Files\Storage\Storage|null (optional) the storage to pass to the cache
- * @return \OC\Files\Cache\Cache
- */
- public function getCache($path = '', $storage = null) {
- if (!$storage) {
- $storage = $this;
- }
- return $this->getWrapperStorage()->getCache($path, $storage);
- }
- /**
- * get a scanner instance for the storage
- *
- * @param string $path
- * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
- * @return \OC\Files\Cache\Scanner
- */
- public function getScanner($path = '', $storage = null) {
- if (!$storage) {
- $storage = $this;
- }
- return $this->getWrapperStorage()->getScanner($path, $storage);
- }
- /**
- * get the user id of the owner of a file or folder
- *
- * @param string $path
- * @return string
- */
- public function getOwner($path) {
- return $this->getWrapperStorage()->getOwner($path);
- }
- /**
- * get a watcher instance for the cache
- *
- * @param string $path
- * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
- * @return \OC\Files\Cache\Watcher
- */
- public function getWatcher($path = '', $storage = null) {
- if (!$storage) {
- $storage = $this;
- }
- return $this->getWrapperStorage()->getWatcher($path, $storage);
- }
- public function getPropagator($storage = null) {
- if (!$storage) {
- $storage = $this;
- }
- return $this->getWrapperStorage()->getPropagator($storage);
- }
- public function getUpdater($storage = null) {
- if (!$storage) {
- $storage = $this;
- }
- return $this->getWrapperStorage()->getUpdater($storage);
- }
- /**
- * @return \OC\Files\Cache\Storage
- */
- public function getStorageCache() {
- return $this->getWrapperStorage()->getStorageCache();
- }
- /**
- * get the ETag for a file or folder
- *
- * @param string $path
- * @return string|false
- */
- public function getETag($path) {
- return $this->getWrapperStorage()->getETag($path);
- }
- /**
- * Returns true
- *
- * @return true
- */
- public function test() {
- return $this->getWrapperStorage()->test();
- }
- /**
- * Returns the wrapped storage's value for isLocal()
- *
- * @return bool wrapped storage's isLocal() value
- */
- public function isLocal() {
- return $this->getWrapperStorage()->isLocal();
- }
- /**
- * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
- *
- * @param class-string<IStorage> $class
- * @return bool
- */
- public function instanceOfStorage($class) {
- if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
- // FIXME Temporary fix to keep existing checks working
- $class = '\OCA\Files_Sharing\SharedStorage';
- }
- return is_a($this, $class) or $this->getWrapperStorage()->instanceOfStorage($class);
- }
- /**
- * @psalm-template T of IStorage
- * @psalm-param class-string<T> $class
- * @psalm-return T|null
- */
- public function getInstanceOfStorage(string $class) {
- $storage = $this;
- while ($storage instanceof Wrapper) {
- if ($storage instanceof $class) {
- break;
- }
- $storage = $storage->getWrapperStorage();
- }
- if (!($storage instanceof $class)) {
- return null;
- }
- return $storage;
- }
- /**
- * Pass any methods custom to specific storage implementations to the wrapped storage
- *
- * @param string $method
- * @param array $args
- * @return mixed
- */
- public function __call($method, $args) {
- return call_user_func_array([$this->getWrapperStorage(), $method], $args);
- }
- /**
- * A custom storage implementation can return an url for direct download of a give file.
- *
- * For now the returned array can hold the parameter url - in future more attributes might follow.
- *
- * @param string $path
- * @return array|bool
- */
- public function getDirectDownload($path) {
- return $this->getWrapperStorage()->getDirectDownload($path);
- }
- /**
- * Get availability of the storage
- *
- * @return array [ available, last_checked ]
- */
- public function getAvailability() {
- return $this->getWrapperStorage()->getAvailability();
- }
- /**
- * Set availability of the storage
- *
- * @param bool $isAvailable
- */
- public function setAvailability($isAvailable) {
- $this->getWrapperStorage()->setAvailability($isAvailable);
- }
- /**
- * @param string $path the path of the target folder
- * @param string $fileName the name of the file itself
- * @return void
- * @throws InvalidPathException
- */
- public function verifyPath($path, $fileName) {
- $this->getWrapperStorage()->verifyPath($path, $fileName);
- }
- /**
- * @param IStorage $sourceStorage
- * @param string $sourceInternalPath
- * @param string $targetInternalPath
- * @return bool
- */
- public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
- if ($sourceStorage === $this) {
- return $this->copy($sourceInternalPath, $targetInternalPath);
- }
- return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
- }
- /**
- * @param IStorage $sourceStorage
- * @param string $sourceInternalPath
- * @param string $targetInternalPath
- * @return bool
- */
- public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
- if ($sourceStorage === $this) {
- return $this->rename($sourceInternalPath, $targetInternalPath);
- }
- return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
- }
- public function getMetaData($path) {
- return $this->getWrapperStorage()->getMetaData($path);
- }
- /**
- * @param string $path
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param \OCP\Lock\ILockingProvider $provider
- * @throws \OCP\Lock\LockedException
- */
- public function acquireLock($path, $type, ILockingProvider $provider) {
- if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
- $this->getWrapperStorage()->acquireLock($path, $type, $provider);
- }
- }
- /**
- * @param string $path
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param \OCP\Lock\ILockingProvider $provider
- */
- public function releaseLock($path, $type, ILockingProvider $provider) {
- if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
- $this->getWrapperStorage()->releaseLock($path, $type, $provider);
- }
- }
- /**
- * @param string $path
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param \OCP\Lock\ILockingProvider $provider
- */
- public function changeLock($path, $type, ILockingProvider $provider) {
- if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
- $this->getWrapperStorage()->changeLock($path, $type, $provider);
- }
- }
- /**
- * @return bool
- */
- public function needsPartFile() {
- return $this->getWrapperStorage()->needsPartFile();
- }
- public function writeStream(string $path, $stream, ?int $size = null): int {
- $storage = $this->getWrapperStorage();
- if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
- /** @var IWriteStreamStorage $storage */
- return $storage->writeStream($path, $stream, $size);
- } else {
- $target = $this->fopen($path, 'w');
- [$count, $result] = \OC_Helper::streamCopy($stream, $target);
- fclose($stream);
- fclose($target);
- return $count;
- }
- }
- public function getDirectoryContent($directory): \Traversable {
- return $this->getWrapperStorage()->getDirectoryContent($directory);
- }
- public function isWrapperOf(IStorage $storage) {
- $wrapped = $this->getWrapperStorage();
- if ($wrapped === $storage) {
- return true;
- }
- if ($wrapped instanceof Wrapper) {
- return $wrapped->isWrapperOf($storage);
- }
- return false;
- }
- }
|