nextcloud / server

lib/private/BackgroundJob/TimedJob.php

Indentation +20 added lines, -20 removed lines

@@ -32,26 +32,26 @@
  * @package OC\BackgroundJob
  */
 abstract class TimedJob extends Job {
-	protected $interval = 0;
+    protected $interval = 0;
 
-	/**
-	 * set the interval for the job
-	 *
-	 * @param int $interval
-	 */
-	public function setInterval($interval) {
-		$this->interval = $interval;
-	}
+    /**
+     * set the interval for the job
+     *
+     * @param int $interval
+     */
+    public function setInterval($interval) {
+        $this->interval = $interval;
+    }
 
-	/**
-	 * run the job if
-	 *
-	 * @param JobList $jobList
-	 * @param ILogger|null $logger
-	 */
-	public function execute($jobList, ILogger $logger = null) {
-		if ((time() - $this->lastRun) > $this->interval) {
-			parent::execute($jobList, $logger);
-		}
-	}
+    /**
+     * run the job if
+     *
+     * @param JobList $jobList
+     * @param ILogger|null $logger
+     */
+    public function execute($jobList, ILogger $logger = null) {
+        if ((time() - $this->lastRun) > $this->interval) {
+            parent::execute($jobList, $logger);
+        }
+    }
 }

lib/private/BackgroundJob/QueuedJob.php

Indentation +10 added lines, -10 removed lines

@@ -32,14 +32,14 @@
  * @package OC\BackgroundJob
  */
 abstract class QueuedJob extends Job {
-	/**
-	 * run the job, then remove it from the joblist
-	 *
-	 * @param JobList $jobList
-	 * @param ILogger|null $logger
-	 */
-	public function execute($jobList, ILogger $logger = null) {
-		$jobList->remove($this, $this->argument);
-		parent::execute($jobList, $logger);
-	}
+    /**
+     * run the job, then remove it from the joblist
+     *
+     * @param JobList $jobList
+     * @param ILogger|null $logger
+     */
+    public function execute($jobList, ILogger $logger = null) {
+        $jobList->remove($this, $this->argument);
+        parent::execute($jobList, $logger);
+    }
 }

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

Indentation +498 added lines, -498 removed lines

@@ -34,502 +34,502 @@
  */
 class Encoding extends Wrapper {
 
-	/**
-	 * @var ICache
-	 */
-	private $namesCache;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		$this->storage = $parameters['storage'];
-		$this->namesCache = new CappedMemoryCache();
-	}
-
-	/**
-	 * Returns whether the given string is only made of ASCII characters
-	 *
-	 * @param string $str string
-	 *
-	 * @return bool true if the string is all ASCII, false otherwise
-	 */
-	private function isAscii($str) {
-		return (bool) !preg_match('/[\\x80-\\xff]+/', $str);
-	}
-
-	/**
-	 * Checks whether the given path exists in NFC or NFD form after checking
-	 * each form for each path section and returns the correct form.
-	 * If no existing path found, returns the path as it was given.
-	 *
-	 * @param string $fullPath path to check
-	 *
-	 * @return string original or converted path
-	 */
-	private function findPathToUse($fullPath) {
-		$cachedPath = $this->namesCache[$fullPath];
-		if ($cachedPath !== null) {
-			return $cachedPath;
-		}
-
-		$sections = explode('/', $fullPath);
-		$path = '';
-		foreach ($sections as $section) {
-			$convertedPath = $this->findPathToUseLastSection($path, $section);
-			if ($convertedPath === null) {
-				// no point in continuing if the section was not found, use original path
-				return $fullPath;
-			}
-			$path = $convertedPath . '/';
-		}
-		$path = rtrim($path, '/');
-		return $path;
-	}
-
-	/**
-	 * Checks whether the last path section of the given path exists in NFC or NFD form
-	 * and returns the correct form. If no existing path found, returns null.
-	 *
-	 * @param string $basePath base path to check
-	 * @param string $lastSection last section of the path to check for NFD/NFC variations
-	 *
-	 * @return string|null original or converted path, or null if none of the forms was found
-	 */
-	private function findPathToUseLastSection($basePath, $lastSection) {
-		$fullPath = $basePath . $lastSection;
-		if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) {
-			$this->namesCache[$fullPath] = $fullPath;
-			return $fullPath;
-		}
-
-		// swap encoding
-		if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) {
-			$otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D);
-		} else {
-			$otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C);
-		}
-		$otherFullPath = $basePath . $otherFormPath;
-		if ($this->storage->file_exists($otherFullPath)) {
-			$this->namesCache[$fullPath] = $otherFullPath;
-			return $otherFullPath;
-		}
-
-		// return original path, file did not exist at all
-		$this->namesCache[$fullPath] = $fullPath;
-		return null;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.mkdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function mkdir($path) {
-		// note: no conversion here, method should not be called with non-NFC names!
-		$result = $this->storage->mkdir($path);
-		if ($result) {
-			$this->namesCache[$path] = $path;
-		}
-		return $result;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		$result = $this->storage->rmdir($this->findPathToUse($path));
-		if ($result) {
-			unset($this->namesCache[$path]);
-		}
-		return $result;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource
-	 */
-	public function opendir($path) {
-		return $this->storage->opendir($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.is_dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_dir($path) {
-		return $this->storage->is_dir($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.is_file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_file($path) {
-		return $this->storage->is_file($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	public function stat($path) {
-		return $this->storage->stat($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function filetype($path) {
-		return $this->storage->filetype($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filesize($path) {
-		return $this->storage->filesize($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isCreatable($path) {
-		return $this->storage->isCreatable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-		return $this->storage->isReadable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isUpdatable($path) {
-		return $this->storage->isUpdatable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isDeletable($path) {
-		return $this->storage->isDeletable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isSharable($path) {
-		return $this->storage->isSharable($this->findPathToUse($path));
-	}
-
-	/**
-	 * get the full permissions of a path.
-	 * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function getPermissions($path) {
-		return $this->storage->getPermissions($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function file_exists($path) {
-		return $this->storage->file_exists($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filemtime($path) {
-		return $this->storage->filemtime($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function file_get_contents($path) {
-		return $this->storage->file_get_contents($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 */
-	public function file_put_contents($path, $data) {
-		return $this->storage->file_put_contents($this->findPathToUse($path), $data);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		$result = $this->storage->unlink($this->findPathToUse($path));
-		if ($result) {
-			unset($this->namesCache[$path]);
-		}
-		return $result;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		// second name always NFC
-		return $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function copy($path1, $path2) {
-		return $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		$result = $this->storage->fopen($this->findPathToUse($path), $mode);
-		if ($result && $mode !== 'r' && $mode !== 'rb') {
-			unset($this->namesCache[$path]);
-		}
-		return $result;
-	}
-
-	/**
-	 * get the mimetype for a file or folder
-	 * The mimetype for a folder is required to be "httpd/unix-directory"
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getMimeType($path) {
-		return $this->storage->getMimeType($this->findPathToUse($path));
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.hash.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string
-	 */
-	public function hash($type, $path, $raw = false) {
-		return $this->storage->hash($type, $this->findPathToUse($path), $raw);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		return $this->storage->free_space($this->findPathToUse($path));
-	}
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array
-	 */
-	public function search($query) {
-		return $this->storage->search($query);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 */
-	public function touch($path, $mtime = null) {
-		return $this->storage->touch($this->findPathToUse($path), $mtime);
-	}
-
-	/**
-	 * get the path to a local version of the file.
-	 * The local version of the file can be temporary and doesn't have to be persistent across requests
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getLocalFile($path) {
-		return $this->storage->getLocalFile($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 *
-	 * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
-	 * returning true for other changes in the folder is optional
-	 */
-	public function hasUpdated($path, $time) {
-		return $this->storage->hasUpdated($this->findPathToUse($path), $time);
-	}
-
-	/**
-	 * get a cache instance for the storage
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache
-	 * @return \OC\Files\Cache\Cache
-	 */
-	public function getCache($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->storage->getCache($this->findPathToUse($path), $storage);
-	}
-
-	/**
-	 * get a scanner instance for the storage
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
-	 * @return \OC\Files\Cache\Scanner
-	 */
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->storage->getScanner($this->findPathToUse($path), $storage);
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		return $this->storage->getETag($this->findPathToUse($path));
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath));
-		}
-
-		$result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
-		if ($result) {
-			unset($this->namesCache[$targetInternalPath]);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			$result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath));
-			if ($result) {
-				unset($this->namesCache[$sourceInternalPath]);
-				unset($this->namesCache[$targetInternalPath]);
-			}
-			return $result;
-		}
-
-		$result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
-		if ($result) {
-			unset($this->namesCache[$sourceInternalPath]);
-			unset($this->namesCache[$targetInternalPath]);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		return $this->storage->getMetaData($this->findPathToUse($path));
-	}
+    /**
+     * @var ICache
+     */
+    private $namesCache;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        $this->storage = $parameters['storage'];
+        $this->namesCache = new CappedMemoryCache();
+    }
+
+    /**
+     * Returns whether the given string is only made of ASCII characters
+     *
+     * @param string $str string
+     *
+     * @return bool true if the string is all ASCII, false otherwise
+     */
+    private function isAscii($str) {
+        return (bool) !preg_match('/[\\x80-\\xff]+/', $str);
+    }
+
+    /**
+     * Checks whether the given path exists in NFC or NFD form after checking
+     * each form for each path section and returns the correct form.
+     * If no existing path found, returns the path as it was given.
+     *
+     * @param string $fullPath path to check
+     *
+     * @return string original or converted path
+     */
+    private function findPathToUse($fullPath) {
+        $cachedPath = $this->namesCache[$fullPath];
+        if ($cachedPath !== null) {
+            return $cachedPath;
+        }
+
+        $sections = explode('/', $fullPath);
+        $path = '';
+        foreach ($sections as $section) {
+            $convertedPath = $this->findPathToUseLastSection($path, $section);
+            if ($convertedPath === null) {
+                // no point in continuing if the section was not found, use original path
+                return $fullPath;
+            }
+            $path = $convertedPath . '/';
+        }
+        $path = rtrim($path, '/');
+        return $path;
+    }
+
+    /**
+     * Checks whether the last path section of the given path exists in NFC or NFD form
+     * and returns the correct form. If no existing path found, returns null.
+     *
+     * @param string $basePath base path to check
+     * @param string $lastSection last section of the path to check for NFD/NFC variations
+     *
+     * @return string|null original or converted path, or null if none of the forms was found
+     */
+    private function findPathToUseLastSection($basePath, $lastSection) {
+        $fullPath = $basePath . $lastSection;
+        if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) {
+            $this->namesCache[$fullPath] = $fullPath;
+            return $fullPath;
+        }
+
+        // swap encoding
+        if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) {
+            $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D);
+        } else {
+            $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C);
+        }
+        $otherFullPath = $basePath . $otherFormPath;
+        if ($this->storage->file_exists($otherFullPath)) {
+            $this->namesCache[$fullPath] = $otherFullPath;
+            return $otherFullPath;
+        }
+
+        // return original path, file did not exist at all
+        $this->namesCache[$fullPath] = $fullPath;
+        return null;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.mkdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function mkdir($path) {
+        // note: no conversion here, method should not be called with non-NFC names!
+        $result = $this->storage->mkdir($path);
+        if ($result) {
+            $this->namesCache[$path] = $path;
+        }
+        return $result;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        $result = $this->storage->rmdir($this->findPathToUse($path));
+        if ($result) {
+            unset($this->namesCache[$path]);
+        }
+        return $result;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource
+     */
+    public function opendir($path) {
+        return $this->storage->opendir($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.is_dir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_dir($path) {
+        return $this->storage->is_dir($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.is_file.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_file($path) {
+        return $this->storage->is_file($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array
+     */
+    public function stat($path) {
+        return $this->storage->stat($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function filetype($path) {
+        return $this->storage->filetype($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filesize($path) {
+        return $this->storage->filesize($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isCreatable($path) {
+        return $this->storage->isCreatable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+        return $this->storage->isReadable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isUpdatable($path) {
+        return $this->storage->isUpdatable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isDeletable($path) {
+        return $this->storage->isDeletable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isSharable($path) {
+        return $this->storage->isSharable($this->findPathToUse($path));
+    }
+
+    /**
+     * get the full permissions of a path.
+     * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function getPermissions($path) {
+        return $this->storage->getPermissions($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function file_exists($path) {
+        return $this->storage->file_exists($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filemtime($path) {
+        return $this->storage->filemtime($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string
+     */
+    public function file_get_contents($path) {
+        return $this->storage->file_get_contents($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     */
+    public function file_put_contents($path, $data) {
+        return $this->storage->file_put_contents($this->findPathToUse($path), $data);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        $result = $this->storage->unlink($this->findPathToUse($path));
+        if ($result) {
+            unset($this->namesCache[$path]);
+        }
+        return $result;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        // second name always NFC
+        return $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function copy($path1, $path2) {
+        return $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        $result = $this->storage->fopen($this->findPathToUse($path), $mode);
+        if ($result && $mode !== 'r' && $mode !== 'rb') {
+            unset($this->namesCache[$path]);
+        }
+        return $result;
+    }
+
+    /**
+     * get the mimetype for a file or folder
+     * The mimetype for a folder is required to be "httpd/unix-directory"
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getMimeType($path) {
+        return $this->storage->getMimeType($this->findPathToUse($path));
+    }
+
+    /**
+     * see http://php.net/manual/en/function.hash.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string
+     */
+    public function hash($type, $path, $raw = false) {
+        return $this->storage->hash($type, $this->findPathToUse($path), $raw);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        return $this->storage->free_space($this->findPathToUse($path));
+    }
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array
+     */
+    public function search($query) {
+        return $this->storage->search($query);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     */
+    public function touch($path, $mtime = null) {
+        return $this->storage->touch($this->findPathToUse($path), $mtime);
+    }
+
+    /**
+     * get the path to a local version of the file.
+     * The local version of the file can be temporary and doesn't have to be persistent across requests
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getLocalFile($path) {
+        return $this->storage->getLocalFile($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     *
+     * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
+     * returning true for other changes in the folder is optional
+     */
+    public function hasUpdated($path, $time) {
+        return $this->storage->hasUpdated($this->findPathToUse($path), $time);
+    }
+
+    /**
+     * get a cache instance for the storage
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache
+     * @return \OC\Files\Cache\Cache
+     */
+    public function getCache($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->storage->getCache($this->findPathToUse($path), $storage);
+    }
+
+    /**
+     * get a scanner instance for the storage
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
+     * @return \OC\Files\Cache\Scanner
+     */
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->storage->getScanner($this->findPathToUse($path), $storage);
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        return $this->storage->getETag($this->findPathToUse($path));
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath));
+        }
+
+        $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
+        if ($result) {
+            unset($this->namesCache[$targetInternalPath]);
+        }
+        return $result;
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            $result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath));
+            if ($result) {
+                unset($this->namesCache[$sourceInternalPath]);
+                unset($this->namesCache[$targetInternalPath]);
+            }
+            return $result;
+        }
+
+        $result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
+        if ($result) {
+            unset($this->namesCache[$sourceInternalPath]);
+            unset($this->namesCache[$targetInternalPath]);
+        }
+        return $result;
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        return $this->storage->getMetaData($this->findPathToUse($path));
+    }
 }

lib/public/IDateTimeFormatter.php

Indentation +104 added lines, -104 removed lines

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

lib/public/Share/Exceptions/GenericShareException.php

Indentation +13 added lines, -13 removed lines

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

lib/public/BackgroundJob/IJob.php

Indentation +46 added lines, -46 removed lines

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

lib/public/Encryption/Exceptions/GenericEncryptionException.php

Indentation +13 added lines, -13 removed lines

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

lib/public/Files/Storage.php

Indentation +413 added lines, -413 removed lines

@@ -47,417 +47,417 @@
  * @deprecated 9.0.0 use \OCP\Files\Storage\IStorage instead
  */
 interface Storage extends IStorage {
-	/**
-	 * $parameters is a free form array with the configuration options needed to construct the storage
-	 *
-	 * @param array $parameters
-	 * @since 6.0.0
-	 */
-	public function __construct($parameters);
-
-	/**
-	 * Get the identifier for the storage,
-	 * the returned id should be the same for every storage object that is created with the same parameters
-	 * and two storage objects with the same id should refer to two storages that display the same files.
-	 *
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getId();
-
-	/**
-	 * see http://php.net/manual/en/function.mkdir.php
-	 * implementations need to implement a recursive mkdir
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function mkdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rmdir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|false
-	 * @since 6.0.0
-	 */
-	public function opendir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function is_dir($path);
-
-	/**
-	 * see http://php.net/manual/en/function.is-file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function is_file($path);
-
-	/**
-	 * see http://php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|false
-	 * @since 6.0.0
-	 */
-	public function stat($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function filetype($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function filesize($path);
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isCreatable($path);
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isReadable($path);
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isUpdatable($path);
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isDeletable($path);
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isSharable($path);
-
-	/**
-	 * get the full permissions of a path.
-	 * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
-	 *
-	 * @param string $path
-	 * @return int
-	 * @since 6.0.0
-	 */
-	public function getPermissions($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function file_exists($path);
-
-	/**
-	 * see http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function filemtime($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function file_get_contents($path);
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function file_put_contents($path, $data);
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function unlink($path);
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rename($path1, $path2);
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function copy($path1, $path2);
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|false
-	 * @since 6.0.0
-	 */
-	public function fopen($path, $mode);
-
-	/**
-	 * get the mimetype for a file or folder
-	 * The mimetype for a folder is required to be "httpd/unix-directory"
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function getMimeType($path);
-
-	/**
-	 * see http://php.net/manual/en/function.hash-file.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function hash($type, $path, $raw = false);
-
-	/**
-	 * see http://php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int|false
-	 * @since 6.0.0
-	 */
-	public function free_space($path);
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array|false
-	 * @since 6.0.0
-	 */
-	public function search($query);
-
-	/**
-	 * see http://php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function touch($path, $mtime = null);
-
-	/**
-	 * get the path to a local version of the file.
-	 * The local version of the file can be temporary and doesn't have to be persistent across requests
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function getLocalFile($path);
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 * @since 6.0.0
-	 *
-	 * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
-	 * returning true for other changes in the folder is optional
-	 */
-	public function hasUpdated($path, $time);
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string|false
-	 * @since 6.0.0
-	 */
-	public function getETag($path);
-
-	/**
-	 * Returns whether the storage is local, which means that files
-	 * are stored on the local filesystem instead of remotely.
-	 * Calling getLocalFile() for local storages should always
-	 * return the local files, whereas for non-local storages
-	 * it might return a temporary file.
-	 *
-	 * @return bool true if the files are stored locally, false otherwise
-	 * @since 7.0.0
-	 */
-	public function isLocal();
-
-	/**
-	 * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
-	 *
-	 * @param string $class
-	 * @return bool
-	 * @since 7.0.0
-	 */
-	public function instanceOfStorage($class);
-
-	/**
-	 * A custom storage implementation can return an url for direct download of a give file.
-	 *
-	 * For now the returned array can hold the parameter url - in future more attributes might follow.
-	 *
-	 * @param string $path
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getDirectDownload($path);
-
-	/**
-	 * @param string $path the path of the target folder
-	 * @param string $fileName the name of the file itself
-	 * @return void
-	 * @throws InvalidPathException
-	 * @since 8.1.0
-	 */
-	public function verifyPath($path, $fileName);
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
-
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider);
-
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider);
-
-	/**
-	 * @param string $path The path of the file to change the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 * @since 8.1.0
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider);
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @since 8.2.0
-	 * @return bool
-	 */
-	public function test();
-
-	/**
-	 * @since 8.2.0
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability();
-
-	/**
-	 * @since 8.2.0
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable);
-
-	public function needsPartFile();
+    /**
+     * $parameters is a free form array with the configuration options needed to construct the storage
+     *
+     * @param array $parameters
+     * @since 6.0.0
+     */
+    public function __construct($parameters);
+
+    /**
+     * Get the identifier for the storage,
+     * the returned id should be the same for every storage object that is created with the same parameters
+     * and two storage objects with the same id should refer to two storages that display the same files.
+     *
+     * @return string
+     * @since 6.0.0
+     */
+    public function getId();
+
+    /**
+     * see http://php.net/manual/en/function.mkdir.php
+     * implementations need to implement a recursive mkdir
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function mkdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rmdir($path);
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|false
+     * @since 6.0.0
+     */
+    public function opendir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-dir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function is_dir($path);
+
+    /**
+     * see http://php.net/manual/en/function.is-file.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function is_file($path);
+
+    /**
+     * see http://php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|false
+     * @since 6.0.0
+     */
+    public function stat($path);
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function filetype($path);
+
+    /**
+     * see http://php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function filesize($path);
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isCreatable($path);
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isReadable($path);
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isUpdatable($path);
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isDeletable($path);
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isSharable($path);
+
+    /**
+     * get the full permissions of a path.
+     * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
+     *
+     * @param string $path
+     * @return int
+     * @since 6.0.0
+     */
+    public function getPermissions($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function file_exists($path);
+
+    /**
+     * see http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function filemtime($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function file_get_contents($path);
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     * @since 6.0.0
+     */
+    public function file_put_contents($path, $data);
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function unlink($path);
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rename($path1, $path2);
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     * @since 6.0.0
+     */
+    public function copy($path1, $path2);
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|false
+     * @since 6.0.0
+     */
+    public function fopen($path, $mode);
+
+    /**
+     * get the mimetype for a file or folder
+     * The mimetype for a folder is required to be "httpd/unix-directory"
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function getMimeType($path);
+
+    /**
+     * see http://php.net/manual/en/function.hash-file.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function hash($type, $path, $raw = false);
+
+    /**
+     * see http://php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int|false
+     * @since 6.0.0
+     */
+    public function free_space($path);
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array|false
+     * @since 6.0.0
+     */
+    public function search($query);
+
+    /**
+     * see http://php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     * @since 6.0.0
+     */
+    public function touch($path, $mtime = null);
+
+    /**
+     * get the path to a local version of the file.
+     * The local version of the file can be temporary and doesn't have to be persistent across requests
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function getLocalFile($path);
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     * @since 6.0.0
+     *
+     * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
+     * returning true for other changes in the folder is optional
+     */
+    public function hasUpdated($path, $time);
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string|false
+     * @since 6.0.0
+     */
+    public function getETag($path);
+
+    /**
+     * Returns whether the storage is local, which means that files
+     * are stored on the local filesystem instead of remotely.
+     * Calling getLocalFile() for local storages should always
+     * return the local files, whereas for non-local storages
+     * it might return a temporary file.
+     *
+     * @return bool true if the files are stored locally, false otherwise
+     * @since 7.0.0
+     */
+    public function isLocal();
+
+    /**
+     * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
+     *
+     * @param string $class
+     * @return bool
+     * @since 7.0.0
+     */
+    public function instanceOfStorage($class);
+
+    /**
+     * A custom storage implementation can return an url for direct download of a give file.
+     *
+     * For now the returned array can hold the parameter url - in future more attributes might follow.
+     *
+     * @param string $path
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getDirectDownload($path);
+
+    /**
+     * @param string $path the path of the target folder
+     * @param string $fileName the name of the file itself
+     * @return void
+     * @throws InvalidPathException
+     * @since 8.1.0
+     */
+    public function verifyPath($path, $fileName);
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 8.1.0
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     * @since 8.1.0
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
+
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider);
+
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider);
+
+    /**
+     * @param string $path The path of the file to change the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     * @since 8.1.0
+     */
+    public function changeLock($path, $type, ILockingProvider $provider);
+
+    /**
+     * Test a storage for availability
+     *
+     * @since 8.2.0
+     * @return bool
+     */
+    public function test();
+
+    /**
+     * @since 8.2.0
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability();
+
+    /**
+     * @since 8.2.0
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable);
+
+    public function needsPartFile();
 }

lib/public/Files/StorageAuthException.php

Indentation +11 added lines, -11 removed lines

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