nextcloud / server

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/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/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();
 }

lib/public/Files/StorageAuthException.php

Indentation +11 added lines, -11 removed lines

@@ -27,15 +27,15 @@
  */
 class StorageAuthException extends StorageNotAvailableException {
 
-	/**
-	 * StorageAuthException constructor.
-	 *
-	 * @param string $message
-	 * @param \Exception|null $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage unauthorized. %s', [$message]), self::STATUS_UNAUTHORIZED, $previous);
-	}
+    /**
+     * StorageAuthException constructor.
+     *
+     * @param string $message
+     * @param \Exception|null $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage unauthorized. %s', [$message]), self::STATUS_UNAUTHORIZED, $previous);
+    }
 }

lib/public/Files/StorageBadConfigException.php

Indentation +11 added lines, -11 removed lines

@@ -27,16 +27,16 @@
  */
 class StorageBadConfigException extends StorageNotAvailableException {
 
-	/**
-	 * ExtStorageBadConfigException constructor.
-	 *
-	 * @param string $message
-	 * @param \Exception|null $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage incomplete configuration. %s', [$message]), self::STATUS_INCOMPLETE_CONF, $previous);
-	}
+    /**
+     * ExtStorageBadConfigException constructor.
+     *
+     * @param string $message
+     * @param \Exception|null $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage incomplete configuration. %s', [$message]), self::STATUS_INCOMPLETE_CONF, $previous);
+    }
 
 }

lib/public/Files/Storage/IStorage.php

Indentation +411 added lines, -411 removed lines

@@ -44,415 +44,415 @@
  * @since 9.0.0
  */
 interface IStorage {
-	/**
-	 * $parameters is a free form array with the configuration options needed to construct the storage
-	 *
-	 * @param array $parameters
-	 * @since 9.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 9.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 9.0.0
-	 */
-	public function mkdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function rmdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|false
-	 * @since 9.0.0
-	 */
-	public function opendir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function is_dir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.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 9.0.0
-	 */
-	public function stat($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.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 9.0.0
-	 */
-	public function filesize($path);
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isCreatable($path);
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isReadable($path);
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isUpdatable($path);
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isDeletable($path);
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.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 9.0.0
-	 */
-	public function getPermissions($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function file_exists($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 9.0.0
-	 */
-	public function filemtime($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 9.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 9.0.0
-	 */
-	public function file_put_contents($path, $data);
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function unlink($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 9.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 9.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 9.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 9.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 9.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 9.0.0
-	 */
-	public function free_space($path);
-
-	/**
-	 * 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 9.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 9.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 9.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 9.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 9.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 9.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 9.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 9.0.0
-	 */
-	public function verifyPath($path, $fileName);
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @since 9.0.0
-	 * @return bool
-	 */
-	public function test();
-
-	/**
-	 * @since 9.0.0
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability();
-
-	/**
-	 * @since 9.0.0
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable);
-
-	/**
-	 * @param string $path path for which to retrieve the owner
-	 * @since 9.0.0
-	 */
-	public function getOwner($path);
-
-	/**
-	 * @return ICache
-	 * @since 9.0.0
-	 */
-	public function getCache();
-
-	/**
-	 * @return IPropagator
-	 * @since 9.0.0
-	 */
-	public function getPropagator();
-
-	/**
-	 * @return IScanner
-	 * @since 9.0.0
-	 */
-	public function getScanner();
-
-	/**
-	 * @return IUpdater
-	 * @since 9.0.0
-	 */
-	public function getUpdater();
-
-	/**
-	 * @return IWatcher
-	 * @since 9.0.0
-	 */
-	public function getWatcher();
+    /**
+     * $parameters is a free form array with the configuration options needed to construct the storage
+     *
+     * @param array $parameters
+     * @since 9.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 9.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 9.0.0
+     */
+    public function mkdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function rmdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|false
+     * @since 9.0.0
+     */
+    public function opendir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-dir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function is_dir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-file.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.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 9.0.0
+     */
+    public function stat($path);
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.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 9.0.0
+     */
+    public function filesize($path);
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isCreatable($path);
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isReadable($path);
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isUpdatable($path);
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isDeletable($path);
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.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 9.0.0
+     */
+    public function getPermissions($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function file_exists($path);
+
+    /**
+     * see http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 9.0.0
+     */
+    public function filemtime($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 9.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 9.0.0
+     */
+    public function file_put_contents($path, $data);
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function unlink($path);
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 9.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 9.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 9.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 9.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 9.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 9.0.0
+     */
+    public function free_space($path);
+
+    /**
+     * 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 9.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 9.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 9.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 9.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 9.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 9.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 9.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 9.0.0
+     */
+    public function verifyPath($path, $fileName);
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 9.0.0
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 9.0.0
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * Test a storage for availability
+     *
+     * @since 9.0.0
+     * @return bool
+     */
+    public function test();
+
+    /**
+     * @since 9.0.0
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability();
+
+    /**
+     * @since 9.0.0
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable);
+
+    /**
+     * @param string $path path for which to retrieve the owner
+     * @since 9.0.0
+     */
+    public function getOwner($path);
+
+    /**
+     * @return ICache
+     * @since 9.0.0
+     */
+    public function getCache();
+
+    /**
+     * @return IPropagator
+     * @since 9.0.0
+     */
+    public function getPropagator();
+
+    /**
+     * @return IScanner
+     * @since 9.0.0
+     */
+    public function getScanner();
+
+    /**
+     * @return IUpdater
+     * @since 9.0.0
+     */
+    public function getUpdater();
+
+    /**
+     * @return IWatcher
+     * @since 9.0.0
+     */
+    public function getWatcher();
 }

lib/public/Files/ForbiddenException.php

Indentation +19 added lines, -19 removed lines

@@ -32,25 +32,25 @@
  */
 class ForbiddenException extends \Exception {
 
-	/** @var bool */
-	private $retry;
+    /** @var bool */
+    private $retry;
 
-	/**
-	 * @param string $message
-	 * @param bool $retry
-	 * @param \Exception|null $previous previous exception for cascading
-	 * @since 9.0.0
-	 */
-	public function __construct($message, $retry, \Exception $previous = null) {
-		parent::__construct($message, 0, $previous);
-		$this->retry = $retry;
-	}
+    /**
+     * @param string $message
+     * @param bool $retry
+     * @param \Exception|null $previous previous exception for cascading
+     * @since 9.0.0
+     */
+    public function __construct($message, $retry, \Exception $previous = null) {
+        parent::__construct($message, 0, $previous);
+        $this->retry = $retry;
+    }
 
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function getRetry() {
-		return (bool) $this->retry;
-	}
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function getRetry() {
+        return (bool) $this->retry;
+    }
 }

lib/public/Files/StorageTimeoutException.php

Indentation +11 added lines, -11 removed lines

@@ -27,15 +27,15 @@
  */
 class StorageTimeoutException extends StorageNotAvailableException {
 
-	/**
-	 * StorageTimeoutException constructor.
-	 *
-	 * @param string $message
-	 * @param \Exception|null $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage connection timeout. %s', [$message]), self::STATUS_TIMEOUT, $previous);
-	}
+    /**
+     * StorageTimeoutException constructor.
+     *
+     * @param string $message
+     * @param \Exception|null $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage connection timeout. %s', [$message]), self::STATUS_TIMEOUT, $previous);
+    }
 }

lib/public/Files/StorageConnectionException.php

Indentation +11 added lines, -11 removed lines

@@ -27,15 +27,15 @@
  */
 class StorageConnectionException extends StorageNotAvailableException {
 
-	/**
-	 * StorageConnectionException constructor.
-	 *
-	 * @param string $message
-	 * @param \Exception|null $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage connection error. %s', [$message]), self::STATUS_NETWORK_ERROR, $previous);
-	}
+    /**
+     * StorageConnectionException constructor.
+     *
+     * @param string $message
+     * @param \Exception|null $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage connection error. %s', [$message]), self::STATUS_NETWORK_ERROR, $previous);
+    }
 }