nextcloud / server

lib/public/Files/StorageTimeoutException.php

Indentation +12 added lines, -12 removed lines

@@ -27,16 +27,16 @@
  */
 class StorageTimeoutException extends StorageNotAvailableException {
 
-	/**
-	 * StorageTimeoutException constructor.
-	 *
-	 * @param string $message
-	 * @param int $code
-	 * @param \Exception $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 int $code
+     * @param \Exception $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/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/ICache.php

Indentation +199 added lines, -199 removed lines

@@ -35,223 +35,223 @@
  * @since 9.0.0
  */
 interface ICache {
-	const NOT_FOUND = 0;
-	const PARTIAL = 1; //only partial data available, file not cached in the database
-	const SHALLOW = 2; //folder in cache, but not all child files are completely scanned
-	const COMPLETE = 3;
+    const NOT_FOUND = 0;
+    const PARTIAL = 1; //only partial data available, file not cached in the database
+    const SHALLOW = 2; //folder in cache, but not all child files are completely scanned
+    const COMPLETE = 3;
 
-	/**
-	 * Get the numeric storage id for this cache's storage
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getNumericStorageId();
+    /**
+     * Get the numeric storage id for this cache's storage
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getNumericStorageId();
 
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string | int $file either the path of a file or folder or the file id for a file or folder
-	 * @return ICacheEntry|false the cache entry or false if the file is not found in the cache
-	 * @since 9.0.0
-	 */
-	public function get($file);
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string | int $file either the path of a file or folder or the file id for a file or folder
+     * @return ICacheEntry|false the cache entry or false if the file is not found in the cache
+     * @since 9.0.0
+     */
+    public function get($file);
 
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * Only returns files one level deep, no recursion
-	 *
-	 * @param string $folder
-	 * @return ICacheEntry[]
-	 * @since 9.0.0
-	 */
-	public function getFolderContents($folder);
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * Only returns files one level deep, no recursion
+     *
+     * @param string $folder
+     * @return ICacheEntry[]
+     * @since 9.0.0
+     */
+    public function getFolderContents($folder);
 
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * Only returns files one level deep, no recursion
-	 *
-	 * @param int $fileId the file id of the folder
-	 * @return ICacheEntry[]
-	 * @since 9.0.0
-	 */
-	public function getFolderContentsById($fileId);
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * Only returns files one level deep, no recursion
+     *
+     * @param int $fileId the file id of the folder
+     * @return ICacheEntry[]
+     * @since 9.0.0
+     */
+    public function getFolderContentsById($fileId);
 
-	/**
-	 * store meta data for a file or folder
-	 * This will automatically call either insert or update depending on if the file exists
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 * @since 9.0.0
-	 */
-	public function put($file, array $data);
+    /**
+     * store meta data for a file or folder
+     * This will automatically call either insert or update depending on if the file exists
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     * @since 9.0.0
+     */
+    public function put($file, array $data);
 
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 * @since 9.0.0
-	 */
-	public function insert($file, array $data);
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     * @since 9.0.0
+     */
+    public function insert($file, array $data);
 
-	/**
-	 * update the metadata of an existing file or folder in the cache
-	 *
-	 * @param int $id the fileid of the existing file or folder
-	 * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
-	 * @since 9.0.0
-	 */
-	public function update($id, array $data);
+    /**
+     * update the metadata of an existing file or folder in the cache
+     *
+     * @param int $id the fileid of the existing file or folder
+     * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
+     * @since 9.0.0
+     */
+    public function update($id, array $data);
 
-	/**
-	 * get the file id for a file
-	 *
-	 * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
-	 *
-	 * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
-	 *
-	 * @param string $file
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getId($file);
+    /**
+     * get the file id for a file
+     *
+     * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
+     *
+     * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
+     *
+     * @param string $file
+     * @return int
+     * @since 9.0.0
+     */
+    public function getId($file);
 
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getParentId($file);
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     * @since 9.0.0
+     */
+    public function getParentId($file);
 
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function inCache($file);
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     * @since 9.0.0
+     */
+    public function inCache($file);
 
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * when removing a folder from the cache all files and folders inside the folder will be removed as well
-	 *
-	 * @param string $file
-	 * @since 9.0.0
-	 */
-	public function remove($file);
+    /**
+     * remove a file or folder from the cache
+     *
+     * when removing a folder from the cache all files and folders inside the folder will be removed as well
+     *
+     * @param string $file
+     * @since 9.0.0
+     */
+    public function remove($file);
 
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @since 9.0.0
-	 */
-	public function move($source, $target);
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     * @since 9.0.0
+     */
+    public function move($source, $target);
 
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * Note that this should make sure the entries are removed from the source cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 * @throws \OC\DatabaseException
-	 * @since 9.0.0
-	 */
-	public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath);
+    /**
+     * Move a file or folder in the cache
+     *
+     * Note that this should make sure the entries are removed from the source cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws \OC\DatabaseException
+     * @since 9.0.0
+     */
+    public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath);
 
-	/**
-	 * Get the scan status of a file
-	 *
-	 * - ICache::NOT_FOUND: File is not in the cache
-	 * - ICache::PARTIAL: File is not stored in the cache but some incomplete data is known
-	 * - ICache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
-	 * - ICache::COMPLETE: The file or folder, with all it's children) are fully scanned
-	 *
-	 * @param string $file
-	 *
-	 * @return int ICache::NOT_FOUND, ICache::PARTIAL, ICache::SHALLOW or ICache::COMPLETE
-	 * @since 9.0.0
-	 */
-	public function getStatus($file);
+    /**
+     * Get the scan status of a file
+     *
+     * - ICache::NOT_FOUND: File is not in the cache
+     * - ICache::PARTIAL: File is not stored in the cache but some incomplete data is known
+     * - ICache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
+     * - ICache::COMPLETE: The file or folder, with all it's children) are fully scanned
+     *
+     * @param string $file
+     *
+     * @return int ICache::NOT_FOUND, ICache::PARTIAL, ICache::SHALLOW or ICache::COMPLETE
+     * @since 9.0.0
+     */
+    public function getStatus($file);
 
-	/**
-	 * search for files matching $pattern, files are matched if their filename matches the search pattern
-	 *
-	 * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
-	 * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
-	 * @since 9.0.0
-	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
-	 */
-	public function search($pattern);
+    /**
+     * search for files matching $pattern, files are matched if their filename matches the search pattern
+     *
+     * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
+     * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
+     * @since 9.0.0
+     * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
+     */
+    public function search($pattern);
 
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
-	 *        where it will search for all mimetypes in the group ('image/*')
-	 * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
-	 * @since 9.0.0
-	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
-	 */
-	public function searchByMime($mimetype);
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
+     *        where it will search for all mimetypes in the group ('image/*')
+     * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
+     * @since 9.0.0
+     * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
+     */
+    public function searchByMime($mimetype);
 
-	/**
-	 * Search for files by tag of a given users.
-	 *
-	 * Note that every user can tag files differently.
-	 *
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return ICacheEntry[] file data
-	 * @since 9.0.0
-	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
-	 */
-	public function searchByTag($tag, $userId);
+    /**
+     * Search for files by tag of a given users.
+     *
+     * Note that every user can tag files differently.
+     *
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return ICacheEntry[] file data
+     * @since 9.0.0
+     * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
+     */
+    public function searchByTag($tag, $userId);
 
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 * @since 9.0.0
-	 */
-	public function getIncomplete();
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     * @since 9.0.0
+     */
+    public function getIncomplete();
 
-	/**
-	 * get the path of a file on this storage by it's file id
-	 *
-	 * @param int $id the file id of the file or folder to search
-	 * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
-	 * @since 9.0.0
-	 */
-	public function getPathById($id);
+    /**
+     * get the path of a file on this storage by it's file id
+     *
+     * @param int $id the file id of the file or folder to search
+     * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
+     * @since 9.0.0
+     */
+    public function getPathById($id);
 
-	/**
-	 * normalize the given path for usage in the cache
-	 *
-	 * @param string $path
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function normalize($path);
+    /**
+     * normalize the given path for usage in the cache
+     *
+     * @param string $path
+     * @return string
+     * @since 9.0.0
+     */
+    public function normalize($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/Lock/ILockingProvider.php

Indentation +42 added lines, -42 removed lines

@@ -30,51 +30,51 @@
  * @since 8.1.0
  */
 interface ILockingProvider {
-	/**
-	 * @since 8.1.0
-	 */
-	const LOCK_SHARED = 1;
-	/**
-	 * @since 8.1.0
-	 */
-	const LOCK_EXCLUSIVE = 2;
+    /**
+     * @since 8.1.0
+     */
+    const LOCK_SHARED = 1;
+    /**
+     * @since 8.1.0
+     */
+    const LOCK_EXCLUSIVE = 2;
 
-	/**
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function isLocked($path, $type);
+    /**
+     * @param string $path
+     * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @return bool
+     * @since 8.1.0
+     */
+    public function isLocked($path, $type);
 
-	/**
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function acquireLock($path, $type);
+    /**
+     * @param string $path
+     * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function acquireLock($path, $type);
 
-	/**
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @since 8.1.0
-	 */
-	public function releaseLock($path, $type);
+    /**
+     * @param string $path
+     * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @since 8.1.0
+     */
+    public function releaseLock($path, $type);
 
-	/**
-	 * Change the type of an existing lock
-	 *
-	 * @param string $path
-	 * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function changeLock($path, $targetType);
+    /**
+     * Change the type of an existing lock
+     *
+     * @param string $path
+     * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function changeLock($path, $targetType);
 
-	/**
-	 * release all lock acquired by this instance
-	 * @since 8.1.0
-	 */
-	public function releaseAll();
+    /**
+     * release all lock acquired by this instance
+     * @since 8.1.0
+     */
+    public function releaseAll();
 }

lib/public/Lock/LockedException.php

Indentation +25 added lines, -25 removed lines

@@ -32,31 +32,31 @@
  */
 class LockedException extends \Exception {
 
-	/**
-	 * Locked path
-	 *
-	 * @var string
-	 */
-	private $path;
+    /**
+     * Locked path
+     *
+     * @var string
+     */
+    private $path;
 
-	/**
-	 * LockedException constructor.
-	 *
-	 * @param string $path locked path
-	 * @param \Exception $previous previous exception for cascading
-	 *
-	 * @since 8.1.0
-	 */
-	public function __construct($path, \Exception $previous = null) {
-		parent::__construct('"' . $path . '" is locked', 0, $previous);
-		$this->path = $path;
-	}
+    /**
+     * LockedException constructor.
+     *
+     * @param string $path locked path
+     * @param \Exception $previous previous exception for cascading
+     *
+     * @since 8.1.0
+     */
+    public function __construct($path, \Exception $previous = null) {
+        parent::__construct('"' . $path . '" is locked', 0, $previous);
+        $this->path = $path;
+    }
 
-	/**
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getPath() {
-		return $this->path;
-	}
+    /**
+     * @return string
+     * @since 8.1.0
+     */
+    public function getPath() {
+        return $this->path;
+    }
 }

lib/public/JSON.php

Indentation +145 added lines, -145 removed lines

@@ -40,158 +40,158 @@
  * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
  */
 class JSON {
-	/**
-	 * Encode and print $data in JSON format
-	 * @param array $data The data to use
-	 * @param bool $setContentType the optional content type
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function encodedPrint( $data, $setContentType=true ) {
-		\OC_JSON::encodedPrint($data, $setContentType);
-	}
+    /**
+     * Encode and print $data in JSON format
+     * @param array $data The data to use
+     * @param bool $setContentType the optional content type
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function encodedPrint( $data, $setContentType=true ) {
+        \OC_JSON::encodedPrint($data, $setContentType);
+    }
 
-	/**
-	 * Check if the user is logged in, send json error msg if not.
-	 *
-	 * This method checks if a user is logged in. If not, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Authentication error."}}
-	 *
-	 * Add this call to the start of all ajax method files that requires
-	 * an authenticated user.
-	 * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
-	 */
-	public static function checkLoggedIn() {
-		\OC_JSON::checkLoggedIn();
-	}
+    /**
+     * Check if the user is logged in, send json error msg if not.
+     *
+     * This method checks if a user is logged in. If not, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Authentication error."}}
+     *
+     * Add this call to the start of all ajax method files that requires
+     * an authenticated user.
+     * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
+     */
+    public static function checkLoggedIn() {
+        \OC_JSON::checkLoggedIn();
+    }
 
-	/**
-	 * Check an ajax get/post call if the request token is valid.
-	 *
-	 * This method checks for a valid variable 'requesttoken' in $_GET,
-	 * $_POST and $_SERVER. If a valid token is not found, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Token expired. Please reload page."}}
-	 *
-	 * Add this call to the start of all ajax method files that creates,
-	 * updates or deletes anything.
-	 * In cases where you e.g. use an ajax call to load a dialog containing
-	 * a submittable form, you will need to add the requesttoken first as a
-	 * parameter to the ajax call, then assign it to the template and finally
-	 * add a hidden input field also named 'requesttoken' containing the value.
-	 * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead
-	 */
-	public static function callCheck() {
-		\OC_JSON::callCheck();
-	}
+    /**
+     * Check an ajax get/post call if the request token is valid.
+     *
+     * This method checks for a valid variable 'requesttoken' in $_GET,
+     * $_POST and $_SERVER. If a valid token is not found, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Token expired. Please reload page."}}
+     *
+     * Add this call to the start of all ajax method files that creates,
+     * updates or deletes anything.
+     * In cases where you e.g. use an ajax call to load a dialog containing
+     * a submittable form, you will need to add the requesttoken first as a
+     * parameter to the ajax call, then assign it to the template and finally
+     * add a hidden input field also named 'requesttoken' containing the value.
+     * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead
+     */
+    public static function callCheck() {
+        \OC_JSON::callCheck();
+    }
 
-	/**
-	 * Send json success msg
-	 *
-	 * Return a json success message with optional extra data.
-	 * @see OCP\JSON::error()		for the format to use.
-	 *
-	 * @param array $data The data to use
-	 * @return string json formatted string.
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function success( $data = array() ) {
-		\OC_JSON::success($data);
-	}
+    /**
+     * Send json success msg
+     *
+     * Return a json success message with optional extra data.
+     * @see OCP\JSON::error()		for the format to use.
+     *
+     * @param array $data The data to use
+     * @return string json formatted string.
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function success( $data = array() ) {
+        \OC_JSON::success($data);
+    }
 
-	/**
-	 * Send json error msg
-	 *
-	 * Return a json error message with optional extra data for
-	 * error message or app specific data.
-	 *
-	 * Example use:
-	 *
-	 *     $id = [some value]
-	 *     OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id)));
-	 *
-	 * Will return the json formatted string:
-	 *
-	 *     {"status":"error","data":{"message":"An error happened", "id":[some value]}}
-	 *
-	 * @param array $data The data to use
-	 * @return string json formatted error string.
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function error( $data = array() ) {
-		\OC_JSON::error( $data );
-	}
+    /**
+     * Send json error msg
+     *
+     * Return a json error message with optional extra data for
+     * error message or app specific data.
+     *
+     * Example use:
+     *
+     *     $id = [some value]
+     *     OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id)));
+     *
+     * Will return the json formatted string:
+     *
+     *     {"status":"error","data":{"message":"An error happened", "id":[some value]}}
+     *
+     * @param array $data The data to use
+     * @return string json formatted error string.
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function error( $data = array() ) {
+        \OC_JSON::error( $data );
+    }
 
-	/**
-	 * Set Content-Type header to jsonrequest
-	 * @param string $type The content type header
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function setContentTypeHeader( $type='application/json' ) {
-		\OC_JSON::setContentTypeHeader($type);
-	}
+    /**
+     * Set Content-Type header to jsonrequest
+     * @param string $type The content type header
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function setContentTypeHeader( $type='application/json' ) {
+        \OC_JSON::setContentTypeHeader($type);
+    }
 
-	/**
-	 * Check if the App is enabled and send JSON error message instead
-	 *
-	 * This method checks if a specific app is enabled. If not, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Application is not enabled."}}
-	 *
-	 * Add this call to the start of all ajax method files that requires
-	 * a specific app to be enabled.
-	 *
-	 * @param string $app The app to check
-	 * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled.
-	 */
-	public static function checkAppEnabled( $app ) {
-		\OC_JSON::checkAppEnabled($app);
-	}
+    /**
+     * Check if the App is enabled and send JSON error message instead
+     *
+     * This method checks if a specific app is enabled. If not, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Application is not enabled."}}
+     *
+     * Add this call to the start of all ajax method files that requires
+     * a specific app to be enabled.
+     *
+     * @param string $app The app to check
+     * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled.
+     */
+    public static function checkAppEnabled( $app ) {
+        \OC_JSON::checkAppEnabled($app);
+    }
 
-	/**
-	 * Check if the user is a admin, send json error msg if not
-	 *
-	 * This method checks if the current user has admin rights. If not, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Authentication error."}}
-	 *
-	 * Add this call to the start of all ajax method files that requires
-	 * administrative rights.
-	 *
-	 * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
-	 */
-	public static function checkAdminUser() {
-		\OC_JSON::checkAdminUser();
-	}
+    /**
+     * Check if the user is a admin, send json error msg if not
+     *
+     * This method checks if the current user has admin rights. If not, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Authentication error."}}
+     *
+     * Add this call to the start of all ajax method files that requires
+     * administrative rights.
+     *
+     * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
+     */
+    public static function checkAdminUser() {
+        \OC_JSON::checkAdminUser();
+    }
 
-	/**
-	 * Encode JSON
-	 * @param array $data
-	 * @return string
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function encode($data) {
-		return \OC_JSON::encode($data);
-	}
+    /**
+     * Encode JSON
+     * @param array $data
+     * @return string
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function encode($data) {
+        return \OC_JSON::encode($data);
+    }
 
-	/**
-	 * Check is a given user exists - send json error msg if not
-	 * @param string $user
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function checkUserExists($user) {
-		\OC_JSON::checkUserExists($user);
-	}
+    /**
+     * Check is a given user exists - send json error msg if not
+     * @param string $user
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function checkUserExists($user) {
+        \OC_JSON::checkUserExists($user);
+    }
 }