nextcloud / server

lib/private/Files/Storage/Local.php

Indentation +452 added lines, -452 removed lines

@@ -50,456 +50,456 @@
  * for local filestore, we only have to map the paths
  */
 class Local extends \OC\Files\Storage\Common {
-	protected $datadir;
-
-	protected $dataDirLength;
-
-	protected $allowSymlinks = false;
-
-	protected $realDataDir;
-
-	public function __construct($arguments) {
-		if (!isset($arguments['datadir']) || !is_string($arguments['datadir'])) {
-			throw new \InvalidArgumentException('No data directory set for local storage');
-		}
-		$this->datadir = str_replace('//', '/', $arguments['datadir']);
-		// some crazy code uses a local storage on root...
-		if ($this->datadir === '/') {
-			$this->realDataDir = $this->datadir;
-		} else {
-			$realPath = realpath($this->datadir) ?: $this->datadir;
-			$this->realDataDir = rtrim($realPath, '/') . '/';
-		}
-		if (substr($this->datadir, -1) !== '/') {
-			$this->datadir .= '/';
-		}
-		$this->dataDirLength = strlen($this->realDataDir);
-	}
-
-	public function __destruct() {
-	}
-
-	public function getId() {
-		return 'local::' . $this->datadir;
-	}
-
-	public function mkdir($path) {
-		return @mkdir($this->getSourcePath($path), 0777, true);
-	}
-
-	public function rmdir($path) {
-		if (!$this->isDeletable($path)) {
-			return false;
-		}
-		try {
-			$it = new \RecursiveIteratorIterator(
-				new \RecursiveDirectoryIterator($this->getSourcePath($path)),
-				\RecursiveIteratorIterator::CHILD_FIRST
-			);
-			/**
-			 * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach
-			 * This bug is fixed in PHP 5.5.9 or before
-			 * See #8376
-			 */
-			$it->rewind();
-			while ($it->valid()) {
-				/**
-				 * @var \SplFileInfo $file
-				 */
-				$file = $it->current();
-				if (in_array($file->getBasename(), ['.', '..'])) {
-					$it->next();
-					continue;
-				} elseif ($file->isDir()) {
-					rmdir($file->getPathname());
-				} elseif ($file->isFile() || $file->isLink()) {
-					unlink($file->getPathname());
-				}
-				$it->next();
-			}
-			return rmdir($this->getSourcePath($path));
-		} catch (\UnexpectedValueException $e) {
-			return false;
-		}
-	}
-
-	public function opendir($path) {
-		return opendir($this->getSourcePath($path));
-	}
-
-	public function is_dir($path) {
-		if (substr($path, -1) == '/') {
-			$path = substr($path, 0, -1);
-		}
-		return is_dir($this->getSourcePath($path));
-	}
-
-	public function is_file($path) {
-		return is_file($this->getSourcePath($path));
-	}
-
-	public function stat($path) {
-		clearstatcache();
-		$fullPath = $this->getSourcePath($path);
-		$statResult = stat($fullPath);
-		if (PHP_INT_SIZE === 4 && !$this->is_dir($path)) {
-			$filesize = $this->filesize($path);
-			$statResult['size'] = $filesize;
-			$statResult[7] = $filesize;
-		}
-		return $statResult;
-	}
-
-	public function filetype($path) {
-		$filetype = filetype($this->getSourcePath($path));
-		if ($filetype == 'link') {
-			$filetype = filetype(realpath($this->getSourcePath($path)));
-		}
-		return $filetype;
-	}
-
-	public function filesize($path) {
-		if ($this->is_dir($path)) {
-			return 0;
-		}
-		$fullPath = $this->getSourcePath($path);
-		if (PHP_INT_SIZE === 4) {
-			$helper = new \OC\LargeFileHelper;
-			return $helper->getFileSize($fullPath);
-		}
-		return filesize($fullPath);
-	}
-
-	public function isReadable($path) {
-		return is_readable($this->getSourcePath($path));
-	}
-
-	public function isUpdatable($path) {
-		return is_writable($this->getSourcePath($path));
-	}
-
-	public function file_exists($path) {
-		return file_exists($this->getSourcePath($path));
-	}
-
-	public function filemtime($path) {
-		$fullPath = $this->getSourcePath($path);
-		clearstatcache(true, $fullPath);
-		if (!$this->file_exists($path)) {
-			return false;
-		}
-		if (PHP_INT_SIZE === 4) {
-			$helper = new \OC\LargeFileHelper();
-			return $helper->getFileMtime($fullPath);
-		}
-		return filemtime($fullPath);
-	}
-
-	public function touch($path, $mtime = null) {
-		// sets the modification time of the file to the given value.
-		// If mtime is nil the current time is set.
-		// note that the access time of the file always changes to the current time.
-		if ($this->file_exists($path) and !$this->isUpdatable($path)) {
-			return false;
-		}
-		if (!is_null($mtime)) {
-			$result = @touch($this->getSourcePath($path), $mtime);
-		} else {
-			$result = @touch($this->getSourcePath($path));
-		}
-		if ($result) {
-			clearstatcache(true, $this->getSourcePath($path));
-		}
-
-		return $result;
-	}
-
-	public function file_get_contents($path) {
-		return file_get_contents($this->getSourcePath($path));
-	}
-
-	public function file_put_contents($path, $data) {
-		return file_put_contents($this->getSourcePath($path), $data);
-	}
-
-	public function unlink($path) {
-		if ($this->is_dir($path)) {
-			return $this->rmdir($path);
-		} else if ($this->is_file($path)) {
-			return unlink($this->getSourcePath($path));
-		} else {
-			return false;
-		}
-
-	}
-
-	private function treeContainsBlacklistedFile(string $path): bool {
-		$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path));
-		foreach ($iterator as $file) {
-			/** @var \SplFileInfo $file */
-			if (Filesystem::isFileBlacklisted($file->getBasename())) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	public function rename($path1, $path2) {
-		$srcParent = dirname($path1);
-		$dstParent = dirname($path2);
-
-		if (!$this->isUpdatable($srcParent)) {
-			\OCP\Util::writeLog('core', 'unable to rename, source directory is not writable : ' . $srcParent, ILogger::ERROR);
-			return false;
-		}
-
-		if (!$this->isUpdatable($dstParent)) {
-			\OCP\Util::writeLog('core', 'unable to rename, destination directory is not writable : ' . $dstParent, ILogger::ERROR);
-			return false;
-		}
-
-		if (!$this->file_exists($path1)) {
-			\OCP\Util::writeLog('core', 'unable to rename, file does not exists : ' . $path1, ILogger::ERROR);
-			return false;
-		}
-
-		if ($this->is_dir($path2)) {
-			$this->rmdir($path2);
-		} else if ($this->is_file($path2)) {
-			$this->unlink($path2);
-		}
-
-		if ($this->is_dir($path1)) {
-			// we can't move folders across devices, use copy instead
-			$stat1 = stat(dirname($this->getSourcePath($path1)));
-			$stat2 = stat(dirname($this->getSourcePath($path2)));
-			if ($stat1['dev'] !== $stat2['dev']) {
-				$result = $this->copy($path1, $path2);
-				if ($result) {
-					$result &= $this->rmdir($path1);
-				}
-				return $result;
-			}
-
-			if ($this->treeContainsBlacklistedFile($this->getSourcePath($path1))) {
-				throw new ForbiddenException('Invalid path', false);
-			}
-		}
-
-		return rename($this->getSourcePath($path1), $this->getSourcePath($path2));
-	}
-
-	public function copy($path1, $path2) {
-		if ($this->is_dir($path1)) {
-			return parent::copy($path1, $path2);
-		} else {
-			return copy($this->getSourcePath($path1), $this->getSourcePath($path2));
-		}
-	}
-
-	public function fopen($path, $mode) {
-		return fopen($this->getSourcePath($path), $mode);
-	}
-
-	public function hash($type, $path, $raw = false) {
-		return hash_file($type, $this->getSourcePath($path), $raw);
-	}
-
-	public function free_space($path) {
-		$sourcePath = $this->getSourcePath($path);
-		// using !is_dir because $sourcePath might be a part file or
-		// non-existing file, so we'd still want to use the parent dir
-		// in such cases
-		if (!is_dir($sourcePath)) {
-			// disk_free_space doesn't work on files
-			$sourcePath = dirname($sourcePath);
-		}
-		$space = @disk_free_space($sourcePath);
-		if ($space === false || is_null($space)) {
-			return \OCP\Files\FileInfo::SPACE_UNKNOWN;
-		}
-		return $space;
-	}
-
-	public function search($query) {
-		return $this->searchInDir($query);
-	}
-
-	public function getLocalFile($path) {
-		return $this->getSourcePath($path);
-	}
-
-	public function getLocalFolder($path) {
-		return $this->getSourcePath($path);
-	}
-
-	/**
-	 * @param string $query
-	 * @param string $dir
-	 * @return array
-	 */
-	protected function searchInDir($query, $dir = '') {
-		$files = [];
-		$physicalDir = $this->getSourcePath($dir);
-		foreach (scandir($physicalDir) as $item) {
-			if (\OC\Files\Filesystem::isIgnoredDir($item))
-				continue;
-			$physicalItem = $physicalDir . '/' . $item;
-
-			if (strstr(strtolower($item), strtolower($query)) !== false) {
-				$files[] = $dir . '/' . $item;
-			}
-			if (is_dir($physicalItem)) {
-				$files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
-			}
-		}
-		return $files;
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		if ($this->file_exists($path)) {
-			return $this->filemtime($path) > $time;
-		} else {
-			return true;
-		}
-	}
-
-	/**
-	 * Get the source path (on disk) of a given path
-	 *
-	 * @param string $path
-	 * @return string
-	 * @throws ForbiddenException
-	 */
-	public function getSourcePath($path) {
-		if (Filesystem::isFileBlacklisted($path)) {
-			throw new ForbiddenException('Invalid path', false);
-		}
-
-		$fullPath = $this->datadir . $path;
-		$currentPath = $path;
-		if ($this->allowSymlinks || $currentPath === '') {
-			return $fullPath;
-		}
-		$pathToResolve = $fullPath;
-		$realPath = realpath($pathToResolve);
-		while ($realPath === false) { // for non existing files check the parent directory
-			$currentPath = dirname($currentPath);
-			if ($currentPath === '' || $currentPath === '.') {
-				return $fullPath;
-			}
-			$realPath = realpath($this->datadir . $currentPath);
-		}
-		if ($realPath) {
-			$realPath = $realPath . '/';
-		}
-		if (substr($realPath, 0, $this->dataDirLength) === $this->realDataDir) {
-			return $fullPath;
-		}
-
-		\OCP\Util::writeLog('core', "Following symlinks is not allowed ('$fullPath' -> '$realPath' not inside '{$this->realDataDir}')", ILogger::ERROR);
-		throw new ForbiddenException('Following symlinks is not allowed', false);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function isLocal() {
-		return true;
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		if ($this->is_file($path)) {
-			$stat = $this->stat($path);
-
-			if ($stat === false) {
-				return md5('');
-			}
-
-			$toHash = '';
-			if (isset($stat['mtime'])) {
-				$toHash .= $stat['mtime'];
-			}
-			if (isset($stat['ino'])) {
-				$toHash .= $stat['ino'];
-			}
-			if (isset($stat['dev'])) {
-				$toHash .= $stat['dev'];
-			}
-			if (isset($stat['size'])) {
-				$toHash .= $stat['size'];
-			}
-
-			return md5($toHash);
-		} else {
-			return parent::getETag($path);
-		}
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) {
-		if ($sourceStorage->instanceOfStorage(Local::class)) {
-			if ($sourceStorage->instanceOfStorage(Jail::class)) {
-				/**
-				 * @var \OC\Files\Storage\Wrapper\Jail $sourceStorage
-				 */
-				$sourceInternalPath = $sourceStorage->getUnjailedPath($sourceInternalPath);
-			}
-			/**
-			 * @var \OC\Files\Storage\Local $sourceStorage
-			 */
-			$rootStorage = new Local(['datadir' => '/']);
-			return $rootStorage->copy($sourceStorage->getSourcePath($sourceInternalPath), $this->getSourcePath($targetInternalPath));
-		} else {
-			return parent::copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		}
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage->instanceOfStorage(Local::class)) {
-			if ($sourceStorage->instanceOfStorage(Jail::class)) {
-				/**
-				 * @var \OC\Files\Storage\Wrapper\Jail $sourceStorage
-				 */
-				$sourceInternalPath = $sourceStorage->getUnjailedPath($sourceInternalPath);
-			}
-			/**
-			 * @var \OC\Files\Storage\Local $sourceStorage
-			 */
-			$rootStorage = new Local(['datadir' => '/']);
-			return $rootStorage->rename($sourceStorage->getSourcePath($sourceInternalPath), $this->getSourcePath($targetInternalPath));
-		} else {
-			return parent::moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		}
-	}
-
-	public function writeStream(string $path, $stream, int $size = null): int {
-		return (int)file_put_contents($this->getSourcePath($path), $stream);
-	}
+    protected $datadir;
+
+    protected $dataDirLength;
+
+    protected $allowSymlinks = false;
+
+    protected $realDataDir;
+
+    public function __construct($arguments) {
+        if (!isset($arguments['datadir']) || !is_string($arguments['datadir'])) {
+            throw new \InvalidArgumentException('No data directory set for local storage');
+        }
+        $this->datadir = str_replace('//', '/', $arguments['datadir']);
+        // some crazy code uses a local storage on root...
+        if ($this->datadir === '/') {
+            $this->realDataDir = $this->datadir;
+        } else {
+            $realPath = realpath($this->datadir) ?: $this->datadir;
+            $this->realDataDir = rtrim($realPath, '/') . '/';
+        }
+        if (substr($this->datadir, -1) !== '/') {
+            $this->datadir .= '/';
+        }
+        $this->dataDirLength = strlen($this->realDataDir);
+    }
+
+    public function __destruct() {
+    }
+
+    public function getId() {
+        return 'local::' . $this->datadir;
+    }
+
+    public function mkdir($path) {
+        return @mkdir($this->getSourcePath($path), 0777, true);
+    }
+
+    public function rmdir($path) {
+        if (!$this->isDeletable($path)) {
+            return false;
+        }
+        try {
+            $it = new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator($this->getSourcePath($path)),
+                \RecursiveIteratorIterator::CHILD_FIRST
+            );
+            /**
+             * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach
+             * This bug is fixed in PHP 5.5.9 or before
+             * See #8376
+             */
+            $it->rewind();
+            while ($it->valid()) {
+                /**
+                 * @var \SplFileInfo $file
+                 */
+                $file = $it->current();
+                if (in_array($file->getBasename(), ['.', '..'])) {
+                    $it->next();
+                    continue;
+                } elseif ($file->isDir()) {
+                    rmdir($file->getPathname());
+                } elseif ($file->isFile() || $file->isLink()) {
+                    unlink($file->getPathname());
+                }
+                $it->next();
+            }
+            return rmdir($this->getSourcePath($path));
+        } catch (\UnexpectedValueException $e) {
+            return false;
+        }
+    }
+
+    public function opendir($path) {
+        return opendir($this->getSourcePath($path));
+    }
+
+    public function is_dir($path) {
+        if (substr($path, -1) == '/') {
+            $path = substr($path, 0, -1);
+        }
+        return is_dir($this->getSourcePath($path));
+    }
+
+    public function is_file($path) {
+        return is_file($this->getSourcePath($path));
+    }
+
+    public function stat($path) {
+        clearstatcache();
+        $fullPath = $this->getSourcePath($path);
+        $statResult = stat($fullPath);
+        if (PHP_INT_SIZE === 4 && !$this->is_dir($path)) {
+            $filesize = $this->filesize($path);
+            $statResult['size'] = $filesize;
+            $statResult[7] = $filesize;
+        }
+        return $statResult;
+    }
+
+    public function filetype($path) {
+        $filetype = filetype($this->getSourcePath($path));
+        if ($filetype == 'link') {
+            $filetype = filetype(realpath($this->getSourcePath($path)));
+        }
+        return $filetype;
+    }
+
+    public function filesize($path) {
+        if ($this->is_dir($path)) {
+            return 0;
+        }
+        $fullPath = $this->getSourcePath($path);
+        if (PHP_INT_SIZE === 4) {
+            $helper = new \OC\LargeFileHelper;
+            return $helper->getFileSize($fullPath);
+        }
+        return filesize($fullPath);
+    }
+
+    public function isReadable($path) {
+        return is_readable($this->getSourcePath($path));
+    }
+
+    public function isUpdatable($path) {
+        return is_writable($this->getSourcePath($path));
+    }
+
+    public function file_exists($path) {
+        return file_exists($this->getSourcePath($path));
+    }
+
+    public function filemtime($path) {
+        $fullPath = $this->getSourcePath($path);
+        clearstatcache(true, $fullPath);
+        if (!$this->file_exists($path)) {
+            return false;
+        }
+        if (PHP_INT_SIZE === 4) {
+            $helper = new \OC\LargeFileHelper();
+            return $helper->getFileMtime($fullPath);
+        }
+        return filemtime($fullPath);
+    }
+
+    public function touch($path, $mtime = null) {
+        // sets the modification time of the file to the given value.
+        // If mtime is nil the current time is set.
+        // note that the access time of the file always changes to the current time.
+        if ($this->file_exists($path) and !$this->isUpdatable($path)) {
+            return false;
+        }
+        if (!is_null($mtime)) {
+            $result = @touch($this->getSourcePath($path), $mtime);
+        } else {
+            $result = @touch($this->getSourcePath($path));
+        }
+        if ($result) {
+            clearstatcache(true, $this->getSourcePath($path));
+        }
+
+        return $result;
+    }
+
+    public function file_get_contents($path) {
+        return file_get_contents($this->getSourcePath($path));
+    }
+
+    public function file_put_contents($path, $data) {
+        return file_put_contents($this->getSourcePath($path), $data);
+    }
+
+    public function unlink($path) {
+        if ($this->is_dir($path)) {
+            return $this->rmdir($path);
+        } else if ($this->is_file($path)) {
+            return unlink($this->getSourcePath($path));
+        } else {
+            return false;
+        }
+
+    }
+
+    private function treeContainsBlacklistedFile(string $path): bool {
+        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path));
+        foreach ($iterator as $file) {
+            /** @var \SplFileInfo $file */
+            if (Filesystem::isFileBlacklisted($file->getBasename())) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function rename($path1, $path2) {
+        $srcParent = dirname($path1);
+        $dstParent = dirname($path2);
+
+        if (!$this->isUpdatable($srcParent)) {
+            \OCP\Util::writeLog('core', 'unable to rename, source directory is not writable : ' . $srcParent, ILogger::ERROR);
+            return false;
+        }
+
+        if (!$this->isUpdatable($dstParent)) {
+            \OCP\Util::writeLog('core', 'unable to rename, destination directory is not writable : ' . $dstParent, ILogger::ERROR);
+            return false;
+        }
+
+        if (!$this->file_exists($path1)) {
+            \OCP\Util::writeLog('core', 'unable to rename, file does not exists : ' . $path1, ILogger::ERROR);
+            return false;
+        }
+
+        if ($this->is_dir($path2)) {
+            $this->rmdir($path2);
+        } else if ($this->is_file($path2)) {
+            $this->unlink($path2);
+        }
+
+        if ($this->is_dir($path1)) {
+            // we can't move folders across devices, use copy instead
+            $stat1 = stat(dirname($this->getSourcePath($path1)));
+            $stat2 = stat(dirname($this->getSourcePath($path2)));
+            if ($stat1['dev'] !== $stat2['dev']) {
+                $result = $this->copy($path1, $path2);
+                if ($result) {
+                    $result &= $this->rmdir($path1);
+                }
+                return $result;
+            }
+
+            if ($this->treeContainsBlacklistedFile($this->getSourcePath($path1))) {
+                throw new ForbiddenException('Invalid path', false);
+            }
+        }
+
+        return rename($this->getSourcePath($path1), $this->getSourcePath($path2));
+    }
+
+    public function copy($path1, $path2) {
+        if ($this->is_dir($path1)) {
+            return parent::copy($path1, $path2);
+        } else {
+            return copy($this->getSourcePath($path1), $this->getSourcePath($path2));
+        }
+    }
+
+    public function fopen($path, $mode) {
+        return fopen($this->getSourcePath($path), $mode);
+    }
+
+    public function hash($type, $path, $raw = false) {
+        return hash_file($type, $this->getSourcePath($path), $raw);
+    }
+
+    public function free_space($path) {
+        $sourcePath = $this->getSourcePath($path);
+        // using !is_dir because $sourcePath might be a part file or
+        // non-existing file, so we'd still want to use the parent dir
+        // in such cases
+        if (!is_dir($sourcePath)) {
+            // disk_free_space doesn't work on files
+            $sourcePath = dirname($sourcePath);
+        }
+        $space = @disk_free_space($sourcePath);
+        if ($space === false || is_null($space)) {
+            return \OCP\Files\FileInfo::SPACE_UNKNOWN;
+        }
+        return $space;
+    }
+
+    public function search($query) {
+        return $this->searchInDir($query);
+    }
+
+    public function getLocalFile($path) {
+        return $this->getSourcePath($path);
+    }
+
+    public function getLocalFolder($path) {
+        return $this->getSourcePath($path);
+    }
+
+    /**
+     * @param string $query
+     * @param string $dir
+     * @return array
+     */
+    protected function searchInDir($query, $dir = '') {
+        $files = [];
+        $physicalDir = $this->getSourcePath($dir);
+        foreach (scandir($physicalDir) as $item) {
+            if (\OC\Files\Filesystem::isIgnoredDir($item))
+                continue;
+            $physicalItem = $physicalDir . '/' . $item;
+
+            if (strstr(strtolower($item), strtolower($query)) !== false) {
+                $files[] = $dir . '/' . $item;
+            }
+            if (is_dir($physicalItem)) {
+                $files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
+            }
+        }
+        return $files;
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        if ($this->file_exists($path)) {
+            return $this->filemtime($path) > $time;
+        } else {
+            return true;
+        }
+    }
+
+    /**
+     * Get the source path (on disk) of a given path
+     *
+     * @param string $path
+     * @return string
+     * @throws ForbiddenException
+     */
+    public function getSourcePath($path) {
+        if (Filesystem::isFileBlacklisted($path)) {
+            throw new ForbiddenException('Invalid path', false);
+        }
+
+        $fullPath = $this->datadir . $path;
+        $currentPath = $path;
+        if ($this->allowSymlinks || $currentPath === '') {
+            return $fullPath;
+        }
+        $pathToResolve = $fullPath;
+        $realPath = realpath($pathToResolve);
+        while ($realPath === false) { // for non existing files check the parent directory
+            $currentPath = dirname($currentPath);
+            if ($currentPath === '' || $currentPath === '.') {
+                return $fullPath;
+            }
+            $realPath = realpath($this->datadir . $currentPath);
+        }
+        if ($realPath) {
+            $realPath = $realPath . '/';
+        }
+        if (substr($realPath, 0, $this->dataDirLength) === $this->realDataDir) {
+            return $fullPath;
+        }
+
+        \OCP\Util::writeLog('core', "Following symlinks is not allowed ('$fullPath' -> '$realPath' not inside '{$this->realDataDir}')", ILogger::ERROR);
+        throw new ForbiddenException('Following symlinks is not allowed', false);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isLocal() {
+        return true;
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        if ($this->is_file($path)) {
+            $stat = $this->stat($path);
+
+            if ($stat === false) {
+                return md5('');
+            }
+
+            $toHash = '';
+            if (isset($stat['mtime'])) {
+                $toHash .= $stat['mtime'];
+            }
+            if (isset($stat['ino'])) {
+                $toHash .= $stat['ino'];
+            }
+            if (isset($stat['dev'])) {
+                $toHash .= $stat['dev'];
+            }
+            if (isset($stat['size'])) {
+                $toHash .= $stat['size'];
+            }
+
+            return md5($toHash);
+        } else {
+            return parent::getETag($path);
+        }
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) {
+        if ($sourceStorage->instanceOfStorage(Local::class)) {
+            if ($sourceStorage->instanceOfStorage(Jail::class)) {
+                /**
+                 * @var \OC\Files\Storage\Wrapper\Jail $sourceStorage
+                 */
+                $sourceInternalPath = $sourceStorage->getUnjailedPath($sourceInternalPath);
+            }
+            /**
+             * @var \OC\Files\Storage\Local $sourceStorage
+             */
+            $rootStorage = new Local(['datadir' => '/']);
+            return $rootStorage->copy($sourceStorage->getSourcePath($sourceInternalPath), $this->getSourcePath($targetInternalPath));
+        } else {
+            return parent::copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        }
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage->instanceOfStorage(Local::class)) {
+            if ($sourceStorage->instanceOfStorage(Jail::class)) {
+                /**
+                 * @var \OC\Files\Storage\Wrapper\Jail $sourceStorage
+                 */
+                $sourceInternalPath = $sourceStorage->getUnjailedPath($sourceInternalPath);
+            }
+            /**
+             * @var \OC\Files\Storage\Local $sourceStorage
+             */
+            $rootStorage = new Local(['datadir' => '/']);
+            return $rootStorage->rename($sourceStorage->getSourcePath($sourceInternalPath), $this->getSourcePath($targetInternalPath));
+        } else {
+            return parent::moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        }
+    }
+
+    public function writeStream(string $path, $stream, int $size = null): int {
+        return (int)file_put_contents($this->getSourcePath($path), $stream);
+    }
 }

lib/private/Files/Storage/Temporary.php

Indentation +13 added lines, -13 removed lines

@@ -29,20 +29,20 @@
  * local storage backend in temporary folder for testing purpose
  */
 class Temporary extends Local{
-	public function __construct($arguments = null) {
-		parent::__construct(['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]);
-	}
+    public function __construct($arguments = null) {
+        parent::__construct(['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]);
+    }
 
-	public function cleanUp() {
-		\OC_Helper::rmdirr($this->datadir);
-	}
+    public function cleanUp() {
+        \OC_Helper::rmdirr($this->datadir);
+    }
 
-	public function __destruct() {
-		parent::__destruct();
-		$this->cleanUp();
-	}
+    public function __destruct() {
+        parent::__destruct();
+        $this->cleanUp();
+    }
 
-	public function getDataDir() {
-		return $this->datadir;
-	}
+    public function getDataDir() {
+        return $this->datadir;
+    }
 }

lib/private/Files/Storage/Common.php

Indentation +782 added lines, -782 removed lines

@@ -76,790 +76,790 @@
  */
 abstract class Common implements Storage, ILockingStorage, IWriteStreamStorage {
 
-	use LocalTempFileTrait;
-
-	protected $cache;
-	protected $scanner;
-	protected $watcher;
-	protected $propagator;
-	protected $storageCache;
-	protected $updater;
-
-	protected $mountOptions = [];
-	protected $owner = null;
-
-	private $shouldLogLocks = null;
-	private $logger;
-
-	public function __construct($parameters) {
-	}
-
-	/**
-	 * Remove a file or folder
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	protected function remove($path) {
-		if ($this->is_dir($path)) {
-			return $this->rmdir($path);
-		} else if ($this->is_file($path)) {
-			return $this->unlink($path);
-		} else {
-			return false;
-		}
-	}
-
-	public function is_dir($path) {
-		return $this->filetype($path) === 'dir';
-	}
-
-	public function is_file($path) {
-		return $this->filetype($path) === 'file';
-	}
-
-	public function filesize($path) {
-		if ($this->is_dir($path)) {
-			return 0; //by definition
-		} else {
-			$stat = $this->stat($path);
-			if (isset($stat['size'])) {
-				return $stat['size'];
-			} else {
-				return 0;
-			}
-		}
-	}
-
-	public function isReadable($path) {
-		// at least check whether it exists
-		// subclasses might want to implement this more thoroughly
-		return $this->file_exists($path);
-	}
-
-	public function isUpdatable($path) {
-		// at least check whether it exists
-		// subclasses might want to implement this more thoroughly
-		// a non-existing file/folder isn't updatable
-		return $this->file_exists($path);
-	}
-
-	public function isCreatable($path) {
-		if ($this->is_dir($path) && $this->isUpdatable($path)) {
-			return true;
-		}
-		return false;
-	}
-
-	public function isDeletable($path) {
-		if ($path === '' || $path === '/') {
-			return false;
-		}
-		$parent = dirname($path);
-		return $this->isUpdatable($parent) && $this->isUpdatable($path);
-	}
-
-	public function isSharable($path) {
-		return $this->isReadable($path);
-	}
-
-	public function getPermissions($path) {
-		$permissions = 0;
-		if ($this->isCreatable($path)) {
-			$permissions |= \OCP\Constants::PERMISSION_CREATE;
-		}
-		if ($this->isReadable($path)) {
-			$permissions |= \OCP\Constants::PERMISSION_READ;
-		}
-		if ($this->isUpdatable($path)) {
-			$permissions |= \OCP\Constants::PERMISSION_UPDATE;
-		}
-		if ($this->isDeletable($path)) {
-			$permissions |= \OCP\Constants::PERMISSION_DELETE;
-		}
-		if ($this->isSharable($path)) {
-			$permissions |= \OCP\Constants::PERMISSION_SHARE;
-		}
-		return $permissions;
-	}
-
-	public function filemtime($path) {
-		$stat = $this->stat($path);
-		if (isset($stat['mtime']) && $stat['mtime'] > 0) {
-			return $stat['mtime'];
-		} else {
-			return 0;
-		}
-	}
-
-	public function file_get_contents($path) {
-		$handle = $this->fopen($path, "r");
-		if (!$handle) {
-			return false;
-		}
-		$data = stream_get_contents($handle);
-		fclose($handle);
-		return $data;
-	}
-
-	public function file_put_contents($path, $data) {
-		$handle = $this->fopen($path, "w");
-		$this->removeCachedFile($path);
-		$count = fwrite($handle, $data);
-		fclose($handle);
-		return $count;
-	}
-
-	public function rename($path1, $path2) {
-		$this->remove($path2);
-
-		$this->removeCachedFile($path1);
-		return $this->copy($path1, $path2) and $this->remove($path1);
-	}
-
-	public function copy($path1, $path2) {
-		if ($this->is_dir($path1)) {
-			$this->remove($path2);
-			$dir = $this->opendir($path1);
-			$this->mkdir($path2);
-			while ($file = readdir($dir)) {
-				if (!Filesystem::isIgnoredDir($file)) {
-					if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) {
-						return false;
-					}
-				}
-			}
-			closedir($dir);
-			return true;
-		} else {
-			$source = $this->fopen($path1, 'r');
-			$target = $this->fopen($path2, 'w');
-			list(, $result) = \OC_Helper::streamCopy($source, $target);
-			if (!$result) {
-				\OC::$server->getLogger()->warning("Failed to write data while copying $path1 to $path2");
-			}
-			$this->removeCachedFile($path2);
-			return $result;
-		}
-	}
-
-	public function getMimeType($path) {
-		if ($this->is_dir($path)) {
-			return 'httpd/unix-directory';
-		} elseif ($this->file_exists($path)) {
-			return \OC::$server->getMimeTypeDetector()->detectPath($path);
-		} else {
-			return false;
-		}
-	}
-
-	public function hash($type, $path, $raw = false) {
-		$fh = $this->fopen($path, 'rb');
-		$ctx = hash_init($type);
-		hash_update_stream($ctx, $fh);
-		fclose($fh);
-		return hash_final($ctx, $raw);
-	}
-
-	public function search($query) {
-		return $this->searchInDir($query);
-	}
-
-	public function getLocalFile($path) {
-		return $this->getCachedFile($path);
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 */
-	private function addLocalFolder($path, $target) {
-		$dh = $this->opendir($path);
-		if (is_resource($dh)) {
-			while (($file = readdir($dh)) !== false) {
-				if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
-					if ($this->is_dir($path . '/' . $file)) {
-						mkdir($target . '/' . $file);
-						$this->addLocalFolder($path . '/' . $file, $target . '/' . $file);
-					} else {
-						$tmp = $this->toTmpFile($path . '/' . $file);
-						rename($tmp, $target . '/' . $file);
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * @param string $query
-	 * @param string $dir
-	 * @return array
-	 */
-	protected function searchInDir($query, $dir = '') {
-		$files = [];
-		$dh = $this->opendir($dir);
-		if (is_resource($dh)) {
-			while (($item = readdir($dh)) !== false) {
-				if (\OC\Files\Filesystem::isIgnoredDir($item)) continue;
-				if (strstr(strtolower($item), strtolower($query)) !== false) {
-					$files[] = $dir . '/' . $item;
-				}
-				if ($this->is_dir($dir . '/' . $item)) {
-					$files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
-				}
-			}
-		}
-		closedir($dh);
-		return $files;
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * The method is only used to check if the cache needs to be updated. Storage backends that don't support checking
-	 * the mtime should always return false here. As a result storage implementations that always return false expect
-	 * exclusive access to the backend and will not pick up files that have been added in a way that circumvents
-	 * ownClouds filesystem.
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		return $this->filemtime($path) > $time;
-	}
-
-	public function getCache($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($storage->cache)) {
-			$storage->cache = new Cache($storage);
-		}
-		return $storage->cache;
-	}
-
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($storage->scanner)) {
-			$storage->scanner = new Scanner($storage);
-		}
-		return $storage->scanner;
-	}
-
-	public function getWatcher($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($this->watcher)) {
-			$this->watcher = new Watcher($storage);
-			$globalPolicy = \OC::$server->getConfig()->getSystemValue('filesystem_check_changes', Watcher::CHECK_NEVER);
-			$this->watcher->setPolicy((int)$this->getMountOption('filesystem_check_changes', $globalPolicy));
-		}
-		return $this->watcher;
-	}
-
-	/**
-	 * get a propagator instance for the cache
-	 *
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Propagator
-	 */
-	public function getPropagator($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($storage->propagator)) {
-			$config = \OC::$server->getSystemConfig();
-			$storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_' . $config->getValue('instanceid')]);
-		}
-		return $storage->propagator;
-	}
-
-	public function getUpdater($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($storage->updater)) {
-			$storage->updater = new Updater($storage);
-		}
-		return $storage->updater;
-	}
-
-	public function getStorageCache($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($this->storageCache)) {
-			$this->storageCache = new \OC\Files\Cache\Storage($storage);
-		}
-		return $this->storageCache;
-	}
-
-	/**
-	 * get the owner of a path
-	 *
-	 * @param string $path The path to get the owner
-	 * @return string|false uid or false
-	 */
-	public function getOwner($path) {
-		if ($this->owner === null) {
-			$this->owner = \OC_User::getUser();
-		}
-
-		return $this->owner;
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		return uniqid();
-	}
-
-	/**
-	 * clean a path, i.e. remove all redundant '.' and '..'
-	 * making sure that it can't point to higher than '/'
-	 *
-	 * @param string $path The path to clean
-	 * @return string cleaned path
-	 */
-	public function cleanPath($path) {
-		if (strlen($path) == 0 or $path[0] != '/') {
-			$path = '/' . $path;
-		}
-
-		$output = [];
-		foreach (explode('/', $path) as $chunk) {
-			if ($chunk == '..') {
-				array_pop($output);
-			} else if ($chunk == '.') {
-			} else {
-				$output[] = $chunk;
-			}
-		}
-		return implode('/', $output);
-	}
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @return bool
-	 */
-	public function test() {
-		try {
-			if ($this->stat('')) {
-				return true;
-			}
-			\OC::$server->getLogger()->info("External storage not available: stat() failed");
-			return false;
-		} catch (\Exception $e) {
-			\OC::$server->getLogger()->info("External storage not available: " . $e->getMessage());
-			\OC::$server->getLogger()->logException($e, ['level' => ILogger::DEBUG]);
-			return false;
-		}
-	}
-
-	/**
-	 * get the free space in the storage
-	 *
-	 * @param string $path
-	 * @return int|false
-	 */
-	public function free_space($path) {
-		return \OCP\Files\FileInfo::SPACE_UNKNOWN;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function isLocal() {
-		// the common implementation returns a temporary file by
-		// default, which is not local
-		return false;
-	}
-
-	/**
-	 * 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
-	 */
-	public function instanceOfStorage($class) {
-		if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
-			// FIXME Temporary fix to keep existing checks working
-			$class = '\OCA\Files_Sharing\SharedStorage';
-		}
-		return is_a($this, $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
-	 */
-	public function getDirectDownload($path) {
-		return [];
-	}
-
-	/**
-	 * @inheritdoc
-	 * @throws InvalidPathException
-	 */
-	public function verifyPath($path, $fileName) {
-
-		// verify empty and dot files
-		$trimmed = trim($fileName);
-		if ($trimmed === '') {
-			throw new EmptyFileNameException();
-		}
-
-		if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) {
-			throw new InvalidDirectoryException();
-		}
-
-		if (!\OC::$server->getDatabaseConnection()->supports4ByteText()) {
-			// verify database - e.g. mysql only 3-byte chars
-			if (preg_match('%(?:
+    use LocalTempFileTrait;
+
+    protected $cache;
+    protected $scanner;
+    protected $watcher;
+    protected $propagator;
+    protected $storageCache;
+    protected $updater;
+
+    protected $mountOptions = [];
+    protected $owner = null;
+
+    private $shouldLogLocks = null;
+    private $logger;
+
+    public function __construct($parameters) {
+    }
+
+    /**
+     * Remove a file or folder
+     *
+     * @param string $path
+     * @return bool
+     */
+    protected function remove($path) {
+        if ($this->is_dir($path)) {
+            return $this->rmdir($path);
+        } else if ($this->is_file($path)) {
+            return $this->unlink($path);
+        } else {
+            return false;
+        }
+    }
+
+    public function is_dir($path) {
+        return $this->filetype($path) === 'dir';
+    }
+
+    public function is_file($path) {
+        return $this->filetype($path) === 'file';
+    }
+
+    public function filesize($path) {
+        if ($this->is_dir($path)) {
+            return 0; //by definition
+        } else {
+            $stat = $this->stat($path);
+            if (isset($stat['size'])) {
+                return $stat['size'];
+            } else {
+                return 0;
+            }
+        }
+    }
+
+    public function isReadable($path) {
+        // at least check whether it exists
+        // subclasses might want to implement this more thoroughly
+        return $this->file_exists($path);
+    }
+
+    public function isUpdatable($path) {
+        // at least check whether it exists
+        // subclasses might want to implement this more thoroughly
+        // a non-existing file/folder isn't updatable
+        return $this->file_exists($path);
+    }
+
+    public function isCreatable($path) {
+        if ($this->is_dir($path) && $this->isUpdatable($path)) {
+            return true;
+        }
+        return false;
+    }
+
+    public function isDeletable($path) {
+        if ($path === '' || $path === '/') {
+            return false;
+        }
+        $parent = dirname($path);
+        return $this->isUpdatable($parent) && $this->isUpdatable($path);
+    }
+
+    public function isSharable($path) {
+        return $this->isReadable($path);
+    }
+
+    public function getPermissions($path) {
+        $permissions = 0;
+        if ($this->isCreatable($path)) {
+            $permissions |= \OCP\Constants::PERMISSION_CREATE;
+        }
+        if ($this->isReadable($path)) {
+            $permissions |= \OCP\Constants::PERMISSION_READ;
+        }
+        if ($this->isUpdatable($path)) {
+            $permissions |= \OCP\Constants::PERMISSION_UPDATE;
+        }
+        if ($this->isDeletable($path)) {
+            $permissions |= \OCP\Constants::PERMISSION_DELETE;
+        }
+        if ($this->isSharable($path)) {
+            $permissions |= \OCP\Constants::PERMISSION_SHARE;
+        }
+        return $permissions;
+    }
+
+    public function filemtime($path) {
+        $stat = $this->stat($path);
+        if (isset($stat['mtime']) && $stat['mtime'] > 0) {
+            return $stat['mtime'];
+        } else {
+            return 0;
+        }
+    }
+
+    public function file_get_contents($path) {
+        $handle = $this->fopen($path, "r");
+        if (!$handle) {
+            return false;
+        }
+        $data = stream_get_contents($handle);
+        fclose($handle);
+        return $data;
+    }
+
+    public function file_put_contents($path, $data) {
+        $handle = $this->fopen($path, "w");
+        $this->removeCachedFile($path);
+        $count = fwrite($handle, $data);
+        fclose($handle);
+        return $count;
+    }
+
+    public function rename($path1, $path2) {
+        $this->remove($path2);
+
+        $this->removeCachedFile($path1);
+        return $this->copy($path1, $path2) and $this->remove($path1);
+    }
+
+    public function copy($path1, $path2) {
+        if ($this->is_dir($path1)) {
+            $this->remove($path2);
+            $dir = $this->opendir($path1);
+            $this->mkdir($path2);
+            while ($file = readdir($dir)) {
+                if (!Filesystem::isIgnoredDir($file)) {
+                    if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) {
+                        return false;
+                    }
+                }
+            }
+            closedir($dir);
+            return true;
+        } else {
+            $source = $this->fopen($path1, 'r');
+            $target = $this->fopen($path2, 'w');
+            list(, $result) = \OC_Helper::streamCopy($source, $target);
+            if (!$result) {
+                \OC::$server->getLogger()->warning("Failed to write data while copying $path1 to $path2");
+            }
+            $this->removeCachedFile($path2);
+            return $result;
+        }
+    }
+
+    public function getMimeType($path) {
+        if ($this->is_dir($path)) {
+            return 'httpd/unix-directory';
+        } elseif ($this->file_exists($path)) {
+            return \OC::$server->getMimeTypeDetector()->detectPath($path);
+        } else {
+            return false;
+        }
+    }
+
+    public function hash($type, $path, $raw = false) {
+        $fh = $this->fopen($path, 'rb');
+        $ctx = hash_init($type);
+        hash_update_stream($ctx, $fh);
+        fclose($fh);
+        return hash_final($ctx, $raw);
+    }
+
+    public function search($query) {
+        return $this->searchInDir($query);
+    }
+
+    public function getLocalFile($path) {
+        return $this->getCachedFile($path);
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     */
+    private function addLocalFolder($path, $target) {
+        $dh = $this->opendir($path);
+        if (is_resource($dh)) {
+            while (($file = readdir($dh)) !== false) {
+                if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
+                    if ($this->is_dir($path . '/' . $file)) {
+                        mkdir($target . '/' . $file);
+                        $this->addLocalFolder($path . '/' . $file, $target . '/' . $file);
+                    } else {
+                        $tmp = $this->toTmpFile($path . '/' . $file);
+                        rename($tmp, $target . '/' . $file);
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * @param string $query
+     * @param string $dir
+     * @return array
+     */
+    protected function searchInDir($query, $dir = '') {
+        $files = [];
+        $dh = $this->opendir($dir);
+        if (is_resource($dh)) {
+            while (($item = readdir($dh)) !== false) {
+                if (\OC\Files\Filesystem::isIgnoredDir($item)) continue;
+                if (strstr(strtolower($item), strtolower($query)) !== false) {
+                    $files[] = $dir . '/' . $item;
+                }
+                if ($this->is_dir($dir . '/' . $item)) {
+                    $files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
+                }
+            }
+        }
+        closedir($dh);
+        return $files;
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * The method is only used to check if the cache needs to be updated. Storage backends that don't support checking
+     * the mtime should always return false here. As a result storage implementations that always return false expect
+     * exclusive access to the backend and will not pick up files that have been added in a way that circumvents
+     * ownClouds filesystem.
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        return $this->filemtime($path) > $time;
+    }
+
+    public function getCache($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($storage->cache)) {
+            $storage->cache = new Cache($storage);
+        }
+        return $storage->cache;
+    }
+
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($storage->scanner)) {
+            $storage->scanner = new Scanner($storage);
+        }
+        return $storage->scanner;
+    }
+
+    public function getWatcher($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($this->watcher)) {
+            $this->watcher = new Watcher($storage);
+            $globalPolicy = \OC::$server->getConfig()->getSystemValue('filesystem_check_changes', Watcher::CHECK_NEVER);
+            $this->watcher->setPolicy((int)$this->getMountOption('filesystem_check_changes', $globalPolicy));
+        }
+        return $this->watcher;
+    }
+
+    /**
+     * get a propagator instance for the cache
+     *
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Propagator
+     */
+    public function getPropagator($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($storage->propagator)) {
+            $config = \OC::$server->getSystemConfig();
+            $storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_' . $config->getValue('instanceid')]);
+        }
+        return $storage->propagator;
+    }
+
+    public function getUpdater($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($storage->updater)) {
+            $storage->updater = new Updater($storage);
+        }
+        return $storage->updater;
+    }
+
+    public function getStorageCache($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($this->storageCache)) {
+            $this->storageCache = new \OC\Files\Cache\Storage($storage);
+        }
+        return $this->storageCache;
+    }
+
+    /**
+     * get the owner of a path
+     *
+     * @param string $path The path to get the owner
+     * @return string|false uid or false
+     */
+    public function getOwner($path) {
+        if ($this->owner === null) {
+            $this->owner = \OC_User::getUser();
+        }
+
+        return $this->owner;
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        return uniqid();
+    }
+
+    /**
+     * clean a path, i.e. remove all redundant '.' and '..'
+     * making sure that it can't point to higher than '/'
+     *
+     * @param string $path The path to clean
+     * @return string cleaned path
+     */
+    public function cleanPath($path) {
+        if (strlen($path) == 0 or $path[0] != '/') {
+            $path = '/' . $path;
+        }
+
+        $output = [];
+        foreach (explode('/', $path) as $chunk) {
+            if ($chunk == '..') {
+                array_pop($output);
+            } else if ($chunk == '.') {
+            } else {
+                $output[] = $chunk;
+            }
+        }
+        return implode('/', $output);
+    }
+
+    /**
+     * Test a storage for availability
+     *
+     * @return bool
+     */
+    public function test() {
+        try {
+            if ($this->stat('')) {
+                return true;
+            }
+            \OC::$server->getLogger()->info("External storage not available: stat() failed");
+            return false;
+        } catch (\Exception $e) {
+            \OC::$server->getLogger()->info("External storage not available: " . $e->getMessage());
+            \OC::$server->getLogger()->logException($e, ['level' => ILogger::DEBUG]);
+            return false;
+        }
+    }
+
+    /**
+     * get the free space in the storage
+     *
+     * @param string $path
+     * @return int|false
+     */
+    public function free_space($path) {
+        return \OCP\Files\FileInfo::SPACE_UNKNOWN;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isLocal() {
+        // the common implementation returns a temporary file by
+        // default, which is not local
+        return false;
+    }
+
+    /**
+     * 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
+     */
+    public function instanceOfStorage($class) {
+        if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
+            // FIXME Temporary fix to keep existing checks working
+            $class = '\OCA\Files_Sharing\SharedStorage';
+        }
+        return is_a($this, $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
+     */
+    public function getDirectDownload($path) {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     * @throws InvalidPathException
+     */
+    public function verifyPath($path, $fileName) {
+
+        // verify empty and dot files
+        $trimmed = trim($fileName);
+        if ($trimmed === '') {
+            throw new EmptyFileNameException();
+        }
+
+        if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) {
+            throw new InvalidDirectoryException();
+        }
+
+        if (!\OC::$server->getDatabaseConnection()->supports4ByteText()) {
+            // verify database - e.g. mysql only 3-byte chars
+            if (preg_match('%(?:
       \xF0[\x90-\xBF][\x80-\xBF]{2}      # planes 1-3
     | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
     | \xF4[\x80-\x8F][\x80-\xBF]{2}      # plane 16
 )%xs', $fileName)) {
-				throw new InvalidCharacterInPathException();
-			}
-		}
-
-		// 255 characters is the limit on common file systems (ext/xfs)
-		// oc_filecache has a 250 char length limit for the filename
-		if (isset($fileName[250])) {
-			throw new FileNameTooLongException();
-		}
-
-		// NOTE: $path will remain unverified for now
-		$this->verifyPosixPath($fileName);
-	}
-
-	/**
-	 * @param string $fileName
-	 * @throws InvalidPathException
-	 */
-	protected function verifyPosixPath($fileName) {
-		$fileName = trim($fileName);
-		$this->scanForInvalidCharacters($fileName, "\\/");
-		$reservedNames = ['*'];
-		if (in_array($fileName, $reservedNames)) {
-			throw new ReservedWordException();
-		}
-	}
-
-	/**
-	 * @param string $fileName
-	 * @param string $invalidChars
-	 * @throws InvalidPathException
-	 */
-	private function scanForInvalidCharacters($fileName, $invalidChars) {
-		foreach (str_split($invalidChars) as $char) {
-			if (strpos($fileName, $char) !== false) {
-				throw new InvalidCharacterInPathException();
-			}
-		}
-
-		$sanitizedFileName = filter_var($fileName, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
-		if ($sanitizedFileName !== $fileName) {
-			throw new InvalidCharacterInPathException();
-		}
-	}
-
-	/**
-	 * @param array $options
-	 */
-	public function setMountOptions(array $options) {
-		$this->mountOptions = $options;
-	}
-
-	/**
-	 * @param string $name
-	 * @param mixed $default
-	 * @return mixed
-	 */
-	public function getMountOption($name, $default = null) {
-		return isset($this->mountOptions[$name]) ? $this->mountOptions[$name] : $default;
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) {
-		if ($sourceStorage === $this) {
-			return $this->copy($sourceInternalPath, $targetInternalPath);
-		}
-
-		if ($sourceStorage->is_dir($sourceInternalPath)) {
-			$dh = $sourceStorage->opendir($sourceInternalPath);
-			$result = $this->mkdir($targetInternalPath);
-			if (is_resource($dh)) {
-				while ($result and ($file = readdir($dh)) !== false) {
-					if (!Filesystem::isIgnoredDir($file)) {
-						$result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file);
-					}
-				}
-			}
-		} else {
-			$source = $sourceStorage->fopen($sourceInternalPath, 'r');
-			// TODO: call fopen in a way that we execute again all storage wrappers
-			// to avoid that we bypass storage wrappers which perform important actions
-			// for this operation. Same is true for all other operations which
-			// are not the same as the original one.Once this is fixed we also
-			// need to adjust the encryption wrapper.
-			$target = $this->fopen($targetInternalPath, 'w');
-			list(, $result) = \OC_Helper::streamCopy($source, $target);
-			if ($result and $preserveMtime) {
-				$this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath));
-			}
-			fclose($source);
-			fclose($target);
-
-			if (!$result) {
-				// delete partially written target file
-				$this->unlink($targetInternalPath);
-				// delete cache entry that was created by fopen
-				$this->getCache()->remove($targetInternalPath);
-			}
-		}
-		return (bool)$result;
-	}
-
-	/**
-	 * Check if a storage is the same as the current one, including wrapped storages
-	 *
-	 * @param IStorage $storage
-	 * @return bool
-	 */
-	private function isSameStorage(IStorage $storage): bool {
-		while ($storage->instanceOfStorage(Wrapper::class)) {
-			/**
-			 * @var Wrapper $sourceStorage
-			 */
-			$storage = $storage->getWrapperStorage();
-		}
-
-		return $storage === $this;
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($this->isSameStorage($sourceStorage)) {
-			// resolve any jailed paths
-			while ($sourceStorage->instanceOfStorage(Jail::class)) {
-				/**
-				 * @var Jail $sourceStorage
-				 */
-				$sourceInternalPath = $sourceStorage->getUnjailedPath($sourceInternalPath);
-				$sourceStorage = $sourceStorage->getUnjailedStorage();
-			}
-
-			return $this->rename($sourceInternalPath, $targetInternalPath);
-		}
-
-		if (!$sourceStorage->isDeletable($sourceInternalPath)) {
-			return false;
-		}
-
-		$result = $this->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, true);
-		if ($result) {
-			if ($sourceStorage->is_dir($sourceInternalPath)) {
-				$result &= $sourceStorage->rmdir($sourceInternalPath);
-			} else {
-				$result &= $sourceStorage->unlink($sourceInternalPath);
-			}
-		}
-		return $result;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getMetaData($path) {
-		$permissions = $this->getPermissions($path);
-		if (!$permissions & \OCP\Constants::PERMISSION_READ) {
-			//can't read, nothing we can do
-			return null;
-		}
-
-		$data = [];
-		$data['mimetype'] = $this->getMimeType($path);
-		$data['mtime'] = $this->filemtime($path);
-		if ($data['mtime'] === false) {
-			$data['mtime'] = time();
-		}
-		if ($data['mimetype'] == 'httpd/unix-directory') {
-			$data['size'] = -1; //unknown
-		} else {
-			$data['size'] = $this->filesize($path);
-		}
-		$data['etag'] = $this->getETag($path);
-		$data['storage_mtime'] = $data['mtime'];
-		$data['permissions'] = $permissions;
-
-		return $data;
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider) {
-		$logger = $this->getLockLogger();
-		if ($logger) {
-			$typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive';
-			$logger->info(
-				sprintf(
-					'acquire %s lock on "%s" on storage "%s"',
-					$typeString,
-					$path,
-					$this->getId()
-				),
-				[
-					'app' => 'locking',
-				]
-			);
-		}
-		try {
-			$provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
-		} catch (LockedException $e) {
-			if ($logger) {
-				$logger->logException($e, ['level' => ILogger::INFO]);
-			}
-			throw $e;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider) {
-		$logger = $this->getLockLogger();
-		if ($logger) {
-			$typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive';
-			$logger->info(
-				sprintf(
-					'release %s lock on "%s" on storage "%s"',
-					$typeString,
-					$path,
-					$this->getId()
-				),
-				[
-					'app' => 'locking',
-				]
-			);
-		}
-		try {
-			$provider->releaseLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
-		} catch (LockedException $e) {
-			if ($logger) {
-				$logger->logException($e, ['level' => ILogger::INFO]);
-			}
-			throw $e;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider) {
-		$logger = $this->getLockLogger();
-		if ($logger) {
-			$typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive';
-			$logger->info(
-				sprintf(
-					'change lock on "%s" to %s on storage "%s"',
-					$path,
-					$typeString,
-					$this->getId()
-				),
-				[
-					'app' => 'locking',
-				]
-			);
-		}
-		try {
-			$provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
-		} catch (LockedException $e) {
-			\OC::$server->getLogger()->logException($e, ['level' => ILogger::INFO]);
-			throw $e;
-		}
-	}
-
-	private function getLockLogger() {
-		if (is_null($this->shouldLogLocks)) {
-			$this->shouldLogLocks = \OC::$server->getConfig()->getSystemValue('filelocking.debug', false);
-			$this->logger = $this->shouldLogLocks ? \OC::$server->getLogger() : null;
-		}
-		return $this->logger;
-	}
-
-	/**
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability() {
-		return $this->getStorageCache()->getAvailability();
-	}
-
-	/**
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable) {
-		$this->getStorageCache()->setAvailability($isAvailable);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function needsPartFile() {
-		return true;
-	}
-
-	/**
-	 * fallback implementation
-	 *
-	 * @param string $path
-	 * @param resource $stream
-	 * @param int $size
-	 * @return int
-	 */
-	public function writeStream(string $path, $stream, int $size = null): int {
-		$target = $this->fopen($path, 'w');
-		if (!$target) {
-			return 0;
-		}
-		list($count, $result) = \OC_Helper::streamCopy($stream, $target);
-		fclose($stream);
-		fclose($target);
-		return $count;
-	}
+                throw new InvalidCharacterInPathException();
+            }
+        }
+
+        // 255 characters is the limit on common file systems (ext/xfs)
+        // oc_filecache has a 250 char length limit for the filename
+        if (isset($fileName[250])) {
+            throw new FileNameTooLongException();
+        }
+
+        // NOTE: $path will remain unverified for now
+        $this->verifyPosixPath($fileName);
+    }
+
+    /**
+     * @param string $fileName
+     * @throws InvalidPathException
+     */
+    protected function verifyPosixPath($fileName) {
+        $fileName = trim($fileName);
+        $this->scanForInvalidCharacters($fileName, "\\/");
+        $reservedNames = ['*'];
+        if (in_array($fileName, $reservedNames)) {
+            throw new ReservedWordException();
+        }
+    }
+
+    /**
+     * @param string $fileName
+     * @param string $invalidChars
+     * @throws InvalidPathException
+     */
+    private function scanForInvalidCharacters($fileName, $invalidChars) {
+        foreach (str_split($invalidChars) as $char) {
+            if (strpos($fileName, $char) !== false) {
+                throw new InvalidCharacterInPathException();
+            }
+        }
+
+        $sanitizedFileName = filter_var($fileName, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
+        if ($sanitizedFileName !== $fileName) {
+            throw new InvalidCharacterInPathException();
+        }
+    }
+
+    /**
+     * @param array $options
+     */
+    public function setMountOptions(array $options) {
+        $this->mountOptions = $options;
+    }
+
+    /**
+     * @param string $name
+     * @param mixed $default
+     * @return mixed
+     */
+    public function getMountOption($name, $default = null) {
+        return isset($this->mountOptions[$name]) ? $this->mountOptions[$name] : $default;
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) {
+        if ($sourceStorage === $this) {
+            return $this->copy($sourceInternalPath, $targetInternalPath);
+        }
+
+        if ($sourceStorage->is_dir($sourceInternalPath)) {
+            $dh = $sourceStorage->opendir($sourceInternalPath);
+            $result = $this->mkdir($targetInternalPath);
+            if (is_resource($dh)) {
+                while ($result and ($file = readdir($dh)) !== false) {
+                    if (!Filesystem::isIgnoredDir($file)) {
+                        $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file);
+                    }
+                }
+            }
+        } else {
+            $source = $sourceStorage->fopen($sourceInternalPath, 'r');
+            // TODO: call fopen in a way that we execute again all storage wrappers
+            // to avoid that we bypass storage wrappers which perform important actions
+            // for this operation. Same is true for all other operations which
+            // are not the same as the original one.Once this is fixed we also
+            // need to adjust the encryption wrapper.
+            $target = $this->fopen($targetInternalPath, 'w');
+            list(, $result) = \OC_Helper::streamCopy($source, $target);
+            if ($result and $preserveMtime) {
+                $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath));
+            }
+            fclose($source);
+            fclose($target);
+
+            if (!$result) {
+                // delete partially written target file
+                $this->unlink($targetInternalPath);
+                // delete cache entry that was created by fopen
+                $this->getCache()->remove($targetInternalPath);
+            }
+        }
+        return (bool)$result;
+    }
+
+    /**
+     * Check if a storage is the same as the current one, including wrapped storages
+     *
+     * @param IStorage $storage
+     * @return bool
+     */
+    private function isSameStorage(IStorage $storage): bool {
+        while ($storage->instanceOfStorage(Wrapper::class)) {
+            /**
+             * @var Wrapper $sourceStorage
+             */
+            $storage = $storage->getWrapperStorage();
+        }
+
+        return $storage === $this;
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($this->isSameStorage($sourceStorage)) {
+            // resolve any jailed paths
+            while ($sourceStorage->instanceOfStorage(Jail::class)) {
+                /**
+                 * @var Jail $sourceStorage
+                 */
+                $sourceInternalPath = $sourceStorage->getUnjailedPath($sourceInternalPath);
+                $sourceStorage = $sourceStorage->getUnjailedStorage();
+            }
+
+            return $this->rename($sourceInternalPath, $targetInternalPath);
+        }
+
+        if (!$sourceStorage->isDeletable($sourceInternalPath)) {
+            return false;
+        }
+
+        $result = $this->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, true);
+        if ($result) {
+            if ($sourceStorage->is_dir($sourceInternalPath)) {
+                $result &= $sourceStorage->rmdir($sourceInternalPath);
+            } else {
+                $result &= $sourceStorage->unlink($sourceInternalPath);
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getMetaData($path) {
+        $permissions = $this->getPermissions($path);
+        if (!$permissions & \OCP\Constants::PERMISSION_READ) {
+            //can't read, nothing we can do
+            return null;
+        }
+
+        $data = [];
+        $data['mimetype'] = $this->getMimeType($path);
+        $data['mtime'] = $this->filemtime($path);
+        if ($data['mtime'] === false) {
+            $data['mtime'] = time();
+        }
+        if ($data['mimetype'] == 'httpd/unix-directory') {
+            $data['size'] = -1; //unknown
+        } else {
+            $data['size'] = $this->filesize($path);
+        }
+        $data['etag'] = $this->getETag($path);
+        $data['storage_mtime'] = $data['mtime'];
+        $data['permissions'] = $permissions;
+
+        return $data;
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider) {
+        $logger = $this->getLockLogger();
+        if ($logger) {
+            $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive';
+            $logger->info(
+                sprintf(
+                    'acquire %s lock on "%s" on storage "%s"',
+                    $typeString,
+                    $path,
+                    $this->getId()
+                ),
+                [
+                    'app' => 'locking',
+                ]
+            );
+        }
+        try {
+            $provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
+        } catch (LockedException $e) {
+            if ($logger) {
+                $logger->logException($e, ['level' => ILogger::INFO]);
+            }
+            throw $e;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider) {
+        $logger = $this->getLockLogger();
+        if ($logger) {
+            $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive';
+            $logger->info(
+                sprintf(
+                    'release %s lock on "%s" on storage "%s"',
+                    $typeString,
+                    $path,
+                    $this->getId()
+                ),
+                [
+                    'app' => 'locking',
+                ]
+            );
+        }
+        try {
+            $provider->releaseLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
+        } catch (LockedException $e) {
+            if ($logger) {
+                $logger->logException($e, ['level' => ILogger::INFO]);
+            }
+            throw $e;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function changeLock($path, $type, ILockingProvider $provider) {
+        $logger = $this->getLockLogger();
+        if ($logger) {
+            $typeString = ($type === ILockingProvider::LOCK_SHARED) ? 'shared' : 'exclusive';
+            $logger->info(
+                sprintf(
+                    'change lock on "%s" to %s on storage "%s"',
+                    $path,
+                    $typeString,
+                    $this->getId()
+                ),
+                [
+                    'app' => 'locking',
+                ]
+            );
+        }
+        try {
+            $provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
+        } catch (LockedException $e) {
+            \OC::$server->getLogger()->logException($e, ['level' => ILogger::INFO]);
+            throw $e;
+        }
+    }
+
+    private function getLockLogger() {
+        if (is_null($this->shouldLogLocks)) {
+            $this->shouldLogLocks = \OC::$server->getConfig()->getSystemValue('filelocking.debug', false);
+            $this->logger = $this->shouldLogLocks ? \OC::$server->getLogger() : null;
+        }
+        return $this->logger;
+    }
+
+    /**
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability() {
+        return $this->getStorageCache()->getAvailability();
+    }
+
+    /**
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable) {
+        $this->getStorageCache()->setAvailability($isAvailable);
+    }
+
+    /**
+     * @return bool
+     */
+    public function needsPartFile() {
+        return true;
+    }
+
+    /**
+     * fallback implementation
+     *
+     * @param string $path
+     * @param resource $stream
+     * @param int $size
+     * @return int
+     */
+    public function writeStream(string $path, $stream, int $size = null): int {
+        $target = $this->fopen($path, 'w');
+        if (!$target) {
+            return 0;
+        }
+        list($count, $result) = \OC_Helper::streamCopy($stream, $target);
+        fclose($stream);
+        fclose($target);
+        return $count;
+    }
 }

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

Indentation +600 added lines, -600 removed lines

@@ -36,604 +36,604 @@
 use OCP\Lock\ILockingProvider;
 
 class Wrapper implements \OC\Files\Storage\Storage, ILockingStorage, IWriteStreamStorage {
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	protected $storage;
-
-	public $cache;
-	public $scanner;
-	public $watcher;
-	public $propagator;
-	public $updater;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		$this->storage = $parameters['storage'];
-	}
-
-	/**
-	 * @return \OC\Files\Storage\Storage
-	 */
-	public function getWrapperStorage() {
-		return $this->storage;
-	}
-
-	/**
-	 * 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
-	 */
-	public function getId() {
-		return $this->getWrapperStorage()->getId();
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.mkdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function mkdir($path) {
-		return $this->getWrapperStorage()->mkdir($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		return $this->getWrapperStorage()->rmdir($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource
-	 */
-	public function opendir($path) {
-		return $this->getWrapperStorage()->opendir($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.is_dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_dir($path) {
-		return $this->getWrapperStorage()->is_dir($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.is_file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_file($path) {
-		return $this->getWrapperStorage()->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
-	 */
-	public function stat($path) {
-		return $this->getWrapperStorage()->stat($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function filetype($path) {
-		return $this->getWrapperStorage()->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
-	 */
-	public function filesize($path) {
-		return $this->getWrapperStorage()->filesize($path);
-	}
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isCreatable($path) {
-		return $this->getWrapperStorage()->isCreatable($path);
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-		return $this->getWrapperStorage()->isReadable($path);
-	}
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isUpdatable($path) {
-		return $this->getWrapperStorage()->isUpdatable($path);
-	}
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isDeletable($path) {
-		return $this->getWrapperStorage()->isDeletable($path);
-	}
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isSharable($path) {
-		return $this->getWrapperStorage()->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
-	 */
-	public function getPermissions($path) {
-		return $this->getWrapperStorage()->getPermissions($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function file_exists($path) {
-		return $this->getWrapperStorage()->file_exists($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filemtime($path) {
-		return $this->getWrapperStorage()->filemtime($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->getWrapperStorage()->file_get_contents($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->getWrapperStorage()->file_put_contents($path, $data);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		return $this->getWrapperStorage()->unlink($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		return $this->getWrapperStorage()->rename($path1, $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->getWrapperStorage()->copy($path1, $path2);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		return $this->getWrapperStorage()->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
-	 */
-	public function getMimeType($path) {
-		return $this->getWrapperStorage()->getMimeType($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->getWrapperStorage()->hash($type, $path, $raw);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		return $this->getWrapperStorage()->free_space($path);
-	}
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array
-	 */
-	public function search($query) {
-		return $this->getWrapperStorage()->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->getWrapperStorage()->touch($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->getWrapperStorage()->getLocalFile($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->getWrapperStorage()->hasUpdated($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->getWrapperStorage()->getCache($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->getWrapperStorage()->getScanner($path, $storage);
-	}
-
-
-	/**
-	 * get the user id of the owner of a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getOwner($path) {
-		return $this->getWrapperStorage()->getOwner($path);
-	}
-
-	/**
-	 * get a watcher instance for the cache
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Watcher
-	 */
-	public function getWatcher($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getWatcher($path, $storage);
-	}
-
-	public function getPropagator($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getPropagator($storage);
-	}
-
-	public function getUpdater($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getUpdater($storage);
-	}
-
-	/**
-	 * @return \OC\Files\Cache\Storage
-	 */
-	public function getStorageCache() {
-		return $this->getWrapperStorage()->getStorageCache();
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		return $this->getWrapperStorage()->getETag($path);
-	}
-
-	/**
-	 * Returns true
-	 *
-	 * @return true
-	 */
-	public function test() {
-		return $this->getWrapperStorage()->test();
-	}
-
-	/**
-	 * Returns the wrapped storage's value for isLocal()
-	 *
-	 * @return bool wrapped storage's isLocal() value
-	 */
-	public function isLocal() {
-		return $this->getWrapperStorage()->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
-	 */
-	public function instanceOfStorage($class) {
-		if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
-			// FIXME Temporary fix to keep existing checks working
-			$class = '\OCA\Files_Sharing\SharedStorage';
-		}
-		return is_a($this, $class) or $this->getWrapperStorage()->instanceOfStorage($class);
-	}
-
-	/**
-	 * Pass any methods custom to specific storage implementations to the wrapped storage
-	 *
-	 * @param string $method
-	 * @param array $args
-	 * @return mixed
-	 */
-	public function __call($method, $args) {
-		return call_user_func_array([$this->getWrapperStorage(), $method], $args);
-	}
-
-	/**
-	 * 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
-	 */
-	public function getDirectDownload($path) {
-		return $this->getWrapperStorage()->getDirectDownload($path);
-	}
-
-	/**
-	 * Get availability of the storage
-	 *
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability() {
-		return $this->getWrapperStorage()->getAvailability();
-	}
-
-	/**
-	 * Set availability of the storage
-	 *
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable) {
-		$this->getWrapperStorage()->setAvailability($isAvailable);
-	}
-
-	/**
-	 * @param string $path the path of the target folder
-	 * @param string $fileName the name of the file itself
-	 * @return void
-	 * @throws InvalidPathException
-	 */
-	public function verifyPath($path, $fileName) {
-		$this->getWrapperStorage()->verifyPath($path, $fileName);
-	}
-
-	/**
-	 * @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, $targetInternalPath);
-		}
-
-		return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			return $this->rename($sourceInternalPath, $targetInternalPath);
-		}
-
-		return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		return $this->getWrapperStorage()->getMetaData($path);
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider) {
-		if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-			$this->getWrapperStorage()->acquireLock($path, $type, $provider);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider) {
-		if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-			$this->getWrapperStorage()->releaseLock($path, $type, $provider);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider) {
-		if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-			$this->getWrapperStorage()->changeLock($path, $type, $provider);
-		}
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function needsPartFile() {
-		return $this->getWrapperStorage()->needsPartFile();
-	}
-
-	public function writeStream(string $path, $stream, int $size = null): int {
-		$storage = $this->getWrapperStorage();
-		if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
-			/** @var IWriteStreamStorage $storage */
-			return $storage->writeStream($path, $stream, $size);
-		} else {
-			$target = $this->fopen($path, 'w');
-			list($count, $result) = \OC_Helper::streamCopy($stream, $target);
-			fclose($stream);
-			fclose($target);
-			return $count;
-		}
-	}
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    protected $storage;
+
+    public $cache;
+    public $scanner;
+    public $watcher;
+    public $propagator;
+    public $updater;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        $this->storage = $parameters['storage'];
+    }
+
+    /**
+     * @return \OC\Files\Storage\Storage
+     */
+    public function getWrapperStorage() {
+        return $this->storage;
+    }
+
+    /**
+     * 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
+     */
+    public function getId() {
+        return $this->getWrapperStorage()->getId();
+    }
+
+    /**
+     * see http://php.net/manual/en/function.mkdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function mkdir($path) {
+        return $this->getWrapperStorage()->mkdir($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        return $this->getWrapperStorage()->rmdir($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource
+     */
+    public function opendir($path) {
+        return $this->getWrapperStorage()->opendir($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.is_dir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_dir($path) {
+        return $this->getWrapperStorage()->is_dir($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.is_file.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_file($path) {
+        return $this->getWrapperStorage()->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
+     */
+    public function stat($path) {
+        return $this->getWrapperStorage()->stat($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function filetype($path) {
+        return $this->getWrapperStorage()->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
+     */
+    public function filesize($path) {
+        return $this->getWrapperStorage()->filesize($path);
+    }
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isCreatable($path) {
+        return $this->getWrapperStorage()->isCreatable($path);
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+        return $this->getWrapperStorage()->isReadable($path);
+    }
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isUpdatable($path) {
+        return $this->getWrapperStorage()->isUpdatable($path);
+    }
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isDeletable($path) {
+        return $this->getWrapperStorage()->isDeletable($path);
+    }
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isSharable($path) {
+        return $this->getWrapperStorage()->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
+     */
+    public function getPermissions($path) {
+        return $this->getWrapperStorage()->getPermissions($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function file_exists($path) {
+        return $this->getWrapperStorage()->file_exists($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filemtime($path) {
+        return $this->getWrapperStorage()->filemtime($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->getWrapperStorage()->file_get_contents($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->getWrapperStorage()->file_put_contents($path, $data);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        return $this->getWrapperStorage()->unlink($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        return $this->getWrapperStorage()->rename($path1, $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->getWrapperStorage()->copy($path1, $path2);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        return $this->getWrapperStorage()->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
+     */
+    public function getMimeType($path) {
+        return $this->getWrapperStorage()->getMimeType($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->getWrapperStorage()->hash($type, $path, $raw);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        return $this->getWrapperStorage()->free_space($path);
+    }
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array
+     */
+    public function search($query) {
+        return $this->getWrapperStorage()->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->getWrapperStorage()->touch($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->getWrapperStorage()->getLocalFile($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->getWrapperStorage()->hasUpdated($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->getWrapperStorage()->getCache($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->getWrapperStorage()->getScanner($path, $storage);
+    }
+
+
+    /**
+     * get the user id of the owner of a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getOwner($path) {
+        return $this->getWrapperStorage()->getOwner($path);
+    }
+
+    /**
+     * get a watcher instance for the cache
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Watcher
+     */
+    public function getWatcher($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getWatcher($path, $storage);
+    }
+
+    public function getPropagator($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getPropagator($storage);
+    }
+
+    public function getUpdater($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getUpdater($storage);
+    }
+
+    /**
+     * @return \OC\Files\Cache\Storage
+     */
+    public function getStorageCache() {
+        return $this->getWrapperStorage()->getStorageCache();
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        return $this->getWrapperStorage()->getETag($path);
+    }
+
+    /**
+     * Returns true
+     *
+     * @return true
+     */
+    public function test() {
+        return $this->getWrapperStorage()->test();
+    }
+
+    /**
+     * Returns the wrapped storage's value for isLocal()
+     *
+     * @return bool wrapped storage's isLocal() value
+     */
+    public function isLocal() {
+        return $this->getWrapperStorage()->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
+     */
+    public function instanceOfStorage($class) {
+        if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
+            // FIXME Temporary fix to keep existing checks working
+            $class = '\OCA\Files_Sharing\SharedStorage';
+        }
+        return is_a($this, $class) or $this->getWrapperStorage()->instanceOfStorage($class);
+    }
+
+    /**
+     * Pass any methods custom to specific storage implementations to the wrapped storage
+     *
+     * @param string $method
+     * @param array $args
+     * @return mixed
+     */
+    public function __call($method, $args) {
+        return call_user_func_array([$this->getWrapperStorage(), $method], $args);
+    }
+
+    /**
+     * 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
+     */
+    public function getDirectDownload($path) {
+        return $this->getWrapperStorage()->getDirectDownload($path);
+    }
+
+    /**
+     * Get availability of the storage
+     *
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability() {
+        return $this->getWrapperStorage()->getAvailability();
+    }
+
+    /**
+     * Set availability of the storage
+     *
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable) {
+        $this->getWrapperStorage()->setAvailability($isAvailable);
+    }
+
+    /**
+     * @param string $path the path of the target folder
+     * @param string $fileName the name of the file itself
+     * @return void
+     * @throws InvalidPathException
+     */
+    public function verifyPath($path, $fileName) {
+        $this->getWrapperStorage()->verifyPath($path, $fileName);
+    }
+
+    /**
+     * @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, $targetInternalPath);
+        }
+
+        return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            return $this->rename($sourceInternalPath, $targetInternalPath);
+        }
+
+        return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        return $this->getWrapperStorage()->getMetaData($path);
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider) {
+        if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+            $this->getWrapperStorage()->acquireLock($path, $type, $provider);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider) {
+        if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+            $this->getWrapperStorage()->releaseLock($path, $type, $provider);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function changeLock($path, $type, ILockingProvider $provider) {
+        if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+            $this->getWrapperStorage()->changeLock($path, $type, $provider);
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    public function needsPartFile() {
+        return $this->getWrapperStorage()->needsPartFile();
+    }
+
+    public function writeStream(string $path, $stream, int $size = null): int {
+        $storage = $this->getWrapperStorage();
+        if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
+            /** @var IWriteStreamStorage $storage */
+            return $storage->writeStream($path, $stream, $size);
+        } else {
+            $target = $this->fopen($path, 'w');
+            list($count, $result) = \OC_Helper::streamCopy($stream, $target);
+            fclose($stream);
+            fclose($target);
+            return $count;
+        }
+    }
 }

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

Indentation +988 added lines, -988 removed lines

@@ -51,993 +51,993 @@
 
 class Encryption extends Wrapper {
 
-	use LocalTempFileTrait;
-
-	/** @var string */
-	private $mountPoint;
-
-	/** @var \OC\Encryption\Util */
-	private $util;
-
-	/** @var \OCP\Encryption\IManager */
-	private $encryptionManager;
-
-	/** @var \OCP\ILogger */
-	private $logger;
-
-	/** @var string */
-	private $uid;
-
-	/** @var array */
-	protected $unencryptedSize;
-
-	/** @var \OCP\Encryption\IFile */
-	private $fileHelper;
-
-	/** @var IMountPoint */
-	private $mount;
-
-	/** @var IStorage */
-	private $keyStorage;
-
-	/** @var Update */
-	private $update;
-
-	/** @var Manager */
-	private $mountManager;
-
-	/** @var array remember for which path we execute the repair step to avoid recursions */
-	private $fixUnencryptedSizeOf = [];
-
-	/** @var  ArrayCache */
-	private $arrayCache;
-
-	/**
-	 * @param array $parameters
-	 * @param IManager $encryptionManager
-	 * @param Util $util
-	 * @param ILogger $logger
-	 * @param IFile $fileHelper
-	 * @param string $uid
-	 * @param IStorage $keyStorage
-	 * @param Update $update
-	 * @param Manager $mountManager
-	 * @param ArrayCache $arrayCache
-	 */
-	public function __construct(
-			$parameters,
-			IManager $encryptionManager = null,
-			Util $util = null,
-			ILogger $logger = null,
-			IFile $fileHelper = null,
-			$uid = null,
-			IStorage $keyStorage = null,
-			Update $update = null,
-			Manager $mountManager = null,
-			ArrayCache $arrayCache = null
-		) {
-
-		$this->mountPoint = $parameters['mountPoint'];
-		$this->mount = $parameters['mount'];
-		$this->encryptionManager = $encryptionManager;
-		$this->util = $util;
-		$this->logger = $logger;
-		$this->uid = $uid;
-		$this->fileHelper = $fileHelper;
-		$this->keyStorage = $keyStorage;
-		$this->unencryptedSize = [];
-		$this->update = $update;
-		$this->mountManager = $mountManager;
-		$this->arrayCache = $arrayCache;
-		parent::__construct($parameters);
-	}
-
-	/**
-	 * 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) {
-		$fullPath = $this->getFullPath($path);
-
-		/** @var CacheEntry $info */
-		$info = $this->getCache()->get($path);
-		if (isset($this->unencryptedSize[$fullPath])) {
-			$size = $this->unencryptedSize[$fullPath];
-			// update file cache
-			if ($info instanceof ICacheEntry) {
-				$info = $info->getData();
-				$info['encrypted'] = $info['encryptedVersion'];
-			} else {
-				if (!is_array($info)) {
-					$info = [];
-				}
-				$info['encrypted'] = true;
-			}
-
-			$info['size'] = $size;
-			$this->getCache()->put($path, $info);
-
-			return $size;
-		}
-
-		if (isset($info['fileid']) && $info['encrypted']) {
-			return $this->verifyUnencryptedSize($path, $info['size']);
-		}
-
-		return $this->storage->filesize($path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		$data = $this->storage->getMetaData($path);
-		if (is_null($data)) {
-			return null;
-		}
-		$fullPath = $this->getFullPath($path);
-		$info = $this->getCache()->get($path);
-
-		if (isset($this->unencryptedSize[$fullPath])) {
-			$data['encrypted'] = true;
-			$data['size'] = $this->unencryptedSize[$fullPath];
-		} else {
-			if (isset($info['fileid']) && $info['encrypted']) {
-				$data['size'] = $this->verifyUnencryptedSize($path, $info['size']);
-				$data['encrypted'] = true;
-			}
-		}
-
-		if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) {
-			$data['encryptedVersion'] = $info['encryptedVersion'];
-		}
-
-		return $data;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function file_get_contents($path) {
-
-		$encryptionModule = $this->getEncryptionModule($path);
-
-		if ($encryptionModule) {
-			$handle = $this->fopen($path, "r");
-			if (!$handle) {
-				return false;
-			}
-			$data = stream_get_contents($handle);
-			fclose($handle);
-			return $data;
-		}
-		return $this->storage->file_get_contents($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) {
-		// file put content will always be translated to a stream write
-		$handle = $this->fopen($path, 'w');
-		if (is_resource($handle)) {
-			$written = fwrite($handle, $data);
-			fclose($handle);
-			return $written;
-		}
-
-		return false;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		$fullPath = $this->getFullPath($path);
-		if ($this->util->isExcluded($fullPath)) {
-			return $this->storage->unlink($path);
-		}
-
-		$encryptionModule = $this->getEncryptionModule($path);
-		if ($encryptionModule) {
-			$this->keyStorage->deleteAllFileKeys($this->getFullPath($path));
-		}
-
-		return $this->storage->unlink($path);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-
-		$result = $this->storage->rename($path1, $path2);
-
-		if ($result &&
-			// versions always use the keys from the original file, so we can skip
-			// this step for versions
-			$this->isVersion($path2) === false &&
-			$this->encryptionManager->isEnabled()) {
-			$source = $this->getFullPath($path1);
-			if (!$this->util->isExcluded($source)) {
-				$target = $this->getFullPath($path2);
-				if (isset($this->unencryptedSize[$source])) {
-					$this->unencryptedSize[$target] = $this->unencryptedSize[$source];
-				}
-				$this->keyStorage->renameKeys($source, $target);
-				$module = $this->getEncryptionModule($path2);
-				if ($module) {
-					$module->update($target, $this->uid, []);
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		$result = $this->storage->rmdir($path);
-		$fullPath = $this->getFullPath($path);
-		if ($result &&
-			$this->util->isExcluded($fullPath) === false &&
-			$this->encryptionManager->isEnabled()
-		) {
-			$this->keyStorage->deleteAllFileKeys($fullPath);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-
-		$isReadable = true;
-
-		$metaData = $this->getMetaData($path);
-		if (
-			!$this->is_dir($path) &&
-			isset($metaData['encrypted']) &&
-			$metaData['encrypted'] === true
-		) {
-			$fullPath = $this->getFullPath($path);
-			$module = $this->getEncryptionModule($path);
-			$isReadable = $module->isReadable($fullPath, $this->uid);
-		}
-
-		return $this->storage->isReadable($path) && $isReadable;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function copy($path1, $path2) {
-
-		$source = $this->getFullPath($path1);
-
-		if ($this->util->isExcluded($source)) {
-			return $this->storage->copy($path1, $path2);
-		}
-
-		// need to stream copy file by file in case we copy between a encrypted
-		// and a unencrypted storage
-		$this->unlink($path2);
-		return $this->copyFromStorage($this, $path1, $path2);
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|bool
-	 * @throws GenericEncryptionException
-	 * @throws ModuleDoesNotExistsException
-	 */
-	public function fopen($path, $mode) {
-
-		// check if the file is stored in the array cache, this means that we
-		// copy a file over to the versions folder, in this case we don't want to
-		// decrypt it
-		if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) {
-			$this->arrayCache->remove('encryption_copy_version_' . $path);
-			return $this->storage->fopen($path, $mode);
-		}
-
-		$encryptionEnabled = $this->encryptionManager->isEnabled();
-		$shouldEncrypt = false;
-		$encryptionModule = null;
-		$header = $this->getHeader($path);
-		$signed = isset($header['signed']) && $header['signed'] === 'true';
-		$fullPath = $this->getFullPath($path);
-		$encryptionModuleId = $this->util->getEncryptionModuleId($header);
-
-		if ($this->util->isExcluded($fullPath) === false) {
-
-			$size = $unencryptedSize = 0;
-			$realFile = $this->util->stripPartialFileExtension($path);
-			$targetExists = $this->file_exists($realFile) || $this->file_exists($path);
-			$targetIsEncrypted = false;
-			if ($targetExists) {
-				// in case the file exists we require the explicit module as
-				// specified in the file header - otherwise we need to fail hard to
-				// prevent data loss on client side
-				if (!empty($encryptionModuleId)) {
-					$targetIsEncrypted = true;
-					$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-				}
-
-				if ($this->file_exists($path)) {
-					$size = $this->storage->filesize($path);
-					$unencryptedSize = $this->filesize($path);
-				} else {
-					$size = $unencryptedSize = 0;
-				}
-			}
-
-			try {
-
-				if (
-					$mode === 'w'
-					|| $mode === 'w+'
-					|| $mode === 'wb'
-					|| $mode === 'wb+'
-				) {
-					// if we update a encrypted file with a un-encrypted one we change the db flag
-					if ($targetIsEncrypted && $encryptionEnabled === false) {
-						$cache = $this->storage->getCache();
-						if ($cache) {
-							$entry = $cache->get($path);
-							$cache->update($entry->getId(), ['encrypted' => 0]);
-						}
-					}
-					if ($encryptionEnabled) {
-						// if $encryptionModuleId is empty, the default module will be used
-						$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-						$shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath);
-						$signed = true;
-					}
-				} else {
-					$info = $this->getCache()->get($path);
-					// only get encryption module if we found one in the header
-					// or if file should be encrypted according to the file cache
-					if (!empty($encryptionModuleId)) {
-						$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-						$shouldEncrypt = true;
-					} else if (empty($encryptionModuleId) && $info['encrypted'] === true) {
-						// we come from a old installation. No header and/or no module defined
-						// but the file is encrypted. In this case we need to use the
-						// OC_DEFAULT_MODULE to read the file
-						$encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE');
-						$shouldEncrypt = true;
-						$targetIsEncrypted = true;
-					}
-				}
-			} catch (ModuleDoesNotExistsException $e) {
-				$this->logger->logException($e, [
-					'message' => 'Encryption module "' . $encryptionModuleId . '" not found, file will be stored unencrypted',
-					'level' => ILogger::WARN,
-					'app' => 'core',
-				]);
-			}
-
-			// encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt
-			if (!$encryptionEnabled || !$this->shouldEncrypt($path)) {
-				if (!$targetExists || !$targetIsEncrypted) {
-					$shouldEncrypt = false;
-				}
-			}
-
-			if ($shouldEncrypt === true && $encryptionModule !== null) {
-				$headerSize = $this->getHeaderSize($path);
-				$source = $this->storage->fopen($path, $mode);
-				if (!is_resource($source)) {
-					return false;
-				}
-				$handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header,
-					$this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode,
-					$size, $unencryptedSize, $headerSize, $signed);
-				return $handle;
-			}
-
-		}
-
-		return $this->storage->fopen($path, $mode);
-	}
-
-
-	/**
-	 * perform some plausibility checks if the the unencrypted size is correct.
-	 * If not, we calculate the correct unencrypted size and return it
-	 *
-	 * @param string $path internal path relative to the storage root
-	 * @param int $unencryptedSize size of the unencrypted file
-	 *
-	 * @return int unencrypted size
-	 */
-	protected function verifyUnencryptedSize($path, $unencryptedSize) {
-
-		$size = $this->storage->filesize($path);
-		$result = $unencryptedSize;
-
-		if ($unencryptedSize < 0 ||
-			($size > 0 && $unencryptedSize === $size)
-		) {
-			// check if we already calculate the unencrypted size for the
-			// given path to avoid recursions
-			if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) {
-				$this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true;
-				try {
-					$result = $this->fixUnencryptedSize($path, $size, $unencryptedSize);
-				} catch (\Exception $e) {
-					$this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path);
-					$this->logger->logException($e);
-				}
-				unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]);
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * calculate the unencrypted size
-	 *
-	 * @param string $path internal path relative to the storage root
-	 * @param int $size size of the physical file
-	 * @param int $unencryptedSize size of the unencrypted file
-	 *
-	 * @return int calculated unencrypted size
-	 */
-	protected function fixUnencryptedSize($path, $size, $unencryptedSize) {
-
-		$headerSize = $this->getHeaderSize($path);
-		$header = $this->getHeader($path);
-		$encryptionModule = $this->getEncryptionModule($path);
-
-		$stream = $this->storage->fopen($path, 'r');
-
-		// if we couldn't open the file we return the old unencrypted size
-		if (!is_resource($stream)) {
-			$this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.');
-			return $unencryptedSize;
-		}
-
-		$newUnencryptedSize = 0;
-		$size -= $headerSize;
-		$blockSize = $this->util->getBlockSize();
-
-		// if a header exists we skip it
-		if ($headerSize > 0) {
-			fread($stream, $headerSize);
-		}
-
-		// fast path, else the calculation for $lastChunkNr is bogus
-		if ($size === 0) {
-			return 0;
-		}
-
-		$signed = isset($header['signed']) && $header['signed'] === 'true';
-		$unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed);
-
-		// calculate last chunk nr
-		// next highest is end of chunks, one subtracted is last one
-		// we have to read the last chunk, we can't just calculate it (because of padding etc)
-
-		$lastChunkNr = ceil($size/ $blockSize)-1;
-		// calculate last chunk position
-		$lastChunkPos = ($lastChunkNr * $blockSize);
-		// try to fseek to the last chunk, if it fails we have to read the whole file
-		if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) {
-			$newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize;
-		}
-
-		$lastChunkContentEncrypted='';
-		$count = $blockSize;
-
-		while ($count > 0) {
-			$data=fread($stream, $blockSize);
-			$count=strlen($data);
-			$lastChunkContentEncrypted .= $data;
-			if(strlen($lastChunkContentEncrypted) > $blockSize) {
-				$newUnencryptedSize += $unencryptedBlockSize;
-				$lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize);
-			}
-		}
-
-		fclose($stream);
-
-		// we have to decrypt the last chunk to get it actual size
-		$encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []);
-		$decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end');
-		$decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end');
-
-		// calc the real file size with the size of the last chunk
-		$newUnencryptedSize += strlen($decryptedLastChunk);
-
-		$this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize);
-
-		// write to cache if applicable
-		$cache = $this->storage->getCache();
-		if ($cache) {
-			$entry = $cache->get($path);
-			$cache->update($entry['fileid'], ['size' => $newUnencryptedSize]);
-		}
-
-		return $newUnencryptedSize;
-	}
-
-	/**
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @return bool
-	 */
-	public function moveFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) {
-		if ($sourceStorage === $this) {
-			return $this->rename($sourceInternalPath, $targetInternalPath);
-		}
-
-		// TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
-		// - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage
-		// - copy the file cache update from  $this->copyBetweenStorage to this method
-		// - copy the copyKeys() call from  $this->copyBetweenStorage to this method
-		// - remove $this->copyBetweenStorage
-
-		if (!$sourceStorage->isDeletable($sourceInternalPath)) {
-			return false;
-		}
-
-		$result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true);
-		if ($result) {
-			if ($sourceStorage->is_dir($sourceInternalPath)) {
-				$result &= $sourceStorage->rmdir($sourceInternalPath);
-			} else {
-				$result &= $sourceStorage->unlink($sourceInternalPath);
-			}
-		}
-		return $result;
-	}
-
-
-	/**
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @param bool $isRename
-	 * @return bool
-	 */
-	public function copyFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) {
-
-		// TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
-		// - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage
-		// - copy the file cache update from  $this->copyBetweenStorage to this method
-		// - copy the copyKeys() call from  $this->copyBetweenStorage to this method
-		// - remove $this->copyBetweenStorage
-
-		return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename);
-	}
-
-	/**
-	 * Update the encrypted cache version in the database
-	 *
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $isRename
-	 * @param bool $keepEncryptionVersion
-	 */
-	private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, $keepEncryptionVersion) {
-		$isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath);
-		$cacheInformation = [
-			'encrypted' => $isEncrypted,
-		];
-		if($isEncrypted) {
-			$encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion'];
-
-			// In case of a move operation from an unencrypted to an encrypted
-			// storage the old encrypted version would stay with "0" while the
-			// correct value would be "1". Thus we manually set the value to "1"
-			// for those cases.
-			// See also https://github.com/owncloud/core/issues/23078
-			if($encryptedVersion === 0 || !$keepEncryptionVersion) {
-				$encryptedVersion = 1;
-			}
-
-			$cacheInformation['encryptedVersion'] = $encryptedVersion;
-		}
-
-		// in case of a rename we need to manipulate the source cache because
-		// this information will be kept for the new target
-		if ($isRename) {
-			$sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation);
-		} else {
-			$this->getCache()->put($targetInternalPath, $cacheInformation);
-		}
-	}
-
-	/**
-	 * copy file between two storages
-	 *
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @param bool $isRename
-	 * @return bool
-	 * @throws \Exception
-	 */
-	private function copyBetweenStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) {
-
-		// for versions we have nothing to do, because versions should always use the
-		// key from the original file. Just create a 1:1 copy and done
-		if ($this->isVersion($targetInternalPath) ||
-			$this->isVersion($sourceInternalPath)) {
-			// remember that we try to create a version so that we can detect it during
-			// fopen($sourceInternalPath) and by-pass the encryption in order to
-			// create a 1:1 copy of the file
-			$this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true);
-			$result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-			$this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath);
-			if ($result) {
-				$info = $this->getCache('', $sourceStorage)->get($sourceInternalPath);
-				// make sure that we update the unencrypted size for the version
-				if (isset($info['encrypted']) && $info['encrypted'] === true) {
-					$this->updateUnencryptedSize(
-						$this->getFullPath($targetInternalPath),
-						$info['size']
-					);
-				}
-				$this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, true);
-			}
-			return $result;
-		}
-
-		// first copy the keys that we reuse the existing file key on the target location
-		// and don't create a new one which would break versions for example.
-		$mount = $this->mountManager->findByStorageId($sourceStorage->getId());
-		if (count($mount) === 1) {
-			$mountPoint = $mount[0]->getMountPoint();
-			$source = $mountPoint . '/' . $sourceInternalPath;
-			$target = $this->getFullPath($targetInternalPath);
-			$this->copyKeys($source, $target);
-		} else {
-			$this->logger->error('Could not find mount point, can\'t keep encryption keys');
-		}
-
-		if ($sourceStorage->is_dir($sourceInternalPath)) {
-			$dh = $sourceStorage->opendir($sourceInternalPath);
-			$result = $this->mkdir($targetInternalPath);
-			if (is_resource($dh)) {
-				while ($result and ($file = readdir($dh)) !== false) {
-					if (!Filesystem::isIgnoredDir($file)) {
-						$result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename);
-					}
-				}
-			}
-		} else {
-			try {
-				$source = $sourceStorage->fopen($sourceInternalPath, 'r');
-				$target = $this->fopen($targetInternalPath, 'w');
-				list(, $result) = \OC_Helper::streamCopy($source, $target);
-				fclose($source);
-				fclose($target);
-			} catch (\Exception $e) {
-				fclose($source);
-				fclose($target);
-				throw $e;
-			}
-			if($result) {
-				if ($preserveMtime) {
-					$this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath));
-				}
-				$this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, false);
-			} else {
-				// delete partially written target file
-				$this->unlink($targetInternalPath);
-				// delete cache entry that was created by fopen
-				$this->getCache()->remove($targetInternalPath);
-			}
-		}
-		return (bool)$result;
-
-	}
-
-	/**
-	 * 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) {
-		if ($this->encryptionManager->isEnabled()) {
-			$cachedFile = $this->getCachedFile($path);
-			if (is_string($cachedFile)) {
-				return $cachedFile;
-			}
-		}
-		return $this->storage->getLocalFile($path);
-	}
-
-	/**
-	 * Returns the wrapped storage's value for isLocal()
-	 *
-	 * @return bool wrapped storage's isLocal() value
-	 */
-	public function isLocal() {
-		if ($this->encryptionManager->isEnabled()) {
-			return false;
-		}
-		return $this->storage->isLocal();
-	}
-
-	/**
-	 * 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) {
-		$stat = $this->storage->stat($path);
-		$fileSize = $this->filesize($path);
-		$stat['size'] = $fileSize;
-		$stat[7] = $fileSize;
-		return $stat;
-	}
-
-	/**
-	 * 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) {
-		$fh = $this->fopen($path, 'rb');
-		$ctx = hash_init($type);
-		hash_update_stream($ctx, $fh);
-		fclose($fh);
-		return hash_final($ctx, $raw);
-	}
-
-	/**
-	 * return full path, including mount point
-	 *
-	 * @param string $path relative to mount point
-	 * @return string full path including mount point
-	 */
-	protected function getFullPath($path) {
-		return Filesystem::normalizePath($this->mountPoint . '/' . $path);
-	}
-
-	/**
-	 * read first block of encrypted file, typically this will contain the
-	 * encryption header
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function readFirstBlock($path) {
-		$firstBlock = '';
-		if ($this->storage->file_exists($path)) {
-			$handle = $this->storage->fopen($path, 'r');
-			$firstBlock = fread($handle, $this->util->getHeaderSize());
-			fclose($handle);
-		}
-		return $firstBlock;
-	}
-
-	/**
-	 * return header size of given file
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	protected function getHeaderSize($path) {
-		$headerSize = 0;
-		$realFile = $this->util->stripPartialFileExtension($path);
-		if ($this->storage->file_exists($realFile)) {
-			$path = $realFile;
-		}
-		$firstBlock = $this->readFirstBlock($path);
-
-		if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
-			$headerSize = $this->util->getHeaderSize();
-		}
-
-		return $headerSize;
-	}
-
-	/**
-	 * parse raw header to array
-	 *
-	 * @param string $rawHeader
-	 * @return array
-	 */
-	protected function parseRawHeader($rawHeader) {
-		$result = [];
-		if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
-			$header = $rawHeader;
-			$endAt = strpos($header, Util::HEADER_END);
-			if ($endAt !== false) {
-				$header = substr($header, 0, $endAt + strlen(Util::HEADER_END));
-
-				// +1 to not start with an ':' which would result in empty element at the beginning
-				$exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1));
-
-				$element = array_shift($exploded);
-				while ($element !== Util::HEADER_END) {
-					$result[$element] = array_shift($exploded);
-					$element = array_shift($exploded);
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * read header from file
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	protected function getHeader($path) {
-		$realFile = $this->util->stripPartialFileExtension($path);
-		$exists = $this->storage->file_exists($realFile);
-		if ($exists) {
-			$path = $realFile;
-		}
-
-		$firstBlock = $this->readFirstBlock($path);
-		$result = $this->parseRawHeader($firstBlock);
-
-		// if the header doesn't contain a encryption module we check if it is a
-		// legacy file. If true, we add the default encryption module
-		if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) {
-			if (!empty($result)) {
-				$result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
-			} else if ($exists) {
-				// if the header was empty we have to check first if it is a encrypted file at all
-				// We would do query to filecache only if we know that entry in filecache exists
-				$info = $this->getCache()->get($path);
-				if (isset($info['encrypted']) && $info['encrypted'] === true) {
-					$result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * read encryption module needed to read/write the file located at $path
-	 *
-	 * @param string $path
-	 * @return null|\OCP\Encryption\IEncryptionModule
-	 * @throws ModuleDoesNotExistsException
-	 * @throws \Exception
-	 */
-	protected function getEncryptionModule($path) {
-		$encryptionModule = null;
-		$header = $this->getHeader($path);
-		$encryptionModuleId = $this->util->getEncryptionModuleId($header);
-		if (!empty($encryptionModuleId)) {
-			try {
-				$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-			} catch (ModuleDoesNotExistsException $e) {
-				$this->logger->critical('Encryption module defined in "' . $path . '" not loaded!');
-				throw $e;
-			}
-		}
-
-		return $encryptionModule;
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $unencryptedSize
-	 */
-	public function updateUnencryptedSize($path, $unencryptedSize) {
-		$this->unencryptedSize[$path] = $unencryptedSize;
-	}
-
-	/**
-	 * copy keys to new location
-	 *
-	 * @param string $source path relative to data/
-	 * @param string $target path relative to data/
-	 * @return bool
-	 */
-	protected function copyKeys($source, $target) {
-		if (!$this->util->isExcluded($source)) {
-			return $this->keyStorage->copyKeys($source, $target);
-		}
-
-		return false;
-	}
-
-	/**
-	 * check if path points to a files version
-	 *
-	 * @param $path
-	 * @return bool
-	 */
-	protected function isVersion($path) {
-		$normalized = Filesystem::normalizePath($path);
-		return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/';
-	}
-
-	/**
-	 * check if the given storage should be encrypted or not
-	 *
-	 * @param $path
-	 * @return bool
-	 */
-	protected function shouldEncrypt($path) {
-		$fullPath = $this->getFullPath($path);
-		$mountPointConfig = $this->mount->getOption('encrypt', true);
-		if ($mountPointConfig === false) {
-			return false;
-		}
-
-		try {
-			$encryptionModule = $this->getEncryptionModule($fullPath);
-		} catch (ModuleDoesNotExistsException $e) {
-			return false;
-		}
-
-		if ($encryptionModule === null) {
-			$encryptionModule = $this->encryptionManager->getEncryptionModule();
-		}
-
-		return $encryptionModule->shouldEncrypt($fullPath);
-
-	}
-
-	public function writeStream(string $path, $stream, int $size = null): int {
-		// always fall back to fopen
-		$target = $this->fopen($path, 'w');
-		list($count, $result) = \OC_Helper::streamCopy($stream, $target);
-		fclose($target);
-		return $count;
-	}
+    use LocalTempFileTrait;
+
+    /** @var string */
+    private $mountPoint;
+
+    /** @var \OC\Encryption\Util */
+    private $util;
+
+    /** @var \OCP\Encryption\IManager */
+    private $encryptionManager;
+
+    /** @var \OCP\ILogger */
+    private $logger;
+
+    /** @var string */
+    private $uid;
+
+    /** @var array */
+    protected $unencryptedSize;
+
+    /** @var \OCP\Encryption\IFile */
+    private $fileHelper;
+
+    /** @var IMountPoint */
+    private $mount;
+
+    /** @var IStorage */
+    private $keyStorage;
+
+    /** @var Update */
+    private $update;
+
+    /** @var Manager */
+    private $mountManager;
+
+    /** @var array remember for which path we execute the repair step to avoid recursions */
+    private $fixUnencryptedSizeOf = [];
+
+    /** @var  ArrayCache */
+    private $arrayCache;
+
+    /**
+     * @param array $parameters
+     * @param IManager $encryptionManager
+     * @param Util $util
+     * @param ILogger $logger
+     * @param IFile $fileHelper
+     * @param string $uid
+     * @param IStorage $keyStorage
+     * @param Update $update
+     * @param Manager $mountManager
+     * @param ArrayCache $arrayCache
+     */
+    public function __construct(
+            $parameters,
+            IManager $encryptionManager = null,
+            Util $util = null,
+            ILogger $logger = null,
+            IFile $fileHelper = null,
+            $uid = null,
+            IStorage $keyStorage = null,
+            Update $update = null,
+            Manager $mountManager = null,
+            ArrayCache $arrayCache = null
+        ) {
+
+        $this->mountPoint = $parameters['mountPoint'];
+        $this->mount = $parameters['mount'];
+        $this->encryptionManager = $encryptionManager;
+        $this->util = $util;
+        $this->logger = $logger;
+        $this->uid = $uid;
+        $this->fileHelper = $fileHelper;
+        $this->keyStorage = $keyStorage;
+        $this->unencryptedSize = [];
+        $this->update = $update;
+        $this->mountManager = $mountManager;
+        $this->arrayCache = $arrayCache;
+        parent::__construct($parameters);
+    }
+
+    /**
+     * 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) {
+        $fullPath = $this->getFullPath($path);
+
+        /** @var CacheEntry $info */
+        $info = $this->getCache()->get($path);
+        if (isset($this->unencryptedSize[$fullPath])) {
+            $size = $this->unencryptedSize[$fullPath];
+            // update file cache
+            if ($info instanceof ICacheEntry) {
+                $info = $info->getData();
+                $info['encrypted'] = $info['encryptedVersion'];
+            } else {
+                if (!is_array($info)) {
+                    $info = [];
+                }
+                $info['encrypted'] = true;
+            }
+
+            $info['size'] = $size;
+            $this->getCache()->put($path, $info);
+
+            return $size;
+        }
+
+        if (isset($info['fileid']) && $info['encrypted']) {
+            return $this->verifyUnencryptedSize($path, $info['size']);
+        }
+
+        return $this->storage->filesize($path);
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        $data = $this->storage->getMetaData($path);
+        if (is_null($data)) {
+            return null;
+        }
+        $fullPath = $this->getFullPath($path);
+        $info = $this->getCache()->get($path);
+
+        if (isset($this->unencryptedSize[$fullPath])) {
+            $data['encrypted'] = true;
+            $data['size'] = $this->unencryptedSize[$fullPath];
+        } else {
+            if (isset($info['fileid']) && $info['encrypted']) {
+                $data['size'] = $this->verifyUnencryptedSize($path, $info['size']);
+                $data['encrypted'] = true;
+            }
+        }
+
+        if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) {
+            $data['encryptedVersion'] = $info['encryptedVersion'];
+        }
+
+        return $data;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string
+     */
+    public function file_get_contents($path) {
+
+        $encryptionModule = $this->getEncryptionModule($path);
+
+        if ($encryptionModule) {
+            $handle = $this->fopen($path, "r");
+            if (!$handle) {
+                return false;
+            }
+            $data = stream_get_contents($handle);
+            fclose($handle);
+            return $data;
+        }
+        return $this->storage->file_get_contents($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) {
+        // file put content will always be translated to a stream write
+        $handle = $this->fopen($path, 'w');
+        if (is_resource($handle)) {
+            $written = fwrite($handle, $data);
+            fclose($handle);
+            return $written;
+        }
+
+        return false;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        $fullPath = $this->getFullPath($path);
+        if ($this->util->isExcluded($fullPath)) {
+            return $this->storage->unlink($path);
+        }
+
+        $encryptionModule = $this->getEncryptionModule($path);
+        if ($encryptionModule) {
+            $this->keyStorage->deleteAllFileKeys($this->getFullPath($path));
+        }
+
+        return $this->storage->unlink($path);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+
+        $result = $this->storage->rename($path1, $path2);
+
+        if ($result &&
+            // versions always use the keys from the original file, so we can skip
+            // this step for versions
+            $this->isVersion($path2) === false &&
+            $this->encryptionManager->isEnabled()) {
+            $source = $this->getFullPath($path1);
+            if (!$this->util->isExcluded($source)) {
+                $target = $this->getFullPath($path2);
+                if (isset($this->unencryptedSize[$source])) {
+                    $this->unencryptedSize[$target] = $this->unencryptedSize[$source];
+                }
+                $this->keyStorage->renameKeys($source, $target);
+                $module = $this->getEncryptionModule($path2);
+                if ($module) {
+                    $module->update($target, $this->uid, []);
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        $result = $this->storage->rmdir($path);
+        $fullPath = $this->getFullPath($path);
+        if ($result &&
+            $this->util->isExcluded($fullPath) === false &&
+            $this->encryptionManager->isEnabled()
+        ) {
+            $this->keyStorage->deleteAllFileKeys($fullPath);
+        }
+
+        return $result;
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+
+        $isReadable = true;
+
+        $metaData = $this->getMetaData($path);
+        if (
+            !$this->is_dir($path) &&
+            isset($metaData['encrypted']) &&
+            $metaData['encrypted'] === true
+        ) {
+            $fullPath = $this->getFullPath($path);
+            $module = $this->getEncryptionModule($path);
+            $isReadable = $module->isReadable($fullPath, $this->uid);
+        }
+
+        return $this->storage->isReadable($path) && $isReadable;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function copy($path1, $path2) {
+
+        $source = $this->getFullPath($path1);
+
+        if ($this->util->isExcluded($source)) {
+            return $this->storage->copy($path1, $path2);
+        }
+
+        // need to stream copy file by file in case we copy between a encrypted
+        // and a unencrypted storage
+        $this->unlink($path2);
+        return $this->copyFromStorage($this, $path1, $path2);
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|bool
+     * @throws GenericEncryptionException
+     * @throws ModuleDoesNotExistsException
+     */
+    public function fopen($path, $mode) {
+
+        // check if the file is stored in the array cache, this means that we
+        // copy a file over to the versions folder, in this case we don't want to
+        // decrypt it
+        if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) {
+            $this->arrayCache->remove('encryption_copy_version_' . $path);
+            return $this->storage->fopen($path, $mode);
+        }
+
+        $encryptionEnabled = $this->encryptionManager->isEnabled();
+        $shouldEncrypt = false;
+        $encryptionModule = null;
+        $header = $this->getHeader($path);
+        $signed = isset($header['signed']) && $header['signed'] === 'true';
+        $fullPath = $this->getFullPath($path);
+        $encryptionModuleId = $this->util->getEncryptionModuleId($header);
+
+        if ($this->util->isExcluded($fullPath) === false) {
+
+            $size = $unencryptedSize = 0;
+            $realFile = $this->util->stripPartialFileExtension($path);
+            $targetExists = $this->file_exists($realFile) || $this->file_exists($path);
+            $targetIsEncrypted = false;
+            if ($targetExists) {
+                // in case the file exists we require the explicit module as
+                // specified in the file header - otherwise we need to fail hard to
+                // prevent data loss on client side
+                if (!empty($encryptionModuleId)) {
+                    $targetIsEncrypted = true;
+                    $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+                }
+
+                if ($this->file_exists($path)) {
+                    $size = $this->storage->filesize($path);
+                    $unencryptedSize = $this->filesize($path);
+                } else {
+                    $size = $unencryptedSize = 0;
+                }
+            }
+
+            try {
+
+                if (
+                    $mode === 'w'
+                    || $mode === 'w+'
+                    || $mode === 'wb'
+                    || $mode === 'wb+'
+                ) {
+                    // if we update a encrypted file with a un-encrypted one we change the db flag
+                    if ($targetIsEncrypted && $encryptionEnabled === false) {
+                        $cache = $this->storage->getCache();
+                        if ($cache) {
+                            $entry = $cache->get($path);
+                            $cache->update($entry->getId(), ['encrypted' => 0]);
+                        }
+                    }
+                    if ($encryptionEnabled) {
+                        // if $encryptionModuleId is empty, the default module will be used
+                        $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+                        $shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath);
+                        $signed = true;
+                    }
+                } else {
+                    $info = $this->getCache()->get($path);
+                    // only get encryption module if we found one in the header
+                    // or if file should be encrypted according to the file cache
+                    if (!empty($encryptionModuleId)) {
+                        $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+                        $shouldEncrypt = true;
+                    } else if (empty($encryptionModuleId) && $info['encrypted'] === true) {
+                        // we come from a old installation. No header and/or no module defined
+                        // but the file is encrypted. In this case we need to use the
+                        // OC_DEFAULT_MODULE to read the file
+                        $encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE');
+                        $shouldEncrypt = true;
+                        $targetIsEncrypted = true;
+                    }
+                }
+            } catch (ModuleDoesNotExistsException $e) {
+                $this->logger->logException($e, [
+                    'message' => 'Encryption module "' . $encryptionModuleId . '" not found, file will be stored unencrypted',
+                    'level' => ILogger::WARN,
+                    'app' => 'core',
+                ]);
+            }
+
+            // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt
+            if (!$encryptionEnabled || !$this->shouldEncrypt($path)) {
+                if (!$targetExists || !$targetIsEncrypted) {
+                    $shouldEncrypt = false;
+                }
+            }
+
+            if ($shouldEncrypt === true && $encryptionModule !== null) {
+                $headerSize = $this->getHeaderSize($path);
+                $source = $this->storage->fopen($path, $mode);
+                if (!is_resource($source)) {
+                    return false;
+                }
+                $handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header,
+                    $this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode,
+                    $size, $unencryptedSize, $headerSize, $signed);
+                return $handle;
+            }
+
+        }
+
+        return $this->storage->fopen($path, $mode);
+    }
+
+
+    /**
+     * perform some plausibility checks if the the unencrypted size is correct.
+     * If not, we calculate the correct unencrypted size and return it
+     *
+     * @param string $path internal path relative to the storage root
+     * @param int $unencryptedSize size of the unencrypted file
+     *
+     * @return int unencrypted size
+     */
+    protected function verifyUnencryptedSize($path, $unencryptedSize) {
+
+        $size = $this->storage->filesize($path);
+        $result = $unencryptedSize;
+
+        if ($unencryptedSize < 0 ||
+            ($size > 0 && $unencryptedSize === $size)
+        ) {
+            // check if we already calculate the unencrypted size for the
+            // given path to avoid recursions
+            if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) {
+                $this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true;
+                try {
+                    $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize);
+                } catch (\Exception $e) {
+                    $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path);
+                    $this->logger->logException($e);
+                }
+                unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]);
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * calculate the unencrypted size
+     *
+     * @param string $path internal path relative to the storage root
+     * @param int $size size of the physical file
+     * @param int $unencryptedSize size of the unencrypted file
+     *
+     * @return int calculated unencrypted size
+     */
+    protected function fixUnencryptedSize($path, $size, $unencryptedSize) {
+
+        $headerSize = $this->getHeaderSize($path);
+        $header = $this->getHeader($path);
+        $encryptionModule = $this->getEncryptionModule($path);
+
+        $stream = $this->storage->fopen($path, 'r');
+
+        // if we couldn't open the file we return the old unencrypted size
+        if (!is_resource($stream)) {
+            $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.');
+            return $unencryptedSize;
+        }
+
+        $newUnencryptedSize = 0;
+        $size -= $headerSize;
+        $blockSize = $this->util->getBlockSize();
+
+        // if a header exists we skip it
+        if ($headerSize > 0) {
+            fread($stream, $headerSize);
+        }
+
+        // fast path, else the calculation for $lastChunkNr is bogus
+        if ($size === 0) {
+            return 0;
+        }
+
+        $signed = isset($header['signed']) && $header['signed'] === 'true';
+        $unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed);
+
+        // calculate last chunk nr
+        // next highest is end of chunks, one subtracted is last one
+        // we have to read the last chunk, we can't just calculate it (because of padding etc)
+
+        $lastChunkNr = ceil($size/ $blockSize)-1;
+        // calculate last chunk position
+        $lastChunkPos = ($lastChunkNr * $blockSize);
+        // try to fseek to the last chunk, if it fails we have to read the whole file
+        if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) {
+            $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize;
+        }
+
+        $lastChunkContentEncrypted='';
+        $count = $blockSize;
+
+        while ($count > 0) {
+            $data=fread($stream, $blockSize);
+            $count=strlen($data);
+            $lastChunkContentEncrypted .= $data;
+            if(strlen($lastChunkContentEncrypted) > $blockSize) {
+                $newUnencryptedSize += $unencryptedBlockSize;
+                $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize);
+            }
+        }
+
+        fclose($stream);
+
+        // we have to decrypt the last chunk to get it actual size
+        $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []);
+        $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end');
+        $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end');
+
+        // calc the real file size with the size of the last chunk
+        $newUnencryptedSize += strlen($decryptedLastChunk);
+
+        $this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize);
+
+        // write to cache if applicable
+        $cache = $this->storage->getCache();
+        if ($cache) {
+            $entry = $cache->get($path);
+            $cache->update($entry['fileid'], ['size' => $newUnencryptedSize]);
+        }
+
+        return $newUnencryptedSize;
+    }
+
+    /**
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @return bool
+     */
+    public function moveFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) {
+        if ($sourceStorage === $this) {
+            return $this->rename($sourceInternalPath, $targetInternalPath);
+        }
+
+        // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
+        // - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage
+        // - copy the file cache update from  $this->copyBetweenStorage to this method
+        // - copy the copyKeys() call from  $this->copyBetweenStorage to this method
+        // - remove $this->copyBetweenStorage
+
+        if (!$sourceStorage->isDeletable($sourceInternalPath)) {
+            return false;
+        }
+
+        $result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true);
+        if ($result) {
+            if ($sourceStorage->is_dir($sourceInternalPath)) {
+                $result &= $sourceStorage->rmdir($sourceInternalPath);
+            } else {
+                $result &= $sourceStorage->unlink($sourceInternalPath);
+            }
+        }
+        return $result;
+    }
+
+
+    /**
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @param bool $isRename
+     * @return bool
+     */
+    public function copyFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) {
+
+        // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
+        // - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage
+        // - copy the file cache update from  $this->copyBetweenStorage to this method
+        // - copy the copyKeys() call from  $this->copyBetweenStorage to this method
+        // - remove $this->copyBetweenStorage
+
+        return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename);
+    }
+
+    /**
+     * Update the encrypted cache version in the database
+     *
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $isRename
+     * @param bool $keepEncryptionVersion
+     */
+    private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, $keepEncryptionVersion) {
+        $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath);
+        $cacheInformation = [
+            'encrypted' => $isEncrypted,
+        ];
+        if($isEncrypted) {
+            $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion'];
+
+            // In case of a move operation from an unencrypted to an encrypted
+            // storage the old encrypted version would stay with "0" while the
+            // correct value would be "1". Thus we manually set the value to "1"
+            // for those cases.
+            // See also https://github.com/owncloud/core/issues/23078
+            if($encryptedVersion === 0 || !$keepEncryptionVersion) {
+                $encryptedVersion = 1;
+            }
+
+            $cacheInformation['encryptedVersion'] = $encryptedVersion;
+        }
+
+        // in case of a rename we need to manipulate the source cache because
+        // this information will be kept for the new target
+        if ($isRename) {
+            $sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation);
+        } else {
+            $this->getCache()->put($targetInternalPath, $cacheInformation);
+        }
+    }
+
+    /**
+     * copy file between two storages
+     *
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @param bool $isRename
+     * @return bool
+     * @throws \Exception
+     */
+    private function copyBetweenStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) {
+
+        // for versions we have nothing to do, because versions should always use the
+        // key from the original file. Just create a 1:1 copy and done
+        if ($this->isVersion($targetInternalPath) ||
+            $this->isVersion($sourceInternalPath)) {
+            // remember that we try to create a version so that we can detect it during
+            // fopen($sourceInternalPath) and by-pass the encryption in order to
+            // create a 1:1 copy of the file
+            $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true);
+            $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+            $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath);
+            if ($result) {
+                $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath);
+                // make sure that we update the unencrypted size for the version
+                if (isset($info['encrypted']) && $info['encrypted'] === true) {
+                    $this->updateUnencryptedSize(
+                        $this->getFullPath($targetInternalPath),
+                        $info['size']
+                    );
+                }
+                $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, true);
+            }
+            return $result;
+        }
+
+        // first copy the keys that we reuse the existing file key on the target location
+        // and don't create a new one which would break versions for example.
+        $mount = $this->mountManager->findByStorageId($sourceStorage->getId());
+        if (count($mount) === 1) {
+            $mountPoint = $mount[0]->getMountPoint();
+            $source = $mountPoint . '/' . $sourceInternalPath;
+            $target = $this->getFullPath($targetInternalPath);
+            $this->copyKeys($source, $target);
+        } else {
+            $this->logger->error('Could not find mount point, can\'t keep encryption keys');
+        }
+
+        if ($sourceStorage->is_dir($sourceInternalPath)) {
+            $dh = $sourceStorage->opendir($sourceInternalPath);
+            $result = $this->mkdir($targetInternalPath);
+            if (is_resource($dh)) {
+                while ($result and ($file = readdir($dh)) !== false) {
+                    if (!Filesystem::isIgnoredDir($file)) {
+                        $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename);
+                    }
+                }
+            }
+        } else {
+            try {
+                $source = $sourceStorage->fopen($sourceInternalPath, 'r');
+                $target = $this->fopen($targetInternalPath, 'w');
+                list(, $result) = \OC_Helper::streamCopy($source, $target);
+                fclose($source);
+                fclose($target);
+            } catch (\Exception $e) {
+                fclose($source);
+                fclose($target);
+                throw $e;
+            }
+            if($result) {
+                if ($preserveMtime) {
+                    $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath));
+                }
+                $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, false);
+            } else {
+                // delete partially written target file
+                $this->unlink($targetInternalPath);
+                // delete cache entry that was created by fopen
+                $this->getCache()->remove($targetInternalPath);
+            }
+        }
+        return (bool)$result;
+
+    }
+
+    /**
+     * 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) {
+        if ($this->encryptionManager->isEnabled()) {
+            $cachedFile = $this->getCachedFile($path);
+            if (is_string($cachedFile)) {
+                return $cachedFile;
+            }
+        }
+        return $this->storage->getLocalFile($path);
+    }
+
+    /**
+     * Returns the wrapped storage's value for isLocal()
+     *
+     * @return bool wrapped storage's isLocal() value
+     */
+    public function isLocal() {
+        if ($this->encryptionManager->isEnabled()) {
+            return false;
+        }
+        return $this->storage->isLocal();
+    }
+
+    /**
+     * 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) {
+        $stat = $this->storage->stat($path);
+        $fileSize = $this->filesize($path);
+        $stat['size'] = $fileSize;
+        $stat[7] = $fileSize;
+        return $stat;
+    }
+
+    /**
+     * 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) {
+        $fh = $this->fopen($path, 'rb');
+        $ctx = hash_init($type);
+        hash_update_stream($ctx, $fh);
+        fclose($fh);
+        return hash_final($ctx, $raw);
+    }
+
+    /**
+     * return full path, including mount point
+     *
+     * @param string $path relative to mount point
+     * @return string full path including mount point
+     */
+    protected function getFullPath($path) {
+        return Filesystem::normalizePath($this->mountPoint . '/' . $path);
+    }
+
+    /**
+     * read first block of encrypted file, typically this will contain the
+     * encryption header
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function readFirstBlock($path) {
+        $firstBlock = '';
+        if ($this->storage->file_exists($path)) {
+            $handle = $this->storage->fopen($path, 'r');
+            $firstBlock = fread($handle, $this->util->getHeaderSize());
+            fclose($handle);
+        }
+        return $firstBlock;
+    }
+
+    /**
+     * return header size of given file
+     *
+     * @param string $path
+     * @return int
+     */
+    protected function getHeaderSize($path) {
+        $headerSize = 0;
+        $realFile = $this->util->stripPartialFileExtension($path);
+        if ($this->storage->file_exists($realFile)) {
+            $path = $realFile;
+        }
+        $firstBlock = $this->readFirstBlock($path);
+
+        if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
+            $headerSize = $this->util->getHeaderSize();
+        }
+
+        return $headerSize;
+    }
+
+    /**
+     * parse raw header to array
+     *
+     * @param string $rawHeader
+     * @return array
+     */
+    protected function parseRawHeader($rawHeader) {
+        $result = [];
+        if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
+            $header = $rawHeader;
+            $endAt = strpos($header, Util::HEADER_END);
+            if ($endAt !== false) {
+                $header = substr($header, 0, $endAt + strlen(Util::HEADER_END));
+
+                // +1 to not start with an ':' which would result in empty element at the beginning
+                $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1));
+
+                $element = array_shift($exploded);
+                while ($element !== Util::HEADER_END) {
+                    $result[$element] = array_shift($exploded);
+                    $element = array_shift($exploded);
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * read header from file
+     *
+     * @param string $path
+     * @return array
+     */
+    protected function getHeader($path) {
+        $realFile = $this->util->stripPartialFileExtension($path);
+        $exists = $this->storage->file_exists($realFile);
+        if ($exists) {
+            $path = $realFile;
+        }
+
+        $firstBlock = $this->readFirstBlock($path);
+        $result = $this->parseRawHeader($firstBlock);
+
+        // if the header doesn't contain a encryption module we check if it is a
+        // legacy file. If true, we add the default encryption module
+        if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) {
+            if (!empty($result)) {
+                $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
+            } else if ($exists) {
+                // if the header was empty we have to check first if it is a encrypted file at all
+                // We would do query to filecache only if we know that entry in filecache exists
+                $info = $this->getCache()->get($path);
+                if (isset($info['encrypted']) && $info['encrypted'] === true) {
+                    $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * read encryption module needed to read/write the file located at $path
+     *
+     * @param string $path
+     * @return null|\OCP\Encryption\IEncryptionModule
+     * @throws ModuleDoesNotExistsException
+     * @throws \Exception
+     */
+    protected function getEncryptionModule($path) {
+        $encryptionModule = null;
+        $header = $this->getHeader($path);
+        $encryptionModuleId = $this->util->getEncryptionModuleId($header);
+        if (!empty($encryptionModuleId)) {
+            try {
+                $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+            } catch (ModuleDoesNotExistsException $e) {
+                $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!');
+                throw $e;
+            }
+        }
+
+        return $encryptionModule;
+    }
+
+    /**
+     * @param string $path
+     * @param int $unencryptedSize
+     */
+    public function updateUnencryptedSize($path, $unencryptedSize) {
+        $this->unencryptedSize[$path] = $unencryptedSize;
+    }
+
+    /**
+     * copy keys to new location
+     *
+     * @param string $source path relative to data/
+     * @param string $target path relative to data/
+     * @return bool
+     */
+    protected function copyKeys($source, $target) {
+        if (!$this->util->isExcluded($source)) {
+            return $this->keyStorage->copyKeys($source, $target);
+        }
+
+        return false;
+    }
+
+    /**
+     * check if path points to a files version
+     *
+     * @param $path
+     * @return bool
+     */
+    protected function isVersion($path) {
+        $normalized = Filesystem::normalizePath($path);
+        return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/';
+    }
+
+    /**
+     * check if the given storage should be encrypted or not
+     *
+     * @param $path
+     * @return bool
+     */
+    protected function shouldEncrypt($path) {
+        $fullPath = $this->getFullPath($path);
+        $mountPointConfig = $this->mount->getOption('encrypt', true);
+        if ($mountPointConfig === false) {
+            return false;
+        }
+
+        try {
+            $encryptionModule = $this->getEncryptionModule($fullPath);
+        } catch (ModuleDoesNotExistsException $e) {
+            return false;
+        }
+
+        if ($encryptionModule === null) {
+            $encryptionModule = $this->encryptionManager->getEncryptionModule();
+        }
+
+        return $encryptionModule->shouldEncrypt($fullPath);
+
+    }
+
+    public function writeStream(string $path, $stream, int $size = null): int {
+        // always fall back to fopen
+        $target = $this->fopen($path, 'w');
+        list($count, $result) = \OC_Helper::streamCopy($stream, $target);
+        fclose($target);
+        return $count;
+    }
 
 }

lib/private/Files/Storage/DAV.php

Indentation +809 added lines, -809 removed lines

@@ -62,813 +62,813 @@
  * @package OC\Files\Storage
  */
 class DAV extends Common {
-	/** @var string */
-	protected $password;
-	/** @var string */
-	protected $user;
-	/** @var string */
-	protected $authType;
-	/** @var string */
-	protected $host;
-	/** @var bool */
-	protected $secure;
-	/** @var string */
-	protected $root;
-	/** @var string */
-	protected $certPath;
-	/** @var bool */
-	protected $ready;
-	/** @var Client */
-	protected $client;
-	/** @var ArrayCache */
-	protected $statCache;
-	/** @var IClientService */
-	protected $httpClientService;
-	/** @var ICertificateManager */
-	protected $certManager;
-
-	/**
-	 * @param array $params
-	 * @throws \Exception
-	 */
-	public function __construct($params) {
-		$this->statCache = new ArrayCache();
-		$this->httpClientService = \OC::$server->getHTTPClientService();
-		if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
-			$host = $params['host'];
-			//remove leading http[s], will be generated in createBaseUri()
-			if (substr($host, 0, 8) == "https://") $host = substr($host, 8);
-			else if (substr($host, 0, 7) == "http://") $host = substr($host, 7);
-			$this->host = $host;
-			$this->user = $params['user'];
-			$this->password = $params['password'];
-			if (isset($params['authType'])) {
-				$this->authType = $params['authType'];
-			}
-			if (isset($params['secure'])) {
-				if (is_string($params['secure'])) {
-					$this->secure = ($params['secure'] === 'true');
-				} else {
-					$this->secure = (bool)$params['secure'];
-				}
-			} else {
-				$this->secure = false;
-			}
-			if ($this->secure === true) {
-				// inject mock for testing
-				$this->certManager = \OC::$server->getCertificateManager();
-				if (is_null($this->certManager)) { //no user
-					$this->certManager = \OC::$server->getCertificateManager(null);
-				}
-			}
-			$this->root = $params['root'] ?? '/';
-			$this->root = '/' . ltrim($this->root, '/');
-			$this->root = rtrim($this->root, '/') . '/';
-		} else {
-			throw new \Exception('Invalid webdav storage configuration');
-		}
-	}
-
-	protected function init() {
-		if ($this->ready) {
-			return;
-		}
-		$this->ready = true;
-
-		$settings = [
-			'baseUri' => $this->createBaseUri(),
-			'userName' => $this->user,
-			'password' => $this->password,
-		];
-		if (isset($this->authType)) {
-			$settings['authType'] = $this->authType;
-		}
-
-		$proxy = \OC::$server->getConfig()->getSystemValue('proxy', '');
-		if ($proxy !== '') {
-			$settings['proxy'] = $proxy;
-		}
-
-		$this->client = new Client($settings);
-		$this->client->setThrowExceptions(true);
-
-		if($this->secure === true) {
-			$certPath = $this->certManager->getAbsoluteBundlePath();
-			if (file_exists($certPath)) {
-				$this->certPath = $certPath;
-			}
-			if ($this->certPath) {
-				$this->client->addCurlSetting(CURLOPT_CAINFO, $this->certPath);
-			}
-		}
-	}
-
-	/**
-	 * Clear the stat cache
-	 */
-	public function clearStatCache() {
-		$this->statCache->clear();
-	}
-
-	/** {@inheritdoc} */
-	public function getId() {
-		return 'webdav::' . $this->user . '@' . $this->host . '/' . $this->root;
-	}
-
-	/** {@inheritdoc} */
-	public function createBaseUri() {
-		$baseUri = 'http';
-		if ($this->secure) {
-			$baseUri .= 's';
-		}
-		$baseUri .= '://' . $this->host . $this->root;
-		return $baseUri;
-	}
-
-	/** {@inheritdoc} */
-	public function mkdir($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$result = $this->simpleResponse('MKCOL', $path, null, 201);
-		if ($result) {
-			$this->statCache->set($path, true);
-		}
-		return $result;
-	}
-
-	/** {@inheritdoc} */
-	public function rmdir($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		// FIXME: some WebDAV impl return 403 when trying to DELETE
-		// a non-empty folder
-		$result = $this->simpleResponse('DELETE', $path . '/', null, 204);
-		$this->statCache->clear($path . '/');
-		$this->statCache->remove($path);
-		return $result;
-	}
-
-	/** {@inheritdoc} */
-	public function opendir($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		try {
-			$response = $this->client->propFind(
-				$this->encodePath($path),
-				['{DAV:}getetag'],
-				1
-			);
-			if ($response === false) {
-				return false;
-			}
-			$content = [];
-			$files = array_keys($response);
-			array_shift($files); //the first entry is the current directory
-
-			if (!$this->statCache->hasKey($path)) {
-				$this->statCache->set($path, true);
-			}
-			foreach ($files as $file) {
-				$file = urldecode($file);
-				// do not store the real entry, we might not have all properties
-				if (!$this->statCache->hasKey($path)) {
-					$this->statCache->set($file, true);
-				}
-				$file = basename($file);
-				$content[] = $file;
-			}
-			return IteratorDirectory::wrap($content);
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/**
-	 * Propfind call with cache handling.
-	 *
-	 * First checks if information is cached.
-	 * If not, request it from the server then store to cache.
-	 *
-	 * @param string $path path to propfind
-	 *
-	 * @return array|boolean propfind response or false if the entry was not found
-	 *
-	 * @throws ClientHttpException
-	 */
-	protected function propfind($path) {
-		$path = $this->cleanPath($path);
-		$cachedResponse = $this->statCache->get($path);
-		// we either don't know it, or we know it exists but need more details
-		if (is_null($cachedResponse) || $cachedResponse === true) {
-			$this->init();
-			try {
-				$response = $this->client->propFind(
-					$this->encodePath($path),
-					[
-						'{DAV:}getlastmodified',
-						'{DAV:}getcontentlength',
-						'{DAV:}getcontenttype',
-						'{http://owncloud.org/ns}permissions',
-						'{http://open-collaboration-services.org/ns}share-permissions',
-						'{DAV:}resourcetype',
-						'{DAV:}getetag',
-					]
-				);
-				$this->statCache->set($path, $response);
-			} catch (ClientHttpException $e) {
-				if ($e->getHttpStatus() === 404 || $e->getHttpStatus() === 405) {
-					$this->statCache->clear($path . '/');
-					$this->statCache->set($path, false);
-					return false;
-				}
-				$this->convertException($e, $path);
-			} catch (\Exception $e) {
-				$this->convertException($e, $path);
-			}
-		} else {
-			$response = $cachedResponse;
-		}
-		return $response;
-	}
-
-	/** {@inheritdoc} */
-	public function filetype($path) {
-		try {
-			$response = $this->propfind($path);
-			if ($response === false) {
-				return false;
-			}
-			$responseType = [];
-			if (isset($response["{DAV:}resourcetype"])) {
-				/** @var ResourceType[] $response */
-				$responseType = $response["{DAV:}resourcetype"]->getValue();
-			}
-			return (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function file_exists($path) {
-		try {
-			$path = $this->cleanPath($path);
-			$cachedState = $this->statCache->get($path);
-			if ($cachedState === false) {
-				// we know the file doesn't exist
-				return false;
-			} else if (!is_null($cachedState)) {
-				return true;
-			}
-			// need to get from server
-			return ($this->propfind($path) !== false);
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function unlink($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$result = $this->simpleResponse('DELETE', $path, null, 204);
-		$this->statCache->clear($path . '/');
-		$this->statCache->remove($path);
-		return $result;
-	}
-
-	/** {@inheritdoc} */
-	public function fopen($path, $mode) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		switch ($mode) {
-			case 'r':
-			case 'rb':
-				try {
-					$response = $this->httpClientService
-						->newClient()
-						->get($this->createBaseUri() . $this->encodePath($path), [
-							'auth' => [$this->user, $this->password],
-							'stream' => true
-						]);
-				} catch (\GuzzleHttp\Exception\ClientException $e) {
-					if ($e->getResponse() instanceof ResponseInterface
-						&& $e->getResponse()->getStatusCode() === 404) {
-						return false;
-					} else {
-						throw $e;
-					}
-				}
-
-				if ($response->getStatusCode() !== Http::STATUS_OK) {
-					if ($response->getStatusCode() === Http::STATUS_LOCKED) {
-						throw new \OCP\Lock\LockedException($path);
-					} else {
-						Util::writeLog("webdav client", 'Guzzle get returned status code ' . $response->getStatusCode(), ILogger::ERROR);
-					}
-				}
-
-				return $response->getBody();
-			case 'w':
-			case 'wb':
-			case 'a':
-			case 'ab':
-			case 'r+':
-			case 'w+':
-			case 'wb+':
-			case 'a+':
-			case 'x':
-			case 'x+':
-			case 'c':
-			case 'c+':
-				//emulate these
-				$tempManager = \OC::$server->getTempManager();
-				if (strrpos($path, '.') !== false) {
-					$ext = substr($path, strrpos($path, '.'));
-				} else {
-					$ext = '';
-				}
-				if ($this->file_exists($path)) {
-					if (!$this->isUpdatable($path)) {
-						return false;
-					}
-					if ($mode === 'w' or $mode === 'w+') {
-						$tmpFile = $tempManager->getTemporaryFile($ext);
-					} else {
-						$tmpFile = $this->getCachedFile($path);
-					}
-				} else {
-					if (!$this->isCreatable(dirname($path))) {
-						return false;
-					}
-					$tmpFile = $tempManager->getTemporaryFile($ext);
-				}
-				$handle = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
-					$this->writeBack($tmpFile, $path);
-				});
-		}
-	}
-
-	/**
-	 * @param string $tmpFile
-	 */
-	public function writeBack($tmpFile, $path) {
-		$this->uploadFile($tmpFile, $path);
-		unlink($tmpFile);
-	}
-
-	/** {@inheritdoc} */
-	public function free_space($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		try {
-			// TODO: cacheable ?
-			$response = $this->client->propfind($this->encodePath($path), ['{DAV:}quota-available-bytes']);
-			if ($response === false) {
-				return FileInfo::SPACE_UNKNOWN;
-			}
-			if (isset($response['{DAV:}quota-available-bytes'])) {
-				return (int)$response['{DAV:}quota-available-bytes'];
-			} else {
-				return FileInfo::SPACE_UNKNOWN;
-			}
-		} catch (\Exception $e) {
-			return FileInfo::SPACE_UNKNOWN;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function touch($path, $mtime = null) {
-		$this->init();
-		if (is_null($mtime)) {
-			$mtime = time();
-		}
-		$path = $this->cleanPath($path);
-
-		// if file exists, update the mtime, else create a new empty file
-		if ($this->file_exists($path)) {
-			try {
-				$this->statCache->remove($path);
-				$this->client->proppatch($this->encodePath($path), ['{DAV:}lastmodified' => $mtime]);
-				// non-owncloud clients might not have accepted the property, need to recheck it
-				$response = $this->client->propfind($this->encodePath($path), ['{DAV:}getlastmodified'], 0);
-				if ($response === false) {
-					return false;
-				}
-				if (isset($response['{DAV:}getlastmodified'])) {
-					$remoteMtime = strtotime($response['{DAV:}getlastmodified']);
-					if ($remoteMtime !== $mtime) {
-						// server has not accepted the mtime
-						return false;
-					}
-				}
-			} catch (ClientHttpException $e) {
-				if ($e->getHttpStatus() === 501) {
-					return false;
-				}
-				$this->convertException($e, $path);
-				return false;
-			} catch (\Exception $e) {
-				$this->convertException($e, $path);
-				return false;
-			}
-		} else {
-			$this->file_put_contents($path, '');
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $data
-	 * @return int
-	 */
-	public function file_put_contents($path, $data) {
-		$path = $this->cleanPath($path);
-		$result = parent::file_put_contents($path, $data);
-		$this->statCache->remove($path);
-		return $result;
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 */
-	protected function uploadFile($path, $target) {
-		$this->init();
-
-		// invalidate
-		$target = $this->cleanPath($target);
-		$this->statCache->remove($target);
-		$source = fopen($path, 'r');
-
-		$this->httpClientService
-			->newClient()
-			->put($this->createBaseUri() . $this->encodePath($target), [
-				'body' => $source,
-				'auth' => [$this->user, $this->password]
-			]);
-
-		$this->removeCachedFile($target);
-	}
-
-	/** {@inheritdoc} */
-	public function rename($path1, $path2) {
-		$this->init();
-		$path1 = $this->cleanPath($path1);
-		$path2 = $this->cleanPath($path2);
-		try {
-			// overwrite directory ?
-			if ($this->is_dir($path2)) {
-				// needs trailing slash in destination
-				$path2 = rtrim($path2, '/') . '/';
-			}
-			$this->client->request(
-				'MOVE',
-				$this->encodePath($path1),
-				null,
-				[
-					'Destination' => $this->createBaseUri() . $this->encodePath($path2),
-				]
-			);
-			$this->statCache->clear($path1 . '/');
-			$this->statCache->clear($path2 . '/');
-			$this->statCache->set($path1, false);
-			$this->statCache->set($path2, true);
-			$this->removeCachedFile($path1);
-			$this->removeCachedFile($path2);
-			return true;
-		} catch (\Exception $e) {
-			$this->convertException($e);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function copy($path1, $path2) {
-		$this->init();
-		$path1 = $this->cleanPath($path1);
-		$path2 = $this->cleanPath($path2);
-		try {
-			// overwrite directory ?
-			if ($this->is_dir($path2)) {
-				// needs trailing slash in destination
-				$path2 = rtrim($path2, '/') . '/';
-			}
-			$this->client->request(
-				'COPY',
-				$this->encodePath($path1),
-				null,
-				[
-					'Destination' => $this->createBaseUri() . $this->encodePath($path2),
-				]
-			);
-			$this->statCache->clear($path2 . '/');
-			$this->statCache->set($path2, true);
-			$this->removeCachedFile($path2);
-			return true;
-		} catch (\Exception $e) {
-			$this->convertException($e);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function stat($path) {
-		try {
-			$response = $this->propfind($path);
-			if (!$response) {
-				return false;
-			}
-			return [
-				'mtime' => strtotime($response['{DAV:}getlastmodified']),
-				'size' => (int)isset($response['{DAV:}getcontentlength']) ? $response['{DAV:}getcontentlength'] : 0,
-			];
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return [];
-	}
-
-	/** {@inheritdoc} */
-	public function getMimeType($path) {
-		$remoteMimetype = $this->getMimeTypeFromRemote($path);
-		if ($remoteMimetype === 'application/octet-stream') {
-			return \OC::$server->getMimeTypeDetector()->detectPath($path);
-		} else {
-			return $remoteMimetype;
-		}
-	}
-
-	public function getMimeTypeFromRemote($path) {
-		try {
-			$response = $this->propfind($path);
-			if ($response === false) {
-				return false;
-			}
-			$responseType = [];
-			if (isset($response["{DAV:}resourcetype"])) {
-				/** @var ResourceType[] $response */
-				$responseType = $response["{DAV:}resourcetype"]->getValue();
-			}
-			$type = (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
-			if ($type == 'dir') {
-				return 'httpd/unix-directory';
-			} elseif (isset($response['{DAV:}getcontenttype'])) {
-				return $response['{DAV:}getcontenttype'];
-			} else {
-				return 'application/octet-stream';
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	public function cleanPath($path) {
-		if ($path === '') {
-			return $path;
-		}
-		$path = Filesystem::normalizePath($path);
-		// remove leading slash
-		return substr($path, 1);
-	}
-
-	/**
-	 * URL encodes the given path but keeps the slashes
-	 *
-	 * @param string $path to encode
-	 * @return string encoded path
-	 */
-	protected function encodePath($path) {
-		// slashes need to stay
-		return str_replace('%2F', '/', rawurlencode($path));
-	}
-
-	/**
-	 * @param string $method
-	 * @param string $path
-	 * @param string|resource|null $body
-	 * @param int $expected
-	 * @return bool
-	 * @throws StorageInvalidException
-	 * @throws StorageNotAvailableException
-	 */
-	protected function simpleResponse($method, $path, $body, $expected) {
-		$path = $this->cleanPath($path);
-		try {
-			$response = $this->client->request($method, $this->encodePath($path), $body);
-			return $response['statusCode'] == $expected;
-		} catch (ClientHttpException $e) {
-			if ($e->getHttpStatus() === 404 && $method === 'DELETE') {
-				$this->statCache->clear($path . '/');
-				$this->statCache->set($path, false);
-				return false;
-			}
-
-			$this->convertException($e, $path);
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/**
-	 * check if curl is installed
-	 */
-	public static function checkDependencies() {
-		return true;
-	}
-
-	/** {@inheritdoc} */
-	public function isUpdatable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_UPDATE);
-	}
-
-	/** {@inheritdoc} */
-	public function isCreatable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_CREATE);
-	}
-
-	/** {@inheritdoc} */
-	public function isSharable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_SHARE);
-	}
-
-	/** {@inheritdoc} */
-	public function isDeletable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_DELETE);
-	}
-
-	/** {@inheritdoc} */
-	public function getPermissions($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$response = $this->propfind($path);
-		if ($response === false) {
-			return 0;
-		}
-		if (isset($response['{http://owncloud.org/ns}permissions'])) {
-			return $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
-		} else if ($this->is_dir($path)) {
-			return Constants::PERMISSION_ALL;
-		} else if ($this->file_exists($path)) {
-			return Constants::PERMISSION_ALL - Constants::PERMISSION_CREATE;
-		} else {
-			return 0;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getETag($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$response = $this->propfind($path);
-		if ($response === false) {
-			return null;
-		}
-		if (isset($response['{DAV:}getetag'])) {
-			$etag = trim($response['{DAV:}getetag'], '"');
-			if (strlen($etag) > 40) {
-				$etag = md5($etag);
-			}
-			return $etag;
-		}
-		return parent::getEtag($path);
-	}
-
-	/**
-	 * @param string $permissionsString
-	 * @return int
-	 */
-	protected function parsePermissions($permissionsString) {
-		$permissions = Constants::PERMISSION_READ;
-		if (strpos($permissionsString, 'R') !== false) {
-			$permissions |= Constants::PERMISSION_SHARE;
-		}
-		if (strpos($permissionsString, 'D') !== false) {
-			$permissions |= Constants::PERMISSION_DELETE;
-		}
-		if (strpos($permissionsString, 'W') !== false) {
-			$permissions |= Constants::PERMISSION_UPDATE;
-		}
-		if (strpos($permissionsString, 'CK') !== false) {
-			$permissions |= Constants::PERMISSION_CREATE;
-			$permissions |= Constants::PERMISSION_UPDATE;
-		}
-		return $permissions;
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @throws \OCP\Files\StorageNotAvailableException
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		try {
-			// force refresh for $path
-			$this->statCache->remove($path);
-			$response = $this->propfind($path);
-			if ($response === false) {
-				if ($path === '') {
-					// if root is gone it means the storage is not available
-					throw new StorageNotAvailableException('root is gone');
-				}
-				return false;
-			}
-			if (isset($response['{DAV:}getetag'])) {
-				$cachedData = $this->getCache()->get($path);
-				$etag = null;
-				if (isset($response['{DAV:}getetag'])) {
-					$etag = trim($response['{DAV:}getetag'], '"');
-				}
-				if (!empty($etag) && $cachedData['etag'] !== $etag) {
-					return true;
-				} else if (isset($response['{http://open-collaboration-services.org/ns}share-permissions'])) {
-					$sharePermissions = (int)$response['{http://open-collaboration-services.org/ns}share-permissions'];
-					return $sharePermissions !== $cachedData['permissions'];
-				} else if (isset($response['{http://owncloud.org/ns}permissions'])) {
-					$permissions = $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
-					return $permissions !== $cachedData['permissions'];
-				} else {
-					return false;
-				}
-			} else {
-				$remoteMtime = strtotime($response['{DAV:}getlastmodified']);
-				return $remoteMtime > $time;
-			}
-		} catch (ClientHttpException $e) {
-			if ($e->getHttpStatus() === 405) {
-				if ($path === '') {
-					// if root is gone it means the storage is not available
-					throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-				}
-				return false;
-			}
-			$this->convertException($e, $path);
-			return false;
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-			return false;
-		}
-	}
-
-	/**
-	 * Interpret the given exception and decide whether it is due to an
-	 * unavailable storage, invalid storage or other.
-	 * This will either throw StorageInvalidException, StorageNotAvailableException
-	 * or do nothing.
-	 *
-	 * @param Exception $e sabre exception
-	 * @param string $path optional path from the operation
-	 *
-	 * @throws StorageInvalidException if the storage is invalid, for example
-	 * when the authentication expired or is invalid
-	 * @throws StorageNotAvailableException if the storage is not available,
-	 * which might be temporary
-	 * @throws ForbiddenException if the action is not allowed
-	 */
-	protected function convertException(Exception $e, $path = '') {
-		\OC::$server->getLogger()->logException($e, ['app' => 'files_external', 'level' => ILogger::DEBUG]);
-		if ($e instanceof ClientHttpException) {
-			if ($e->getHttpStatus() === Http::STATUS_LOCKED) {
-				throw new \OCP\Lock\LockedException($path);
-			}
-			if ($e->getHttpStatus() === Http::STATUS_UNAUTHORIZED) {
-				// either password was changed or was invalid all along
-				throw new StorageInvalidException(get_class($e) . ': ' . $e->getMessage());
-			} else if ($e->getHttpStatus() === Http::STATUS_METHOD_NOT_ALLOWED) {
-				// ignore exception for MethodNotAllowed, false will be returned
-				return;
-			} else if ($e->getHttpStatus() === Http::STATUS_FORBIDDEN){
-				// The operation is forbidden. Fail somewhat gracefully
-				throw new ForbiddenException(get_class($e) . ':' . $e->getMessage());
-			}
-			throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-		} else if ($e instanceof ClientException) {
-			// connection timeout or refused, server could be temporarily down
-			throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-		} else if ($e instanceof \InvalidArgumentException) {
-			// parse error because the server returned HTML instead of XML,
-			// possibly temporarily down
-			throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-		} else if (($e instanceof StorageNotAvailableException) || ($e instanceof StorageInvalidException)) {
-			// rethrow
-			throw $e;
-		}
-
-		// TODO: only log for now, but in the future need to wrap/rethrow exception
-	}
+    /** @var string */
+    protected $password;
+    /** @var string */
+    protected $user;
+    /** @var string */
+    protected $authType;
+    /** @var string */
+    protected $host;
+    /** @var bool */
+    protected $secure;
+    /** @var string */
+    protected $root;
+    /** @var string */
+    protected $certPath;
+    /** @var bool */
+    protected $ready;
+    /** @var Client */
+    protected $client;
+    /** @var ArrayCache */
+    protected $statCache;
+    /** @var IClientService */
+    protected $httpClientService;
+    /** @var ICertificateManager */
+    protected $certManager;
+
+    /**
+     * @param array $params
+     * @throws \Exception
+     */
+    public function __construct($params) {
+        $this->statCache = new ArrayCache();
+        $this->httpClientService = \OC::$server->getHTTPClientService();
+        if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
+            $host = $params['host'];
+            //remove leading http[s], will be generated in createBaseUri()
+            if (substr($host, 0, 8) == "https://") $host = substr($host, 8);
+            else if (substr($host, 0, 7) == "http://") $host = substr($host, 7);
+            $this->host = $host;
+            $this->user = $params['user'];
+            $this->password = $params['password'];
+            if (isset($params['authType'])) {
+                $this->authType = $params['authType'];
+            }
+            if (isset($params['secure'])) {
+                if (is_string($params['secure'])) {
+                    $this->secure = ($params['secure'] === 'true');
+                } else {
+                    $this->secure = (bool)$params['secure'];
+                }
+            } else {
+                $this->secure = false;
+            }
+            if ($this->secure === true) {
+                // inject mock for testing
+                $this->certManager = \OC::$server->getCertificateManager();
+                if (is_null($this->certManager)) { //no user
+                    $this->certManager = \OC::$server->getCertificateManager(null);
+                }
+            }
+            $this->root = $params['root'] ?? '/';
+            $this->root = '/' . ltrim($this->root, '/');
+            $this->root = rtrim($this->root, '/') . '/';
+        } else {
+            throw new \Exception('Invalid webdav storage configuration');
+        }
+    }
+
+    protected function init() {
+        if ($this->ready) {
+            return;
+        }
+        $this->ready = true;
+
+        $settings = [
+            'baseUri' => $this->createBaseUri(),
+            'userName' => $this->user,
+            'password' => $this->password,
+        ];
+        if (isset($this->authType)) {
+            $settings['authType'] = $this->authType;
+        }
+
+        $proxy = \OC::$server->getConfig()->getSystemValue('proxy', '');
+        if ($proxy !== '') {
+            $settings['proxy'] = $proxy;
+        }
+
+        $this->client = new Client($settings);
+        $this->client->setThrowExceptions(true);
+
+        if($this->secure === true) {
+            $certPath = $this->certManager->getAbsoluteBundlePath();
+            if (file_exists($certPath)) {
+                $this->certPath = $certPath;
+            }
+            if ($this->certPath) {
+                $this->client->addCurlSetting(CURLOPT_CAINFO, $this->certPath);
+            }
+        }
+    }
+
+    /**
+     * Clear the stat cache
+     */
+    public function clearStatCache() {
+        $this->statCache->clear();
+    }
+
+    /** {@inheritdoc} */
+    public function getId() {
+        return 'webdav::' . $this->user . '@' . $this->host . '/' . $this->root;
+    }
+
+    /** {@inheritdoc} */
+    public function createBaseUri() {
+        $baseUri = 'http';
+        if ($this->secure) {
+            $baseUri .= 's';
+        }
+        $baseUri .= '://' . $this->host . $this->root;
+        return $baseUri;
+    }
+
+    /** {@inheritdoc} */
+    public function mkdir($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $result = $this->simpleResponse('MKCOL', $path, null, 201);
+        if ($result) {
+            $this->statCache->set($path, true);
+        }
+        return $result;
+    }
+
+    /** {@inheritdoc} */
+    public function rmdir($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        // FIXME: some WebDAV impl return 403 when trying to DELETE
+        // a non-empty folder
+        $result = $this->simpleResponse('DELETE', $path . '/', null, 204);
+        $this->statCache->clear($path . '/');
+        $this->statCache->remove($path);
+        return $result;
+    }
+
+    /** {@inheritdoc} */
+    public function opendir($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        try {
+            $response = $this->client->propFind(
+                $this->encodePath($path),
+                ['{DAV:}getetag'],
+                1
+            );
+            if ($response === false) {
+                return false;
+            }
+            $content = [];
+            $files = array_keys($response);
+            array_shift($files); //the first entry is the current directory
+
+            if (!$this->statCache->hasKey($path)) {
+                $this->statCache->set($path, true);
+            }
+            foreach ($files as $file) {
+                $file = urldecode($file);
+                // do not store the real entry, we might not have all properties
+                if (!$this->statCache->hasKey($path)) {
+                    $this->statCache->set($file, true);
+                }
+                $file = basename($file);
+                $content[] = $file;
+            }
+            return IteratorDirectory::wrap($content);
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /**
+     * Propfind call with cache handling.
+     *
+     * First checks if information is cached.
+     * If not, request it from the server then store to cache.
+     *
+     * @param string $path path to propfind
+     *
+     * @return array|boolean propfind response or false if the entry was not found
+     *
+     * @throws ClientHttpException
+     */
+    protected function propfind($path) {
+        $path = $this->cleanPath($path);
+        $cachedResponse = $this->statCache->get($path);
+        // we either don't know it, or we know it exists but need more details
+        if (is_null($cachedResponse) || $cachedResponse === true) {
+            $this->init();
+            try {
+                $response = $this->client->propFind(
+                    $this->encodePath($path),
+                    [
+                        '{DAV:}getlastmodified',
+                        '{DAV:}getcontentlength',
+                        '{DAV:}getcontenttype',
+                        '{http://owncloud.org/ns}permissions',
+                        '{http://open-collaboration-services.org/ns}share-permissions',
+                        '{DAV:}resourcetype',
+                        '{DAV:}getetag',
+                    ]
+                );
+                $this->statCache->set($path, $response);
+            } catch (ClientHttpException $e) {
+                if ($e->getHttpStatus() === 404 || $e->getHttpStatus() === 405) {
+                    $this->statCache->clear($path . '/');
+                    $this->statCache->set($path, false);
+                    return false;
+                }
+                $this->convertException($e, $path);
+            } catch (\Exception $e) {
+                $this->convertException($e, $path);
+            }
+        } else {
+            $response = $cachedResponse;
+        }
+        return $response;
+    }
+
+    /** {@inheritdoc} */
+    public function filetype($path) {
+        try {
+            $response = $this->propfind($path);
+            if ($response === false) {
+                return false;
+            }
+            $responseType = [];
+            if (isset($response["{DAV:}resourcetype"])) {
+                /** @var ResourceType[] $response */
+                $responseType = $response["{DAV:}resourcetype"]->getValue();
+            }
+            return (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function file_exists($path) {
+        try {
+            $path = $this->cleanPath($path);
+            $cachedState = $this->statCache->get($path);
+            if ($cachedState === false) {
+                // we know the file doesn't exist
+                return false;
+            } else if (!is_null($cachedState)) {
+                return true;
+            }
+            // need to get from server
+            return ($this->propfind($path) !== false);
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function unlink($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $result = $this->simpleResponse('DELETE', $path, null, 204);
+        $this->statCache->clear($path . '/');
+        $this->statCache->remove($path);
+        return $result;
+    }
+
+    /** {@inheritdoc} */
+    public function fopen($path, $mode) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        switch ($mode) {
+            case 'r':
+            case 'rb':
+                try {
+                    $response = $this->httpClientService
+                        ->newClient()
+                        ->get($this->createBaseUri() . $this->encodePath($path), [
+                            'auth' => [$this->user, $this->password],
+                            'stream' => true
+                        ]);
+                } catch (\GuzzleHttp\Exception\ClientException $e) {
+                    if ($e->getResponse() instanceof ResponseInterface
+                        && $e->getResponse()->getStatusCode() === 404) {
+                        return false;
+                    } else {
+                        throw $e;
+                    }
+                }
+
+                if ($response->getStatusCode() !== Http::STATUS_OK) {
+                    if ($response->getStatusCode() === Http::STATUS_LOCKED) {
+                        throw new \OCP\Lock\LockedException($path);
+                    } else {
+                        Util::writeLog("webdav client", 'Guzzle get returned status code ' . $response->getStatusCode(), ILogger::ERROR);
+                    }
+                }
+
+                return $response->getBody();
+            case 'w':
+            case 'wb':
+            case 'a':
+            case 'ab':
+            case 'r+':
+            case 'w+':
+            case 'wb+':
+            case 'a+':
+            case 'x':
+            case 'x+':
+            case 'c':
+            case 'c+':
+                //emulate these
+                $tempManager = \OC::$server->getTempManager();
+                if (strrpos($path, '.') !== false) {
+                    $ext = substr($path, strrpos($path, '.'));
+                } else {
+                    $ext = '';
+                }
+                if ($this->file_exists($path)) {
+                    if (!$this->isUpdatable($path)) {
+                        return false;
+                    }
+                    if ($mode === 'w' or $mode === 'w+') {
+                        $tmpFile = $tempManager->getTemporaryFile($ext);
+                    } else {
+                        $tmpFile = $this->getCachedFile($path);
+                    }
+                } else {
+                    if (!$this->isCreatable(dirname($path))) {
+                        return false;
+                    }
+                    $tmpFile = $tempManager->getTemporaryFile($ext);
+                }
+                $handle = fopen($tmpFile, $mode);
+                return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+                    $this->writeBack($tmpFile, $path);
+                });
+        }
+    }
+
+    /**
+     * @param string $tmpFile
+     */
+    public function writeBack($tmpFile, $path) {
+        $this->uploadFile($tmpFile, $path);
+        unlink($tmpFile);
+    }
+
+    /** {@inheritdoc} */
+    public function free_space($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        try {
+            // TODO: cacheable ?
+            $response = $this->client->propfind($this->encodePath($path), ['{DAV:}quota-available-bytes']);
+            if ($response === false) {
+                return FileInfo::SPACE_UNKNOWN;
+            }
+            if (isset($response['{DAV:}quota-available-bytes'])) {
+                return (int)$response['{DAV:}quota-available-bytes'];
+            } else {
+                return FileInfo::SPACE_UNKNOWN;
+            }
+        } catch (\Exception $e) {
+            return FileInfo::SPACE_UNKNOWN;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function touch($path, $mtime = null) {
+        $this->init();
+        if (is_null($mtime)) {
+            $mtime = time();
+        }
+        $path = $this->cleanPath($path);
+
+        // if file exists, update the mtime, else create a new empty file
+        if ($this->file_exists($path)) {
+            try {
+                $this->statCache->remove($path);
+                $this->client->proppatch($this->encodePath($path), ['{DAV:}lastmodified' => $mtime]);
+                // non-owncloud clients might not have accepted the property, need to recheck it
+                $response = $this->client->propfind($this->encodePath($path), ['{DAV:}getlastmodified'], 0);
+                if ($response === false) {
+                    return false;
+                }
+                if (isset($response['{DAV:}getlastmodified'])) {
+                    $remoteMtime = strtotime($response['{DAV:}getlastmodified']);
+                    if ($remoteMtime !== $mtime) {
+                        // server has not accepted the mtime
+                        return false;
+                    }
+                }
+            } catch (ClientHttpException $e) {
+                if ($e->getHttpStatus() === 501) {
+                    return false;
+                }
+                $this->convertException($e, $path);
+                return false;
+            } catch (\Exception $e) {
+                $this->convertException($e, $path);
+                return false;
+            }
+        } else {
+            $this->file_put_contents($path, '');
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @param string $data
+     * @return int
+     */
+    public function file_put_contents($path, $data) {
+        $path = $this->cleanPath($path);
+        $result = parent::file_put_contents($path, $data);
+        $this->statCache->remove($path);
+        return $result;
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     */
+    protected function uploadFile($path, $target) {
+        $this->init();
+
+        // invalidate
+        $target = $this->cleanPath($target);
+        $this->statCache->remove($target);
+        $source = fopen($path, 'r');
+
+        $this->httpClientService
+            ->newClient()
+            ->put($this->createBaseUri() . $this->encodePath($target), [
+                'body' => $source,
+                'auth' => [$this->user, $this->password]
+            ]);
+
+        $this->removeCachedFile($target);
+    }
+
+    /** {@inheritdoc} */
+    public function rename($path1, $path2) {
+        $this->init();
+        $path1 = $this->cleanPath($path1);
+        $path2 = $this->cleanPath($path2);
+        try {
+            // overwrite directory ?
+            if ($this->is_dir($path2)) {
+                // needs trailing slash in destination
+                $path2 = rtrim($path2, '/') . '/';
+            }
+            $this->client->request(
+                'MOVE',
+                $this->encodePath($path1),
+                null,
+                [
+                    'Destination' => $this->createBaseUri() . $this->encodePath($path2),
+                ]
+            );
+            $this->statCache->clear($path1 . '/');
+            $this->statCache->clear($path2 . '/');
+            $this->statCache->set($path1, false);
+            $this->statCache->set($path2, true);
+            $this->removeCachedFile($path1);
+            $this->removeCachedFile($path2);
+            return true;
+        } catch (\Exception $e) {
+            $this->convertException($e);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function copy($path1, $path2) {
+        $this->init();
+        $path1 = $this->cleanPath($path1);
+        $path2 = $this->cleanPath($path2);
+        try {
+            // overwrite directory ?
+            if ($this->is_dir($path2)) {
+                // needs trailing slash in destination
+                $path2 = rtrim($path2, '/') . '/';
+            }
+            $this->client->request(
+                'COPY',
+                $this->encodePath($path1),
+                null,
+                [
+                    'Destination' => $this->createBaseUri() . $this->encodePath($path2),
+                ]
+            );
+            $this->statCache->clear($path2 . '/');
+            $this->statCache->set($path2, true);
+            $this->removeCachedFile($path2);
+            return true;
+        } catch (\Exception $e) {
+            $this->convertException($e);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function stat($path) {
+        try {
+            $response = $this->propfind($path);
+            if (!$response) {
+                return false;
+            }
+            return [
+                'mtime' => strtotime($response['{DAV:}getlastmodified']),
+                'size' => (int)isset($response['{DAV:}getcontentlength']) ? $response['{DAV:}getcontentlength'] : 0,
+            ];
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return [];
+    }
+
+    /** {@inheritdoc} */
+    public function getMimeType($path) {
+        $remoteMimetype = $this->getMimeTypeFromRemote($path);
+        if ($remoteMimetype === 'application/octet-stream') {
+            return \OC::$server->getMimeTypeDetector()->detectPath($path);
+        } else {
+            return $remoteMimetype;
+        }
+    }
+
+    public function getMimeTypeFromRemote($path) {
+        try {
+            $response = $this->propfind($path);
+            if ($response === false) {
+                return false;
+            }
+            $responseType = [];
+            if (isset($response["{DAV:}resourcetype"])) {
+                /** @var ResourceType[] $response */
+                $responseType = $response["{DAV:}resourcetype"]->getValue();
+            }
+            $type = (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
+            if ($type == 'dir') {
+                return 'httpd/unix-directory';
+            } elseif (isset($response['{DAV:}getcontenttype'])) {
+                return $response['{DAV:}getcontenttype'];
+            } else {
+                return 'application/octet-stream';
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    public function cleanPath($path) {
+        if ($path === '') {
+            return $path;
+        }
+        $path = Filesystem::normalizePath($path);
+        // remove leading slash
+        return substr($path, 1);
+    }
+
+    /**
+     * URL encodes the given path but keeps the slashes
+     *
+     * @param string $path to encode
+     * @return string encoded path
+     */
+    protected function encodePath($path) {
+        // slashes need to stay
+        return str_replace('%2F', '/', rawurlencode($path));
+    }
+
+    /**
+     * @param string $method
+     * @param string $path
+     * @param string|resource|null $body
+     * @param int $expected
+     * @return bool
+     * @throws StorageInvalidException
+     * @throws StorageNotAvailableException
+     */
+    protected function simpleResponse($method, $path, $body, $expected) {
+        $path = $this->cleanPath($path);
+        try {
+            $response = $this->client->request($method, $this->encodePath($path), $body);
+            return $response['statusCode'] == $expected;
+        } catch (ClientHttpException $e) {
+            if ($e->getHttpStatus() === 404 && $method === 'DELETE') {
+                $this->statCache->clear($path . '/');
+                $this->statCache->set($path, false);
+                return false;
+            }
+
+            $this->convertException($e, $path);
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /**
+     * check if curl is installed
+     */
+    public static function checkDependencies() {
+        return true;
+    }
+
+    /** {@inheritdoc} */
+    public function isUpdatable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_UPDATE);
+    }
+
+    /** {@inheritdoc} */
+    public function isCreatable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_CREATE);
+    }
+
+    /** {@inheritdoc} */
+    public function isSharable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_SHARE);
+    }
+
+    /** {@inheritdoc} */
+    public function isDeletable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_DELETE);
+    }
+
+    /** {@inheritdoc} */
+    public function getPermissions($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $response = $this->propfind($path);
+        if ($response === false) {
+            return 0;
+        }
+        if (isset($response['{http://owncloud.org/ns}permissions'])) {
+            return $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
+        } else if ($this->is_dir($path)) {
+            return Constants::PERMISSION_ALL;
+        } else if ($this->file_exists($path)) {
+            return Constants::PERMISSION_ALL - Constants::PERMISSION_CREATE;
+        } else {
+            return 0;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getETag($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $response = $this->propfind($path);
+        if ($response === false) {
+            return null;
+        }
+        if (isset($response['{DAV:}getetag'])) {
+            $etag = trim($response['{DAV:}getetag'], '"');
+            if (strlen($etag) > 40) {
+                $etag = md5($etag);
+            }
+            return $etag;
+        }
+        return parent::getEtag($path);
+    }
+
+    /**
+     * @param string $permissionsString
+     * @return int
+     */
+    protected function parsePermissions($permissionsString) {
+        $permissions = Constants::PERMISSION_READ;
+        if (strpos($permissionsString, 'R') !== false) {
+            $permissions |= Constants::PERMISSION_SHARE;
+        }
+        if (strpos($permissionsString, 'D') !== false) {
+            $permissions |= Constants::PERMISSION_DELETE;
+        }
+        if (strpos($permissionsString, 'W') !== false) {
+            $permissions |= Constants::PERMISSION_UPDATE;
+        }
+        if (strpos($permissionsString, 'CK') !== false) {
+            $permissions |= Constants::PERMISSION_CREATE;
+            $permissions |= Constants::PERMISSION_UPDATE;
+        }
+        return $permissions;
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @throws \OCP\Files\StorageNotAvailableException
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        try {
+            // force refresh for $path
+            $this->statCache->remove($path);
+            $response = $this->propfind($path);
+            if ($response === false) {
+                if ($path === '') {
+                    // if root is gone it means the storage is not available
+                    throw new StorageNotAvailableException('root is gone');
+                }
+                return false;
+            }
+            if (isset($response['{DAV:}getetag'])) {
+                $cachedData = $this->getCache()->get($path);
+                $etag = null;
+                if (isset($response['{DAV:}getetag'])) {
+                    $etag = trim($response['{DAV:}getetag'], '"');
+                }
+                if (!empty($etag) && $cachedData['etag'] !== $etag) {
+                    return true;
+                } else if (isset($response['{http://open-collaboration-services.org/ns}share-permissions'])) {
+                    $sharePermissions = (int)$response['{http://open-collaboration-services.org/ns}share-permissions'];
+                    return $sharePermissions !== $cachedData['permissions'];
+                } else if (isset($response['{http://owncloud.org/ns}permissions'])) {
+                    $permissions = $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
+                    return $permissions !== $cachedData['permissions'];
+                } else {
+                    return false;
+                }
+            } else {
+                $remoteMtime = strtotime($response['{DAV:}getlastmodified']);
+                return $remoteMtime > $time;
+            }
+        } catch (ClientHttpException $e) {
+            if ($e->getHttpStatus() === 405) {
+                if ($path === '') {
+                    // if root is gone it means the storage is not available
+                    throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+                }
+                return false;
+            }
+            $this->convertException($e, $path);
+            return false;
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+            return false;
+        }
+    }
+
+    /**
+     * Interpret the given exception and decide whether it is due to an
+     * unavailable storage, invalid storage or other.
+     * This will either throw StorageInvalidException, StorageNotAvailableException
+     * or do nothing.
+     *
+     * @param Exception $e sabre exception
+     * @param string $path optional path from the operation
+     *
+     * @throws StorageInvalidException if the storage is invalid, for example
+     * when the authentication expired or is invalid
+     * @throws StorageNotAvailableException if the storage is not available,
+     * which might be temporary
+     * @throws ForbiddenException if the action is not allowed
+     */
+    protected function convertException(Exception $e, $path = '') {
+        \OC::$server->getLogger()->logException($e, ['app' => 'files_external', 'level' => ILogger::DEBUG]);
+        if ($e instanceof ClientHttpException) {
+            if ($e->getHttpStatus() === Http::STATUS_LOCKED) {
+                throw new \OCP\Lock\LockedException($path);
+            }
+            if ($e->getHttpStatus() === Http::STATUS_UNAUTHORIZED) {
+                // either password was changed or was invalid all along
+                throw new StorageInvalidException(get_class($e) . ': ' . $e->getMessage());
+            } else if ($e->getHttpStatus() === Http::STATUS_METHOD_NOT_ALLOWED) {
+                // ignore exception for MethodNotAllowed, false will be returned
+                return;
+            } else if ($e->getHttpStatus() === Http::STATUS_FORBIDDEN){
+                // The operation is forbidden. Fail somewhat gracefully
+                throw new ForbiddenException(get_class($e) . ':' . $e->getMessage());
+            }
+            throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+        } else if ($e instanceof ClientException) {
+            // connection timeout or refused, server could be temporarily down
+            throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+        } else if ($e instanceof \InvalidArgumentException) {
+            // parse error because the server returned HTML instead of XML,
+            // possibly temporarily down
+            throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+        } else if (($e instanceof StorageNotAvailableException) || ($e instanceof StorageInvalidException)) {
+            // rethrow
+            throw $e;
+        }
+
+        // TODO: only log for now, but in the future need to wrap/rethrow exception
+    }
 }

lib/private/SubAdmin.php

Indentation +246 added lines, -246 removed lines

@@ -38,252 +38,252 @@
 
 class SubAdmin extends PublicEmitter implements ISubAdmin {
 
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/**
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param IDBConnection $dbConn
-	 */
-	public function __construct(IUserManager $userManager,
-	                            IGroupManager $groupManager,
-								IDBConnection $dbConn) {
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->dbConn = $dbConn;
-
-		$this->userManager->listen('\OC\User', 'postDelete', function($user) {
-			$this->post_deleteUser($user);
-		});
-		$this->groupManager->listen('\OC\Group', 'postDelete', function($group) {
-			$this->post_deleteGroup($group);
-		});
-	}
-
-	/**
-	 * add a SubAdmin
-	 * @param IUser $user user to be SubAdmin
-	 * @param IGroup $group group $user becomes subadmin of
-	 */
-	public function createSubAdmin(IUser $user, IGroup $group): void {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->insert('group_admin')
-			->values([
-				'gid' => $qb->createNamedParameter($group->getGID()),
-				'uid' => $qb->createNamedParameter($user->getUID())
-			])
-			->execute();
-
-		$this->emit('\OC\SubAdmin', 'postCreateSubAdmin', [$user, $group]);
-		\OC_Hook::emit("OC_SubAdmin", "post_createSubAdmin", ["gid" => $group->getGID()]);
-	}
-
-	/**
-	 * delete a SubAdmin
-	 * @param IUser $user the user that is the SubAdmin
-	 * @param IGroup $group the group
-	 */
-	public function deleteSubAdmin(IUser $user, IGroup $group): void {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$this->emit('\OC\SubAdmin', 'postDeleteSubAdmin', [$user, $group]);
-		\OC_Hook::emit("OC_SubAdmin", "post_deleteSubAdmin", ["gid" => $group->getGID()]);
-	}
-
-	/**
-	 * get groups of a SubAdmin
-	 * @param IUser $user the SubAdmin
-	 * @return IGroup[]
-	 */
-	public function getSubAdminsGroups(IUser $user): array {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('gid')
-			->from('group_admin')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$groups = [];
-		while($row = $result->fetch()) {
-			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($group)) {
-				$groups[$group->getGID()] = $group;
-			}
-		}
-		$result->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * get an array of groupid and displayName for a user
-	 * @param IUser $user
-	 * @return array ['displayName' => displayname]
-	 */
-	public function getSubAdminsGroupsName(IUser $user): array {
-		return array_map(function($group) {
-			return ['displayName' => $group->getDisplayName()];
-		}, $this->getSubAdminsGroups($user));
-	}
-
-	/**
-	 * get SubAdmins of a group
-	 * @param IGroup $group the group
-	 * @return IUser[]
-	 */
-	public function getGroupsSubAdmins(IGroup $group): array {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('uid')
-			->from('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->execute();
-
-		$users = [];
-		while($row = $result->fetch()) {
-			$user = $this->userManager->get($row['uid']);
-			if(!is_null($user)) {
-				$users[] = $user;
-			}
-		}
-		$result->closeCursor();
-
-		return $users;
-	}
-
-	/**
-	 * get all SubAdmins
-	 * @return array
-	 */
-	public function getAllSubAdmins(): array {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('*')
-			->from('group_admin')
-			->execute();
-
-		$subadmins = [];
-		while($row = $result->fetch()) {
-			$user = $this->userManager->get($row['uid']);
-			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($user) && !is_null($group)) {
-				$subadmins[] = [
-					'user'  => $user,
-					'group' => $group
-				];
-			}
-		}
-		$result->closeCursor();
-
-		return $subadmins;
-	}
-
-	/**
-	 * checks if a user is a SubAdmin of a group
-	 * @param IUser $user
-	 * @param IGroup $group
-	 * @return bool
-	 */
-	public function isSubAdminOfGroup(IUser $user, IGroup $group): bool {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		/*
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /**
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param IDBConnection $dbConn
+     */
+    public function __construct(IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                IDBConnection $dbConn) {
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->dbConn = $dbConn;
+
+        $this->userManager->listen('\OC\User', 'postDelete', function($user) {
+            $this->post_deleteUser($user);
+        });
+        $this->groupManager->listen('\OC\Group', 'postDelete', function($group) {
+            $this->post_deleteGroup($group);
+        });
+    }
+
+    /**
+     * add a SubAdmin
+     * @param IUser $user user to be SubAdmin
+     * @param IGroup $group group $user becomes subadmin of
+     */
+    public function createSubAdmin(IUser $user, IGroup $group): void {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->insert('group_admin')
+            ->values([
+                'gid' => $qb->createNamedParameter($group->getGID()),
+                'uid' => $qb->createNamedParameter($user->getUID())
+            ])
+            ->execute();
+
+        $this->emit('\OC\SubAdmin', 'postCreateSubAdmin', [$user, $group]);
+        \OC_Hook::emit("OC_SubAdmin", "post_createSubAdmin", ["gid" => $group->getGID()]);
+    }
+
+    /**
+     * delete a SubAdmin
+     * @param IUser $user the user that is the SubAdmin
+     * @param IGroup $group the group
+     */
+    public function deleteSubAdmin(IUser $user, IGroup $group): void {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $this->emit('\OC\SubAdmin', 'postDeleteSubAdmin', [$user, $group]);
+        \OC_Hook::emit("OC_SubAdmin", "post_deleteSubAdmin", ["gid" => $group->getGID()]);
+    }
+
+    /**
+     * get groups of a SubAdmin
+     * @param IUser $user the SubAdmin
+     * @return IGroup[]
+     */
+    public function getSubAdminsGroups(IUser $user): array {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('gid')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $groups = [];
+        while($row = $result->fetch()) {
+            $group = $this->groupManager->get($row['gid']);
+            if(!is_null($group)) {
+                $groups[$group->getGID()] = $group;
+            }
+        }
+        $result->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * get an array of groupid and displayName for a user
+     * @param IUser $user
+     * @return array ['displayName' => displayname]
+     */
+    public function getSubAdminsGroupsName(IUser $user): array {
+        return array_map(function($group) {
+            return ['displayName' => $group->getDisplayName()];
+        }, $this->getSubAdminsGroups($user));
+    }
+
+    /**
+     * get SubAdmins of a group
+     * @param IGroup $group the group
+     * @return IUser[]
+     */
+    public function getGroupsSubAdmins(IGroup $group): array {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('uid')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->execute();
+
+        $users = [];
+        while($row = $result->fetch()) {
+            $user = $this->userManager->get($row['uid']);
+            if(!is_null($user)) {
+                $users[] = $user;
+            }
+        }
+        $result->closeCursor();
+
+        return $users;
+    }
+
+    /**
+     * get all SubAdmins
+     * @return array
+     */
+    public function getAllSubAdmins(): array {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('*')
+            ->from('group_admin')
+            ->execute();
+
+        $subadmins = [];
+        while($row = $result->fetch()) {
+            $user = $this->userManager->get($row['uid']);
+            $group = $this->groupManager->get($row['gid']);
+            if(!is_null($user) && !is_null($group)) {
+                $subadmins[] = [
+                    'user'  => $user,
+                    'group' => $group
+                ];
+            }
+        }
+        $result->closeCursor();
+
+        return $subadmins;
+    }
+
+    /**
+     * checks if a user is a SubAdmin of a group
+     * @param IUser $user
+     * @param IGroup $group
+     * @return bool
+     */
+    public function isSubAdminOfGroup(IUser $user, IGroup $group): bool {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        /*
 		 * Primary key is ('gid', 'uid') so max 1 result possible here
 		 */
-		$result = $qb->select('*')
-			->from('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$fetch =  $result->fetch();
-		$result->closeCursor();
-		$result = !empty($fetch) ? true : false;
-
-		return $result;
-	}
-
-	/**
-	 * checks if a user is a SubAdmin
-	 * @param IUser $user
-	 * @return bool
-	 */
-	public function isSubAdmin(IUser $user): bool {
-		// Check if the user is already an admin
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('gid')
-			->from('group_admin')
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->setMaxResults(1)
-			->execute();
-
-		$isSubAdmin = $result->fetch();
-		$result->closeCursor();
-
-		return $isSubAdmin !== false;
-	}
-
-	/**
-	 * checks if a user is a accessible by a subadmin
-	 * @param IUser $subadmin
-	 * @param IUser $user
-	 * @return bool
-	 */
-	public function isUserAccessible(IUser $subadmin, IUser $user): bool {
-		if(!$this->isSubAdmin($subadmin)) {
-			return false;
-		}
-		if($this->groupManager->isAdmin($user->getUID())) {
-			return false;
-		}
-		$accessibleGroups = $this->getSubAdminsGroups($subadmin);
-		foreach($accessibleGroups as $accessibleGroup) {
-			if($accessibleGroup->inGroup($user)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * delete all SubAdmins by $user
-	 * @param IUser $user
-	 */
-	private function post_deleteUser(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-	}
-
-	/**
-	 * delete all SubAdmins by $group
-	 * @param IGroup $group
-	 */
-	private function post_deleteGroup(IGroup $group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->execute();
-	}
+        $result = $qb->select('*')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $fetch =  $result->fetch();
+        $result->closeCursor();
+        $result = !empty($fetch) ? true : false;
+
+        return $result;
+    }
+
+    /**
+     * checks if a user is a SubAdmin
+     * @param IUser $user
+     * @return bool
+     */
+    public function isSubAdmin(IUser $user): bool {
+        // Check if the user is already an admin
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('gid')
+            ->from('group_admin')
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->setMaxResults(1)
+            ->execute();
+
+        $isSubAdmin = $result->fetch();
+        $result->closeCursor();
+
+        return $isSubAdmin !== false;
+    }
+
+    /**
+     * checks if a user is a accessible by a subadmin
+     * @param IUser $subadmin
+     * @param IUser $user
+     * @return bool
+     */
+    public function isUserAccessible(IUser $subadmin, IUser $user): bool {
+        if(!$this->isSubAdmin($subadmin)) {
+            return false;
+        }
+        if($this->groupManager->isAdmin($user->getUID())) {
+            return false;
+        }
+        $accessibleGroups = $this->getSubAdminsGroups($subadmin);
+        foreach($accessibleGroups as $accessibleGroup) {
+            if($accessibleGroup->inGroup($user)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * delete all SubAdmins by $user
+     * @param IUser $user
+     */
+    private function post_deleteUser(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+    }
+
+    /**
+     * delete all SubAdmins by $group
+     * @param IGroup $group
+     */
+    private function post_deleteGroup(IGroup $group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->execute();
+    }
 }

lib/private/Template/Base.php

Indentation +155 added lines, -155 removed lines

@@ -32,160 +32,160 @@
 use OCP\Defaults;
 
 class Base {
-	private $template; // The template
-	private $vars; // Vars
-
-	/** @var \OCP\IL10N */
-	private $l10n;
-
-	/** @var Defaults */
-	private $theme;
-
-	/**
-	 * @param string $template
-	 * @param string $requestToken
-	 * @param \OCP\IL10N $l10n
-	 * @param Defaults $theme
-	 */
-	public function __construct($template, $requestToken, $l10n, $theme ) {
-		$this->vars = [];
-		$this->vars['requesttoken'] = $requestToken;
-		$this->l10n = $l10n;
-		$this->template = $template;
-		$this->theme = $theme;
-	}
-
-	/**
-	 * @param string $serverRoot
-	 * @param string|false $app_dir
-	 * @param string $theme
-	 * @param string $app
-	 * @return string[]
-	 */
-	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
-		// Check if the app is in the app folder or in the root
-		if( file_exists($app_dir.'/templates/' )) {
-			return [
-				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
-				$app_dir.'/templates/',
-			];
-		}
-		return [
-			$serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
-			$serverRoot.'/'.$app.'/templates/',
-		];
-	}
-
-	/**
-	 * @param string $serverRoot
-	 * @param string $theme
-	 * @return string[]
-	 */
-	protected function getCoreTemplateDirs($theme, $serverRoot) {
-		return [
-			$serverRoot.'/themes/'.$theme.'/core/templates/',
-			$serverRoot.'/core/templates/',
-		];
-	}
-
-	/**
-	 * Assign variables
-	 * @param string $key key
-	 * @param array|bool|integer|string $value value
-	 * @return bool
-	 *
-	 * This function assigns a variable. It can be accessed via $_[$key] in
-	 * the template.
-	 *
-	 * If the key existed before, it will be overwritten
-	 */
-	public function assign( $key, $value) {
-		$this->vars[$key] = $value;
-		return true;
-	}
-
-	/**
-	 * Appends a variable
-	 * @param string $key key
-	 * @param mixed $value value
-	 *
-	 * This function assigns a variable in an array context. If the key already
-	 * exists, the value will be appended. It can be accessed via
-	 * $_[$key][$position] in the template.
-	 */
-	public function append( $key, $value ) {
-		if( array_key_exists( $key, $this->vars )) {
-			$this->vars[$key][] = $value;
-		}
-		else{
-			$this->vars[$key] = [ $value ];
-		}
-	}
-
-	/**
-	 * Prints the proceeded template
-	 * @return bool
-	 *
-	 * This function proceeds the template and prints its output.
-	 */
-	public function printPage() {
-		$data = $this->fetchPage();
-		if( $data === false ) {
-			return false;
-		}
-		else{
-			print $data;
-			return true;
-		}
-	}
-
-	/**
-	 * Process the template
-	 *
-	 * @param array|null $additionalParams
-	 * @return string This function processes the template.
-	 *
-	 * This function processes the template.
-	 */
-	public function fetchPage($additionalParams = null) {
-		return $this->load($this->template, $additionalParams);
-	}
-
-	/**
-	 * doing the actual work
-	 *
-	 * @param string $file
-	 * @param array|null $additionalParams
-	 * @return string content
-	 *
-	 * Includes the template file, fetches its output
-	 */
-	protected function load($file, $additionalParams = null) {
-		// Register the variables
-		$_ = $this->vars;
-		$l = $this->l10n;
-		$theme = $this->theme;
-
-		if(!is_null($additionalParams)) {
-			$_ = array_merge( $additionalParams, $this->vars );
-			foreach ($_ as $var => $value) {
-				${$var} = $value;
-			}
-		}
-
-		// Include
-		ob_start();
-		try {
-			include $file;
-			$data = ob_get_contents();
-		} catch (\Exception $e) {
-			@ob_end_clean();
-			throw $e;
-		}
-		@ob_end_clean();
-
-		// Return data
-		return $data;
-	}
+    private $template; // The template
+    private $vars; // Vars
+
+    /** @var \OCP\IL10N */
+    private $l10n;
+
+    /** @var Defaults */
+    private $theme;
+
+    /**
+     * @param string $template
+     * @param string $requestToken
+     * @param \OCP\IL10N $l10n
+     * @param Defaults $theme
+     */
+    public function __construct($template, $requestToken, $l10n, $theme ) {
+        $this->vars = [];
+        $this->vars['requesttoken'] = $requestToken;
+        $this->l10n = $l10n;
+        $this->template = $template;
+        $this->theme = $theme;
+    }
+
+    /**
+     * @param string $serverRoot
+     * @param string|false $app_dir
+     * @param string $theme
+     * @param string $app
+     * @return string[]
+     */
+    protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
+        // Check if the app is in the app folder or in the root
+        if( file_exists($app_dir.'/templates/' )) {
+            return [
+                $serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
+                $app_dir.'/templates/',
+            ];
+        }
+        return [
+            $serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
+            $serverRoot.'/'.$app.'/templates/',
+        ];
+    }
+
+    /**
+     * @param string $serverRoot
+     * @param string $theme
+     * @return string[]
+     */
+    protected function getCoreTemplateDirs($theme, $serverRoot) {
+        return [
+            $serverRoot.'/themes/'.$theme.'/core/templates/',
+            $serverRoot.'/core/templates/',
+        ];
+    }
+
+    /**
+     * Assign variables
+     * @param string $key key
+     * @param array|bool|integer|string $value value
+     * @return bool
+     *
+     * This function assigns a variable. It can be accessed via $_[$key] in
+     * the template.
+     *
+     * If the key existed before, it will be overwritten
+     */
+    public function assign( $key, $value) {
+        $this->vars[$key] = $value;
+        return true;
+    }
+
+    /**
+     * Appends a variable
+     * @param string $key key
+     * @param mixed $value value
+     *
+     * This function assigns a variable in an array context. If the key already
+     * exists, the value will be appended. It can be accessed via
+     * $_[$key][$position] in the template.
+     */
+    public function append( $key, $value ) {
+        if( array_key_exists( $key, $this->vars )) {
+            $this->vars[$key][] = $value;
+        }
+        else{
+            $this->vars[$key] = [ $value ];
+        }
+    }
+
+    /**
+     * Prints the proceeded template
+     * @return bool
+     *
+     * This function proceeds the template and prints its output.
+     */
+    public function printPage() {
+        $data = $this->fetchPage();
+        if( $data === false ) {
+            return false;
+        }
+        else{
+            print $data;
+            return true;
+        }
+    }
+
+    /**
+     * Process the template
+     *
+     * @param array|null $additionalParams
+     * @return string This function processes the template.
+     *
+     * This function processes the template.
+     */
+    public function fetchPage($additionalParams = null) {
+        return $this->load($this->template, $additionalParams);
+    }
+
+    /**
+     * doing the actual work
+     *
+     * @param string $file
+     * @param array|null $additionalParams
+     * @return string content
+     *
+     * Includes the template file, fetches its output
+     */
+    protected function load($file, $additionalParams = null) {
+        // Register the variables
+        $_ = $this->vars;
+        $l = $this->l10n;
+        $theme = $this->theme;
+
+        if(!is_null($additionalParams)) {
+            $_ = array_merge( $additionalParams, $this->vars );
+            foreach ($_ as $var => $value) {
+                ${$var} = $value;
+            }
+        }
+
+        // Include
+        ob_start();
+        try {
+            include $file;
+            $data = ob_get_contents();
+        } catch (\Exception $e) {
+            @ob_end_clean();
+            throw $e;
+        }
+        @ob_end_clean();
+
+        // Return data
+        return $data;
+    }
 
 }

lib/private/Template/ResourceLocator.php

Indentation +169 added lines, -169 removed lines

@@ -30,173 +30,173 @@
 namespace OC\Template;
 
 abstract class ResourceLocator {
-	protected $theme;
-
-	protected $mapping;
-	protected $serverroot;
-	protected $thirdpartyroot;
-	protected $webroot;
-
-	protected $resources = [];
-
-	/** @var \OCP\ILogger */
-	protected $logger;
-
-	/**
-	 * @param \OCP\ILogger $logger
-	 * @param string $theme
-	 * @param array $core_map
-	 * @param array $party_map
-	 */
-	public function __construct(\OCP\ILogger $logger, $theme, $core_map, $party_map) {
-		$this->logger = $logger;
-		$this->theme = $theme;
-		$this->mapping = $core_map + $party_map;
-		$this->serverroot = key($core_map);
-		$this->thirdpartyroot = key($party_map);
-		$this->webroot = $this->mapping[$this->serverroot];
-	}
-
-	/**
-	 * @param string $resource
-	 */
-	abstract public function doFind($resource);
-
-	/**
-	 * @param string $resource
-	 */
-	abstract public function doFindTheme($resource);
-
-	/**
-	 * Finds the resources and adds them to the list
-	 *
-	 * @param array $resources
-	 */
-	public function find($resources) {
-		foreach ($resources as $resource) {
-			try {
-				$this->doFind($resource);
-			} catch (ResourceNotFoundException $e) {
-				$resourceApp = substr($resource, 0, strpos($resource, '/'));
-				$this->logger->debug('Could not find resource file "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
-			}
-		}
-		if (!empty($this->theme)) {
-			foreach ($resources as $resource) {
-				try {
-					$this->doFindTheme($resource);
-				} catch (ResourceNotFoundException $e) {
-					$resourceApp = substr($resource, 0, strpos($resource, '/'));
-					$this->logger->debug('Could not find resource file in theme "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
-				}
-			}
-		}
-	}
-
-	/**
-	 * append the $file resource if exist at $root
-	 *
-	 * @param string $root path to check
-	 * @param string $file the filename
-	 * @param string|null $webRoot base for path, default map $root to $webRoot
-	 * @return bool True if the resource was found, false otherwise
-	 */
-	protected function appendIfExist($root, $file, $webRoot = null) {
-		if (is_file($root.'/'.$file)) {
-			$this->append($root, $file, $webRoot, false);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Attempt to find the webRoot
-	 *
-	 * traverse the potential web roots upwards in the path
-	 *
-	 * example:
-	 *   - root: /srv/www/apps/myapp
-	 *   - available mappings: ['/srv/www']
-	 *
-	 * First we check if a mapping for /srv/www/apps/myapp is available,
-	 * then /srv/www/apps, /srv/www/apps, /srv/www, ... until we find a
-	 * valid web root
-	 *
-	 * @param string $root
-	 * @return string|null The web root or null on failure
-	 */
-	protected function findWebRoot($root) {
-		$webRoot = null;
-		$tmpRoot = $root;
-
-		while ($webRoot === null) {
-			if (isset($this->mapping[$tmpRoot])) {
-				$webRoot = $this->mapping[$tmpRoot];
-				break;
-			}
-
-			if ($tmpRoot === '/') {
-				break;
-			}
-
-			$tmpRoot = dirname($tmpRoot);
-		}
-
-		if ($webRoot === null) {
-			$realpath = realpath($root);
-
-			if ($realpath && ($realpath !== $root)) {
-				return $this->findWebRoot($realpath);
-			}
-		}
-
-		return $webRoot;
-	}
-
-	/**
-	 * append the $file resource at $root
-	 *
-	 * @param string $root path to check
-	 * @param string $file the filename
-	 * @param string|null $webRoot base for path, default map $root to $webRoot
-	 * @param bool $throw Throw an exception, when the route does not exist
-	 * @throws ResourceNotFoundException Only thrown when $throw is true and the resource is missing
-	 */
-	protected function append($root, $file, $webRoot = null, $throw = true) {
-
-		if (!is_string($root)) {
-			if ($throw) {
-				throw new ResourceNotFoundException($file, $webRoot);
-			}
-			return;
-		}
-
-		if (!$webRoot) {
-			$webRoot = $this->findWebRoot($root);
-
-			if ($webRoot === null) {
-				$webRoot = '';
-				$this->logger->error('ResourceLocator can not find a web root (root: {root}, file: {file}, webRoot: {webRoot}, throw: {throw})', [
-					'app' => 'lib',
-					'root' => $root,
-					'file' => $file,
-					'webRoot' => $webRoot,
-					'throw' => $throw ? 'true' : 'false'
-				]);
-			}
-		}
-		$this->resources[] = [$root, $webRoot, $file];
-
-		if ($throw && !is_file($root . '/' . $file)) {
-			throw new ResourceNotFoundException($file, $webRoot);
-		}
-	}
-
-	/**
-	 * Returns the list of all resources that should be loaded
-	 * @return array
-	 */
-	public function getResources() {
-		return $this->resources;
-	}
+    protected $theme;
+
+    protected $mapping;
+    protected $serverroot;
+    protected $thirdpartyroot;
+    protected $webroot;
+
+    protected $resources = [];
+
+    /** @var \OCP\ILogger */
+    protected $logger;
+
+    /**
+     * @param \OCP\ILogger $logger
+     * @param string $theme
+     * @param array $core_map
+     * @param array $party_map
+     */
+    public function __construct(\OCP\ILogger $logger, $theme, $core_map, $party_map) {
+        $this->logger = $logger;
+        $this->theme = $theme;
+        $this->mapping = $core_map + $party_map;
+        $this->serverroot = key($core_map);
+        $this->thirdpartyroot = key($party_map);
+        $this->webroot = $this->mapping[$this->serverroot];
+    }
+
+    /**
+     * @param string $resource
+     */
+    abstract public function doFind($resource);
+
+    /**
+     * @param string $resource
+     */
+    abstract public function doFindTheme($resource);
+
+    /**
+     * Finds the resources and adds them to the list
+     *
+     * @param array $resources
+     */
+    public function find($resources) {
+        foreach ($resources as $resource) {
+            try {
+                $this->doFind($resource);
+            } catch (ResourceNotFoundException $e) {
+                $resourceApp = substr($resource, 0, strpos($resource, '/'));
+                $this->logger->debug('Could not find resource file "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
+            }
+        }
+        if (!empty($this->theme)) {
+            foreach ($resources as $resource) {
+                try {
+                    $this->doFindTheme($resource);
+                } catch (ResourceNotFoundException $e) {
+                    $resourceApp = substr($resource, 0, strpos($resource, '/'));
+                    $this->logger->debug('Could not find resource file in theme "' . $e->getResourcePath() . '"', ['app' => $resourceApp]);
+                }
+            }
+        }
+    }
+
+    /**
+     * append the $file resource if exist at $root
+     *
+     * @param string $root path to check
+     * @param string $file the filename
+     * @param string|null $webRoot base for path, default map $root to $webRoot
+     * @return bool True if the resource was found, false otherwise
+     */
+    protected function appendIfExist($root, $file, $webRoot = null) {
+        if (is_file($root.'/'.$file)) {
+            $this->append($root, $file, $webRoot, false);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Attempt to find the webRoot
+     *
+     * traverse the potential web roots upwards in the path
+     *
+     * example:
+     *   - root: /srv/www/apps/myapp
+     *   - available mappings: ['/srv/www']
+     *
+     * First we check if a mapping for /srv/www/apps/myapp is available,
+     * then /srv/www/apps, /srv/www/apps, /srv/www, ... until we find a
+     * valid web root
+     *
+     * @param string $root
+     * @return string|null The web root or null on failure
+     */
+    protected function findWebRoot($root) {
+        $webRoot = null;
+        $tmpRoot = $root;
+
+        while ($webRoot === null) {
+            if (isset($this->mapping[$tmpRoot])) {
+                $webRoot = $this->mapping[$tmpRoot];
+                break;
+            }
+
+            if ($tmpRoot === '/') {
+                break;
+            }
+
+            $tmpRoot = dirname($tmpRoot);
+        }
+
+        if ($webRoot === null) {
+            $realpath = realpath($root);
+
+            if ($realpath && ($realpath !== $root)) {
+                return $this->findWebRoot($realpath);
+            }
+        }
+
+        return $webRoot;
+    }
+
+    /**
+     * append the $file resource at $root
+     *
+     * @param string $root path to check
+     * @param string $file the filename
+     * @param string|null $webRoot base for path, default map $root to $webRoot
+     * @param bool $throw Throw an exception, when the route does not exist
+     * @throws ResourceNotFoundException Only thrown when $throw is true and the resource is missing
+     */
+    protected function append($root, $file, $webRoot = null, $throw = true) {
+
+        if (!is_string($root)) {
+            if ($throw) {
+                throw new ResourceNotFoundException($file, $webRoot);
+            }
+            return;
+        }
+
+        if (!$webRoot) {
+            $webRoot = $this->findWebRoot($root);
+
+            if ($webRoot === null) {
+                $webRoot = '';
+                $this->logger->error('ResourceLocator can not find a web root (root: {root}, file: {file}, webRoot: {webRoot}, throw: {throw})', [
+                    'app' => 'lib',
+                    'root' => $root,
+                    'file' => $file,
+                    'webRoot' => $webRoot,
+                    'throw' => $throw ? 'true' : 'false'
+                ]);
+            }
+        }
+        $this->resources[] = [$root, $webRoot, $file];
+
+        if ($throw && !is_file($root . '/' . $file)) {
+            throw new ResourceNotFoundException($file, $webRoot);
+        }
+    }
+
+    /**
+     * Returns the list of all resources that should be loaded
+     * @return array
+     */
+    public function getResources() {
+        return $this->resources;
+    }
 }