nextcloud / server

lib/public/Files/Storage/ILockingStorage.php

Indentation +24 added lines, -24 removed lines

@@ -33,30 +33,30 @@
  * @since 9.0.0
  */
 interface ILockingStorage {
-	/**
-	 * @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 9.0.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 9.0.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 9.0.0
-	 */
-	public function releaseLock($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 9.0.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 9.0.0
-	 */
-	public function changeLock($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 9.0.0
+     */
+    public function changeLock($path, $type, ILockingProvider $provider);
 }

lib/public/Files/Notify/IChange.php

Indentation +22 added lines, -22 removed lines

@@ -29,28 +29,28 @@
  * @since 12.0.0
  */
 interface IChange {
-	const ADDED = 1;
-	const REMOVED = 2;
-	const MODIFIED = 3;
-	const RENAMED = 4;
+    const ADDED = 1;
+    const REMOVED = 2;
+    const MODIFIED = 3;
+    const RENAMED = 4;
 
-	/**
-	 * Get the type of the change
-	 *
-	 * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
-	 *
-	 * @since 12.0.0
-	 */
-	public function getType();
+    /**
+     * Get the type of the change
+     *
+     * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
+     *
+     * @since 12.0.0
+     */
+    public function getType();
 
-	/**
-	 * Get the path of the file that was changed relative to the root of the storage
-	 *
-	 * Note, for rename changes this path is the old path for the file
-	 *
-	 * @return mixed
-	 *
-	 * @since 12.0.0
-	 */
-	public function getPath();
+    /**
+     * Get the path of the file that was changed relative to the root of the storage
+     *
+     * Note, for rename changes this path is the old path for the file
+     *
+     * @return mixed
+     *
+     * @since 12.0.0
+     */
+    public function getPath();
 }

lib/public/Files/Notify/INotifyHandler.php

Indentation +29 added lines, -29 removed lines

@@ -30,35 +30,35 @@
  * @since 12.0.0
  */
 interface INotifyHandler {
-	/**
-	 * Start listening for update notifications
-	 *
-	 * The provided callback will be called for every incoming notification with the following parameters
-	 *  - IChange|IRenameChange $change
-	 *
-	 * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
-	 *
-	 * @param callable $callback
-	 *
-	 * @since 12.0.0
-	 */
-	public function listen(callable $callback);
+    /**
+     * Start listening for update notifications
+     *
+     * The provided callback will be called for every incoming notification with the following parameters
+     *  - IChange|IRenameChange $change
+     *
+     * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
+     *
+     * @param callable $callback
+     *
+     * @since 12.0.0
+     */
+    public function listen(callable $callback);
 
-	/**
-	 * Get all changes detected since the start of the notify process or the last call to getChanges
-	 *
-	 * @return IChange[]
-	 *
-	 * @since 12.0.0
-	 */
-	public function getChanges();
+    /**
+     * Get all changes detected since the start of the notify process or the last call to getChanges
+     *
+     * @return IChange[]
+     *
+     * @since 12.0.0
+     */
+    public function getChanges();
 
-	/**
-	 * Stop listening for changes
-	 *
-	 * Note that any pending changes will be discarded
-	 *
-	 * @since 12.0.0
-	 */
-	public function stop();
+    /**
+     * Stop listening for changes
+     *
+     * Note that any pending changes will be discarded
+     *
+     * @since 12.0.0
+     */
+    public function stop();
 }

lib/public/Files/Notify/IRenameChange.php

Indentation +8 added lines, -8 removed lines

@@ -29,12 +29,12 @@
  * @since 12.0.0
  */
 interface IRenameChange extends IChange {
-	/**
-	 * Get the new path of the renamed file relative to the storage root
-	 *
-	 * @return string
-	 *
-	 * @since 12.0.0
-	 */
-	public function getTargetPath();
+    /**
+     * Get the new path of the renamed file relative to the storage root
+     *
+     * @return string
+     *
+     * @since 12.0.0
+     */
+    public function getTargetPath();
 }

lib/public/Files/Cache/IUpdater.php

Indentation +39 added lines, -39 removed lines

@@ -30,47 +30,47 @@
  * @since 9.0.0
  */
 interface IUpdater {
-	/**
-	 * Get the propagator for etags and mtime for the view the updater works on
-	 *
-	 * @return IPropagator
-	 * @since 9.0.0
-	 */
-	public function getPropagator();
+    /**
+     * Get the propagator for etags and mtime for the view the updater works on
+     *
+     * @return IPropagator
+     * @since 9.0.0
+     */
+    public function getPropagator();
 
-	/**
-	 * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem
-	 *
-	 * @param string $path the path of the file to propagate the changes for
-	 * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used
-	 * @since 9.0.0
-	 */
-	public function propagate($path, $time = null);
+    /**
+     * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem
+     *
+     * @param string $path the path of the file to propagate the changes for
+     * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used
+     * @since 9.0.0
+     */
+    public function propagate($path, $time = null);
 
-	/**
-	 * Update the cache for $path and update the size, etag and mtime of the parent folders
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @since 9.0.0
-	 */
-	public function update($path, $time = null);
+    /**
+     * Update the cache for $path and update the size, etag and mtime of the parent folders
+     *
+     * @param string $path
+     * @param int $time
+     * @since 9.0.0
+     */
+    public function update($path, $time = null);
 
-	/**
-	 * Remove $path from the cache and update the size, etag and mtime of the parent folders
-	 *
-	 * @param string $path
-	 * @since 9.0.0
-	 */
-	public function remove($path);
+    /**
+     * Remove $path from the cache and update the size, etag and mtime of the parent folders
+     *
+     * @param string $path
+     * @since 9.0.0
+     */
+    public function remove($path);
 
-	/**
-	 * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders
-	 *
-	 * @param IStorage $sourceStorage
-	 * @param string $source
-	 * @param string $target
-	 * @since 9.0.0
-	 */
-	public function renameFromStorage(IStorage $sourceStorage, $source, $target);
+    /**
+     * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders
+     *
+     * @param IStorage $sourceStorage
+     * @param string $source
+     * @param string $target
+     * @since 9.0.0
+     */
+    public function renameFromStorage(IStorage $sourceStorage, $source, $target);
 }

lib/public/Files/Cache/ICacheEntry.php

Indentation +92 added lines, -92 removed lines

@@ -28,108 +28,108 @@
  * @since 9.0.0
  */
 interface ICacheEntry {
-	const DIRECTORY_MIMETYPE = 'httpd/unix-directory';
+    const DIRECTORY_MIMETYPE = 'httpd/unix-directory';
 
-	/**
-	 * Get the numeric id of a file
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getId();
+    /**
+     * Get the numeric id of a file
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get the numeric id for the storage
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getStorageId();
+    /**
+     * Get the numeric id for the storage
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getStorageId();
 
-	/**
-	 * Get the path of the file relative to the storage root
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getPath();
+    /**
+     * Get the path of the file relative to the storage root
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getPath();
 
-	/**
-	 * Get the file name
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getName();
+    /**
+     * Get the file name
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getName();
 
-	/**
-	 * Get the full mimetype
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMimeType();
+    /**
+     * Get the full mimetype
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMimeType();
 
-	/**
-	 * Get the first part of the mimetype
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMimePart();
+    /**
+     * Get the first part of the mimetype
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMimePart();
 
-	/**
-	 * Get the file size in bytes
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getSize();
+    /**
+     * Get the file size in bytes
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getSize();
 
-	/**
-	 * Get the last modified date as unix timestamp
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getMTime();
+    /**
+     * Get the last modified date as unix timestamp
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getMTime();
 
-	/**
-	 * Get the last modified date on the storage as unix timestamp
-	 *
-	 * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently
-	 * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getStorageMTime();
+    /**
+     * Get the last modified date on the storage as unix timestamp
+     *
+     * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently
+     * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getStorageMTime();
 
-	/**
-	 * Get the etag for the file
-	 *
-	 * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes
-	 * Etag for folders change whenever a file in the folder has changed
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getEtag();
+    /**
+     * Get the etag for the file
+     *
+     * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes
+     * Etag for folders change whenever a file in the folder has changed
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getEtag();
 
-	/**
-	 * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE
-	 * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getPermissions();
+    /**
+     * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE
+     * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getPermissions();
 
-	/**
-	 * Check if the file is encrypted
-	 *
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isEncrypted();
+    /**
+     * Check if the file is encrypted
+     *
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isEncrypted();
 }

lib/public/Files/Cache/IWatcher.php

Indentation +46 added lines, -46 removed lines

@@ -28,56 +28,56 @@
  * @since 9.0.0
  */
 interface IWatcher {
-	const CHECK_NEVER = 0; // never check the underlying filesystem for updates
-	const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file
-	const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates
+    const CHECK_NEVER = 0; // never check the underlying filesystem for updates
+    const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file
+    const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates
 
-	/**
-	 * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS
-	 * @since 9.0.0
-	 */
-	public function setPolicy($policy);
+    /**
+     * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS
+     * @since 9.0.0
+     */
+    public function setPolicy($policy);
 
-	/**
-	 * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS
-	 * @since 9.0.0
-	 */
-	public function getPolicy();
+    /**
+     * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS
+     * @since 9.0.0
+     */
+    public function getPolicy();
 
-	/**
-	 * check $path for updates and update if needed
-	 *
-	 * @param string $path
-	 * @param ICacheEntry|null $cachedEntry
-	 * @return boolean true if path was updated
-	 * @since 9.0.0
-	 */
-	public function checkUpdate($path, $cachedEntry = null);
+    /**
+     * check $path for updates and update if needed
+     *
+     * @param string $path
+     * @param ICacheEntry|null $cachedEntry
+     * @return boolean true if path was updated
+     * @since 9.0.0
+     */
+    public function checkUpdate($path, $cachedEntry = null);
 
-	/**
-	 * Update the cache for changes to $path
-	 *
-	 * @param string $path
-	 * @param ICacheEntry $cachedData
-	 * @since 9.0.0
-	 */
-	public function update($path, $cachedData);
+    /**
+     * Update the cache for changes to $path
+     *
+     * @param string $path
+     * @param ICacheEntry $cachedData
+     * @since 9.0.0
+     */
+    public function update($path, $cachedData);
 
-	/**
-	 * Check if the cache for $path needs to be updated
-	 *
-	 * @param string $path
-	 * @param ICacheEntry $cachedData
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function needsUpdate($path, $cachedData);
+    /**
+     * Check if the cache for $path needs to be updated
+     *
+     * @param string $path
+     * @param ICacheEntry $cachedData
+     * @return bool
+     * @since 9.0.0
+     */
+    public function needsUpdate($path, $cachedData);
 
-	/**
-	 * remove deleted files in $path from the cache
-	 *
-	 * @param string $path
-	 * @since 9.0.0
-	 */
-	public function cleanFolder($path);
+    /**
+     * remove deleted files in $path from the cache
+     *
+     * @param string $path
+     * @since 9.0.0
+     */
+    public function cleanFolder($path);
 }

lib/public/Files/Cache/IPropagator.php

Indentation +23 added lines, -23 removed lines

@@ -28,29 +28,29 @@
  * @since 9.0.0
  */
 interface IPropagator {
-	/**
-	 * Mark the beginning of a propagation batch
-	 *
-	 * Note that not all cache setups support propagation in which case this will be a noop
-	 *
-	 * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent
-	 * before the batch is committed.
-	 *
-	 * @since 9.1.0
-	 */
-	public function beginBatch();
+    /**
+     * Mark the beginning of a propagation batch
+     *
+     * Note that not all cache setups support propagation in which case this will be a noop
+     *
+     * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent
+     * before the batch is committed.
+     *
+     * @since 9.1.0
+     */
+    public function beginBatch();
 
-	/**
-	 * Commit the active propagation batch
-	 *
-	 * @since 9.1.0
-	 */
-	public function commitBatch();
+    /**
+     * Commit the active propagation batch
+     *
+     * @since 9.1.0
+     */
+    public function commitBatch();
 
-	/**
-	 * @param string $internalPath
-	 * @param int $time
-	 * @since 9.0.0
-	 */
-	public function propagateChange($internalPath, $time);
+    /**
+     * @param string $internalPath
+     * @param int $time
+     * @since 9.0.0
+     */
+    public function propagateChange($internalPath, $time);
 }

lib/public/Files/Cache/IScanner.php

Indentation +47 added lines, -47 removed lines

@@ -28,57 +28,57 @@
  * @since 9.0.0
  */
 interface IScanner {
-	const SCAN_RECURSIVE_INCOMPLETE = 2; // only recursive into not fully scanned folders
-	const SCAN_RECURSIVE = true;
-	const SCAN_SHALLOW = false;
+    const SCAN_RECURSIVE_INCOMPLETE = 2; // only recursive into not fully scanned folders
+    const SCAN_RECURSIVE = true;
+    const SCAN_SHALLOW = false;
 
-	const REUSE_NONE = 0;
-	const REUSE_ETAG = 1;
-	const REUSE_SIZE = 2;
+    const REUSE_NONE = 0;
+    const REUSE_ETAG = 1;
+    const REUSE_SIZE = 2;
 
-	/**
-	 * scan a single file and store it in the cache
-	 *
-	 * @param string $file
-	 * @param int $reuseExisting
-	 * @param int $parentId
-	 * @param array | null $cacheData existing data in the cache for the file to be scanned
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return array an array of metadata of the scanned file
-	 * @throws \OC\ServerNotAvailableException
-	 * @throws \OCP\Lock\LockedException
-	 * @since 9.0.0
-	 */
-	public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true);
+    /**
+     * scan a single file and store it in the cache
+     *
+     * @param string $file
+     * @param int $reuseExisting
+     * @param int $parentId
+     * @param array | null $cacheData existing data in the cache for the file to be scanned
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return array an array of metadata of the scanned file
+     * @throws \OC\ServerNotAvailableException
+     * @throws \OCP\Lock\LockedException
+     * @since 9.0.0
+     */
+    public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true);
 
-	/**
-	 * scan a folder and all its children
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return array an array of the meta data of the scanned file or folder
-	 * @since 9.0.0
-	 */
-	public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true);
+    /**
+     * scan a folder and all its children
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return array an array of the meta data of the scanned file or folder
+     * @since 9.0.0
+     */
+    public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true);
 
-	/**
-	 * check if the file should be ignored when scanning
-	 * NOTE: files with a '.part' extension are ignored as well!
-	 *       prevents unfinished put requests to be scanned
-	 *
-	 * @param string $file
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public static function isPartialFile($file);
+    /**
+     * check if the file should be ignored when scanning
+     * NOTE: files with a '.part' extension are ignored as well!
+     *       prevents unfinished put requests to be scanned
+     *
+     * @param string $file
+     * @return boolean
+     * @since 9.0.0
+     */
+    public static function isPartialFile($file);
 
-	/**
-	 * walk over any folders that are not fully scanned yet and scan them
-	 *
-	 * @since 9.0.0
-	 */
-	public function backgroundScan();
+    /**
+     * walk over any folders that are not fully scanned yet and scan them
+     *
+     * @since 9.0.0
+     */
+    public function backgroundScan();
 }