nextcloud / server

lib/private/Files/Storage/Wrapper/Wrapper.php

Indentation +586 added lines, -586 removed lines

@@ -32,590 +32,590 @@
 use OCP\Lock\ILockingProvider;
 
 class Wrapper implements \OC\Files\Storage\Storage, ILockingStorage {
-	/**
-	 * @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() {
-		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 http://php.net/manual/en/function.mkdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function mkdir($path) {
-		return $this->getWrapperStorage()->mkdir($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		return $this->getWrapperStorage()->rmdir($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource
-	 */
-	public function opendir($path) {
-		return $this->getWrapperStorage()->opendir($path);
-	}
-
-	/**
-	 * see http://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 http://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 http://php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	public function stat($path) {
-		return $this->getWrapperStorage()->stat($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function filetype($path) {
-		return $this->getWrapperStorage()->filetype($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filesize($path) {
-		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 http://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 http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filemtime($path) {
-		return $this->getWrapperStorage()->filemtime($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function file_get_contents($path) {
-		return $this->getWrapperStorage()->file_get_contents($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 */
-	public function file_put_contents($path, $data) {
-		return $this->getWrapperStorage()->file_put_contents($path, $data);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		return $this->getWrapperStorage()->unlink($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		return $this->getWrapperStorage()->rename($path1, $path2);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function copy($path1, $path2) {
-		return $this->getWrapperStorage()->copy($path1, $path2);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	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
-	 */
-	public function getMimeType($path) {
-		return $this->getWrapperStorage()->getMimeType($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.hash.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string
-	 */
-	public function hash($type, $path, $raw = false) {
-		return $this->getWrapperStorage()->hash($type, $path, $raw);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		return $this->getWrapperStorage()->free_space($path);
-	}
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array
-	 */
-	public function search($query) {
-		return $this->getWrapperStorage()->search($query);
-	}
-
-	/**
-	 * see http://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
-	 */
-	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 (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
-	 */
-	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 string $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);
-	}
-
-	/**
-	 * 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(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
-	 */
-	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);
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	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();
-	}
+    /**
+     * @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() {
+        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 http://php.net/manual/en/function.mkdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function mkdir($path) {
+        return $this->getWrapperStorage()->mkdir($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        return $this->getWrapperStorage()->rmdir($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource
+     */
+    public function opendir($path) {
+        return $this->getWrapperStorage()->opendir($path);
+    }
+
+    /**
+     * see http://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 http://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 http://php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array
+     */
+    public function stat($path) {
+        return $this->getWrapperStorage()->stat($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function filetype($path) {
+        return $this->getWrapperStorage()->filetype($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filesize($path) {
+        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 http://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 http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filemtime($path) {
+        return $this->getWrapperStorage()->filemtime($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string
+     */
+    public function file_get_contents($path) {
+        return $this->getWrapperStorage()->file_get_contents($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     */
+    public function file_put_contents($path, $data) {
+        return $this->getWrapperStorage()->file_put_contents($path, $data);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        return $this->getWrapperStorage()->unlink($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        return $this->getWrapperStorage()->rename($path1, $path2);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function copy($path1, $path2) {
+        return $this->getWrapperStorage()->copy($path1, $path2);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    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
+     */
+    public function getMimeType($path) {
+        return $this->getWrapperStorage()->getMimeType($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.hash.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string
+     */
+    public function hash($type, $path, $raw = false) {
+        return $this->getWrapperStorage()->hash($type, $path, $raw);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        return $this->getWrapperStorage()->free_space($path);
+    }
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array
+     */
+    public function search($query) {
+        return $this->getWrapperStorage()->search($query);
+    }
+
+    /**
+     * see http://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
+     */
+    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 (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
+     */
+    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 string $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);
+    }
+
+    /**
+     * 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(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
+     */
+    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);
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    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();
+    }
 }

lib/private/Files/Storage/Wrapper/Availability.php

Indentation +435 added lines, -435 removed lines

@@ -30,439 +30,439 @@
  * Throws a StorageNotAvailableException for storages with known failures
  */
 class Availability extends Wrapper {
-	const RECHECK_TTL_SEC = 600; // 10 minutes
-
-	public static function shouldRecheck($availability) {
-		if (!$availability['available']) {
-			// trigger a recheck if TTL reached
-			if ((time() - $availability['last_checked']) > self::RECHECK_TTL_SEC) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * Only called if availability === false
-	 *
-	 * @return bool
-	 */
-	private function updateAvailability() {
-		// reset availability to false so that multiple requests don't recheck concurrently
-		$this->setAvailability(false);
-		try {
-			$result = $this->test();
-		} catch (\Exception $e) {
-			$result = false;
-		}
-		$this->setAvailability($result);
-		return $result;
-	}
-
-	/**
-	 * @return bool
-	 */
-	private function isAvailable() {
-		$availability = $this->getAvailability();
-		if (self::shouldRecheck($availability)) {
-			return $this->updateAvailability();
-		}
-		return $availability['available'];
-	}
-
-	/**
-	 * @throws \OCP\Files\StorageNotAvailableException
-	 */
-	private function checkAvailability() {
-		if (!$this->isAvailable()) {
-			throw new \OCP\Files\StorageNotAvailableException();
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function mkdir($path) {
-		$this->checkAvailability();
-		try {
-			return parent::mkdir($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function rmdir($path) {
-		$this->checkAvailability();
-		try {
-			return parent::rmdir($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function opendir($path) {
-		$this->checkAvailability();
-		try {
-			return parent::opendir($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function is_dir($path) {
-		$this->checkAvailability();
-		try {
-			return parent::is_dir($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function is_file($path) {
-		$this->checkAvailability();
-		try {
-			return parent::is_file($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function stat($path) {
-		$this->checkAvailability();
-		try {
-			return parent::stat($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function filetype($path) {
-		$this->checkAvailability();
-		try {
-			return parent::filetype($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function filesize($path) {
-		$this->checkAvailability();
-		try {
-			return parent::filesize($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function isCreatable($path) {
-		$this->checkAvailability();
-		try {
-			return parent::isCreatable($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function isReadable($path) {
-		$this->checkAvailability();
-		try {
-			return parent::isReadable($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function isUpdatable($path) {
-		$this->checkAvailability();
-		try {
-			return parent::isUpdatable($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function isDeletable($path) {
-		$this->checkAvailability();
-		try {
-			return parent::isDeletable($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function isSharable($path) {
-		$this->checkAvailability();
-		try {
-			return parent::isSharable($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getPermissions($path) {
-		$this->checkAvailability();
-		try {
-			return parent::getPermissions($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function file_exists($path) {
-		if ($path === '') {
-			return true;
-		}
-		$this->checkAvailability();
-		try {
-			return parent::file_exists($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function filemtime($path) {
-		$this->checkAvailability();
-		try {
-			return parent::filemtime($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function file_get_contents($path) {
-		$this->checkAvailability();
-		try {
-			return parent::file_get_contents($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function file_put_contents($path, $data) {
-		$this->checkAvailability();
-		try {
-			return parent::file_put_contents($path, $data);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function unlink($path) {
-		$this->checkAvailability();
-		try {
-			return parent::unlink($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function rename($path1, $path2) {
-		$this->checkAvailability();
-		try {
-			return parent::rename($path1, $path2);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function copy($path1, $path2) {
-		$this->checkAvailability();
-		try {
-			return parent::copy($path1, $path2);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function fopen($path, $mode) {
-		$this->checkAvailability();
-		try {
-			return parent::fopen($path, $mode);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getMimeType($path) {
-		$this->checkAvailability();
-		try {
-			return parent::getMimeType($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function hash($type, $path, $raw = false) {
-		$this->checkAvailability();
-		try {
-			return parent::hash($type, $path, $raw);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function free_space($path) {
-		$this->checkAvailability();
-		try {
-			return parent::free_space($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function search($query) {
-		$this->checkAvailability();
-		try {
-			return parent::search($query);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function touch($path, $mtime = null) {
-		$this->checkAvailability();
-		try {
-			return parent::touch($path, $mtime);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getLocalFile($path) {
-		$this->checkAvailability();
-		try {
-			return parent::getLocalFile($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function hasUpdated($path, $time) {
-		$this->checkAvailability();
-		try {
-			return parent::hasUpdated($path, $time);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getOwner($path) {
-		try {
-			return parent::getOwner($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getETag($path) {
-		$this->checkAvailability();
-		try {
-			return parent::getETag($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getDirectDownload($path) {
-		$this->checkAvailability();
-		try {
-			return parent::getDirectDownload($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$this->checkAvailability();
-		try {
-			return parent::copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$this->checkAvailability();
-		try {
-			return parent::moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getMetaData($path) {
-		$this->checkAvailability();
-		try {
-			return parent::getMetaData($path);
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			$this->setAvailability(false);
-			throw $e;
-		}
-	}
+    const RECHECK_TTL_SEC = 600; // 10 minutes
+
+    public static function shouldRecheck($availability) {
+        if (!$availability['available']) {
+            // trigger a recheck if TTL reached
+            if ((time() - $availability['last_checked']) > self::RECHECK_TTL_SEC) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Only called if availability === false
+     *
+     * @return bool
+     */
+    private function updateAvailability() {
+        // reset availability to false so that multiple requests don't recheck concurrently
+        $this->setAvailability(false);
+        try {
+            $result = $this->test();
+        } catch (\Exception $e) {
+            $result = false;
+        }
+        $this->setAvailability($result);
+        return $result;
+    }
+
+    /**
+     * @return bool
+     */
+    private function isAvailable() {
+        $availability = $this->getAvailability();
+        if (self::shouldRecheck($availability)) {
+            return $this->updateAvailability();
+        }
+        return $availability['available'];
+    }
+
+    /**
+     * @throws \OCP\Files\StorageNotAvailableException
+     */
+    private function checkAvailability() {
+        if (!$this->isAvailable()) {
+            throw new \OCP\Files\StorageNotAvailableException();
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function mkdir($path) {
+        $this->checkAvailability();
+        try {
+            return parent::mkdir($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function rmdir($path) {
+        $this->checkAvailability();
+        try {
+            return parent::rmdir($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function opendir($path) {
+        $this->checkAvailability();
+        try {
+            return parent::opendir($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function is_dir($path) {
+        $this->checkAvailability();
+        try {
+            return parent::is_dir($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function is_file($path) {
+        $this->checkAvailability();
+        try {
+            return parent::is_file($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function stat($path) {
+        $this->checkAvailability();
+        try {
+            return parent::stat($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function filetype($path) {
+        $this->checkAvailability();
+        try {
+            return parent::filetype($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function filesize($path) {
+        $this->checkAvailability();
+        try {
+            return parent::filesize($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function isCreatable($path) {
+        $this->checkAvailability();
+        try {
+            return parent::isCreatable($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function isReadable($path) {
+        $this->checkAvailability();
+        try {
+            return parent::isReadable($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function isUpdatable($path) {
+        $this->checkAvailability();
+        try {
+            return parent::isUpdatable($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function isDeletable($path) {
+        $this->checkAvailability();
+        try {
+            return parent::isDeletable($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function isSharable($path) {
+        $this->checkAvailability();
+        try {
+            return parent::isSharable($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getPermissions($path) {
+        $this->checkAvailability();
+        try {
+            return parent::getPermissions($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function file_exists($path) {
+        if ($path === '') {
+            return true;
+        }
+        $this->checkAvailability();
+        try {
+            return parent::file_exists($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function filemtime($path) {
+        $this->checkAvailability();
+        try {
+            return parent::filemtime($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function file_get_contents($path) {
+        $this->checkAvailability();
+        try {
+            return parent::file_get_contents($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function file_put_contents($path, $data) {
+        $this->checkAvailability();
+        try {
+            return parent::file_put_contents($path, $data);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function unlink($path) {
+        $this->checkAvailability();
+        try {
+            return parent::unlink($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function rename($path1, $path2) {
+        $this->checkAvailability();
+        try {
+            return parent::rename($path1, $path2);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function copy($path1, $path2) {
+        $this->checkAvailability();
+        try {
+            return parent::copy($path1, $path2);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function fopen($path, $mode) {
+        $this->checkAvailability();
+        try {
+            return parent::fopen($path, $mode);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getMimeType($path) {
+        $this->checkAvailability();
+        try {
+            return parent::getMimeType($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function hash($type, $path, $raw = false) {
+        $this->checkAvailability();
+        try {
+            return parent::hash($type, $path, $raw);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function free_space($path) {
+        $this->checkAvailability();
+        try {
+            return parent::free_space($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function search($query) {
+        $this->checkAvailability();
+        try {
+            return parent::search($query);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function touch($path, $mtime = null) {
+        $this->checkAvailability();
+        try {
+            return parent::touch($path, $mtime);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getLocalFile($path) {
+        $this->checkAvailability();
+        try {
+            return parent::getLocalFile($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function hasUpdated($path, $time) {
+        $this->checkAvailability();
+        try {
+            return parent::hasUpdated($path, $time);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getOwner($path) {
+        try {
+            return parent::getOwner($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getETag($path) {
+        $this->checkAvailability();
+        try {
+            return parent::getETag($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getDirectDownload($path) {
+        $this->checkAvailability();
+        try {
+            return parent::getDirectDownload($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $this->checkAvailability();
+        try {
+            return parent::copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $this->checkAvailability();
+        try {
+            return parent::moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getMetaData($path) {
+        $this->checkAvailability();
+        try {
+            return parent::getMetaData($path);
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            $this->setAvailability(false);
+            throw $e;
+        }
+    }
 }

lib/public/IDateTimeFormatter.php

Indentation +104 added lines, -104 removed lines

@@ -30,114 +30,114 @@
  * @since 8.0.0
  */
 interface IDateTimeFormatter {
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime		$timestamp
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone|null	$timeZone	The timezone to use
-	 * @param \OCP\IL10N|null	$l			The locale to use
-	 * @return string Formatted date string
-	 * @since 8.0.0
-	 */
-	public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime		$timestamp
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone|null	$timeZone	The timezone to use
+     * @param \OCP\IL10N|null	$l			The locale to use
+     * @return string Formatted date string
+     * @since 8.0.0
+     */
+    public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime		$timestamp
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param \DateTimeZone|null	$timeZone	The timezone to use
-	 * @param \OCP\IL10N|null	$l			The locale to use
-	 * @return string Formatted relative date string
-	 * @since 8.0.0
-	 */
-	public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime		$timestamp
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param \DateTimeZone|null	$timeZone	The timezone to use
+     * @param \OCP\IL10N|null	$l			The locale to use
+     * @return string Formatted relative date string
+     * @since 8.0.0
+     */
+    public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Gives the relative date of the timestamp
-	 * Only works for past dates
-	 *
-	 * @param int|\DateTime	$timestamp
-	 * @param int|\DateTime|null	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @param \OCP\IL10N|null		$l			The locale to use
-	 * @return string	Dates returned are:
-	 * 				<  1 month	=> Today, Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @since 8.0.0
-	 */
-	public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
+    /**
+     * Gives the relative date of the timestamp
+     * Only works for past dates
+     *
+     * @param int|\DateTime	$timestamp
+     * @param int|\DateTime|null	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @param \OCP\IL10N|null		$l			The locale to use
+     * @return string	Dates returned are:
+     * 				<  1 month	=> Today, Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @since 8.0.0
+     */
+    public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
-	 * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
-	 * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
-	 * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone|null	$timeZone	The timezone to use
-	 * @param \OCP\IL10N|null		$l			The locale to use
-	 * @return string Formatted time string
-	 * @since 8.0.0
-	 */
-	public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
+     * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
+     * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
+     * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone|null	$timeZone	The timezone to use
+     * @param \OCP\IL10N|null		$l			The locale to use
+     * @return string Formatted time string
+     * @since 8.0.0
+     */
+    public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Gives the relative past time of the timestamp
-	 *
-	 * @param int|\DateTime	$timestamp
-	 * @param int|\DateTime|null	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @param \OCP\IL10N|null		$l			The locale to use
-	 * @return string	Dates returned are:
-	 * 				< 60 sec	=> seconds ago
-	 * 				<  1 hour	=> n minutes ago
-	 * 				<  1 day	=> n hours ago
-	 * 				<  1 month	=> Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @since 8.0.0
-	 */
-	public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
+    /**
+     * Gives the relative past time of the timestamp
+     *
+     * @param int|\DateTime	$timestamp
+     * @param int|\DateTime|null	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @param \OCP\IL10N|null		$l			The locale to use
+     * @return string	Dates returned are:
+     * 				< 60 sec	=> seconds ago
+     * 				<  1 hour	=> n minutes ago
+     * 				<  1 day	=> n hours ago
+     * 				<  1 month	=> Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @since 8.0.0
+     */
+    public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp
-	 * @param string	$formatDate		See formatDate() for description
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone|null	$timeZone	The timezone to use
-	 * @param \OCP\IL10N|null		$l			The locale to use
-	 * @return string Formatted date and time string
-	 * @since 8.0.0
-	 */
-	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp
+     * @param string	$formatDate		See formatDate() for description
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone|null	$timeZone	The timezone to use
+     * @param \OCP\IL10N|null		$l			The locale to use
+     * @return string Formatted date and time string
+     * @since 8.0.0
+     */
+    public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp
-	 * @param string	$formatDate		See formatDate() for description
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone|null	$timeZone	The timezone to use
-	 * @param \OCP\IL10N|null		$l			The locale to use
-	 * @return string Formatted relative date and time string
-	 * @since 8.0.0
-	 */
-	public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp
+     * @param string	$formatDate		See formatDate() for description
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone|null	$timeZone	The timezone to use
+     * @param \OCP\IL10N|null		$l			The locale to use
+     * @return string Formatted relative date and time string
+     * @since 8.0.0
+     */
+    public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 }

lib/public/Search/PagedProvider.php

Indentation +32 added lines, -32 removed lines

@@ -30,39 +30,39 @@
  */
 abstract class PagedProvider extends Provider {
 
-	/**
-	 * show all results
-	 * @since 8.0.0
-	 */
-	const SIZE_ALL = 0;
+    /**
+     * show all results
+     * @since 8.0.0
+     */
+    const SIZE_ALL = 0;
 
-	/**
-	 * Constructor
-	 * @param array $options
-	 * @since 8.0.0
-	 */
-	public function __construct($options) {
-		parent::__construct($options);
-	}
+    /**
+     * Constructor
+     * @param array $options
+     * @since 8.0.0
+     */
+    public function __construct($options) {
+        parent::__construct($options);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 */
-	public function search($query) {
-		// old apps might assume they get all results, so we use SIZE_ALL
-		return $this->searchPaged($query, 1, self::SIZE_ALL);
-	}
+    /**
+     * Search for $query
+     * @param string $query
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     */
+    public function search($query) {
+        // old apps might assume they get all results, so we use SIZE_ALL
+        return $this->searchPaged($query, 1, self::SIZE_ALL);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @param int $page pages start at page 1
-	 * @param int $size 0 = SIZE_ALL
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 */
-	abstract public function searchPaged($query, $page, $size);
+    /**
+     * Search for $query
+     * @param string $query
+     * @param int $page pages start at page 1
+     * @param int $size 0 = SIZE_ALL
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     */
+    abstract public function searchPaged($query, $page, $size);
 }

lib/public/Share/Exceptions/GenericShareException.php

Indentation +13 added lines, -13 removed lines

@@ -31,18 +31,18 @@
  */
 class GenericShareException extends HintException {
 
-	/**
-	 * @param string $message
-	 * @param string $hint
-	 * @param int $code
-	 * @param \Exception|null $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
-		if (empty($message)) {
-			$message = 'There was an error retrieving the share. Maybe the link is wrong, it was unshared, or it was deleted.';
-		}
-		parent::__construct($message, $hint, $code, $previous);
-	}
+    /**
+     * @param string $message
+     * @param string $hint
+     * @param int $code
+     * @param \Exception|null $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
+        if (empty($message)) {
+            $message = 'There was an error retrieving the share. Maybe the link is wrong, it was unshared, or it was deleted.';
+        }
+        parent::__construct($message, $hint, $code, $previous);
+    }
 
 }

lib/public/BackgroundJob/IJob.php

Indentation +46 added lines, -46 removed lines

@@ -32,56 +32,56 @@
  * @since 7.0.0
  */
 interface IJob {
-	/**
-	 * Run the background job with the registered argument
-	 *
-	 * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
-	 * @param ILogger|null $logger
-	 * @since 7.0.0
-	 */
-	public function execute($jobList, ILogger $logger = null);
+    /**
+     * Run the background job with the registered argument
+     *
+     * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
+     * @param ILogger|null $logger
+     * @since 7.0.0
+     */
+    public function execute($jobList, ILogger $logger = null);
 
-	/**
-	 * @param int $id
-	 * @since 7.0.0
-	 */
-	public function setId($id);
+    /**
+     * @param int $id
+     * @since 7.0.0
+     */
+    public function setId($id);
 
-	/**
-	 * @param int $lastRun
-	 * @since 7.0.0
-	 */
-	public function setLastRun($lastRun);
+    /**
+     * @param int $lastRun
+     * @since 7.0.0
+     */
+    public function setLastRun($lastRun);
 
-	/**
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function setArgument($argument);
+    /**
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function setArgument($argument);
 
-	/**
-	 * Get the id of the background job
-	 * This id is determined by the job list when a job is added to the list
-	 *
-	 * @return int
-	 * @since 7.0.0
-	 */
-	public function getId();
+    /**
+     * Get the id of the background job
+     * This id is determined by the job list when a job is added to the list
+     *
+     * @return int
+     * @since 7.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get the last time this job was run as unix timestamp
-	 *
-	 * @return int
-	 * @since 7.0.0
-	 */
-	public function getLastRun();
+    /**
+     * Get the last time this job was run as unix timestamp
+     *
+     * @return int
+     * @since 7.0.0
+     */
+    public function getLastRun();
 
-	/**
-	 * Get the argument associated with the background job
-	 * This is the argument that will be passed to the background job
-	 *
-	 * @return mixed
-	 * @since 7.0.0
-	 */
-	public function getArgument();
+    /**
+     * Get the argument associated with the background job
+     * This is the argument that will be passed to the background job
+     *
+     * @return mixed
+     * @since 7.0.0
+     */
+    public function getArgument();
 }

lib/public/Encryption/Exceptions/GenericEncryptionException.php

Indentation +13 added lines, -13 removed lines

@@ -35,18 +35,18 @@
  */
 class GenericEncryptionException extends HintException {
 
-	/**
-	 * @param string $message
-	 * @param string $hint
-	 * @param int $code
-	 * @param \Exception|null $previous
-	 * @since 8.1.0
-	 */
-	public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
-		if (empty($message)) {
-			$message = 'Unspecified encryption exception';
-		}
-		parent::__construct($message, $hint, $code, $previous);
-	}
+    /**
+     * @param string $message
+     * @param string $hint
+     * @param int $code
+     * @param \Exception|null $previous
+     * @since 8.1.0
+     */
+    public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
+        if (empty($message)) {
+            $message = 'Unspecified encryption exception';
+        }
+        parent::__construct($message, $hint, $code, $previous);
+    }
 
 }

lib/public/Diagnostics/IQueryLogger.php

Indentation +36 added lines, -36 removed lines

@@ -33,43 +33,43 @@
  * @since 8.0.0
  */
 interface IQueryLogger extends SQLLogger {
-	/**
-	 * Mark the start of a query providing query SQL statement, its parameters and types. 
-	 * This method should be called as close to the DB as possible and after 
-	 * query is finished finalized with stopQuery() method. 
-	 * 
-	 * @param string $sql
-	 * @param array|null $params
-	 * @param array|null $types
-	 * @since 8.0.0
-	 */
-	public function startQuery($sql, array $params = null, array $types = null);
+    /**
+     * Mark the start of a query providing query SQL statement, its parameters and types. 
+     * This method should be called as close to the DB as possible and after 
+     * query is finished finalized with stopQuery() method. 
+     * 
+     * @param string $sql
+     * @param array|null $params
+     * @param array|null $types
+     * @since 8.0.0
+     */
+    public function startQuery($sql, array $params = null, array $types = null);
 
-	/**
-	 * Mark the end of the current active query. Ending query should store \OCP\Diagnostics\IQuery to
-	 * be returned with getQueries() method.
-	 * 
-	 * @return mixed
-	 * @since 8.0.0
-	 */
-	public function stopQuery();
+    /**
+     * Mark the end of the current active query. Ending query should store \OCP\Diagnostics\IQuery to
+     * be returned with getQueries() method.
+     * 
+     * @return mixed
+     * @since 8.0.0
+     */
+    public function stopQuery();
 
-	/**
-	 * This method should return all \OCP\Diagnostics\IQuery objects stored using
-	 * startQuery()/stopQuery() methods.
-	 * 
-	 * @return \OCP\Diagnostics\IQuery[]
-	 * @since 8.0.0
-	 */
-	public function getQueries();
+    /**
+     * This method should return all \OCP\Diagnostics\IQuery objects stored using
+     * startQuery()/stopQuery() methods.
+     * 
+     * @return \OCP\Diagnostics\IQuery[]
+     * @since 8.0.0
+     */
+    public function getQueries();
 
-	/**
-	 * Activate the module for the duration of the request. Deactivated module
-	 * does not create and store \OCP\Diagnostics\IQuery objects.
-	 * Only activated module should create and store objects to be 
-	 * returned with getQueries() call. 
-	 *
-	 * @since 12.0.0
-	 */
-	public function activate();
+    /**
+     * Activate the module for the duration of the request. Deactivated module
+     * does not create and store \OCP\Diagnostics\IQuery objects.
+     * Only activated module should create and store objects to be 
+     * returned with getQueries() call. 
+     *
+     * @since 12.0.0
+     */
+    public function activate();
 }

lib/public/Files/Storage.php

Indentation +413 added lines, -413 removed lines

@@ -47,417 +47,417 @@
  * @deprecated 9.0.0 use \OCP\Files\Storage\IStorage instead
  */
 interface Storage extends IStorage {
-	/**
-	 * $parameters is a free form array with the configuration options needed to construct the storage
-	 *
-	 * @param array $parameters
-	 * @since 6.0.0
-	 */
-	public function __construct($parameters);
-
-	/**
-	 * 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
-	 * @since 6.0.0
-	 */
-	public function getId();
-
-	/**
-	 * see http://php.net/manual/en/function.mkdir.php
-	 * implementations need to implement a recursive mkdir
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function mkdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rmdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|false
-	 * @since 6.0.0
-	 */
-	public function opendir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function is_dir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function is_file($path);
-
-	/**
-	 * see http://php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|false
-	 * @since 6.0.0
-	 */
-	public function stat($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function filetype($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function filesize($path);
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isCreatable($path);
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isReadable($path);
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isUpdatable($path);
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isDeletable($path);
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function 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
-	 * @since 6.0.0
-	 */
-	public function getPermissions($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function file_exists($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function filemtime($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function file_get_contents($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function file_put_contents($path, $data);
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function unlink($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rename($path1, $path2);
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function copy($path1, $path2);
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|false
-	 * @since 6.0.0
-	 */
-	public function 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|false
-	 * @since 6.0.0
-	 */
-	public function getMimeType($path);
-
-	/**
-	 * see http://php.net/manual/en/function.hash-file.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function hash($type, $path, $raw = false);
-
-	/**
-	 * see http://php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function free_space($path);
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array|false
-	 * @since 6.0.0
-	 */
-	public function search($query);
-
-	/**
-	 * see http://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
-	 * @since 6.0.0
-	 */
-	public function touch($path, $mtime = null);
-
-	/**
-	 * 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
-	 * @since 6.0.0
-	 */
-	public function getLocalFile($path);
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 * @since 6.0.0
-	 *
-	 * 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);
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function getETag($path);
-
-	/**
-	 * Returns whether the storage is local, which means that files
-	 * are stored on the local filesystem instead of remotely.
-	 * Calling getLocalFile() for local storages should always
-	 * return the local files, whereas for non-local storages
-	 * it might return a temporary file.
-	 *
-	 * @return bool true if the files are stored locally, false otherwise
-	 * @since 7.0.0
-	 */
-	public function isLocal();
-
-	/**
-	 * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
-	 *
-	 * @param string $class
-	 * @return bool
-	 * @since 7.0.0
-	 */
-	public function instanceOfStorage($class);
-
-	/**
-	 * 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|false
-	 * @since 8.0.0
-	 */
-	public function getDirectDownload($path);
-
-	/**
-	 * @param string $path the path of the target folder
-	 * @param string $fileName the name of the file itself
-	 * @return void
-	 * @throws InvalidPathException
-	 * @since 8.1.0
-	 */
-	public function verifyPath($path, $fileName);
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider);
-
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider);
-
-	/**
-	 * @param string $path The path of the file to change the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider);
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @since 8.2.0
-	 * @return bool
-	 */
-	public function test();
-
-	/**
-	 * @since 8.2.0
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability();
-
-	/**
-	 * @since 8.2.0
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable);
-
-	public function needsPartFile();
+    /**
+     * $parameters is a free form array with the configuration options needed to construct the storage
+     *
+     * @param array $parameters
+     * @since 6.0.0
+     */
+    public function __construct($parameters);
+
+    /**
+     * 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
+     * @since 6.0.0
+     */
+    public function getId();
+
+    /**
+     * see http://php.net/manual/en/function.mkdir.php
+     * implementations need to implement a recursive mkdir
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function mkdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rmdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|false
+     * @since 6.0.0
+     */
+    public function opendir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-dir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function is_dir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-file.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function is_file($path);
+
+    /**
+     * see http://php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|false
+     * @since 6.0.0
+     */
+    public function stat($path);
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function filetype($path);
+
+    /**
+     * see http://php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function filesize($path);
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isCreatable($path);
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isReadable($path);
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isUpdatable($path);
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isDeletable($path);
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function 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
+     * @since 6.0.0
+     */
+    public function getPermissions($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function file_exists($path);
+
+    /**
+     * see http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function filemtime($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function file_get_contents($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     * @since 6.0.0
+     */
+    public function file_put_contents($path, $data);
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function unlink($path);
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rename($path1, $path2);
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 6.0.0
+     */
+    public function copy($path1, $path2);
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|false
+     * @since 6.0.0
+     */
+    public function 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|false
+     * @since 6.0.0
+     */
+    public function getMimeType($path);
+
+    /**
+     * see http://php.net/manual/en/function.hash-file.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function hash($type, $path, $raw = false);
+
+    /**
+     * see http://php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function free_space($path);
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array|false
+     * @since 6.0.0
+     */
+    public function search($query);
+
+    /**
+     * see http://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
+     * @since 6.0.0
+     */
+    public function touch($path, $mtime = null);
+
+    /**
+     * 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
+     * @since 6.0.0
+     */
+    public function getLocalFile($path);
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     * @since 6.0.0
+     *
+     * 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);
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function getETag($path);
+
+    /**
+     * Returns whether the storage is local, which means that files
+     * are stored on the local filesystem instead of remotely.
+     * Calling getLocalFile() for local storages should always
+     * return the local files, whereas for non-local storages
+     * it might return a temporary file.
+     *
+     * @return bool true if the files are stored locally, false otherwise
+     * @since 7.0.0
+     */
+    public function isLocal();
+
+    /**
+     * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
+     *
+     * @param string $class
+     * @return bool
+     * @since 7.0.0
+     */
+    public function instanceOfStorage($class);
+
+    /**
+     * 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|false
+     * @since 8.0.0
+     */
+    public function getDirectDownload($path);
+
+    /**
+     * @param string $path the path of the target folder
+     * @param string $fileName the name of the file itself
+     * @return void
+     * @throws InvalidPathException
+     * @since 8.1.0
+     */
+    public function verifyPath($path, $fileName);
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 8.1.0
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 8.1.0
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider);
+
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider);
+
+    /**
+     * @param string $path The path of the file to change the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function changeLock($path, $type, ILockingProvider $provider);
+
+    /**
+     * Test a storage for availability
+     *
+     * @since 8.2.0
+     * @return bool
+     */
+    public function test();
+
+    /**
+     * @since 8.2.0
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability();
+
+    /**
+     * @since 8.2.0
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable);
+
+    public function needsPartFile();
 }