nextcloud / server

lib/private/Files/SimpleFS/NewSimpleFile.php

Indentation +189 added lines, -189 removed lines

@@ -34,193 +34,193 @@
 use OCP\Files\SimpleFS\ISimpleFile;
 
 class NewSimpleFile implements ISimpleFile {
-	private $parentFolder;
-	private $name;
-	/** @var File|null */
-	private $file = null;
-
-	/**
-	 * File constructor.
-	 *
-	 * @param File $file
-	 */
-	public function __construct(Folder $parentFolder, string $name) {
-		$this->parentFolder = $parentFolder;
-		$this->name = $name;
-	}
-
-	/**
-	 * Get the name
-	 *
-	 * @return string
-	 */
-	public function getName() {
-		return $this->name;
-	}
-
-	/**
-	 * Get the size in bytes
-	 *
-	 * @return int
-	 */
-	public function getSize() {
-		if ($this->file) {
-			return $this->file->getSize();
-		} else {
-			return 0;
-		}
-	}
-
-	/**
-	 * Get the ETag
-	 *
-	 * @return string
-	 */
-	public function getETag() {
-		if ($this->file) {
-			return $this->file->getEtag();
-		} else {
-			return '';
-		}
-	}
-
-	/**
-	 * Get the last modification time
-	 *
-	 * @return int
-	 */
-	public function getMTime() {
-		if ($this->file) {
-			return $this->file->getMTime();
-		} else {
-			return time();
-		}
-	}
-
-	/**
-	 * Get the content
-	 *
-	 * @return string
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	public function getContent() {
-		if ($this->file) {
-			$result = $this->file->getContent();
-
-			if ($result === false) {
-				$this->checkFile();
-			}
-
-			return $result;
-		} else {
-			return '';
-		}
-	}
-
-	/**
-	 * Overwrite the file
-	 *
-	 * @param string|resource $data
-	 * @throws NotPermittedException
-	 * @throws NotFoundException
-	 */
-	public function putContent($data) {
-		try {
-			if ($this->file) {
-				$this->file->putContent($data);
-			} else {
-				$this->file = $this->parentFolder->newFile($this->name, $data);
-			}
-		} catch (NotFoundException $e) {
-			$this->checkFile();
-		}
-	}
-
-	/**
-	 * Sometimes there are some issues with the AppData. Most of them are from
-	 * user error. But we should handle them gracefull anyway.
-	 *
-	 * If for some reason the current file can't be found. We remove it.
-	 * Then traverse up and check all folders if they exists. This so that the
-	 * next request will have a valid appdata structure again.
-	 *
-	 * @throws NotFoundException
-	 */
-	private function checkFile() {
-		$cur = $this->file;
-
-		while ($cur->stat() === false) {
-			$parent = $cur->getParent();
-			try {
-				$cur->delete();
-			} catch (NotFoundException $e) {
-				// Just continue then
-			}
-			$cur = $parent;
-		}
-
-		if ($cur !== $this->file) {
-			throw new NotFoundException('File does not exist');
-		}
-	}
-
-
-	/**
-	 * Delete the file
-	 *
-	 * @throws NotPermittedException
-	 */
-	public function delete() {
-		if ($this->file) {
-			$this->file->delete();
-		}
-	}
-
-	/**
-	 * Get the MimeType
-	 *
-	 * @return string
-	 */
-	public function getMimeType() {
-		if ($this->file) {
-			return $this->file->getMimeType();
-		} else {
-			return 'text/plain';
-		}
-	}
-
-	/**
-	 * Open the file as stream for reading, resulting resource can be operated as stream like the result from php's own fopen
-	 *
-	 * @return resource
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 14.0.0
-	 */
-	public function read() {
-		if ($this->file) {
-			return $this->file->fopen('r');
-		} else {
-			return fopen('php://temp', 'r');
-		}
-	}
-
-	/**
-	 * Open the file as stream for writing, resulting resource can be operated as stream like the result from php's own fopen
-	 *
-	 * @return resource|bool
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 14.0.0
-	 */
-	public function write() {
-		if ($this->file) {
-			return $this->file->fopen('w');
-		} else {
-			$source = fopen('php://temp', 'w+');
-			return CallbackWrapper::wrap($source, null, null, null, null, function () use ($source) {
-				rewind($source);
-				$this->putContent($source);
-			});
-		}
-	}
+    private $parentFolder;
+    private $name;
+    /** @var File|null */
+    private $file = null;
+
+    /**
+     * File constructor.
+     *
+     * @param File $file
+     */
+    public function __construct(Folder $parentFolder, string $name) {
+        $this->parentFolder = $parentFolder;
+        $this->name = $name;
+    }
+
+    /**
+     * Get the name
+     *
+     * @return string
+     */
+    public function getName() {
+        return $this->name;
+    }
+
+    /**
+     * Get the size in bytes
+     *
+     * @return int
+     */
+    public function getSize() {
+        if ($this->file) {
+            return $this->file->getSize();
+        } else {
+            return 0;
+        }
+    }
+
+    /**
+     * Get the ETag
+     *
+     * @return string
+     */
+    public function getETag() {
+        if ($this->file) {
+            return $this->file->getEtag();
+        } else {
+            return '';
+        }
+    }
+
+    /**
+     * Get the last modification time
+     *
+     * @return int
+     */
+    public function getMTime() {
+        if ($this->file) {
+            return $this->file->getMTime();
+        } else {
+            return time();
+        }
+    }
+
+    /**
+     * Get the content
+     *
+     * @return string
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    public function getContent() {
+        if ($this->file) {
+            $result = $this->file->getContent();
+
+            if ($result === false) {
+                $this->checkFile();
+            }
+
+            return $result;
+        } else {
+            return '';
+        }
+    }
+
+    /**
+     * Overwrite the file
+     *
+     * @param string|resource $data
+     * @throws NotPermittedException
+     * @throws NotFoundException
+     */
+    public function putContent($data) {
+        try {
+            if ($this->file) {
+                $this->file->putContent($data);
+            } else {
+                $this->file = $this->parentFolder->newFile($this->name, $data);
+            }
+        } catch (NotFoundException $e) {
+            $this->checkFile();
+        }
+    }
+
+    /**
+     * Sometimes there are some issues with the AppData. Most of them are from
+     * user error. But we should handle them gracefull anyway.
+     *
+     * If for some reason the current file can't be found. We remove it.
+     * Then traverse up and check all folders if they exists. This so that the
+     * next request will have a valid appdata structure again.
+     *
+     * @throws NotFoundException
+     */
+    private function checkFile() {
+        $cur = $this->file;
+
+        while ($cur->stat() === false) {
+            $parent = $cur->getParent();
+            try {
+                $cur->delete();
+            } catch (NotFoundException $e) {
+                // Just continue then
+            }
+            $cur = $parent;
+        }
+
+        if ($cur !== $this->file) {
+            throw new NotFoundException('File does not exist');
+        }
+    }
+
+
+    /**
+     * Delete the file
+     *
+     * @throws NotPermittedException
+     */
+    public function delete() {
+        if ($this->file) {
+            $this->file->delete();
+        }
+    }
+
+    /**
+     * Get the MimeType
+     *
+     * @return string
+     */
+    public function getMimeType() {
+        if ($this->file) {
+            return $this->file->getMimeType();
+        } else {
+            return 'text/plain';
+        }
+    }
+
+    /**
+     * Open the file as stream for reading, resulting resource can be operated as stream like the result from php's own fopen
+     *
+     * @return resource
+     * @throws \OCP\Files\NotPermittedException
+     * @since 14.0.0
+     */
+    public function read() {
+        if ($this->file) {
+            return $this->file->fopen('r');
+        } else {
+            return fopen('php://temp', 'r');
+        }
+    }
+
+    /**
+     * Open the file as stream for writing, resulting resource can be operated as stream like the result from php's own fopen
+     *
+     * @return resource|bool
+     * @throws \OCP\Files\NotPermittedException
+     * @since 14.0.0
+     */
+    public function write() {
+        if ($this->file) {
+            return $this->file->fopen('w');
+        } else {
+            $source = fopen('php://temp', 'w+');
+            return CallbackWrapper::wrap($source, null, null, null, null, function () use ($source) {
+                rewind($source);
+                $this->putContent($source);
+            });
+        }
+    }
 }

lib/private/Repair/Owncloud/MoveAvatarsBackgroundJob.php

Indentation +67 added lines, -67 removed lines

@@ -34,82 +34,82 @@
 
 class MoveAvatarsBackgroundJob extends QueuedJob {
 
-	/** @var IUserManager */
-	private $userManager;
+    /** @var IUserManager */
+    private $userManager;
 
-	/** @var LoggerInterface */
-	private $logger;
+    /** @var LoggerInterface */
+    private $logger;
 
-	/** @var IAvatarManager */
-	private $avatarManager;
+    /** @var IAvatarManager */
+    private $avatarManager;
 
-	/** @var Storage */
-	private $owncloudAvatarStorage;
+    /** @var Storage */
+    private $owncloudAvatarStorage;
 
-	public function __construct(IUserManager $userManager, LoggerInterface $logger, IAvatarManager $avatarManager, IRootFolder $rootFolder) {
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$this->avatarManager = $avatarManager;
-		try {
-			$this->owncloudAvatarStorage = $rootFolder->get('avatars')->getStorage();
-		} catch (\Exception $e) {
-		}
-	}
+    public function __construct(IUserManager $userManager, LoggerInterface $logger, IAvatarManager $avatarManager, IRootFolder $rootFolder) {
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $this->avatarManager = $avatarManager;
+        try {
+            $this->owncloudAvatarStorage = $rootFolder->get('avatars')->getStorage();
+        } catch (\Exception $e) {
+        }
+    }
 
-	public function run($arguments) {
-		$this->logger->info('Started migrating avatars to AppData folder');
-		$this->moveAvatars();
-		$this->logger->info('All avatars migrated to AppData folder');
-	}
+    public function run($arguments) {
+        $this->logger->info('Started migrating avatars to AppData folder');
+        $this->moveAvatars();
+        $this->logger->info('All avatars migrated to AppData folder');
+    }
 
-	private function moveAvatars(): void {
-		if (!$this->owncloudAvatarStorage) {
-			$this->logger->info('No legacy avatars available, skipping migration');
-			return;
-		}
+    private function moveAvatars(): void {
+        if (!$this->owncloudAvatarStorage) {
+            $this->logger->info('No legacy avatars available, skipping migration');
+            return;
+        }
 
-		$counter = 0;
-		$this->userManager->callForSeenUsers(function (IUser $user) use ($counter) {
-			$uid = $user->getUID();
+        $counter = 0;
+        $this->userManager->callForSeenUsers(function (IUser $user) use ($counter) {
+            $uid = $user->getUID();
 
-			$path = 'avatars/' . $this->buildOwnCloudAvatarPath($uid);
-			$avatar = $this->avatarManager->getAvatar($uid);
-			try {
-				$avatarPath = $path . '/avatar.' . $this->getExtension($path);
-				$resource = $this->owncloudAvatarStorage->fopen($avatarPath, 'r');
-				if (is_resource($resource)) {
-					$avatar->set($resource);
-					fclose($resource);
-				} else {
-					throw new \Exception('Failed to open old avatar file for reading');
-				}
-			} catch (NotFoundException $e) {
-				// In case there is no avatar we can just skip
-			} catch (\Throwable $e) {
-				$this->logger->error('Failed to migrate avatar for user ' . $uid, ['exception' => $e]);
-			}
+            $path = 'avatars/' . $this->buildOwnCloudAvatarPath($uid);
+            $avatar = $this->avatarManager->getAvatar($uid);
+            try {
+                $avatarPath = $path . '/avatar.' . $this->getExtension($path);
+                $resource = $this->owncloudAvatarStorage->fopen($avatarPath, 'r');
+                if (is_resource($resource)) {
+                    $avatar->set($resource);
+                    fclose($resource);
+                } else {
+                    throw new \Exception('Failed to open old avatar file for reading');
+                }
+            } catch (NotFoundException $e) {
+                // In case there is no avatar we can just skip
+            } catch (\Throwable $e) {
+                $this->logger->error('Failed to migrate avatar for user ' . $uid, ['exception' => $e]);
+            }
 
-			$counter++;
-			if ($counter % 100 === 0) {
-				$this->logger->info('{amount} avatars migrated', ['amount' => $counter]);
-			}
-		});
-	}
+            $counter++;
+            if ($counter % 100 === 0) {
+                $this->logger->info('{amount} avatars migrated', ['amount' => $counter]);
+            }
+        });
+    }
 
-	/**
-	 * @throws NotFoundException
-	 */
-	private function getExtension(string $path): string {
-		if ($this->owncloudAvatarStorage->file_exists("{$path}/avatar.jpg")) {
-			return 'jpg';
-		}
-		if ($this->owncloudAvatarStorage->file_exists("{$path}/avatar.png")) {
-			return 'png';
-		}
-		throw new NotFoundException("{$path}/avatar.jpg|png");
-	}
+    /**
+     * @throws NotFoundException
+     */
+    private function getExtension(string $path): string {
+        if ($this->owncloudAvatarStorage->file_exists("{$path}/avatar.jpg")) {
+            return 'jpg';
+        }
+        if ($this->owncloudAvatarStorage->file_exists("{$path}/avatar.png")) {
+            return 'png';
+        }
+        throw new NotFoundException("{$path}/avatar.jpg|png");
+    }
 
-	protected function buildOwnCloudAvatarPath(string $userId): string {
-		return substr_replace(substr_replace(md5($userId), '/', 4, 0), '/', 2, 0);
-	}
+    protected function buildOwnCloudAvatarPath(string $userId): string {
+        return substr_replace(substr_replace(md5($userId), '/', 4, 0), '/', 2, 0);
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -69,13 +69,13 @@ 
 		}
 
 		$counter = 0;
-		$this->userManager->callForSeenUsers(function (IUser $user) use ($counter) {
+		$this->userManager->callForSeenUsers(function(IUser $user) use ($counter) {
 			$uid = $user->getUID();
 
-			$path = 'avatars/' . $this->buildOwnCloudAvatarPath($uid);
+			$path = 'avatars/'.$this->buildOwnCloudAvatarPath($uid);
 			$avatar = $this->avatarManager->getAvatar($uid);
 			try {
-				$avatarPath = $path . '/avatar.' . $this->getExtension($path);
+				$avatarPath = $path.'/avatar.'.$this->getExtension($path);
 				$resource = $this->owncloudAvatarStorage->fopen($avatarPath, 'r');
 				if (is_resource($resource)) {
 					$avatar->set($resource);
@@ -86,7 +86,7 @@ 
 			} catch (NotFoundException $e) {
 				// In case there is no avatar we can just skip
 			} catch (\Throwable $e) {
-				$this->logger->error('Failed to migrate avatar for user ' . $uid, ['exception' => $e]);
+				$this->logger->error('Failed to migrate avatar for user '.$uid, ['exception' => $e]);
 			}
 
 			$counter++;

lib/public/Files/Storage/IStorage.php

Indentation +411 added lines, -411 removed lines

@@ -47,415 +47,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 https://www.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 https://www.php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function rmdir($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|bool
-	 * @since 9.0.0
-	 */
-	public function opendir($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.is-dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function is_dir($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.is-file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function is_file($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|bool
-	 * @since 9.0.0
-	 */
-	public function stat($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 * @since 9.0.0
-	 */
-	public function filetype($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 * @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 https://www.php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function file_exists($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 * @since 9.0.0
-	 */
-	public function filemtime($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 * @since 9.0.0
-	 */
-	public function file_get_contents($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param mixed $data
-	 * @return int|false
-	 * @since 9.0.0
-	 */
-	public function file_put_contents($path, $data);
-
-	/**
-	 * see https://www.php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function unlink($path);
-
-	/**
-	 * see https://www.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 https://www.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 https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|bool
-	 * @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|bool
-	 * @since 9.0.0
-	 */
-	public function getMimeType($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.hash-file.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string|bool
-	 * @since 9.0.0
-	 */
-	public function hash($type, $path, $raw = false);
-
-	/**
-	 * see https://www.php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 * @since 9.0.0
-	 */
-	public function free_space($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 * @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|bool
-	 * @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|bool
-	 * @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|bool
-	 * @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 https://www.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 https://www.php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function rmdir($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|bool
+     * @since 9.0.0
+     */
+    public function opendir($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.is-dir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function is_dir($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.is-file.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function is_file($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|bool
+     * @since 9.0.0
+     */
+    public function stat($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|bool
+     * @since 9.0.0
+     */
+    public function filetype($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int|bool
+     * @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 https://www.php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function file_exists($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|bool
+     * @since 9.0.0
+     */
+    public function filemtime($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|bool
+     * @since 9.0.0
+     */
+    public function file_get_contents($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param mixed $data
+     * @return int|false
+     * @since 9.0.0
+     */
+    public function file_put_contents($path, $data);
+
+    /**
+     * see https://www.php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 9.0.0
+     */
+    public function unlink($path);
+
+    /**
+     * see https://www.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 https://www.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 https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|bool
+     * @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|bool
+     * @since 9.0.0
+     */
+    public function getMimeType($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.hash-file.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string|bool
+     * @since 9.0.0
+     */
+    public function hash($type, $path, $raw = false);
+
+    /**
+     * see https://www.php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int|bool
+     * @since 9.0.0
+     */
+    public function free_space($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     * @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|bool
+     * @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|bool
+     * @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|bool
+     * @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/SimpleFS/ISimpleFile.php

Indentation +76 added lines, -76 removed lines

@@ -34,89 +34,89 @@
  */
 interface ISimpleFile {
 
-	/**
-	 * Get the name
-	 *
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getName();
+    /**
+     * Get the name
+     *
+     * @return string
+     * @since 11.0.0
+     */
+    public function getName();
 
-	/**
-	 * Get the size in bytes
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function getSize();
+    /**
+     * Get the size in bytes
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function getSize();
 
-	/**
-	 * Get the ETag
-	 *
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getETag();
+    /**
+     * Get the ETag
+     *
+     * @return string
+     * @since 11.0.0
+     */
+    public function getETag();
 
-	/**
-	 * Get the last modification time
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function getMTime();
+    /**
+     * Get the last modification time
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function getMTime();
 
-	/**
-	 * Get the content
-	 *
-	 * @throws NotPermittedException
-	 * @throws NotFoundException
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getContent();
+    /**
+     * Get the content
+     *
+     * @throws NotPermittedException
+     * @throws NotFoundException
+     * @return string
+     * @since 11.0.0
+     */
+    public function getContent();
 
-	/**
-	 * Overwrite the file
-	 *
-	 * @param string|resource $data
-	 * @throws NotPermittedException
-	 * @throws NotFoundException
-	 * @since 11.0.0
-	 */
-	public function putContent($data);
+    /**
+     * Overwrite the file
+     *
+     * @param string|resource $data
+     * @throws NotPermittedException
+     * @throws NotFoundException
+     * @since 11.0.0
+     */
+    public function putContent($data);
 
-	/**
-	 * Delete the file
-	 *
-	 * @throws NotPermittedException
-	 * @since 11.0.0
-	 */
-	public function delete();
+    /**
+     * Delete the file
+     *
+     * @throws NotPermittedException
+     * @since 11.0.0
+     */
+    public function delete();
 
-	/**
-	 * Get the MimeType
-	 *
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getMimeType();
+    /**
+     * Get the MimeType
+     *
+     * @return string
+     * @since 11.0.0
+     */
+    public function getMimeType();
 
-	/**
-	 * Open the file as stream for reading, resulting resource can be operated as stream like the result from php's own fopen
-	 *
-	 * @return resource
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 14.0.0
-	 */
-	public function read();
+    /**
+     * Open the file as stream for reading, resulting resource can be operated as stream like the result from php's own fopen
+     *
+     * @return resource
+     * @throws \OCP\Files\NotPermittedException
+     * @since 14.0.0
+     */
+    public function read();
 
-	/**
-	 * Open the file as stream for writing, resulting resource can be operated as stream like the result from php's own fopen
-	 *
-	 * @return resource|bool
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 14.0.0
-	 */
-	public function write();
+    /**
+     * Open the file as stream for writing, resulting resource can be operated as stream like the result from php's own fopen
+     *
+     * @return resource|bool
+     * @throws \OCP\Files\NotPermittedException
+     * @since 14.0.0
+     */
+    public function write();
 }

lib/public/Files/Storage.php

Indentation +413 added lines, -413 removed lines

@@ -51,417 +51,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 https://www.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 https://www.php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rmdir($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|bool
-	 * @since 6.0.0
-	 */
-	public function opendir($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.is-dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function is_dir($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.is-file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function is_file($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|bool
-	 * @since 6.0.0
-	 */
-	public function stat($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 * @since 6.0.0
-	 */
-	public function filetype($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 * @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 https://www.php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function file_exists($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 * @since 6.0.0
-	 */
-	public function filemtime($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 * @since 6.0.0
-	 */
-	public function file_get_contents($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param mixed $data
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function file_put_contents($path, $data);
-
-	/**
-	 * see https://www.php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function unlink($path);
-
-	/**
-	 * see https://www.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 https://www.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 https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|bool
-	 * @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|bool
-	 * @since 6.0.0
-	 */
-	public function getMimeType($path);
-
-	/**
-	 * see https://www.php.net/manual/en/function.hash-file.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string|bool
-	 * @since 6.0.0
-	 */
-	public function hash($type, $path, $raw = false);
-
-	/**
-	 * see https://www.php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 * @since 6.0.0
-	 */
-	public function free_space($path);
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array|bool
-	 * @since 6.0.0
-	 */
-	public function search($query);
-
-	/**
-	 * see https://www.php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 * @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|bool
-	 * @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|bool
-	 * @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|bool
-	 * @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 https://www.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 https://www.php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rmdir($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|bool
+     * @since 6.0.0
+     */
+    public function opendir($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.is-dir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function is_dir($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.is-file.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function is_file($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|bool
+     * @since 6.0.0
+     */
+    public function stat($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|bool
+     * @since 6.0.0
+     */
+    public function filetype($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int|bool
+     * @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 https://www.php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function file_exists($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|bool
+     * @since 6.0.0
+     */
+    public function filemtime($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|bool
+     * @since 6.0.0
+     */
+    public function file_get_contents($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param mixed $data
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function file_put_contents($path, $data);
+
+    /**
+     * see https://www.php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function unlink($path);
+
+    /**
+     * see https://www.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 https://www.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 https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|bool
+     * @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|bool
+     * @since 6.0.0
+     */
+    public function getMimeType($path);
+
+    /**
+     * see https://www.php.net/manual/en/function.hash-file.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string|bool
+     * @since 6.0.0
+     */
+    public function hash($type, $path, $raw = false);
+
+    /**
+     * see https://www.php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int|bool
+     * @since 6.0.0
+     */
+    public function free_space($path);
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array|bool
+     * @since 6.0.0
+     */
+    public function search($query);
+
+    /**
+     * see https://www.php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     * @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|bool
+     * @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|bool
+     * @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|bool
+     * @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();
 }